CoolCMS API

WorkListState : string
in package

State of a job (`cms_mod_company_work_lists.state`); a `WorkList` is a job, a `WorkSheet` is a work sheet inside it.

A job is only open or archived. Archiving ends the job; it is not a billing action and neither invoices nor locks anything retroactively (the individual sheets are locked). The closing and invoicing lifecycle lives in WorkSheetState. Only the manager changes the state; the entity is just a carrier.

Table of Contents

Cases

Archived  = 'archived'
Open  = 'open'

Methods

isLocked()  : bool
Returns whether the job is locked against changes.
lockedStates()  : array<int, self>
Returns the states in which the job is locked against changes; only `Archived`.

Cases

Methods

isLocked()

Returns whether the job is locked against changes.

public isLocked() : bool
Return values
bool

lockedStates()

Returns the states in which the job is locked against changes; only `Archived`.

public static lockedStates() : array<int, self>

An unknown value that still appears in the database is caught by the fail-closed guard (unknownState) instead of a silent fall-through.

Return values
array<int, self>
On this page

Search results