| Methods |
public
|
__construct()
Constructor
|
#
|
public
|
setApiKey(string $apiKeyIdentifier, string $key): $this
Sets API key
Parameters
| $apiKeyIdentifier |
API key identifier (authentication scheme)
|
| $key |
API key or token
|
|
#
|
public
|
getApiKey(string $apiKeyIdentifier): null|string
Gets API key
Parameters
| $apiKeyIdentifier |
API key identifier (authentication scheme)
|
Returns
|
#
|
public
|
setApiKeyPrefix(string $apiKeyIdentifier, string $prefix): $this
Sets the prefix for API key (e.g. Bearer)
Sets the prefix for API key (e.g. Bearer)
Parameters
| $apiKeyIdentifier |
API key identifier (authentication scheme)
|
| $prefix |
API key prefix, e.g. Bearer
|
|
#
|
public
|
getApiKeyPrefix(string $apiKeyIdentifier): null|string
Gets API key prefix
Parameters
| $apiKeyIdentifier |
API key identifier (authentication scheme)
|
|
#
|
public
|
setAccessToken(string $accessToken): $this
Sets the access token for OAuth
Sets the access token for OAuth
Parameters
| $accessToken |
Token for OAuth
|
|
#
|
public
|
getAccessToken(): string
Gets the access token for OAuth
Gets the access token for OAuth
Returns
|
#
|
public
|
setBooleanFormatForQueryString(string $booleanFormat): $this
Sets boolean format for query string.
Sets boolean format for query string.
|
#
|
public
|
getBooleanFormatForQueryString(): string
Gets boolean format for query string.
Gets boolean format for query string.
Returns
Boolean format for query string
|
#
|
public
|
setUsername(string $username): $this
Sets the username for HTTP basic authentication
Sets the username for HTTP basic authentication
Parameters
| $username |
Username for HTTP basic authentication
|
|
#
|
public
|
getUsername(): string
Gets the username for HTTP basic authentication
Gets the username for HTTP basic authentication
Returns
Username for HTTP basic authentication
|
#
|
public
|
setPassword(string $password): $this
Sets the password for HTTP basic authentication
Sets the password for HTTP basic authentication
Parameters
| $password |
Password for HTTP basic authentication
|
|
#
|
public
|
getPassword(): string
Gets the password for HTTP basic authentication
Gets the password for HTTP basic authentication
Returns
Password for HTTP basic authentication
|
#
|
public
|
setHost(string $host): $this
Sets the host
|
#
|
public
|
getHost(): string
Gets the host
|
#
|
public
|
setUserAgent(string $userAgent): $this
Sets the user agent of the api client
Sets the user agent of the api client
Parameters
| $userAgent |
the user agent of the api client
|
Throws
|
#
|
public
|
getUserAgent(): string
Gets the user agent of the api client
Gets the user agent of the api client
Returns
|
#
|
public
|
setDebug(bool $debug): $this
Sets debug flag
|
#
|
public
|
getDebug(): bool
Gets the debug flag
|
#
|
public
|
setDebugFile(string $debugFile): $this
Sets the debug file
|
#
|
public
|
getDebugFile(): string
Gets the debug file
|
#
|
public
|
setTempFolderPath(string $tempFolderPath): $this
Sets the temp folder path
Sets the temp folder path
Parameters
| $tempFolderPath |
Temp folder path
|
|
#
|
public
|
getTempFolderPath(): string
Gets the temp folder path
Gets the temp folder path
Returns
|
#
|
public
static
|
getDefaultConfiguration(): Configuration
Gets the default configuration instance
Gets the default configuration instance
|
#
|
public
static
|
setDefaultConfiguration(Configuration $config): void
Sets the default configuration instance
Sets the default configuration instance
Parameters
| $config |
An instance of the Configuration Object
|
|
#
|
public
static
|
toDebugReport(): string
Gets the essential information for debugging
Gets the essential information for debugging
Returns
|
#
|
public
|
getApiKeyWithPrefix(string $apiKeyIdentifier): null|string
Get API key (with prefix if set)
Get API key (with prefix if set)
Parameters
| $apiKeyIdentifier |
name of apikey
|
Returns
|
#
|
public
|
getHostSettings(): array
Returns an array of host settings
Returns an array of host settings
Returns
an array of host settings
|
#
|
public
static
|
getHostString(array $hostsSettings, int $hostIndex, array|null $variables = null): string
Returns URL based on host settings, index and variables
Returns URL based on host settings, index and variables
Parameters
| $hostIndex |
index of the host settings
|
| $variables |
hash of variable and the corresponding value (optional)
|
Returns
URL based on host settings
|
#
|
public
|
getHostFromSettings(int $index, array|null $variables = null): string
Returns URL based on the index and variables
Returns URL based on the index and variables
Parameters
| $index |
index of the host settings
|
| $variables |
hash of variable and the corresponding value (optional)
|
Returns
URL based on host settings
|
#
|