phpDocumentor
Back to top  

RecurringTemplate

 Methods

Construct a new template

__construct(array $data, \Moneybird\Contact $contact, bool $isDirty) 

Parameters

$data

array

$contact

\Moneybird\Contact

$isDirty

bool

new data is dirty, defaults to true

Proxy to disclose method

__get(String $key) : mixed
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::__get()

Parameters

$key

String

Returns

mixed

Magic set method Do not allow set

__set(string $name, mixed $value) 
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::__set()

Parameters

$name

string

$value

mixed

Exceptions

\Moneybird\Domainmodel\Exception

Create an invoice for this template

createInvoice() : \Moneybird\Invoice

Returns

\Moneybird\Invoice

Deletes a the template (or sets inactive)

delete(\Moneybird\Service $service) 

Parameters

$service

\Moneybird\Service

Discloses all values of the object that should be visible in the view layer.

disclose(mixed $key) : mixed
Inherited

access public
inherited_from \Moneybird\Domainmodel\AbstractModel::disclose()

Parameters

$key

mixed

Returns

mixed

Returns an array representation of this object's dirty attributes

getDirtyAttributes() : array
Inherited

access public
inherited_from \Moneybird\Domainmodel\AbstractModel::getDirtyAttributes()

Returns

array

Return the objects id or null

getId() : int
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::getId()

Returns

int

Get all invoices of this template

getInvoices(\Moneybird\Invoice\Service $service, string $filter) : \Moneybird\Invoice\ArrayObject

access public

Parameters

$service

\Moneybird\Invoice\Service

$filter

string

Returns

\Moneybird\Invoice\ArrayObject

Returns true if the object contains any dirty attributes

isDirty() : bool
Inherited

access public
inherited_from \Moneybird\Domainmodel\AbstractModel::isDirty()

Returns

bool

Updates or inserts the template

save(\Moneybird\Service $service) : \Moneybird\self

Parameters

$service

\Moneybird\Service

Exceptions

\Moneybird\NotValidException

Returns

\Moneybird\self

Copy info from contact to template

setContact(\Moneybird\Contact $contact, bool $isDirty) : \Moneybird\self

access public

Parameters

$contact

\Moneybird\Contact

$isDirty

bool

new data is dirty, defaults to true

Returns

\Moneybird\self

Sets data

setData(array $data, bool $isDirty) 
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::setData()

Parameters

$data

array

$isDirty

bool

new data is dirty, defaults to true

Get array representation of Subject

toArray() : Array
Inherited

inherited_from \Moneybird\Mapper\Mapable::toArray()

Returns

Array

Create disclosedAttributes array

_initDisclosedAttributes() 
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::_initDisclosedAttributes()

Initialize vars

_initVars() 

Copy the object

copy(array $filter) : \Moneybird\Domainmodel\self
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::copy()

Parameters

$filter

Array

Attributes not to copy

Returns

\Moneybird\Domainmodel\self

Extract will take an array and try to automatically map the array values to properties in this object

extract(array $values, Array $filter, bool $isDirty) 
Inherited

access protected
inherited_from \Moneybird\Domainmodel\AbstractModel::extract()

Parameters

$values

Array

$filter

Array

$isDirty

bool

new data is dirty, defaults to true

Initialize

init() 
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::init()

Adopt the data from $self

reload(\Moneybird\Domainmodel\AbstractModel $self) : \Moneybird\Domainmodel\self
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::reload()

Parameters

$self

\Moneybird\Domainmodel\AbstractModel

Returns

\Moneybird\Domainmodel\self

Returns an array representation of this object

selfToArray(array $filter) : array
Inherited

access protected
inherited_from \Moneybird\Domainmodel\AbstractModel::selfToArray()

Parameters

$filter

Returns

array

Set dirty state to clean

setClean(string $attr) : \Moneybird\Domainmodel\self
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::setClean()

Parameters

$attr

string

Name of attribute, if null (default) set all attribures clean

Returns

\Moneybird\Domainmodel\self

Set details

setDetailsAttr(\Moneybird\RecurringTemplate\Detail\ArrayObject $value, bool $isDirty) 

Parameters

$value

\Moneybird\RecurringTemplate_Detail_Array

$isDirty

bool

new value is dirty, defaults to true

Set dirty state to dirty

setDirty(string $attr) : \Moneybird\Domainmodel\self
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::setDirty()

Parameters

$attr

string

Name of attribute, if null (default) set all attribures dirty

Returns

\Moneybird\Domainmodel\self

Set dirty state based on bool

setDirtyState(bool $isDirty, string $attr) : \Moneybird\Domainmodel\self
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::setDirtyState()

Parameters

$isDirty

bool

$attr

string

Name of attribute, if null (default) change state of all attribures

Returns

\Moneybird\Domainmodel\self

Set frecuency type

setFrequencyTypeAttr(int $value, bool $isDirty) 

Parameters

$value

int

$isDirty

bool

new value is dirty, defaults to true

Exceptions

\Moneybird\Exception

Set Id

setIdAttr(int $value) 

Parameters

$value

int

Exceptions

\Moneybird\InvalidIdException

Validate object

validate() : bool

Returns

bool

 Properties

 

Available frequency types

$frequencyTypes : Array

static
 

Array of attributes that are dirty

$_dirtyAttr : Array
Inherited

inherited_from \Moneybird\Domainmodel\AbstractModel::$$_dirtyAttr
 

Array containing attributes to disclose

$_discloseAttr : array
Inherited

access protected
inherited_from \Moneybird\Domainmodel\AbstractModel::$$_discloseAttr
 

Disclosure

$_disclosure : \Moneybird\Disclosure
Inherited

access protected
inherited_from \Moneybird\Domainmodel\AbstractModel::$$_disclosure
 

Array of attributes that can't be modified

$_readonlyAttr : Array

 

Array of attributes that are required

$_requiredAttr : Array

 

$active

$active 

 

$contactId

$contactId 

 

$createdAt

$createdAt 

 

$currency

$currency 

 

$details

$details 

 

$discount

$discount 

 

$frequency

$frequency 

 

$frequencyType

$frequencyType 

 

$id

$id 

 

$invoiceProfileId

$invoiceProfileId 

 

$lastDate

$lastDate 

 

$nextDate

$nextDate 

 

$numberOfOccurences

$numberOfOccurences 

 

$occurences

$occurences 

 

$sendInvoice

$sendInvoice 

 

$startDate

$startDate 

 

$templateId

$templateId 

 

$totalPriceExclTax

$totalPriceExclTax 

 

$totalPriceInclTax

$totalPriceInclTax 

 

$updatedAt

$updatedAt 

 Constants

 

Send frequency

FREQUENCY_6MONTHS 

const FREQUENCY_6MONTHS Send every 6 months
 

Send frequency

FREQUENCY_MONTH 

const FREQUENCY_MONTH Send every month
 

Send frequency

FREQUENCY_QUARTER 

const FREQUENCY_QUARTER Send every quarter
 

Send frequency

FREQUENCY_WEEKLY 

const FREQUENCY_WEEKLY Send every week
 

Send frequency

FREQUENCY_YEAR 

const FREQUENCY_YEAR Send every year