__construct()
__get()
__set()
__toString()
buildData()
checkRequiredAPIFields()
create()
createNew()
delete()
get()
getAPIFields()
getAll()
getAvailableFilterMethods()
getAvailableOrderMethods()
getContents()
getController()
getCreationDate()
getCreatorName()
getCreatorStaff()
getCreatorStaffId()
getForStaff()
getForStaffId()
getId()
getNoteColor()
getRequiredAPIFields()
getTicket()
getTicketId()
getType()
getUser()
getUserId()
getUserOrganization()
getUserOrganizationId()
isNew()
isReadOnly()
refresh()
save()
setContents()
setCreator()
setForStaff()
setForStaffId()
setNoteColor()
setReadOnly()
setTicket()
setTicketId()
toString()
update()
getRESTClient()
parseData()
initAPIFieldsAccessors()
$_filter_methods
$_order_methods
$contents
$controller
$creation_date
$creator_staff_id
$creator_staff_name
$for_staff_id
$id
$note_color
$object_xml_name
$read_only
$ticket_id
$type
$user_id
$user_organization_id
$_api_fields
$creator_staff
$for_staff
$ticket
$user
$user_organization
COLOR_BLUE
COLOR_GREEN
COLOR_PURPLE
COLOR_RED
COLOR_YELLOW
FILES_DATA_NAME
TYPE_TICKET
TYPE_USER
TYPE_USER_ORGANIZATION
Kayako TicketNote 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+-+TicketNote |
since | Kayako version 4.01.240 |
package | Object\Ticket |
__construct(array $data)
inherited_from | \kyObjectBase::__construct() |
---|
array
Object data from XML response converted into array.
__get(string $api_field_name) : mixed
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() |
string
API field name.
mixed
__set(string $api_field_name, mixed $value) : mixed
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() |
string
API field name.
mixed
API field value.
mixed
__toString() : string
Calls toString() method to get the object description.
inherited_from | \kyObjectBase::__toString() |
---|
string
buildData(bool $create) : array
Values must be set in format accepted by REST API.
bool
Indicates if the result will be used to create (true) or update (false) an object.
array
checkRequiredAPIFields(bool $create, bool $throw_exception) : string[] | bool
inherited_from | \kyObjectBase::checkRequiredAPIFields() |
---|
bool
True when object will be created. False when object will be updated.
bool
True to throw an exception on missing fields. False to return list of missing fields or true when there are none.
\kyException |
When there are missing field values and $throw_exception is true. |
---|
string[]
bool
List of missing API fields or true when there are none.createNew(\kyTicket $ticket, \kyStaff $creator, string $contents) : \kyTicketNote
WARNING: Data is not sent to Kayako unless you explicitly call create() on this method's result.
string
Contents of new note.
delete()
getAPIFields() : string[]
Format of returned array:
array( '' => Field description. (getter: , setter: ), ...repeat... )
inherited_from | \kyObjectBase::getAPIFields() |
---|
string[]
getAvailableFilterMethods(bool $filter_names_only) : array
Optionaly you can return get method names used to filter objects.
inherited_from | \kyObjectBase::getAvailableFilterMethods() |
---|
bool
True (default) to return array('filterByXXX', 'filterByYYY', ...). False to return array('filterByXXX' => 'getXXX', 'filterByYYY' => 'YYY', ...).
array
getAvailableOrderMethods(bool $order_names_only) : array
Optionaly you can return get method names used to order objects.
inherited_from | \kyObjectBase::getAvailableOrderMethods() |
---|
bool
True (default) to return array('orderByXXX', 'orderByYYY', ...). False to return array('orderByXXX' => 'getXXX', 'orderByYYY' => 'YYY', ...).
array
getContents() : string
filterBy |
---|
string
getController() : string
inherited_from | \kyObjectBase::getController() |
---|
string
getCreationDate(string $format) : string
see | \global\http://www.php.net/manual/en/function.date.php |
---|---|
filterBy | |
orderBy |
string
Output format of the date. If null the format set in client configuration is used.
string
getCreatorName() : string
filterBy | |
---|---|
orderBy |
string
getCreatorStaff(bool $reload) : \kyStaff
Result is cached until the end of script.
bool
True to reload data from server. False to use the cached value (if present).
getCreatorStaffId() : int
filterBy | |
---|---|
orderBy |
int
getForStaff(bool $reload) : \kyStaff
Result is cached until the end of script.
bool
True to reload data from server. False to use the cached value (if present).
getForStaffId() : int
filterBy | |
---|---|
orderBy |
int
getId(bool $complete) : int | array
ticket identifier and ticket post identifier in case of TicketPost).
bool
True to return complete list of identifiers as needed by API to identify the object.
int
array
getNoteColor() : int
see | \global\kyTicketNote::COLOR |
---|---|
filterBy |
int
getRequiredAPIFields(bool $create) : string[]
inherited_from | \kyObjectBase::getRequiredAPIFields() |
---|
bool
True when object will be created. False when object will be updated.
string[]
getTicket(bool $reload) : \kyTicket
Applicable only for notes of type kyTicketNote::TYPE_TICKET. Result is cached until the end of script.
bool
True to reload data from server. False to use the cached value (if present).
getTicketId() : int
Applicable only for notes of type kyTicketNote::TYPE_TICKET.
int
getType() : string
see | \global\kyTicketNote::TYPE |
---|---|
filterBy | |
orderBy |
string
getUser(bool $reload) : \kyUser
Applicable only for notes of type kyTicketNote::TYPE_USER. Result is cached until the end of script.
bool
True to reload data from server. False to use the cached value (if present).
getUserId() : int
Applicable only for notes of type kyTicketNote::TYPE_USER.
filterBy | |
---|---|
orderBy |
int
getUserOrganization(bool $reload) : \kyUserOrganization
Applicable only for notes of type kyTicketNote::TYPE_USER_ORGANIZATION. Result is cached until the end of script.
bool
True to reload data from server. False to use the cached value (if present).
getUserOrganizationId() : int
Applicable only for notes of type kyTicketNote::TYPE_USER_ORGANIZATION.
filterBy | |
---|---|
orderBy |
int
isNew() : bool
inherited_from | \kyObjectBase::isNew() |
---|
bool
isReadOnly() : bool
inherited_from | \kyObjectBase::isReadOnly() |
---|
bool
setCreator(\kyStaff | int | string $creator) : \kyTicketNote
\kyStaff
int
string
Staff OR Staff identifier OR creator name (if the ticket is to be created without providing a staff user, ex: System messages, Alerts etc.).
setReadOnly(bool $read_only) : bool
inherited_from | \kyObjectBase::setReadOnly() |
---|
bool
Read only flag.
bool
setTicketId(int $ticket_id) : \kyTicketNote
toString() : string
string
parseData(array $data)
array
Object data from XML response.
initAPIFieldsAccessors()
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() |
$_filter_methods : string[]
Format:
array(
'
inherited_from | \kyObjectBase::$$_filter_methods |
---|
$_order_methods : string[]
Format:
array(
'
inherited_from | \kyObjectBase::$$_order_methods |
---|
$contents : string
apiField | required_create=true |
---|
$controller : string
Override in descending classes.
$creation_date : int
apiField |
---|
$creator_staff_id : int
apiField | alias=staffid |
---|
$creator_staff_name : string
apiField | getter=getCreatorName setter=setCreator alias=fullname |
---|
$for_staff_id : int
apiField |
---|
$id : int
apiField |
---|
$note_color : int
see | \global\kyTicketNote::COLOR |
---|---|
apiField |
$object_xml_name : string
Override in descending classes.
$read_only : bool
Override in descending classes.
inherited_from | \kyObjectBase::$$read_only |
---|
$ticket_id : int
apiField | required_create=true |
---|
$type : string
see | \global\kyTicketNote::TYPE |
---|---|
apiField |
$user_id : int
apiField |
---|
$user_organization_id : int
apiField |
---|
$_api_fields : array
Format:
array(
'
inherited_from | \kyObjectBase::$$_api_fields |
---|
$user_organization : \kyUserOrganization
COLOR_BLUE : int
COLOR_GREEN : int
COLOR_PURPLE : int
COLOR_RED : int
COLOR_YELLOW : int
FILES_DATA_NAME : string
inherited_from | \kyObjectBase::FILES_DATA_NAME |
---|
TYPE_TICKET : string
TYPE_USER : string
TYPE_USER_ORGANIZATION : string