__construct()
__get()
__set()
__toString()
buildData()
checkRequiredAPIFields()
create()
createNew()
createNewFromFile()
delete()
get()
getAPIFields()
getAll()
getAvailableFilterMethods()
getAvailableOrderMethods()
getContents()
getController()
getDateline()
getFileName()
getFileSize()
getFileType()
getId()
getRequiredAPIFields()
getTicket()
getTicketId()
getTicketPost()
getTicketPostId()
isNew()
isReadOnly()
refresh()
save()
setContents()
setContentsFromFile()
setFileName()
setReadOnly()
setTicketId()
setTicketPost()
setTicketPostId()
toString()
update()
getRESTClient()
parseData()
initAPIFieldsAccessors()
$_filter_methods
$_order_methods
$contents
$controller
$dateline
$file_name
$file_size
$file_type
$id
$object_xml_name
$read_only
$ticket_id
$ticket_post_id
$_api_fields
$ticket
$ticket_post
FILES_DATA_NAME
Kayako TicketAttachment 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+-+TicketAttachment |
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.create() : \kyObjectBase
createNew(\kyTicketPost $ticket_post, string $contents, string $file_name) : \kyTicketAttachment
WARNING: Data is not sent to Kayako unless you explicitly call create() on this method's result.
string
Raw contents of the file.
string
Filename.
createNewFromFile(\kyTicketPost $ticket_post, string $file_path, string $file_name) : \kyTicketAttachment
WARNING: Data is not sent to Kayako unless you explicitly call create() on this method's result.
string
Path to file.
string
Optional. Use to set filename other than physical file.
delete()
get(int $ticket_id, int $id) : \kyTicketAttachment
int
Ticket identifier.
int
Ticket attachment identifier.
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(bool $auto_fetch) : string
bool
True to automatically fetch the contents of the attachment if not present.
string
getController() : string
inherited_from | \kyObjectBase::getController() |
---|
string
getDateline(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
getFileName() : string
filterBy | |
---|---|
orderBy |
string
getFileSize(bool $formatted) : mixed
filterBy | |
---|---|
orderBy |
bool
True to format result nicely (KB, MB, and so on).
mixed
getFileType() : string
filterBy | |
---|---|
orderBy |
string
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
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
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
int
getTicketPost(bool $reload) : \kyTicketPost
Result is cached until the end of script.
bool
True to reload data from server. False to use the cached value (if present).
getTicketPostId() : int
int
isNew() : bool
inherited_from | \kyObjectBase::isNew() |
---|
bool
isReadOnly() : bool
inherited_from | \kyObjectBase::isReadOnly() |
---|
bool
setContents(string $contents) : \kyTicketAttachment
string
Raw contents of the attachment (NOT base64 encoded).
setContentsFromFile(string $file_path, string $file_name) : \kyTicketAttachment
string
Path to file.
string
Optional. Use to set filename other than physical file.
\kyException |
---|
setReadOnly(bool $read_only) : bool
inherited_from | \kyObjectBase::setReadOnly() |
---|
bool
Read only flag.
bool
setTicketId(int $ticket_id) : \kyTicketAttachment
setTicketPostId(int $ticket_post_id) : \kyTicketAttachment
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.
$dateline : int
apiField |
---|
$file_name : string
apiField | required_create=true |
---|
$file_size : int
apiField |
---|
$file_type : string
apiField |
---|
$id : int
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 |
---|
$ticket_post_id : int
apiField | required_create=true |
---|
$_api_fields : array
Format:
array(
'
inherited_from | \kyObjectBase::$$_api_fields |
---|
FILES_DATA_NAME : string
inherited_from | \kyObjectBase::FILES_DATA_NAME |
---|