API Documentation
Back to top  

Client

Extends \EasyTransac\Entities\Entity

Represents a client

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
inherited

Arguments

$name

String

Name of the parameter to set

$arguments

Array

Response

mixed

__construct

__construct()
inherited

Attach a api argument converter

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

Arguments

$converter

\EasyTransac\Entities\EasyTransac\Converters\IConverter

Response

\EasyTransac\Entities\Entity

Call all registred converters

callConverters(Mixed $value) : Mixed
inherited

Arguments

$value

Mixed

Response

Mixed

getAddress

getAddress()

getCity

getCity()

getEmail

getEmail()

getFirstname

getFirstname()

getId

getId()

getLastname

getLastname()

getPhone

getPhone()

getZipCode

getZipCode()

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

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

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)
inherited

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)
inherited

Arguments

$itemsList

\EasyTransac\Entities\Array

$checkRequired

Boolean

Make the mapping between class attributes and API fields

makeMapping()
inherited

setAddress

setAddress( $address)

Arguments

$address

setCity

setCity( $city)

Arguments

$city

setEmail

setEmail( $email)

Arguments

$email

setFirstname

setFirstname( $firstname)

Arguments

$firstname

setId

setId( $id)

Arguments

$id

setLastname

setLastname( $lastname)

Arguments

$lastname

setPhone

setPhone( $phone)

Arguments

$phone

setZipCode

setZipCode( $zipCode)

Arguments

$zipCode

Prepares an array with the class fields formatted for the API

toArray() : Array
inherited

Response

Array

Properties

id

id :
map

:Id *

Type(s)

email

email :
map

:Email *

Type(s)

firstname

firstname :
map

:Firstname *

Type(s)

lastname

lastname :
map

:Lastname *

Type(s)

phone

phone :
map

:Phone *

Type(s)

address

address :
map

:Address *

Type(s)

zipCode

zipCode :
map

:ZipCode *

Type(s)

city

city :
map

:City *

Type(s)

mapping

mapping :
inherited

Type(s)

additionalFields

additionalFields :
inherited

Type(s)

converters

converters :
inherited

Type(s)