1. class
  2. Ceo
  3. Core
  4. Models
  5. Assignment

Assignment

class Assignment extends BaseModel

Assignment model. Assignments act as containers for multiple content items.

Assignments can also have a due date in additional to regular publish info.

Traits

Srnable
The SRNable trait provides an easy interface to generate and find by SRNs
Pushable
The Pushable provides a simple mechanic for pushing an item into the web socket server's pusher.

Properties

integer $id Assignment ID
string $uuid Assignment UUID
string $slug Assignment slug
string $type Assignment type
string $title Assignment title
string $abstract Assignment abstract
string $content Assignment content
string $notes Editor/Production notes
string $created_at Created timestamp
string $modified_at Last modified timestamp
string $published_at Publish timestamp
string $due_at Due date timestamp
integer $creator_id Creating user
integer $workflow_id Workflow ID
string $contact_name Assignment contact name
string $contact_phone Assignment contact name
string $location Location of assignment
string $action_start_time Start time of assignment timestamp
string $action_end_time End time of assignment timestamp

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
string
getSrn()

Return model's SRN. Model should implement a 'srn_name' protected value.

from Srnable
object
findFirstBySrn(string $srn)

Find model by SRN

from Srnable
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
initialize()

Initializer

beforeValidation()

No description

validation()

No description

string
getSource()

Returns table name mapped in the model.

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

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

static Assignment
findFirst(mixed $parameters = null)

Allows to query the first record that match the specified conditions

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 Srnable at line line 18
string getSrn()

Return model's SRN. Model should implement a 'srn_name' protected value.

Otherwise, this will pull from the 'getSource' method

Return Value

string SRN

in Srnable at line line 37
object findFirstBySrn(string $srn)

Find model by SRN

Parameters

string $srn complete SRN

Return Value

object Model object

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 161
initialize()

Initializer

at line line 234
beforeValidation()

at line line 253
validation()

at line line 277
string getSource()

Returns table name mapped in the model.

Return Value

string

at line line 288
static Assignment[] find(mixed $parameters = null)

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

Parameters

mixed $parameters

Return Value

Assignment[]

at line line 299
static Assignment findFirst(mixed $parameters = null)

Allows to query the first record that match the specified conditions

Parameters

mixed $parameters

Return Value

Assignment

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

Array override

Parameters

array $ops Options for generation

Return Value

array