CoolCMS API

Schedule extends Schedule
in package

Schedule of periodic invoice generation. No owned collections; the scalar fields are inherited from {@see BaseSchedule} (`name`, `renewalPeriod`, `interval`, `renewalDate`, `endDate`, `active`, `generateFrom` plus the FKs `invoiceTemplateId` and `invoiceId`).

Attributes
#[Entity]
#[Table]
$name: 'cms_mod_invoicer_schedules'
#[TableAlias]
'schedule'

Table of Contents

Properties

$active  : bool
$endDate  : DateTime|null
$generateFrom  : string
$id  : int|null
$invoiceId  : int|null
$invoiceTemplateId  : int|null
$name  : string|null
$renewalDate  : DateTime
$renewalDay  : int|null
$renewalPeriod  : string
$renewalPeriodInterval  : int

Methods

__construct()  : mixed
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getActive()  : bool
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getEndDate()  : DateTime|null
getGenerateFrom()  : string
getId()  : int|null
getInvoiceId()  : int|null
getInvoiceTemplateId()  : int|null
getName()  : string|null
getRenewalDate()  : DateTime
getRenewalDay()  : int|null
getRenewalPeriod()  : string
getRenewalPeriodInterval()  : int
isActive()  : bool
isPersisted()  : bool
setActive()  : $this
setEndDate()  : $this
setGenerateFrom()  : $this
setId()  : $this
setInvoiceId()  : $this
setInvoiceTemplateId()  : $this
setName()  : $this
setRenewalDate()  : $this
setRenewalDay()  : $this
setRenewalPeriod()  : $this
setRenewalPeriodInterval()  : $this
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$active

protected bool $active = true
Attributes
#[Column]
$name: 'active'
$type: 'boolean'

$endDate

protected DateTime|null $endDate = null
Attributes
#[Column]
$name: 'end_date'
$type: 'date'
$nullable: true

$generateFrom

protected string $generateFrom = 'template'
Attributes
#[Column]
$name: 'generate_from'
$type: 'string'
$columnDefinition: "ENUM('template','invoice')"

$id

protected int|null $id = null
Attributes
#[Column]
$name: 'schedule_id'
$type: 'integer'
$options: ['unsigned' => true]
#[GeneratedValue]
#[Id]

$invoiceId

protected int|null $invoiceId = null
Attributes
#[Column]
$name: 'cms_mod_invoicer_invoices_invoice_id'
$type: 'integer'
$nullable: true
$options: ['unsigned' => true]

$invoiceTemplateId

protected int|null $invoiceTemplateId = null
Attributes
#[Column]
$name: 'cms_mod_invoicer_invoice_templates_invoice_template_id'
$type: 'integer'
$nullable: true
$options: ['unsigned' => true]

$name

protected string|null $name = null
Attributes
#[Column]
$name: 'name'
$type: 'string'
$length: 255
$nullable: true

$renewalDate

protected DateTime $renewalDate = new DateTime()
Attributes
#[Column]
$name: 'renewal_date'
$type: 'date'

$renewalDay

protected int|null $renewalDay = null
Attributes
#[Column]
$name: 'renewal_day'
$type: 'smallint'
$nullable: true
$options: ['unsigned' => true]

$renewalPeriod

protected string $renewalPeriod = 'never'
Attributes
#[Column]
$name: 'renewal_period'
$type: 'string'
$columnDefinition: "ENUM('never','year','month','day')"

$renewalPeriodInterval

protected int $renewalPeriodInterval = 0
Attributes
#[Column]
$name: 'renewal_period_interval'
$type: 'integer'

Methods

__construct()

public __construct([int|null $id = null ][, string|null $name = null ][, string $renewalPeriod = 'never' ][, int $renewalPeriodInterval = 0 ][, DateTime $renewalDate = new DateTime() ][, int|null $renewalDay = null ][, DateTime|null $endDate = null ][, bool $active = true ][, int|null $invoiceTemplateId = null ][, int|null $invoiceId = null ][, string $generateFrom = 'template' ]) : mixed
Parameters
$id : int|null = null
$name : string|null = null
$renewalPeriod : string = 'never'
$renewalPeriodInterval : int = 0
$renewalDate : DateTime = new DateTime()
$renewalDay : int|null = null
$endDate : DateTime|null = null
$active : bool = true
$invoiceTemplateId : int|null = null
$invoiceId : int|null = null
$generateFrom : string = 'template'

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getActive()

public getActive() : bool
Return values
bool

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getEndDate()

public getEndDate() : DateTime|null
Return values
DateTime|null

getGenerateFrom()

public getGenerateFrom() : string
Return values
string

getInvoiceId()

public getInvoiceId() : int|null
Return values
int|null

getInvoiceTemplateId()

public getInvoiceTemplateId() : int|null
Return values
int|null

getName()

public getName() : string|null
Return values
string|null

getRenewalDate()

public getRenewalDate() : DateTime
Return values
DateTime

getRenewalDay()

public getRenewalDay() : int|null
Return values
int|null

getRenewalPeriod()

public getRenewalPeriod() : string
Return values
string

getRenewalPeriodInterval()

public getRenewalPeriodInterval() : int
Return values
int

isActive()

public isActive() : bool
Return values
bool

setActive()

public setActive(bool $active) : $this
Parameters
$active : bool
Return values
$this

setEndDate()

public setEndDate(DateTime|null $endDate) : $this
Parameters
$endDate : DateTime|null
Return values
$this

setGenerateFrom()

public setGenerateFrom(string $generateFrom) : $this
Parameters
$generateFrom : string
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setInvoiceId()

public setInvoiceId(int|null $invoiceId) : $this
Parameters
$invoiceId : int|null
Return values
$this

setInvoiceTemplateId()

public setInvoiceTemplateId(int|null $invoiceTemplateId) : $this
Parameters
$invoiceTemplateId : int|null
Return values
$this

setName()

public setName(string|null $name) : $this
Parameters
$name : string|null
Return values
$this

setRenewalDate()

public setRenewalDate(DateTime $renewalDate) : $this
Parameters
$renewalDate : DateTime
Return values
$this

setRenewalDay()

public setRenewalDay(int|null $renewalDay) : $this
Parameters
$renewalDay : int|null
Return values
$this

setRenewalPeriod()

public setRenewalPeriod(string $renewalPeriod) : $this
Parameters
$renewalPeriod : string
Return values
$this

setRenewalPeriodInterval()

public setRenewalPeriodInterval(int $renewalPeriodInterval) : $this
Parameters
$renewalPeriodInterval : int
Return values
$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results