API Documentation
\
mCASH
Error
HttpClient
Utilities

\mCASHStatusCode

StatusCode class.

Summary

Methods
Properties
Constants
endpointUrlAppend()
baseUrl()
instanceUrl()
classUrl()
classAppendUrl()
className()
refresh()
__construct()
__set()
__isset()
__unset()
__get()
offsetSet()
offsetExists()
offsetUnset()
offsetGet()
keys()
constructFrom()
refreshFrom()
serializeParameters()
jsonSerialize()
__toJSON()
__toString()
__toArray()
retrieve()
all()
No public properties found
No constants found
_request()
_create()
_all()
_retrieve()
_save()
_delete()
$endpointUrlAppend
$updateParams
$_opts
$_values
$_unsavedValues
$_retrieveOptions
$endpointUrl
N/A
_validateParams()
No private properties found
N/A

Properties

$endpointUrlAppend

$endpointUrlAppend : mixed

endpointUrlAppend

String that will be appended to the API instance url

Type

mixed

$updateParams

$updateParams : array

updateParams

(default value: array()) Contains strings of allowed object values to be updated upon save

Type

array

$_opts

$_opts : mixed

_opts

Type

mixed

$_values

$_values : mixed

_values

Type

mixed

$_unsavedValues

$_unsavedValues : mixed

_unsavedValues

Type

mixed

$_retrieveOptions

$_retrieveOptions : mixed

_retrieveOptions

Type

mixed

$endpointUrl

$endpointUrl : string

endpointUrl

(default value: "status_code")

Type

string

Methods

endpointUrlAppend()

endpointUrlAppend(mixed  $apnd) : void

endpointUrlAppend function.

Used to change the static endpointUrlAppend variable

Parameters

mixed $apnd

baseUrl()

baseUrl() : string

baseUrl function.

Returns the base url for the api based on api status (live / test).

Returns

string

instanceUrl()

instanceUrl() : string

instanceUrl function.

Returns the full url for the instance that is called.

Returns

string

classUrl()

classUrl() : string

classUrl function.

Returns the api url for the current class (fallback to class name if endpointUrl is not defined)

Returns

string

classAppendUrl()

classAppendUrl() : string

clasAppendsUrl function.

Returns a string to append on the classUrl() if $endpointUrlAppend is defined in the current class

Returns

string

className()

className() : string

className function.

Returns a classname without namespaces

Returns

string

refresh()

refresh() : \mCASH\mCASHObject|static

refresh function.

Reloads the current instance from the mCASH Api

Returns

\mCASH\mCASHObject|static

__construct()

__construct(mixed  $id = null, mixed  $opts = null) : void

__construct function.

Parameters

mixed $id

(default: null)
mixed $opts

(default: null)

__set()

__set(mixed  $k, mixed  $v) : void

__set function.

Parameters

mixed $k
mixed $v

__isset()

__isset(mixed  $k) : void

__isset function.

Parameters

mixed $k

__unset()

__unset(mixed  $k) : void

__unset function.

Parameters

mixed $k

__get()

__get(mixed  $k) : void

__get function.

Parameters

mixed $k

offsetSet()

offsetSet(mixed  $k, mixed  $v) : void

offsetSet function.

Parameters

mixed $k
mixed $v

offsetExists()

offsetExists(mixed  $k) : void

offsetExists function.

Parameters

mixed $k

offsetUnset()

offsetUnset(mixed  $k) : void

offsetUnset function.

Parameters

mixed $k

offsetGet()

offsetGet(mixed  $k) : void

offsetGet function.

Parameters

mixed $k

keys()

keys() : void

keys function.

constructFrom()

constructFrom(mixed  $values, mixed  $opts) : void

constructFrom function.

Parameters

mixed $values
mixed $opts

refreshFrom()

refreshFrom(mixed  $values, mixed  $opts, boolean  $partial = false) : void

refreshFrom function.

Parameters

mixed $values
mixed $opts
boolean $partial

(default: false)

serializeParameters()

serializeParameters() : void

serializeParameters function.

jsonSerialize()

jsonSerialize() : void

jsonSerialize function.

__toJSON()

__toJSON() : void

__toJSON function.

__toString()

__toString() : void

__toString function.

__toArray()

__toArray(boolean  $recursive = false) : void

__toArray function.

Parameters

boolean $recursive

(default: false)

retrieve()

retrieve(mixed  $id = null, mixed  $opts = null) : void

retrieve function.

Parameters

mixed $id

(default: null)
mixed $opts

(default: null)

all()

all() : void

all function.

_request()

_request(mixed  $method, mixed  $url, array  $params = array(), mixed  $opts = null) : \mCASH\mCASHObject|static

_request function.

Handles request to the mCASH API and returns and instance of mCASHObject or the current class

Parameters

mixed $method
mixed $url
array $params

(default: array())
mixed $opts

(default: null)

Returns

\mCASH\mCASHObject|static

_create()

_create(mixed  $params = null, mixed  $opts = null) : \mCASH\mCASHObject|Static

_create function.

Sends POST with parameters to mCASH Api. Used when creating new objects

Parameters

mixed $params

(default: null)
mixed $opts

(default: null)

Returns

\mCASH\mCASHObject|Static

_all()

_all(mixed  $params = null, mixed  $opts = null) : \mCASH\mCASHObject|Static

_all function.

Fetches all object of given type from mCASH Api

Parameters

mixed $params

(default: null)
mixed $opts

(default: null)

Returns

\mCASH\mCASHObject|Static

_retrieve()

_retrieve(mixed  $id, mixed  $opts = null) : Static

_retrieve function.

Retrieves a specific object from mCASH Api based on current object class and ID

Parameters

mixed $id
mixed $opts

(default: null)

Returns

Static

_save()

_save(mixed  $opts = null) : Static

_save function.

Performs a PUT request to mCASH Api, saving the current object

Parameters

mixed $opts

(default: null)

Returns

Static

_delete()

_delete(mixed  $params = null, mixed  $opts = null) : Boolean

_delete function.

Performs a DELETE request to mCASH Api, deleting the current object

Parameters

mixed $params

(default: null)
mixed $opts

(default: null)

Returns

Boolean

_validateParams()

_validateParams(mixed  $params = null) : void

_validateParams function.

Function used to validate that a params array have been passed

Parameters

mixed $params

(default: null)