API Documentation
Back to top  

DocumentRequest

Extends \EasyTransac\Entities\Entity

Represents arguments for request "adddocument"

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

getCustomer

getCustomer()

getDocument

getDocument()

getDocumentId

getDocumentId()

getShowContent

getShowContent()

getUser

getUser()

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

setCustomer

setCustomer( $customer)

Arguments

$customer

setDocument

setDocument( $document)

Arguments

$document

setDocumentId

setDocumentId( $documentId)

Arguments

$documentId

setShowContent

setShowContent( $showContent)

Arguments

$showContent

setUser

setUser( $User)

Arguments

$User

Prepares an array with the class fields formatted for the API

toArray() : Array
inherited

Response

Array

Properties

customer

customer :
object

:Customer *

Type(s)

User

User :
object

:User *

Type(s)

document

document :
object

:Document *

Type(s)

documentId

documentId :
map

:DocumentId *

Type(s)

showContent

showContent :
map

:ShowContent *

Type(s)

mapping

mapping :
inherited

Type(s)

additionalFields

additionalFields :
inherited

Type(s)

converters

converters :
inherited

Type(s)