1. class
  2. Ceo
  3. Api
  4. Models
  5. PrintDocument

PrintDocument

class PrintDocument extends BaseModel

Print Documents model

Print document model is just a placeholder for InDesign layouts.

Traits

Pushable
The Pushable provides a simple mechanic for pushing an item into the web socket server's pusher.

Properties

integer $id ID
string $uuid UUID
string $label Label slug
string $tracking_label Normalized combo of the path stub and the file name this doesn't change after first creation
integer $issue_id Issue ID
integer $workflow_id Workflow ID
boolean $print_locked Print locked
string $print_locked_user Print locked user
integer $workflow_section_id Print workflow section
DateTime $modified_at Modified at
integer $assignee_id Assignee id
DateTime $created_at Created at

Methods

getResultsetClass()

No description

from BaseModel
boolean
hasProperty(string $str)

Determine if the model has a public property.

from BaseModel
BaseModel
setRelated(string $relation, mixed $value = array())

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

from BaseModel
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;
   .
from Pushable
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

  • category - (string) supplemental category
  • options - (array) override options, see setPushableOptions for more info

from Pushable
PrintDocument
initialize()

Initializer

string
getSource()

Returns table name mapped in the model.

static Versions[]
find(mixed $parameters = null)

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

static Versions
findFirst(mixed $parameters = null)

Allows to query the first record that match the specified conditions

static 
findFirstByLabel($id)

No description

static 
findFirstByTrackingLabel($str)

No description

array
toArray(array $ops = false)

Array override

Details

in BaseModel at line line 13
getResultsetClass()

in BaseModel at line line 25
boolean hasProperty(string $str)

Determine if the model has a public property.

Useful in determining valid sorting options on the front end.

Parameters

string $str Property

Return Value

boolean

in BaseModel at line line 40
BaseModel setRelated(string $relation, mixed $value = array())

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

Return Value

BaseModel

in Pushable at line line 44
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

in Pushable at line line 58
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

  • category - (string) supplemental category
  • options - (array) override options, see setPushableOptions for more info

Parameters

array $kwargs

at line line 105
PrintDocument initialize()

Initializer

Return Value

PrintDocument

at line line 168
string getSource()

Returns table name mapped in the model.

Return Value

string

at line line 179
static Versions[] find(mixed $parameters = null)

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

Parameters

mixed $parameters

Return Value

Versions[]

at line line 190
static Versions findFirst(mixed $parameters = null)

Allows to query the first record that match the specified conditions

Parameters

mixed $parameters

Return Value

Versions

at line line 195
static findFirstByLabel($id)

Parameters

$id

at line line 205
static findFirstByTrackingLabel($str)

Parameters

$str

at line line 220
array toArray(array $ops = false)

Array override

Parameters

array $ops Options for generation

Return Value

array