IronCore
in package
Core functionality for Iron.io products
Tags
Table of Contents
- DELETE = 'DELETE'
- GET = 'GET'
- HEADER_ACCEPT = "application/json"
- HEADER_ACCEPT_ENCODING = "gzip, deflate"
- HTTP_ACCEPTED = 202
- HTTP_CREATED = 201
- HTTP_OK = 200
- PATCH = 'PATCH'
- POST = 'POST'
- PUT = 'PUT'
- $connection_timeout : mixed
- $debug_enabled : mixed
- $max_retries : mixed
- $proxy : mixed
- $proxy_userpwd : mixed
- $ssl_verifypeer : mixed
- $api_version : mixed
- $client_name : mixed
- $client_version : mixed
- $core_version : mixed
- $curl : mixed
- $default_values : mixed
- $encryption_key : mixed
- $headers : mixed
- $host : mixed
- $last_status : mixed
- $port : mixed
- $product_name : mixed
- $project_id : mixed
- $protocol : mixed
- $token : mixed
- $url : mixed
- $urlFetchContext : mixed
- $urlFetchData : mixed
- $urlFetchUrl : mixed
- $version : mixed
- __destruct() : mixed
- getLastStatus() : mixed
- apiCall() : mixed
- callWithRetries() : mixed
- compiledCurlHeaders() : mixed
- compiledHeaders() : mixed
- compiledUrlFetchHeaders() : mixed
- curlEnabled() : mixed
- dateRfc3339() : mixed
- debug() : mixed
- getConfigData() : array<string|int, mixed>
- Load configuration
- homeDir() : mixed
- json_decode() : mixed
- loadConfigFile() : mixed
- loadFromEnv() : mixed
- loadFromHash() : mixed
- reportHttpError() : mixed
- setCommonHeaders() : mixed
- setVarIfValue() : mixed
- userAgent() : mixed
- waitRandomInterval() : mixed
- Wait for a random time between 0 and (4^currentRetry * 100) milliseconds
Constants
DELETE
public
mixed
DELETE
= 'DELETE'
GET
public
mixed
GET
= 'GET'
HEADER_ACCEPT
public
mixed
HEADER_ACCEPT
= "application/json"
HEADER_ACCEPT_ENCODING
public
mixed
HEADER_ACCEPT_ENCODING
= "gzip, deflate"
HTTP_ACCEPTED
public
mixed
HTTP_ACCEPTED
= 202
HTTP_CREATED
public
mixed
HTTP_CREATED
= 201
HTTP_OK
public
mixed
HTTP_OK
= 200
PATCH
public
mixed
PATCH
= 'PATCH'
POST
public
mixed
POST
= 'POST'
PUT
public
mixed
PUT
= 'PUT'
Properties
$connection_timeout
public
mixed
$connection_timeout
= 60
$debug_enabled
public
mixed
$debug_enabled
= alse
$max_retries
public
mixed
$max_retries
= 5
$proxy
public
mixed
$proxy
=
ull
$proxy_userpwd
public
mixed
$proxy_userpwd
=
ull
$ssl_verifypeer
public
mixed
$ssl_verifypeer
= rue
$api_version
protected
mixed
$api_version
$client_name
protected
mixed
$client_name
=
ull
$client_version
protected
mixed
$client_version
=
ull
$core_version
protected
mixed
$core_version
= '0.2.1'
$curl
protected
mixed
$curl
=
ull
$default_values
protected
mixed
$default_values
=
ull
$encryption_key
protected
mixed
$encryption_key
$headers
protected
mixed
$headers
$host
protected
mixed
$host
$last_status
protected
mixed
$last_status
$port
protected
mixed
$port
$product_name
protected
mixed
$product_name
=
ull
$project_id
protected
mixed
$project_id
$protocol
protected
mixed
$protocol
$token
protected
mixed
$token
$url
protected
mixed
$url
$urlFetchContext
protected
mixed
$urlFetchContext
$urlFetchData
protected
mixed
$urlFetchData
$urlFetchUrl
protected
mixed
$urlFetchUrl
$version
protected
mixed
$version
Methods
__destruct()
public
__destruct() : mixed
Return values
mixed —getLastStatus()
public
getLastStatus() : mixed
Return values
mixed —apiCall()
protected
apiCall(mixed $type, mixed $url[, mixed $params = array() ][, mixed $data = null ]) : mixed
Parameters
- $type : mixed
- $url : mixed
- $params : mixed = array()
- $data : mixed = null
Return values
mixed —callWithRetries()
protected
callWithRetries() : mixed
Return values
mixed —compiledCurlHeaders()
protected
compiledCurlHeaders() : mixed
Return values
mixed —compiledHeaders()
protected
compiledHeaders() : mixed
Return values
mixed —compiledUrlFetchHeaders()
protected
compiledUrlFetchHeaders() : mixed
Return values
mixed —curlEnabled()
protected
curlEnabled() : mixed
Return values
mixed —dateRfc3339()
protected
static dateRfc3339(mixed $timestamp) : mixed
Parameters
- $timestamp : mixed
Return values
mixed —debug()
protected
debug(mixed $var_name, mixed $variable) : mixed
Parameters
- $var_name : mixed
- $variable : mixed
Return values
mixed —getConfigData()
Load configuration
protected
getConfigData(array<string|int, mixed>|string|null $config) : array<string|int, mixed>
Parameters
- $config : array<string|int, mixed>|string|null
-
array of options or name of config file
Tags
Return values
array<string|int, mixed> —homeDir()
protected
static homeDir() : mixed
Return values
mixed —json_decode()
protected
static json_decode(mixed $response) : mixed
Parameters
- $response : mixed
Return values
mixed —loadConfigFile()
protected
loadConfigFile(mixed $file) : mixed
Parameters
- $file : mixed
Return values
mixed —loadFromEnv()
protected
loadFromEnv(mixed $prefix) : mixed
Parameters
- $prefix : mixed
Return values
mixed —loadFromHash()
protected
loadFromHash(mixed $options) : mixed
Parameters
- $options : mixed
Return values
mixed —reportHttpError()
protected
reportHttpError(mixed $status, mixed $text) : mixed
Parameters
- $status : mixed
- $text : mixed
Return values
mixed —setCommonHeaders()
protected
setCommonHeaders() : mixed
Return values
mixed —setVarIfValue()
protected
setVarIfValue(mixed $key, mixed $options_or_value) : mixed
Parameters
- $key : mixed
- $options_or_value : mixed
Return values
mixed —userAgent()
protected
userAgent() : mixed
Return values
mixed —waitRandomInterval()
Wait for a random time between 0 and (4^currentRetry * 100) milliseconds
protected
static waitRandomInterval(int $retry) : mixed
Parameters
- $retry : int
-
currentRetry number