Kayako PHP API Library
Back to top  

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

 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

Values must be set in format accepted by REST API.

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

\kyObjectBase

Creates new attachment for ticket post with contents provided as parameter.

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.

Parameters

$ticket_post

\kyTicketPost

Ticket post.

$contents

string

Raw contents of the file.

$file_name

string

Filename.

Returns

\kyTicketAttachment

Creates new attachment for ticket post with contents read from physical file.

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.

Parameters

$ticket_post

\kyTicketPost

Ticket post.

$file_path

string

Path to file.

$file_name

string

Optional. Use to set filename other than physical file.

Returns

\kyTicketAttachment

Deletes the object on the server.

delete() 

Returns ticket attachment.

get(int $ticket_id, int $id) : \kyTicketAttachment

Parameters

$ticket_id

int

Ticket identifier.

$id

int

Ticket attachment identifier.

Returns

\kyTicketAttachment

Returns array of API fields.

getAPIFields() : string[]
Inherited

Format of returned array:

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

inherited_from \kyObjectBase::getAPIFields()

Returns

string[]

Returns all attachments in posts of the ticket.

getAll(int $ticket_id) : \kyResultSet

Parameters

$ticket_id

int

Ticket identifier.

Returns

\kyResultSet

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

Return raw contents of the attachment (NOT base64 encoded).

getContents(bool $auto_fetch) : string

Parameters

$auto_fetch

bool

True to automatically fetch the contents of the attachment if not present.

Returns

string

Returns object controller.

getController() : string
Inherited

inherited_from \kyObjectBase::getController()

Returns

string

Returns date and time of when this attachment was created.

getDateline(string $format) : string

see \global\http://www.php.net/manual/en/function.date.php
filterBy
orderBy

Parameters

$format

string

Output format of the date. If null the format set in client configuration is used.

Returns

string

Returns attachment file name.

getFileName() : string

filterBy
orderBy

Returns

string

Returns attachment file size.

getFileSize(bool $formatted) : mixed

filterBy
orderBy

Parameters

$formatted

bool

True to format result nicely (KB, MB, and so on).

Returns

mixed

Returns attachment MIME type.

getFileType() : string

filterBy
orderBy

Returns

string

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 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 the ticket this attachment belongs to.

getTicket(bool $reload) : \kyTicket

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

\kyTicket

Returns identifier of the ticket this attachment belongs to.

getTicketId() : int

Returns

int

Returns the ticket post this attachment is attached to.

getTicketPost(bool $reload) : \kyTicketPost

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

\kyTicketPost

Returns identifier of the ticket post this attachment is attached to.

getTicketPostId() : int

Returns

int

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

Refreshes the object data from server.

refresh() : \kyObjectBase
Inherited

inherited_from \kyObjectBase::refresh()

Exceptions

\BadMethodCallException

Returns

\kyObjectBase

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

save() : \kyObjectBase
Inherited

inherited_from \kyObjectBase::save()

Returns

\kyObjectBase

Sets raw contents of the attachment (NOT base64 encoded).

setContents(string $contents) : \kyTicketAttachment

Parameters

$contents

string

Raw contents of the attachment (NOT base64 encoded).

Returns

\kyTicketAttachment

Sets contents of the attachment by reading it from a physical file.

setContentsFromFile(string $file_path, string $file_name) : \kyTicketAttachment

Parameters

$file_path

string

Path to file.

$file_name

string

Optional. Use to set filename other than physical file.

Exceptions

\kyException

Returns

\kyTicketAttachment

Sets the attachment file name.

setFileName(string $file_name) : \kyTicketAttachment

Parameters

$file_name

string

File name.

Returns

\kyTicketAttachment

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

Sets identifier of the ticket this attachment will belong to.

setTicketId(int $ticket_id) : \kyTicketAttachment

Parameters

$ticket_id

int

Ticket identifier.

Returns

\kyTicketAttachment

Sets the ticket post this attachment will be attached to.

setTicketPost(\kyTicketPost $ticket_post) 

Automatically sets the ticket.

Parameters

$ticket_post

\kyTicketPost

Ticket post.

Sets identifier of the ticket post this attachment will be attached to.

setTicketPostId(int $ticket_post_id) : \kyTicketAttachment

Parameters

$ticket_post_id

int

Ticket post identifier.

Returns

\kyTicketAttachment

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

Exceptions

\BadMethodCallException
\kyException

Returns

\kyObjectBase

Adds boolean field to object data array only if its value is non-empty.

buildDataBool(array $data, string $field_name, mixed $field_value) 
Inherited

inherited_from \kyObjectBase::buildDataBool()

Parameters

$data

array

Data used to create or update the object.

$field_name

string

Field name.

$field_value

mixed

Field value.

Adds array field to object data array only if its value is proper array and is non-empty.

buildDataList(array $data, string $field_name, mixed $field_value) 
Inherited

inherited_from \kyObjectBase::buildDataList()

Parameters

$data

array

Data used to create or update the object.

$field_name

string

Field name.

$field_value

mixed

Field value.

Adds numeric field to object data array only if its value is proper number.

buildDataNumeric(array $data, string $field_name, mixed $field_value) 
Inherited

inherited_from \kyObjectBase::buildDataNumeric()

Parameters

$data

array

Data used to create or update the object.

$field_name

string

Field name.

$field_value

mixed

Field value.

Adds string field to object data array only if its value is non-empty.

buildDataString(array $data, string $field_name, mixed $field_value) 
Inherited

inherited_from \kyObjectBase::buildDataString()

Parameters

$data

array

Data used to create or update the object.

$field_name

string

Field name.

$field_value

mixed

Field value.

Returns REST client.

getRESTClient() : \kyRESTClientInterface
Inherited

inherited_from \kyObjectBase::getRESTClient()

Returns

\kyRESTClientInterface

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]{0,1} [alias=field name alias]* [accessor=setter/getter name]{0,1} [getter=getter name]{0,1} [setter=setter name]{0,1} [required_create=true if field if required when creating object]{0,1} [required_update=true if field if required when udpating object]{0,1} [required=true if field if required when creating or updating object]{0,1} 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
 

Raw contents of attachment.

$contents : string

apiField required_create=true
 

Default Kayako controller used to operate on this objects.

$controller : string

Override in descending classes.

 

Timestamp of when this attachment was created.

$dateline : int

apiField
 

Attachment file name.

$file_name : string

apiField required_create=true
 

Attachment size in bytes.

$file_size : int

apiField
 

Attachment MIME type.

$file_type : string

apiField
 

Ticket attachment identifier.

$id : int

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
Inherited

Override in descending classes.

inherited_from \kyObjectBase::$$read_only
 

Identifier of ticket that this attachment is attached to.

$ticket_id : int

apiField required_create=true
 

Identifier of ticket post that this attachment is attached to.

$ticket_post_id : int

apiField required_create=true
 

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
 

Ticket with this attachment.

$ticket : \kyTicket

 

Ticket post with this attachment.

$ticket_post : \kyTicketPost

 Constants

 

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

FILES_DATA_NAME : string
Inherited

inherited_from \kyObjectBase::FILES_DATA_NAME