Properties

$id

$id : integer

ID

Type

integer

$uuid

$uuid : string

UUID

Type

string

$label

$label : string

Label slug

Type

string

$tracking_label

$tracking_label : string

Normalized combo of the path stub and the file name this doesn't change after first creation

Type

string

$issue_id

$issue_id : integer

Issue ID

Type

integer

$workflow_id

$workflow_id : integer

Workflow ID

Type

integer

$print_locked

$print_locked : boolean

Print locked

Type

boolean

$print_locked_user

$print_locked_user : string

Print locked user

Type

string

$workflow_section_id

$workflow_section_id : integer

Print workflow section

Type

integer

$modified_at

$modified_at : \Ceo\Api\Models\DateTime

Modified at

Type

\Ceo\Api\Models\DateTime

$assignee_id

$assignee_id : integer

Assignee id

Type

integer

$created_at

$created_at : \Ceo\Api\Models\DateTime

Created at

Type

\Ceo\Api\Models\DateTime

$pushable_defaults

$pushable_defaults : 

Type

Methods

setPushableOptions()

setPushableOptions(array  $opts = array()) 

Set default pushable options for model, uses an array with the keys

  • category - string socket category user is subscribed to
  • related - array of related properties to include when serializing

Example:

class Content extends BaseModel
{
   use Pushable;
   ...
   $this->setPushableOptions([
      'category' => 'contentupdate',
      'related' => [
          'export',
          'authors',
          'tags',
          'assignment',
          'attachment',
          'audit',
          'export',
          'dominantAttachment'
      ]
  ]
}

Parameters

array $opts

pushToSocket()

pushToSocket(array  $kwargs = array()) 

Push the model to the web socket server via the queue service Options are set as keyword arguments in the form of <ul> <li>category - (string) supplemental category</li> <li>options - (array) override options, see setPushableOptions for more info</li> </ul>

Parameters

array $kwargs

getResultsetClass()

getResultsetClass() 

hasProperty()

hasProperty(string  $str) : boolean

Determine if the model has a public property.

Useful in determining valid sorting options on the front end.

Parameters

string $str

Property

Returns

boolean

setRelated()

setRelated(string  $relation, mixed  $value = array()) : self

Phalcon has this bug where if you enumerate a relation then try to set it via the magic setter, it won't save.

I think it has something to do with implicit transactions, but I'm not entirely sure...

Parameters

string $relation
mixed $value

Returns

self

initialize()

initialize() : self

Initializer

Returns

self

getSource()

getSource() : string

Returns table name mapped in the model.

Returns

string

find()

find(mixed  $parameters = null) : array<mixed,\Ceo\Api\Models\Versions>

Allows to query a set of records that match the specified conditions

Parameters

mixed $parameters

Returns

array<mixed,\Ceo\Api\Models\Versions>

findFirst()

findFirst(mixed  $parameters = null) : \Ceo\Api\Models\Versions

Allows to query the first record that match the specified conditions

Parameters

mixed $parameters

Returns

\Ceo\Api\Models\Versions

findFirstByLabel()

findFirstByLabel(  $id) 

Parameters

$id

findFirstByTrackingLabel()

findFirstByTrackingLabel(  $str) 

Parameters

$str

toArray()

toArray(array  $ops = false) : array

Array override

Parameters

array $ops

Options for generation

Returns

array

toArrayRelated()

toArrayRelated(  $ops,   $array) 

Parameters

$ops
$array