Kayako PHP API Library
Back to top  

Class holding library configuration.

author Tomasz Sawicki (https://github.com/Furgas)
package Common

 Methods

Initializes client configuration object.

__construct(string $base_url, string $api_key, string $secret_key) 

Parameters

$base_url

string

Base URL of Kayako REST API.

$api_key

string

Kayako REST API key.

$secret_key

string

Kayako REST API secret key.

Returns current library configuration.

get() : \kyConfig

Exceptions

\kyException

Returns

\kyConfig

Returns Kayako REST API key.

getAPIKey() : string

Returns

string

Returns base URL of Kayako REST API.

getBaseURL() : string

Returns

string

Returns default format of date object properties used in getters and setters.

getDateFormat() : string

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

Returns

string

Returns default format of datetime object properties used in getters and setters.

getDatetimeFormat() : string

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

Returns

string

Returns request URL construction type.

getIsStandardURLType() : bool

Returns True for standard URL and False to use "e" parameter in URL.

see \global\http://wiki.kayako.com/display/DEV/Kayako+REST+API#KayakoRESTAPI-RequestURLtype

Returns

bool

Returns REST client instance.

getRESTClient() : \kyRESTClientInterface

Returns

\kyRESTClientInterface

Returns Kayako REST API secret key.

getSecretKey() : string

Returns

string

Returns whether debug mode is enabled.

isDebugEnabled() : bool

When enabled, REST requests and responses are logged using error_log.

Returns

bool

Sets the current library configuration.

set(\kyConfig $config) : \kyConfig

Should be called before before contacting the API.

Parameters

$config

\kyConfig

Configuration.

Returns

\kyConfig

Sets Kayako REST API key.

setAPIKey(string $api_key) : \kyConfig

Parameters

$api_key

string

Kayako REST API key.

Returns

\kyConfig

Sets the base URL of Kayako REST API.

setBaseURL(string $base_url) : \kyConfig

Parameters

$base_url

string

Base URL of Kayako REST API.

Returns

\kyConfig

Sets default format of date object properties used in getters and setters.

setDateFormat(string $date_format) : \kyConfig

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

Parameters

$date_format

string

Default format of date object properties used in getters and setters.

Returns

\kyConfig

Sets default format of datetime object properties used in getters and setters.

setDatetimeFormat(string $datetime_format) : \kyConfig

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

Parameters

$datetime_format

string

Default format of datetime object properties used in getters and setters.

Returns

\kyConfig

Enables or disables debug mode.

setDebugEnabled(bool $is_debug_enabled) : \kyConfig

When enabled, REST requests and responses are logged using error_log.

Parameters

$is_debug_enabled

bool

Returns

\kyConfig

Sets request URL construction type.

setIsStandardURLType(bool $is_standard_url_type) : \kyConfig

True for standard URL (ex. http://example.domain.com/api/index.php?/Module/Controller/Action&parameter=1&). False to use "e" parameter in URL (ex. http://example.domain.com/api/index.php?e=/Module/Controller/Action&parameter=1&).

see \global\http://wiki.kayako.com/display/DEV/Kayako+REST+API#KayakoRESTAPI-RequestURLtype

Parameters

$is_standard_url_type

bool

True for standard URL. False to use "e" parameter in URL.

Returns

\kyConfig

Sets REST client.

setRESTClient(\kyRESTClientInterface $rest_client) : \kyConfig

Parameters

$rest_client

\kyRESTClientInterface

REST client instance.

Returns

\kyConfig

Sets Kayako REST API secret key.

setSecretKey(string $secret_key) : \kyConfig

Parameters

$secret_key

string

Kayako REST API secret key.

Returns

\kyConfig

 Properties

 

Kayako REST API key.

$api_key : string

 

Base URL of Kayako REST API.

$base_url : string

 

Current configuration.

$current_config : \kyConfig

 

Default format of date object properties used in getters and setters.

$date_format : string

 

Default format of datetime object properties used in getters and setters.

$datetime_format : string

 

True to enable outputing REST requests and responses to error log.

$is_debug_enabled : bool

 

Request URL construction type.

$is_standard_url_type : bool

True for standard URL (ex. http://example.domain.com/api/index.php?/Module/Controller/Action&parameter=1&). False to use "e" parameter in URL (ex. http://example.domain.com/api/index.php?e=/Module/Controller/Action&parameter=1&).

see \global\http://wiki.kayako.com/display/DEV/Kayako+REST+API#KayakoRESTAPI-RequestURLtype
 

REST client.

$rest_client : \kyRESTClientInterface

 

Kayako REST API secret key.

$secret_key : string