Client

About 2 min

Client

Properties

encryptionDefaultKey

public string $encryptionDefaultKey

encryptionDefaultCipher

public string $encryptionDefaultCipher = 'AES-256-CBC'

encryptionHeader

public string $encryptionHeader = 'X-HAZAAR-COMKEY'

bufferSize

private int $bufferSize = 4096

connectionTimeout

private int $connectionTimeout = 5

headers

private array $headers

cookies

private array $cookies

localCert

public string $localCert

certPassphrase

public string $certPassphrase

autoRedirect

private bool $autoRedirect = true

redirectMethods

private array $redirectMethods = array (
  0 => 'GET',
  1 => 'OPTIONS',
  2 => 'PROPFIND',
)

username

public string $username

password

public string $password

auth

public Adapter $auth

encryptionKey

public string $encryptionKey

encryptionCipher

public string $encryptionCipher

Methods

__construct

public __construct(?string $localCert, ?string $passphrase): void

Parameters

Parameter	Type	Description
`$localCert`	`string`
`$passphrase`	`string`

auth

public auth(string $username, string $password): void

Parameters

Parameter	Type	Description
`$username`	`string`
`$password`	`string`

authorisation

public authorisation(Adapter $auth): void

Parameters

Parameter	Type	Description
`$auth`	`Adapter`

setHeader

public setHeader(string $header, string $value): void

Parameters

Parameter	Type	Description
`$header`	`string`
`$value`	`string`

options

public options(string $url): Response

Parameters

Parameter	Type	Description
`$url`	`string`

get

public get(URL $url, int $redirectLimit = 10, int $offset = -1, ?int $maxlen): Response

Parameters

Parameter	Type	Description
`$url`	`URL`
`$redirectLimit`	`int`
`$offset`	`int`
`$maxlen`	`int`

head

public head(URL $url, int $redirectLimit = 10): Response

Parameters

Parameter	Type	Description
`$url`	`URL`
`$redirectLimit`	`int`

post

public post(URL $url, mixed $data, ?string $dataType, int $redirectLimit = 0): Response

Parameters

Parameter	Type	Description
`$url`	`URL`
`$data`	`mixed`
`$dataType`	`string`
`$redirectLimit`	`int`

delete

public delete(URL $url): Response

Parameters

Parameter	Type	Description
`$url`	`URL`

trace

public trace(URL $url): Response

Parameters

Parameter	Type	Description
`$url`	`URL`

send

Send a request to the desination host.

public send(Request $request, int $redirectLimit = 10): ?Response

Parameters

Parameter	Type	Description
`$request`	`Request`	The request to send
`$redirectLimit`	`int`	The number of allowed redirects. To disable

                          automated redirects on this request, set to FALSE. |

getCookies

public getCookies(string $): void

Parameters

Parameter	Type	Description
`$`	`string`

getCookie

public getCookie(string $name): string

Parameters

Parameter	Type	Description
`$name`	`string`

hasCookie

public hasCookie(string $name): bool

Parameters

Parameter	Type	Description
`$name`	`string`

deleteCookie

public deleteCookie(string $name): void

Parameters

Parameter	Type	Description
`$name`	`string`

setCookie

public setCookie(string $cookie): void

Parameters

Parameter	Type	Description
`$cookie`	`string`

cacheCookie

public cacheCookie(CacheAdapter $cache, bool $cacheAll = false): bool

Parameters

Parameter	Type	Description
`$cache`	`CacheAdapter`
`$cacheAll`	`bool`

uncacheCookie

public uncacheCookie(CacheAdapter $cache): bool

Parameters

Parameter	Type	Description
`$cache`	`CacheAdapter`

deleteCookies

public deleteCookies(): void

disableRedirect

public disableRedirect(): void

enableEncryption

public enableEncryption(?string $key, ?string $cipher): void

Parameters

Parameter	Type	Description
`$key`	`string`
`$cipher`	`string`

applyCookies

private applyCookies(Request $request): Request

Parameters

Parameter	Type	Description
`$request`	`Request`

Generated by Hazaar API Doc Generator