__construct()
get()
getAPIKey()
getBaseURL()
getDateFormat()
getDatetimeFormat()
getIsStandardURLType()
getRESTClient()
getSecretKey()
isDebugEnabled()
set()
setAPIKey()
setBaseURL()
setDateFormat()
setDatetimeFormat()
setDebugEnabled()
setIsStandardURLType()
setRESTClient()
setSecretKey()
$api_key
$base_url
$current_config
$date_format
$datetime_format
$is_debug_enabled
$is_standard_url_type
$rest_client
$secret_key
Class holding library configuration.
author | Tomasz Sawicki (https://github.com/Furgas) |
---|---|
package | Common |
__construct(string $base_url, string $api_key, string $secret_key)
string
Base URL of Kayako REST API.
string
Kayako REST API key.
string
Kayako REST API secret key.
getAPIKey() : string
string
getBaseURL() : string
string
getDateFormat() : string
see | \global\http://www.php.net/manual/en/function.date.php |
---|
string
getDatetimeFormat() : string
see | \global\http://www.php.net/manual/en/function.date.php |
---|
string
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 |
---|
bool
getSecretKey() : string
string
isDebugEnabled() : bool
When enabled, REST requests and responses are logged using error_log.
bool
set(\kyConfig $config) : \kyConfig
setDateFormat(string $date_format) : \kyConfig
see | \global\http://www.php.net/manual/en/function.date.php |
---|
string
Default format of date object properties used in getters and setters.
setDatetimeFormat(string $datetime_format) : \kyConfig
see | \global\http://www.php.net/manual/en/function.date.php |
---|
string
Default format of datetime object properties used in getters and setters.
setDebugEnabled(bool $is_debug_enabled) : \kyConfig
When enabled, REST requests and responses are logged using error_log.
bool
setIsStandardURLType(bool $is_standard_url_type) : \kyConfig
True for standard URL (ex. http://example.domain.com/api/index.php?/Module/Controller/Action¶meter=1&). False to use "e" parameter in URL (ex. http://example.domain.com/api/index.php?e=/Module/Controller/Action¶meter=1&).
see | \global\http://wiki.kayako.com/display/DEV/Kayako+REST+API#KayakoRESTAPI-RequestURLtype |
---|
bool
True for standard URL. False to use "e" parameter in URL.
$api_key : string
$base_url : string
$date_format : string
$datetime_format : string
$is_debug_enabled : bool
$is_standard_url_type : bool
True for standard URL (ex. http://example.domain.com/api/index.php?/Module/Controller/Action¶meter=1&). False to use "e" parameter in URL (ex. http://example.domain.com/api/index.php?e=/Module/Controller/Action¶meter=1&).
see | \global\http://wiki.kayako.com/display/DEV/Kayako+REST+API#KayakoRESTAPI-RequestURLtype |
---|
$secret_key : string