Class shardimage\shardimagephpapi\services\Client

All Classes | Properties | Methods

Inheritance	shardimage\shardimagephpapi\services\Client » shardimage\shardimagephpapi\services\BaseService » shardimage\shardimagephpapi\base\BaseObject
Subclasses	shardimage\shardimagephp\auth\ClientService

Client service.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$authData	string	Authentication class	shardimage\shardimagephpapi\services\Client
$cache	shardimage\shardimagephpapi\base\caches\CacheInterface		shardimage\shardimagephpapi\services\Client
$cacheExpiration	integer		shardimage\shardimagephpapi\services\Client
$customHeaderPrefix	string	Prefix for custom headers (e.g. X-Some-Header)	shardimage\shardimagephpapi\services\BaseService
$customHeaders	array	Custom HTTP headers (x-.	shardimage\shardimagephpapi\services\Client
$headers	array	Additional HTTP headers	shardimage\shardimagephpapi\services\Client
$host	string	Backend host	shardimage\shardimagephpapi\services\BaseService
$preferredResource	string	Preferred resource handler for presenting resources	shardimage\shardimagephpapi\services\BaseService
$proxy	string\|array	Proxy or an array of proxies per protocol	shardimage\shardimagephpapi\services\Client
$resourceHandlers	array	Resource handlers (e.g. for files)	shardimage\shardimagephpapi\services\BaseService
$useGzip	\shardimage\shardimagephpapi\services\Gzip	Compression support	shardimage\shardimagephpapi\services\Client
$useMsgPack	boolean	MsgPack support	shardimage\shardimagephpapi\services\Client

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()	Creates the object, populates the properties and calls the "init" method.	shardimage\shardimagephpapi\base\BaseObject
__get()	Returns the value of a non-defined property, it there is a getter method.	shardimage\shardimagephpapi\base\BaseObject
__isset()	Does the non-defined property with a getter exist and is it not NULL?	shardimage\shardimagephpapi\base\BaseObject
__set()	Sets the value of a non-defined property, if there is a setter method.	shardimage\shardimagephpapi\base\BaseObject
__unset()	Sets the value of a non-defined property to NULL, if there is a setter.	shardimage\shardimagephpapi\base\BaseObject
buildCustomHeader()	Builds a custom header (e.g. X-Some-Header).	shardimage\shardimagephpapi\services\BaseService
getResourceHandler()	Returns whether the provided value is file.	shardimage\shardimagephpapi\services\BaseService
init()	Initializes the client data.	shardimage\shardimagephpapi\services\Client
log()	Logs an event.	shardimage\shardimagephpapi\services\BaseService
parseCustomHeader()		shardimage\shardimagephpapi\services\BaseService
toArray()	Converts the object an array.	shardimage\shardimagephpapi\base\BaseObject

Protected Methods

Hide inherited methods

Method	Description	Defined By
ensureClass()	Creates an object from the given parameters.	shardimage\shardimagephpapi\base\BaseObject

Property Details

$authData public property

Authentication class

public string $authData = \shardimage\shardimagephpapi\api\auth\NullAuthData::class

$cache public property

public shardimage\shardimagephpapi\base\caches\CacheInterface $cache = null

$cacheExpiration public property

public integer $cacheExpiration = 0

$customHeaders public property

Custom HTTP headers (x-...)

public array $customHeaders = []

$headers public property

Additional HTTP headers

public array $headers = []

$proxy public property

Proxy or an array of proxies per protocol

public string|array $proxy = null

$useGzip public property

Compression support

public \shardimage\shardimagephpapi\services\Gzip $useGzip = true

$useMsgPack public property

MsgPack support

public boolean $useMsgPack = true

Method Details

init() public method

Initializes the client data.

public void init ( )
throws	shardimage\shardimagephpapi\base\exceptions\InvalidConfigException