API Documentation
\
MoxiworksPlatform
Exception

\MoxiworksPlatformCredentials

Object used to manage Moxi Works Platform credentials

Summary

Methods
Properties
Constants
__construct()
secret()
setSecret()
identifier()
setIdentifier()
instance()
setInstance()
ready()
getIdentifier()
getSecret()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$identifier
$secret
$instance
N/A

Properties

$identifier

$identifier : \Symfony\Component\Translation\Tests\StringClass

Type

\Symfony\Component\Translation\Tests\StringClass — Your Moxi Works Platform Identifier. this must be set before any Moxi Works Platform calls can be made.

$secret

$secret : \Symfony\Component\Translation\Tests\StringClass

Type

\Symfony\Component\Translation\Tests\StringClass — Your Moxi Works Platform secret. this must be set before any Moxi Works Platform calls can be made

Methods

__construct()

__construct(\Symfony\Component\Translation\Tests\StringClass  $platform_id, \Symfony\Component\Translation\Tests\StringClass  $secret)

Constructs a new MoxiworksPlatform\Credentials object, with the specified Moxi Works Platform Identifier and Moxi Works Platform Secret

Parameters

\Symfony\Component\Translation\Tests\StringClass $platform_id

Your Moxi Works Platform ID
\Symfony\Component\Translation\Tests\StringClass $secret

Your Moxi Works Platform Secret

secret()

secret() : \Symfony\Component\Translation\Tests\StringClass

The configured platform secret

Returns

\Symfony\Component\Translation\Tests\StringClass —

the platform secret

setSecret()

setSecret(  $sec)

Parameters

$sec

StringClass Your Moxi Works Platform secret

identifier()

identifier() : \Symfony\Component\Translation\Tests\StringClass

Returns

\Symfony\Component\Translation\Tests\StringClass —

Your Moxi Works Platform Identifier

setIdentifier()

setIdentifier(  $pid)

Parameters

$pid

StringClass Your Moxi Works Platform ID

setInstance()

setInstance(  $inst)

Parameters

$inst

Credentials The Singleton instnace of this class

ready()

ready() : boolean

Returns

boolean —

Whether the Moxi Works Platform Identifier and Secret have been set.

getIdentifier()

getIdentifier() : string

Returns the Moxi Works Platform Identifier for this credentials object.

Returns

string

getSecret()

getSecret() : string

Returns the Moxi Works Platform secret for this credentials object.

Returns

string