Reamaze PHP SDK
Back to top  

Api

Class Api

package

mixisLv\Reamaze
author

Mikus Rozenbergs mikus.rozenbergs@gmail.com

Methods

__construct

__construct(string $brand, string $loginEmail, string $apiToken)
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$brand

string

your Reamaze brand

$loginEmail

string

your Reamaze login email

$apiToken

string

your Reamaze API token

__destruct

__destruct()
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

__get

__get( $property) : \mixisLv\Reamaze\Api\Articles|\mixisLv\Reamaze\Api\Channels|\mixisLv\Reamaze\Api\Contacts|\mixisLv\Reamaze\Api\Conversations|\mixisLv\Reamaze\Api\Messages|\mixisLv\Reamaze\Api\Reports|\mixisLv\Reamaze\Api\Staff|null
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$property

Response

\mixisLv\Reamaze\Api\Articles|\mixisLv\Reamaze\Api\Channels|\mixisLv\Reamaze\Api\Contacts|\mixisLv\Reamaze\Api\Conversations|\mixisLv\Reamaze\Api\Messages|\mixisLv\Reamaze\Api\Reports|\mixisLv\Reamaze\Api\Staff|null

call

call( $action, string $method, array $params) : \stdClass
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$action

$method

string

GET/POST/PUT

$params

array

Response

\stdClass

error

error( $code,  $response)
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$code

$response

errorMessage

errorMessage( $code,  $errorMsg) : mixed|string
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$code

$errorMsg

Response

mixed|string

getProperty

getProperty( $property) : \mixisLv\Reamaze\Api\Articles|\mixisLv\Reamaze\Api\Channels|\mixisLv\Reamaze\Api\Contacts|\mixisLv\Reamaze\Api\Conversations|\mixisLv\Reamaze\Api\Messages|\mixisLv\Reamaze\Api\Reports|\mixisLv\Reamaze\Api\Staff|null
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$property

Response

\mixisLv\Reamaze\Api\Articles|\mixisLv\Reamaze\Api\Channels|\mixisLv\Reamaze\Api\Contacts|\mixisLv\Reamaze\Api\Conversations|\mixisLv\Reamaze\Api\Messages|\mixisLv\Reamaze\Api\Reports|\mixisLv\Reamaze\Api\Staff|null

getUrl

getUrl( $action,  $method,  $params)
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$action

$method

$params

implodeErrors

implodeErrors(array $errors) : string
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$errors

array

Response

string

isError

isError( $response,  $httpCode) : boolean
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$response

$httpCode

Response

boolean

log

log(string $message)
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$message

string

paramsToJson

paramsToJson( $params)
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$params

Properties

debug

debug : boolean
var

Type(s)

boolean

Reamaze brand

brand : string
var

Reamaze brand

Type(s)

string

Reamaze login email

loginEmail : string
var

Reamaze login email

Type(s)

string

Reamaze token

apiToken : string
var

Reamaze token

Type(s)

string

cURL handle

curl : resource
var

cURL handle

Type(s)

resource

articles

articles : \mixisLv\Reamaze\Api\Articles

Type(s)

\mixisLv\Reamaze\Api\Articles

contacts

contacts : \mixisLv\Reamaze\Api\Contacts

Type(s)

\mixisLv\Reamaze\Api\Contacts

conversations

conversations : \mixisLv\Reamaze\Api\Conversations

Type(s)

\mixisLv\Reamaze\Api\Conversations

messages

messages : \mixisLv\Reamaze\Api\Messages

Type(s)

\mixisLv\Reamaze\Api\Messages

channels

channels : \mixisLv\Reamaze\Api\Channels

Type(s)

\mixisLv\Reamaze\Api\Channels

staff

staff : \mixisLv\Reamaze\Api\Staff

Type(s)

\mixisLv\Reamaze\Api\Staff

reports

reports : \mixisLv\Reamaze\Api\Reports

Type(s)

\mixisLv\Reamaze\Api\Reports