delete()
get()
post()
put()
setConfig()
processRequest()
buildPostBody()
getRequestData()
$config
METHOD_DELETE
METHOD_GET
METHOD_POST
METHOD_PUT
Default REST client implementation.
author | Tomasz Sawicki (https://github.com/Furgas) |
---|---|
package | Common\REST |
delete(string $controller, array $parameters)
see | \global\kyRESTClientInterface::delete() |
---|
string
Kayako controller to call.
array
List of additional parameters (like object identifiers or search parameters).
get(string $controller, array $parameters) : array
see | \global\kyRESTClientInterface::get() |
---|
string
Kayako controller to call.
array
Optional. List of additional parameters (like object identifiers or search parameters).
array
XML parsed to array in @see ky_xml_to_array() style.post(string $controller, array $parameters, array $data, array $files) : array
Format of $files parameter:
array( '' => array('file_name' => ' ', 'contents' => ' '), ...repeat... )
see | \global\kyRESTClientInterface::post() |
---|
string
Kayako controller to call.
array
Optional. List of additional parameters (like object identifiers or search parameters).
array
Optional. Data array with parameter name as key and parameter value as value.
array
Optional. Array of files.
array
XML parsed to array in @see ky_xml_to_array() style.put(string $controller, array $parameters, array $data, array $files) : array
Format of $files parameter:
array( '' => array('file_name' => ' ', 'contents' => ' '), ...repeat... )
see | \global\kyRESTClientInterface::put() |
---|
string
Kayako controller to call.
array
Optional. List of additional parameters (like object identifiers or search parameters).
array
Optional. Data array with parameter name as key and parameter value as value.
array
Optional. Array of files in form of: array('
array
XML parsed to array in @see ky_xml_to_array() style.setConfig(\kyConfig $config)
processRequest(string $controller, string $method, array $parameters, array $data, array $files) : array
string
Kayako controller to call. Null to use default controller defined for object.
string
HTTP verb.
array
Optional. List of additional parameters (like object identifiers or search parameters).
array
Optional. Data array with parameter name as key and parameter value as value.
array
Optional. Array of files in form of: array('
\kyException |
---|
array
buildPostBody(array $data, array $files, array $headers) : string
If files are provided the result is encoded using multipart/form-data otherwise application/x-www-form-urlencoded is used. Part of code are taken from https://github.com/fictivekin/Resty.php.
array
Data array with parameter name as key and parameter value as value.
array
Optional. Array of files in form of: array('
array
Optional. Placeholder for headers.
string
getRequestData(string $controller, string $method, array $parameters, array $data) : string
string
Kayako controller to call. Null to use default controller defined for object.
string
HTTP verb.
array
List of additional parameters (like object identifiers or search parameters).
array
Placeholder for POST/PUT data.
string
METHOD_DELETE : string
For deleting objects.
inherited_from | \kyRESTClientInterface::METHOD_DELETE |
---|
METHOD_GET : string
For getting objects.
inherited_from | \kyRESTClientInterface::METHOD_GET |
---|
METHOD_POST : string
For creating object.
inherited_from | \kyRESTClientInterface::METHOD_POST |
---|
METHOD_PUT : string
For updating objects.
inherited_from | \kyRESTClientInterface::METHOD_PUT |
---|