API Documentation
Back to top  

Entity

Generic entity

author

Klyde
copyright

EasyTransac
package

Default

Methods

Allows to set a value not yet implemented in the SDK but available in the API

__call(String $name, Array $arguments) : mixed

Arguments

$name

String

Name of the parameter to set

$arguments

Array

Response

mixed

__construct

__construct()

Attach a api argument converter

addConverter(\EasyTransac\Entities\EasyTransac\Converters\IConverter $converter) : \EasyTransac\Entities\Entity

Arguments

$converter

\EasyTransac\Entities\EasyTransac\Converters\IConverter

Response

\EasyTransac\Entities\Entity

Call all registred converters

callConverters(Mixed $value) : Mixed

Arguments

$value

Mixed

Response

Mixed

Allows to fill the entity with data returned by the EasyTransac API

hydrate(Mixed $fields, Boolean $checkRequired = false) : \EasyTransac\Entities\Entity

Arguments

$fields

Mixed

Array or \stdClass

$checkRequired

Boolean

Response

\EasyTransac\Entities\Entity

Fill the entity with the API json response

hydrateWidthObject(\stdClass $fields, Boolean $checkRequired = false)

Arguments

$fields

\stdClass

$checkRequired

Boolean

Fill the entity with an list of entity (see: CreditCardList with comment tag @array)

hydrateWithArray(\EasyTransac\Entities\Array<Entity> $itemsList, Boolean $checkRequired = false)

Arguments

$itemsList

\EasyTransac\Entities\Array

$checkRequired

Boolean

Make the mapping between class attributes and API fields

makeMapping()

Prepares an array with the class fields formatted for the API

toArray() : Array

Response

Array

Properties

mapping

mapping :

Type(s)

additionalFields

additionalFields :

Type(s)

converters

converters :

Type(s)