Kayako TicketStatus object.

All objects interacting with Kayako REST API should extend this class and define: * Kayako controller * XML element name holding object's data in REST response

author Tomasz Sawicki (https://github.com/Furgas)
link http://wiki.kayako.com/display/DEV/REST+-+TicketStatus
since Kayako version 4.01.240
package Object\Ticket

 Methods

Default constructor.

__construct(array $data) 
Inherited

inherited_from \kyObjectBase::__construct()

Parameters

$data

array

Object data from XML response converted into array.

Returns API field value.

__get(string $api_field_name) : mixed
Inherited

Returns API field value based on API field name used by Kayako.

link http://wiki.kayako.com/display/DEV/REST+API+Reference
inherited_from \kyObjectBase::__get()

Parameters

$api_field_name

string

API field name.

Returns

mixed

Sets API field value.

__set(string $api_field_name, mixed $value) : mixed
Inherited

Sets API field value based on API field name used by Kayako.

link http://wiki.kayako.com/display/DEV/REST+API+Reference
inherited_from \kyObjectBase::__set()

Parameters

$api_field_name

string

API field name.

$value

mixed

API field value.

Returns

mixed

Returns object description with it's type and identifier.

__toString() : string
Inherited

Calls toString() method to get the object description.

inherited_from \kyObjectBase::__toString()

Returns

string

Should build the array of object data for creating or updating the object.

buildData(bool $create) : array
Inherited

Values must be set in format accepted by REST API.

inherited_from \kyObjectBase::buildData()

Parameters

$create

bool

Indicates if the result will be used to create (true) or update (false) an object.

Returns

array

Checks wheter this object has all required fields set.

checkRequiredAPIFields(bool $create, bool $throw_exception) : string[] | bool
Inherited

inherited_from \kyObjectBase::checkRequiredAPIFields()

Parameters

$create

bool

True when object will be created. False when object will be updated.

$throw_exception

bool

True to throw an exception on missing fields. False to return list of missing fields or true when there are none.

Exceptions

\kyException When there are missing field values and $throw_exception is true.

Returns

string[]boolList of missing API fields or true when there are none.

Creates an object on the server and refreshes its local data.

create() : \kyObjectBase
Inherited

inherited_from \kyObjectBase::create()

Exceptions

\BadMethodCallException
\kyException

Returns

Creates new object.

createNew() 
Inherited

Compatible with method chaining.

inherited_from \kyObjectBase::createNew()

Deletes the object on the server.

delete() 
Inherited

inherited_from \kyObjectBase::delete()

Fetches the object from server.

get(int | array $id) : \kyObjectBase
Inherited

inherited_from \kyObjectBase::get()

Parameters

$id

intarray

Object identifier or list of identifiers (ex. ticket identifier and ticket post identifier when fetching TicketPost).

Returns

Returns array of API fields.

getAPIFields() : string[]
Inherited

Format of returned array:

array(
    '' => Field description. (getter: , setter: ),
    ...repeat...
)

inherited_from \kyObjectBase::getAPIFields()

Returns

string[]

Fetches objects from server.

getAll(array $search_parameters) : \kyResultSet
Inherited

inherited_from \kyObjectBase::getAll()

Parameters

$search_parameters

array

Optional. Additional search parameters.

Returns

Returns list of available filter methods for use in result sets with objects of this type.

getAvailableFilterMethods(bool $filter_names_only) : array
Inherited

Optionaly you can return get method names used to filter objects.

inherited_from \kyObjectBase::getAvailableFilterMethods()

Parameters

$filter_names_only

bool

True (default) to return array('filterByXXX', 'filterByYYY', ...). False to return array('filterByXXX' => 'getXXX', 'filterByYYY' => 'YYY', ...).

Returns

array

Returns list of available order methods for use in result sets with objects of this type.

getAvailableOrderMethods(bool $order_names_only) : array
Inherited

Optionaly you can return get method names used to order objects.

inherited_from \kyObjectBase::getAvailableOrderMethods()

Parameters

$order_names_only

bool

True (default) to return array('orderByXXX', 'orderByYYY', ...). False to return array('orderByXXX' => 'getXXX', 'orderByYYY' => 'YYY', ...).

Returns

array

Returns object controller.

getController() : string
Inherited

inherited_from \kyObjectBase::getController()

Returns

string

Returns linked department.

getDepartment(bool $reload) : \kyDepartment

If a ticket status is linked to a department, it will be visible only under the linked department. Result is cached until the end of script.

Parameters

$reload

bool

True to reload data from server. False to use the cached value (if present).

Returns

Returns linked department identifier.

getDepartmentId() : int

If a ticket status is linked to a department, it will be visible only under the linked department.

filterBy

Returns

int

Returns whether ticket count for this status is displayed in the filter ticket tree.

getDisplayCount() : bool

filterBy
orderBy

Returns

bool

Returns

string

Returns ticket status display order.

getDisplayOrder() : int

filterBy
orderBy

Returns

int

Should return object identifier or complete list of identifiers as needed by API to identify the object (ex.

getId(bool $complete) : int | array

ticket identifier and ticket post identifier in case of TicketPost).

Parameters

$complete

bool

True to return complete list of identifiers as needed by API to identify the object.

Returns

intarray

Returns whether tickets with this status are marked as resolved/closed.

getMarkAsResolved() : bool

filterBy
orderBy

Returns

bool

Returns list of required API fields for objects of this class.

getRequiredAPIFields(bool $create) : string[]
Inherited

inherited_from \kyObjectBase::getRequiredAPIFields()

Parameters

$create

bool

True when object will be created. False when object will be updated.

Returns

string[]

Returns whether Kayako will automatically clear the due time for a ticket when the ticket status changes to this status.

getResetDueTime() : bool

filterBy

Returns

bool

Returns list of identifiers of staff groups which can change ticket status to this status.

getStaffGroupIds() : int[]

filterBy name=StaffGroupId
orderBy name=StaffGroupId

Returns

int[]

Returns list of staff groups which can change ticket status to this status.

getStaffGroups(bool $reload) : \kyResultSet

Result is cached until the end of script.

Parameters

$reload

bool

True to reload data from server. False to use the cached value (if present).

Returns

Returns whether a ticket status can be changed to this status only by the selected staff teams.

getStaffVisibilityCustom() : bool

filterBy

Returns

bool

Returns background color associated with this ticket status in GUI.

getStatusBackgroundColor() : string

This color is used for the "General Tab Bar" in Kayako GUI when viewing the ticket.

filterBy

Returns

string

Returns font color associated with this ticket status in GUI.

getStatusColor() : string

filterBy

Returns

string

Returns ticket status title.

getTitle() : string

filterBy
orderBy

Returns

string

If whether whenever a ticket is changed to this ticket status a survey email will be dispatched to the user asking for rating and comments.

getTriggerSurvey() : bool

filterBy

Returns

bool

Returns type of this ticket status.

getType() : string

see \global\kyTicketStatus::TYPE
filterBy
orderBy

Returns

string

Returns whether this ticket status is visible under specified department.

isAvailableInDepartment(\kyDepartment | int $department) : bool

filterBy

Parameters

$department

\kyDepartmentint

Department or its identifier.

Returns

bool

Returns whether the object is new and not yet saved on the server.

isNew() : bool
Inherited

inherited_from \kyObjectBase::isNew()

Returns

bool

Returns whether this object is read only.

isReadOnly() : bool
Inherited

inherited_from \kyObjectBase::isReadOnly()

Returns

bool

Returns whether this ticket status can be set by specified staff group.

isVisibleToStaffGroup(\kyStaffGroup | int $staff_group) : bool

filterBy

Parameters

$staff_group

\kyStaffGroupint

Staff group or its identifier.

Returns

bool

Refreshes the object data from server.

refresh() : \kyObjectBase
Inherited

inherited_from \kyObjectBase::refresh()

Exceptions

\BadMethodCallException

Returns

Saves (creates or updates) the object to the server.

save() : \kyObjectBase
Inherited

inherited_from \kyObjectBase::save()

Returns

Sets whether this object is read only.

setReadOnly(bool $read_only) : bool
Inherited

inherited_from \kyObjectBase::setReadOnly()

Parameters

$read_only

bool

Read only flag.

Returns

bool

Should return short (one line) description of the object (it's title, name, etc.).

toString() : string

Returns

string

Updates the object on the server and refreshes its local data.

update() : \kyObjectBase
Inherited

inherited_from \kyObjectBase::update()

Exceptions

\BadMethodCallException
\kyException

Returns

Returns REST client.

getRESTClient() : \kyRESTClientInterface
Inherited

inherited_from \kyObjectBase::getRESTClient()

Returns

Should use passed data to fill object properties.

parseData(array $data) 

Parameters

$data

array

Object data from XML response.

Builds API fields list.

initAPIFieldsAccessors() 
Inherited

Scans protected and private properties of called class, searches for

apiField [name=field name] [accessor=setter/getter name] [getter=getter name] [setter=setter name] [required_create=true if field if required when creating object] [required_update=true if field if required when udpating object] [required=true if field if required when creating or updating object] and builds API field list with property name, description, setter and getter method names, and required flags.
see \global\kyObjectBase::$_api_fields
inherited_from \kyObjectBase::initAPIFieldsAccessors()

 Properties

 

Cache for available filter methods.

$_filter_methods : string[]
Inherited

Format: array( '' => array( '' => '', ...repeat for every filtering enabled method... ), ...repeat for every object class... )

inherited_from \kyObjectBase::$$_filter_methods
 

Cache for available order methods.

$_order_methods : string[]
Inherited

Format: array( '' => array( '' => '', ...repeat for every ordering enabled method... ), ...repeat for every object class... )

inherited_from \kyObjectBase::$$_order_methods
 

Default Kayako controller used to operate on this objects.

$controller : string

Override in descending classes.

 

Linked department identifier.

$department_id : int

If a ticket status is linked to a department, it will be visible only under the linked department.

apiField
 

If ticket count for this status is displayed in the filter ticket tree.

$display_count : bool

apiField
 

Path to icon displayed in GUI for this ticket status.

$display_icon : string

apiField
 

Ticket status display order.

$display_order : int

apiField
 

Ticket status identifier.

$id : int

apiField
 

If tickets with this status are marked as resolved/closed.

$mark_as_resolved : bool

apiField
 

Indicates the name of object element in XML response.

$object_xml_name : string

Override in descending classes.

 

Controls if the object can be created/updated/deleted.

$read_only : bool

Override in descending classes.

 

If enabled, Kayako will automatically clear the due time for a ticket when the ticket status changes to this status.

$reset_due_time : bool

apiField
 

Identifiers of staff groups which can change ticket status to this status.

$staff_group_ids : int[]

apiField name=staffgroupid
 

If enabled, a ticket status can be changed to this status only by the selected staff teams.

$staff_visibility_custom : bool

see \global\kyTicketStatus::$staff_group_ids
apiField
 

Background color associated with this ticket status in GUI.

$status_bg_color : string

This color is used for the "General Tab Bar" in Kayako GUI when viewing the ticket.

apiField
 

Font color associated with this ticket status in GUI.

$status_color : string

apiField
 

Ticket status title.

$title : string

apiField
 

If enabled, whenever a ticket is changed to this ticket status a survey email will be dispatched to the user asking for rating and comments.

$trigger_survey : bool

apiField
 

Type of ticket status.

$type : string

see \global\kyTicketStatus::TYPE
apiField
 

Cache for API fields.

$_api_fields : array
Inherited

Format: array( '' => array( '' => array( 'property' => '', 'description' => '', 'getter' => '', 'setter' => '', 'required_create' => , 'required_update' => ), ...repeat for every class api field... ), ...repeat for every object class... )

inherited_from \kyObjectBase::$$_api_fields
 

Linked department.

$department : \kyDepartment

 

Staff groups which can change ticket status to this status.

$staff_groups : \kyStaffGroup[]

 Constants

 

Data key for storing files to send as multipart/form-data.

FILES_DATA_NAME : string
Inherited

inherited_from \kyObjectBase::FILES_DATA_NAME
 

TYPE_PRIVATE

TYPE_PRIVATE 

 

TYPE_PUBLIC

TYPE_PUBLIC