API Documentation
Back to top  

Document

Extends \EasyTransac\Entities\Entity

Represents a document

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

getComment

getComment()

getContent

getContent()

getDate

getDate()

getDateUpdated

getDateUpdated()

getDocumentType

getDocumentType()

getExtension

getExtension()

getId

getId()

getStatus

getStatus()

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

setComment

setComment( $comment)

Arguments

$comment

setContent

setContent( $content)

Arguments

$content

setDate

setDate( $date)

Arguments

$date

setDateUpdated

setDateUpdated( $dateUpdated)

Arguments

$dateUpdated

setDocumentType

setDocumentType( $documentType)

Arguments

$documentType

setExtension

setExtension( $extension)

Arguments

$extension

setId

setId( $id)

Arguments

$id

setStatus

setStatus( $status)

Arguments

$status

Prepares an array with the class fields formatted for the API

toArray() : Array
inherited

Response

Array

Properties

id

id :
map

:Id *

Type(s)

documentType

documentType :
map

:DocumentType *

Type(s)

status

status :
map

:Status *

Type(s)

date

date :
map

:Date *

Type(s)

dateUpdated

dateUpdated :
map

:DateUpdated *

Type(s)

content

content :
map

:Content *

Type(s)

comment

comment :
map

:Comment *

Type(s)

extension

extension :
map

:Extension *

Type(s)

mapping

mapping :
inherited

Type(s)

additionalFields

additionalFields :
inherited

Type(s)

converters

converters :
inherited

Type(s)