phpDocumentor » \SubclassRecurringTemplate

RecurringTemplate

Methods

Construct a new template

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

Inherited

inherited_from	\Moneybird\RecurringTemplate::__construct()

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()
inherited_from	\Moneybird\RecurringTemplate::__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()
inherited_from	\Moneybird\RecurringTemplate::__set()

Parameters

$name

string

$value

mixed

Exceptions

`\Moneybird\Domainmodel\Exception`

Create an invoice for this template

createInvoice() : \Moneybird\Invoice

Inherited

inherited_from	\Moneybird\RecurringTemplate::createInvoice()

Returns

\Moneybird\Invoice

Deletes a the template (or sets inactive)

delete(\Moneybird\Service $service)

Inherited

inherited_from	\Moneybird\RecurringTemplate::delete()

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()
inherited_from	\Moneybird\RecurringTemplate::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()
inherited_from	\Moneybird\RecurringTemplate::getDirtyAttributes()

Returns

array

Return the objects id or null

getId() : int

Inherited

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

Returns

int

Get all invoices of this template

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

Inherited

access	public
inherited_from	\Moneybird\RecurringTemplate::getInvoices()

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()
inherited_from	\Moneybird\RecurringTemplate::isDirty()

Returns

bool

Updates or inserts the template

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

Inherited

inherited_from	\Moneybird\RecurringTemplate::save()

Parameters

$service

\Moneybird\Service

Exceptions

`\Moneybird\NotValidException`

Returns

\Moneybird\self

Copy info from contact to template

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

Inherited

access	public
inherited_from	\Moneybird\RecurringTemplate::setContact()

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()
inherited_from	\Moneybird\RecurringTemplate::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()
inherited_from	\Moneybird\RecurringTemplate::toArray()

Returns

Array

Create disclosedAttributes array

_initDisclosedAttributes()

Inherited

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

Initialize vars

_initVars()

Inherited

inherited_from	\Moneybird\RecurringTemplate::_initVars()

Copy the object

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

Inherited

inherited_from	\Moneybird\Domainmodel\AbstractModel::copy()
inherited_from	\Moneybird\RecurringTemplate::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()
inherited_from	\Moneybird\RecurringTemplate::extract()

Parameters

$values

Array

$filter

Array

$isDirty

bool

new data is dirty, defaults to true

Initialize

init()

Inherited

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

Adopt the data from $self

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

Inherited

inherited_from	\Moneybird\Domainmodel\AbstractModel::reload()
inherited_from	\Moneybird\RecurringTemplate::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()
inherited_from	\Moneybird\RecurringTemplate::selfToArray()

Parameters

$filter

Returns

array

Set dirty state to clean

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

Inherited

inherited_from	\Moneybird\Domainmodel\AbstractModel::setClean()
inherited_from	\Moneybird\RecurringTemplate::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)

Inherited

inherited_from	\Moneybird\RecurringTemplate::setDetailsAttr()

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()
inherited_from	\Moneybird\RecurringTemplate::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()
inherited_from	\Moneybird\RecurringTemplate::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)

Inherited

inherited_from	\Moneybird\RecurringTemplate::setFrequencyTypeAttr()

Parameters

$value

int

$isDirty

bool

new value is dirty, defaults to true

Exceptions

`\Moneybird\Exception`

Set Id

setIdAttr(int $value)

Inherited

inherited_from	\Moneybird\RecurringTemplate::setIdAttr()

Parameters

$value

int

Exceptions

`\Moneybird\InvalidIdException`

Validate object

validate() : bool

Inherited

inherited_from	\Moneybird\RecurringTemplate::validate()

Returns

bool

Properties

Available frequency types

$frequencyTypes : Array

Inherited

static
inherited_from	\Moneybird\RecurringTemplate::$$frequencyTypes

Array of attributes that are dirty

$_dirtyAttr : Array

Inherited

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

Array containing attributes to disclose

$_discloseAttr : array

Inherited

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

Disclosure

$_disclosure : \Moneybird\Disclosure

Inherited

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

Array of attributes that can't be modified

$_readonlyAttr : Array

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$_readonlyAttr

Array of attributes that are required

$_requiredAttr : Array

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$_requiredAttr

$active

$active

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$active

$contactId

$contactId

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$contactId

$createdAt

$createdAt

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$createdAt

$currency

$currency

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$currency

$details

$details

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$details

$discount

$discount

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$discount

$frequency

$frequency

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$frequency

$frequencyType

$frequencyType

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$frequencyType

$id

$id

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$id

$invoiceProfileId

$invoiceProfileId

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$invoiceProfileId

$lastDate

$lastDate

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$lastDate

$nextDate

$nextDate

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$nextDate

$numberOfOccurences

$numberOfOccurences

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$numberOfOccurences

$occurences

$occurences

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$occurences

$sendInvoice

$sendInvoice

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$sendInvoice

$startDate

$startDate

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$startDate

$templateId

$templateId

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$templateId

$totalPriceExclTax

$totalPriceExclTax

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$totalPriceExclTax

$totalPriceInclTax

$totalPriceInclTax

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$totalPriceInclTax

$updatedAt

$updatedAt

Inherited

inherited_from	\Moneybird\RecurringTemplate::$$updatedAt

Constants

Send frequency

FREQUENCY_6MONTHS

Inherited

const	FREQUENCY_6MONTHS Send every 6 months
inherited_from	\Moneybird\RecurringTemplate::FREQUENCY_6MONTHS

Send frequency

FREQUENCY_MONTH

Inherited

const	FREQUENCY_MONTH Send every month
inherited_from	\Moneybird\RecurringTemplate::FREQUENCY_MONTH

Send frequency

FREQUENCY_QUARTER

Inherited

const	FREQUENCY_QUARTER Send every quarter
inherited_from	\Moneybird\RecurringTemplate::FREQUENCY_QUARTER

Send frequency

FREQUENCY_WEEKLY

Inherited

const	FREQUENCY_WEEKLY Send every week
inherited_from	\Moneybird\RecurringTemplate::FREQUENCY_WEEKLY

Send frequency

FREQUENCY_YEAR

Inherited

const	FREQUENCY_YEAR Send every year
inherited_from	\Moneybird\RecurringTemplate::FREQUENCY_YEAR