CoolCMS API

WorkList extends WorkList
in package

Job (work list): a billing batch of one client; a new one is created after invoicing.

There is no item collection: work items are read through WorkItemManager with the workListId filter, not through an inline collection.

Attributes
#[Entity]
#[Table]
$name: 'cms_mod_company_work_lists'
#[TableAlias]
'workList'

Table of Contents

Properties

$closedDatetime  : DateTime|null
$companyId  : int
$currencyId  : int|null
$deleted  : bool
$id  : int|null
$insertDatetime  : DateTime
$invoicerCustomerContactId  : int|null
$invoicerCustomerId  : int|null
$invoicerInvoiceTypeId  : int|null
$name  : string
$note  : string|null
$state  : WorkListState
$supplyPlaceCountryCode  : string|null

Methods

__construct()  : mixed
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getClosedDatetime()  : DateTime|null
getCompanyId()  : int
getCurrencyId()  : int|null
getDeleted()  : bool
getId()  : int|null
getInsertDatetime()  : DateTime
getInvoicerCustomerContactId()  : int|null
getInvoicerCustomerId()  : int|null
getInvoicerInvoiceTypeId()  : int|null
getName()  : string
getNote()  : string|null
getState()  : WorkListState
getSupplyPlaceCountryCode()  : string|null
isDeleted()  : bool
isPersisted()  : bool
setClosedDatetime()  : $this
setCompanyId()  : $this
setCurrencyId()  : $this
setDeleted()  : $this
setId()  : $this
setInsertDatetime()  : $this
setInvoicerCustomerContactId()  : $this
setInvoicerCustomerId()  : $this
setInvoicerInvoiceTypeId()  : $this
setName()  : $this
setNote()  : $this
setState()  : $this
setSupplyPlaceCountryCode()  : $this
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$closedDatetime

protected DateTime|null $closedDatetime = null
Attributes
#[Column]
$name: 'closed_datetime'
$type: 'datetime'
$nullable: true
#[ExternalReadonly]

$companyId

protected int $companyId = 0
Attributes
#[Column]
$name: 'company_id'
$type: 'integer'
$options: ['unsigned' => true]

$currencyId

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

$id

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

$insertDatetime

protected DateTime $insertDatetime = new DateTime()
Attributes
#[Column]
$name: 'insert_datetime'
$type: 'datetime'
#[ExternalReadonly]

$invoicerCustomerContactId

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

$invoicerCustomerId

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

$invoicerInvoiceTypeId

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

$name

protected string $name = ''
Attributes
#[Column]
$name: 'name'
$type: 'string'
$length: 255

$note

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

$supplyPlaceCountryCode

protected string|null $supplyPlaceCountryCode = null
Attributes
#[Column]
$name: 'supply_place_country_code'
$type: 'string'
$length: 2
$nullable: true
$options: ['fixed' => true]

Methods

__construct()

public __construct([int|null $id = null ][, int $companyId = 0 ][, int|null $invoicerCustomerId = null ][, int|null $invoicerCustomerContactId = null ][, int|null $invoicerInvoiceTypeId = null ][, int|null $currencyId = null ][, string|null $supplyPlaceCountryCode = null ][, string $name = '' ][, WorkListState $state = WorkListState::Open ][, DateTime|null $closedDatetime = null ][, string|null $note = null ][, DateTime $insertDatetime = new DateTime() ][, bool $deleted = false ]) : mixed
Parameters
$id : int|null = null
$companyId : int = 0
$invoicerCustomerId : int|null = null
$invoicerCustomerContactId : int|null = null
$invoicerInvoiceTypeId : int|null = null
$currencyId : int|null = null
$supplyPlaceCountryCode : string|null = null
$name : string = ''
$state : WorkListState = WorkListState::Open
$closedDatetime : DateTime|null = null
$note : string|null = null
$insertDatetime : DateTime = new DateTime()
$deleted : bool = false

callInitMethods()

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

public callInitMethods() : void

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>

getClosedDatetime()

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

getCompanyId()

public getCompanyId() : int
Return values
int

getCurrencyId()

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

getDeleted()

public getDeleted() : bool
Return values
bool

getInsertDatetime()

public getInsertDatetime() : DateTime
Return values
DateTime

getInvoicerCustomerContactId()

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

getInvoicerCustomerId()

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

getInvoicerInvoiceTypeId()

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

getName()

public getName() : string
Return values
string

getNote()

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

getSupplyPlaceCountryCode()

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

isDeleted()

public isDeleted() : bool
Return values
bool

setClosedDatetime()

public setClosedDatetime(DateTime|null $closedDatetime) : $this
Parameters
$closedDatetime : DateTime|null
Return values
$this

setCompanyId()

public setCompanyId(int $companyId) : $this
Parameters
$companyId : int
Return values
$this

setCurrencyId()

public setCurrencyId(int|null $currencyId) : $this
Parameters
$currencyId : int|null
Return values
$this

setDeleted()

public setDeleted(bool $deleted) : $this
Parameters
$deleted : bool
Return values
$this

setId()

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

setInsertDatetime()

public setInsertDatetime(DateTime $insertDatetime) : $this
Parameters
$insertDatetime : DateTime
Return values
$this

setInvoicerCustomerContactId()

public setInvoicerCustomerContactId(int|null $invoicerCustomerContactId) : $this
Parameters
$invoicerCustomerContactId : int|null
Return values
$this

setInvoicerCustomerId()

public setInvoicerCustomerId(int|null $invoicerCustomerId) : $this
Parameters
$invoicerCustomerId : int|null
Return values
$this

setInvoicerInvoiceTypeId()

public setInvoicerInvoiceTypeId(int|null $invoicerInvoiceTypeId) : $this
Parameters
$invoicerInvoiceTypeId : int|null
Return values
$this

setName()

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

setNote()

public setNote(string|null $note) : $this
Parameters
$note : string|null
Return values
$this

setSupplyPlaceCountryCode()

public setSupplyPlaceCountryCode(string|null $supplyPlaceCountryCode) : $this
Parameters
$supplyPlaceCountryCode : string|null
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