API Documentation
Back to top  

StandardResponse

Response used in return of a request

author

Klyde
copyright

EasyTransac
package

Default

Methods

Returns the entity of the response (example: an entity "Customer")

getContent() : \EasyTransac\Entities\Entity

Response

\EasyTransac\Entities\Entity

Get the error code returned by the EasyTransac API

getErrorCode() : String

Response

String

Get the error message in case of error of call or missing argument

getErrorMessage() : String

Response

String

Returns true if the signature request/response is the same

isSameSignature() : boolean|Boolean

Response

boolean|Boolean

Returns if the response is OK

isSuccess() : boolean

Response

boolean

Defines the entity

setContent(\EasyTransac\Entities\Entity $entity) : \EasyTransac\Responses\StandardResponse

Arguments

$entity

\EasyTransac\Entities\Entity

Response

\EasyTransac\Responses\StandardResponse

Defines the error code

setErrorCode(String $code) : \EasyTransac\Responses\StandardResponse

Arguments

$code

String

Response

\EasyTransac\Responses\StandardResponse

Defines the error message

setErrorMessage(String $message) : \EasyTransac\Responses\StandardResponse

Arguments

$message

String

Response

\EasyTransac\Responses\StandardResponse

Defines is the signature request/response is the same

setSameSignature(Boolean $same) : \EasyTransac\Responses\StandardResponse

Arguments

$same

Boolean

Response

\EasyTransac\Responses\StandardResponse

Defines if the response is OK

setSuccess(Boolean $success) : \EasyTransac\Responses\StandardResponse

Arguments

$success

Boolean

Response

\EasyTransac\Responses\StandardResponse

Properties

entity

entity :

Type(s)

errorMessage

errorMessage :

Type(s)

errorCode

errorCode :

Type(s)

success

success :

Type(s)

sameSignature

sameSignature :

Type(s)