Docs For Class Shift8_Queue

Description

Simple object that describes all the elements that a queue item can have.

It is up to the processor to decide which ones to actually use. One could extend this to support more items

author: Paris Stamatopoulos
version: 0.1.1
usedby: Shift8

Located in /Queue/Item.php (line 28)

Method Summary

Shift8_Queue_Item __construct ([array $data = false])

string getCommand ()

dateTime getDateAdded ()

dateTime getDateExecuted ()

integer getQueueId ()

string[] getRequestArguments ([boolean $serialized = false])

Shift8_Event[] getResponse ([boolean $serialized = false])

void setCommand (string $command)

void setDateAdded (dateTime $date)

void setDateExecuted (dateTime $date)

void setQueueId (integer $queue_id)

void setRequestArguments (string[] $arguments)

void setResponse (Shift8_Event|Shift8_Event[] $response)

Methods

Constructor __construct (line 41)

Class constructor

access: public

Shift8_Queue_Item __construct ([array $data = false])

array $data

getCommand (line 81)

Returns the command of the Queue Item

access: public

string getCommand ()

getDateAdded (line 149)

Gets the date when this command was added

access: public

dateTime getDateAdded ()

getDateExecuted (line 169)

Gets the date when this command was executed

access: public

dateTime getDateExecuted ()

getQueueId (line 61)

Returns the id of the current item in the queue

access: public

integer getQueueId ()

getRequestArguments (line 114)

Gets the request arguments for this command in this queue item

access: public

string[] getRequestArguments ([boolean $serialized = false])

boolean $serialized: Whether to return the data serialized or not

getResponse (line 137)

Gets the response in Shift8_Event objects

access: public

Shift8_Event[] getResponse ([boolean $serialized = false])

boolean $serialized: Whether to return the data serialized or not

setCommand (line 92)

Sets the command for this queue item

access: public

void setCommand (string $command)

string $command

setDateAdded (line 160)

Sets the date when this command was added to the queue

access: public

void setDateAdded (dateTime $date)

dateTime $date

setDateExecuted (line 180)

Sets the date when this command was executed

access: public

void setDateExecuted (dateTime $date)

dateTime $date

setQueueId (line 72)

Sets the id of the current item in the queue

access: public

void setQueueId (integer $queue_id)

integer $queue_id

setRequestArguments (line 103)

Sets the request arguments for this command in this queue item

access: public

void setRequestArguments (string[] $arguments)

string[] $arguments

setResponse (line 126)

Sets the response for this queue item

access: public

void setResponse (Shift8_Event|Shift8_Event[] $response)

Shift8_Event|Shift8_Event[] $response

Class Shift8_Queue_Item