API Documentation
Back to top  

User

Extends \EasyTransac\Entities\Entity

Represents arguments for the request "AddUser" and "UpdateUser"

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

getAccountOwner

getAccountOwner()

getActivationEmail

getActivationEmail()

getActive

getActive()

getAddress

getAddress()

getBalance

getBalance()

getBic

getBic()

getBirthDate

getBirthDate()

getCallingCode

getCallingCode()

getCity

getCity()

getCompany

getCompany()

getCompanyCountry

getCompanyCountry()

getCompanyType

getCompanyType()

getConditionsAccepted

getConditionsAccepted()

getCountry

getCountry()

getEmail

getEmail()

getFirstname

getFirstname()

getGender

getGender()

getIban

getIban()

getId

getId()

getIdentifier

getIdentifier()

getJoinDate

getJoinDate()

getLastname

getLastname()

getNationality

getNationality()

getPassword

getPassword()

getPhone

getPhone()

getSetCompany

getSetCompany()

getSiret

getSiret()

getTester

getTester()

getVat

getVat()

getWelcomeEmail

getWelcomeEmail()

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

setAccountOwner

setAccountOwner( $accountOwner)

Arguments

$accountOwner

setActivationEmail

setActivationEmail( $activationEmail)

Arguments

$activationEmail

setActive

setActive( $active)

Arguments

$active

setAddress

setAddress( $address)

Arguments

$address

setBalance

setBalance( $balance)

Arguments

$balance

setBic

setBic( $bic)

Arguments

$bic

setBirthDate

setBirthDate( $birthDate)

Arguments

$birthDate

setCallingCode

setCallingCode( $callingCode)

Arguments

$callingCode

setCity

setCity( $city)

Arguments

$city

setCompany

setCompany( $company)

Arguments

$company

setCompanyCountry

setCompanyCountry( $companyCountry)

Arguments

$companyCountry

setCompanyType

setCompanyType( $companyType)

Arguments

$companyType

setConditionsAccepted

setConditionsAccepted( $conditionsAccepted)

Arguments

$conditionsAccepted

setCountry

setCountry( $country)

Arguments

$country

setEmail

setEmail( $email)

Arguments

$email

setFirstname

setFirstname( $firstname)

Arguments

$firstname

setGender

setGender( $gender)

Arguments

$gender

setIban

setIban( $iban)

Arguments

$iban

setId

setId( $id)

Arguments

$id

setIdentifier

setIdentifier( $identifier)

Arguments

$identifier

setJoinDate

setJoinDate( $joinDate)

Arguments

$joinDate

setLastname

setLastname( $lastname)

Arguments

$lastname

setNationality

setNationality( $nationality)

Arguments

$nationality

setPassword

setPassword( $password)

Arguments

$password

setPhone

setPhone( $phone)

Arguments

$phone

setSetCompany

setSetCompany( $setCompany)

Arguments

$setCompany

setSiret

setSiret( $siret)

Arguments

$siret

setTester

setTester( $tester)

Arguments

$tester

setVat

setVat( $vat)

Arguments

$vat

setWelcomeEmail

setWelcomeEmail( $welcomeEmail)

Arguments

$welcomeEmail

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)

password

password :
map

:Password *

Type(s)

identifier

identifier :
map

:Identifier *

Type(s)

company

company :
map

:Company *

Type(s)

firstname

firstname :
map

:Firstname *

Type(s)

lastname

lastname :
map

:Lastname *

Type(s)

address

address :
map

:Address *

Type(s)

zipCode

zipCode :
map

:ZipCode *

Type(s)

city

city :
map

:City *

Type(s)

callingCode

callingCode :
map

:CallingCode *

Type(s)

phone

phone :
map

:Phone *

Type(s)

birthDate

birthDate :
map

:BirthDate *

Type(s)

nationality

nationality :
map

:Nationality *

Type(s)

accountOwner

accountOwner :
map

:AccountOwner *

Type(s)

iban

iban :
map

:Iban *

Type(s)

bic

bic :
map

:Bic *

Type(s)

vat

vat :
map

:Vat *

Type(s)

siret

siret :
map

:Siret *

Type(s)

activationEmail

activationEmail :
map

:ActivationEmail *

Type(s)

joinDate

joinDate :
map

:JoinDate *

Type(s)

balance

balance :
map

:Balance *

Type(s)

conditionsAccepted

conditionsAccepted :
map

:ConditionsAccepted *

Type(s)

active

active :
map

:Active *

Type(s)

tester

tester :
map

:Tester *

Type(s)

companyType

companyType :
map

:CompanyType *

Type(s)

companyCountry

companyCountry :
map

:CompanyCountry *

Type(s)

gender

gender :
map

:Gender *

Type(s)

country

country :
map

:Country *

Type(s)

welcomeEmail

welcomeEmail :
map

:WelcomeEmail *

Type(s)

setCompany

setCompany :
map

:SetCompany *

Type(s)

mapping

mapping :
inherited

Type(s)

additionalFields

additionalFields :
inherited

Type(s)

converters

converters :
inherited

Type(s)