Configuration
in package
Configuration Class Doc Comment PHP version 5
Tags
Table of Contents
- $accessToken : string
- Access token for OAuth
- $apiKeyPrefixes : array<string|int, string>
- Associate array to store API prefix (e.g. Bearer)
- $apiKeys : array<string|int, string>
- Associate array to store API key(s)
- $curlConnectTimeout : string
- Timeout (second) of the HTTP connection, by default set to 0, no timeout
- $curlTimeout : string
- Timeout (second) of the HTTP request, by default set to 0, no timeout
- $debug : bool
- Debug switch (default set to false)
- $debugFile : string
- Debug file location (log to STDOUT by default)
- $defaultHeaders : array<string|int, mixed>
- The default header(s)
- $host : string
- The host
- $password : string
- Password for HTTP basic authentication
- $proxyHost : string
- Curl proxy host
- $proxyPassword : string
- Curl proxy password
- $proxyPort : int
- Curl proxy port
- $proxyType : int
- Curl proxy type, e.g. CURLPROXY_HTTP or CURLPROXY_SOCKS5
- $proxyUser : string
- Curl proxy username
- $sslVerification : bool
- Indicates if SSL verification should be enabled or disabled.
- $tempFolderPath : string
- Debug file location (log to STDOUT by default)
- $userAgent : string
- User agent of the HTTP request, set to "PHP-Swagger" by default
- $username : string
- Username for HTTP basic authentication
- $defaultConfiguration : mixed
- __construct() : mixed
- Constructor
- addDefaultHeader() : Configuration
- Adds a default header
- deleteDefaultHeader() : Configuration
- Deletes a default header
- getAccessToken() : string
- Gets the access token for OAuth
- getApiKey() : string
- Gets API key
- getApiKeyPrefix() : string
- Gets API key prefix
- getCurlConnectTimeout() : string
- Gets the HTTP connect timeout value
- getCurlProxyHost() : string
- Gets the HTTP Proxy Host
- getCurlProxyPassword() : string
- Gets the HTTP Proxy Password
- getCurlProxyPort() : int
- Gets the HTTP Proxy Port
- getCurlProxyType() : int
- Gets the HTTP Proxy Type
- getCurlProxyUser() : string
- Gets the HTTP Proxy User
- getCurlTimeout() : string
- Gets the HTTP timeout value
- getDebug() : bool
- Gets the debug flag
- getDebugFile() : string
- Gets the debug file
- getDefaultConfiguration() : Configuration
- Gets the default configuration instance
- getDefaultHeaders() : array<string|int, mixed>
- Gets the default header
- getHost() : string
- Gets the host
- getPassword() : string
- Gets the password for HTTP basic authentication
- getSSLVerification() : bool
- Gets if SSL verification should be enabled or disabled
- getTempFolderPath() : string
- Gets the temp folder path
- getUserAgent() : string
- Gets the user agent of the api client
- getUsername() : string
- Gets the username for HTTP basic authentication
- setAccessToken() : Configuration
- Sets the access token for OAuth
- setApiKey() : Configuration
- Sets API key
- setApiKeyPrefix() : Configuration
- Sets the prefix for API key (e.g. Bearer)
- setCurlConnectTimeout() : Configuration
- Sets the HTTP connect timeout value
- setCurlProxyHost() : ApiClient
- Sets the HTTP Proxy Host
- setCurlProxyPassword() : ApiClient
- Sets the HTTP Proxy Password
- setCurlProxyPort() : ApiClient
- Sets the HTTP Proxy Port
- setCurlProxyType() : ApiClient
- Sets the HTTP Proxy Type
- setCurlProxyUser() : ApiClient
- Sets the HTTP Proxy User
- setCurlTimeout() : Configuration
- Sets the HTTP timeout value
- setDebug() : Configuration
- Sets debug flag
- setDebugFile() : Configuration
- Sets the debug file
- setDefaultConfiguration() : void
- Sets the detault configuration instance
- setHost() : Configuration
- Sets the host
- setPassword() : Configuration
- Sets the password for HTTP basic authentication
- setSSLVerification() : Configuration
- Sets if SSL verification should be enabled or disabled
- setTempFolderPath() : Configuration
- Sets the temp folder path
- setUserAgent() : Configuration
- Sets the user agent of the api client
- setUsername() : Configuration
- Sets the username for HTTP basic authentication
- toDebugReport() : string
- Gets the essential information for debugging
Properties
$accessToken
Access token for OAuth
protected
string
$accessToken
= ''
$apiKeyPrefixes
Associate array to store API prefix (e.g. Bearer)
protected
array<string|int, string>
$apiKeyPrefixes
= []
$apiKeys
Associate array to store API key(s)
protected
array<string|int, string>
$apiKeys
= []
$curlConnectTimeout
Timeout (second) of the HTTP connection, by default set to 0, no timeout
protected
string
$curlConnectTimeout
= 0
$curlTimeout
Timeout (second) of the HTTP request, by default set to 0, no timeout
protected
string
$curlTimeout
= 0
$debug
Debug switch (default set to false)
protected
bool
$debug
= false
$debugFile
Debug file location (log to STDOUT by default)
protected
string
$debugFile
= 'php://output'
$defaultHeaders
The default header(s)
protected
array<string|int, mixed>
$defaultHeaders
= []
$host
The host
protected
string
$host
= 'https://www.docusign.net/restapi'
$password
Password for HTTP basic authentication
protected
string
$password
= ''
$proxyHost
Curl proxy host
protected
string
$proxyHost
$proxyPassword
Curl proxy password
protected
string
$proxyPassword
$proxyPort
Curl proxy port
protected
int
$proxyPort
$proxyType
Curl proxy type, e.g. CURLPROXY_HTTP or CURLPROXY_SOCKS5
protected
int
$proxyType
Tags
$proxyUser
Curl proxy username
protected
string
$proxyUser
$sslVerification
Indicates if SSL verification should be enabled or disabled.
protected
bool
$sslVerification
= true
This is useful if the host uses a self-signed SSL certificate.
True if the certificate should be validated, false otherwise.
$tempFolderPath
Debug file location (log to STDOUT by default)
protected
string
$tempFolderPath
$userAgent
User agent of the HTTP request, set to "PHP-Swagger" by default
protected
string
$userAgent
= "Swagger-Codegen/5.1.0/php"
$username
Username for HTTP basic authentication
protected
string
$username
= ''
$defaultConfiguration
private
static mixed
$defaultConfiguration
= null
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
Return values
mixed —addDefaultHeader()
Adds a default header
public
addDefaultHeader(string $headerName, string $headerValue) : Configuration
Parameters
- $headerName : string
-
header name (e.g. Token)
- $headerValue : string
-
header value (e.g. 1z8wp3)
Return values
Configuration —deleteDefaultHeader()
Deletes a default header
public
deleteDefaultHeader(string $headerName) : Configuration
Parameters
- $headerName : string
-
the header to delete
Return values
Configuration —getAccessToken()
Gets the access token for OAuth
public
getAccessToken() : string
Return values
string —Access token for OAuth
getApiKey()
Gets API key
public
getApiKey(string $apiKeyIdentifier) : string
Parameters
- $apiKeyIdentifier : string
-
API key identifier (authentication scheme)
Return values
string —API key or token
getApiKeyPrefix()
Gets API key prefix
public
getApiKeyPrefix(string $apiKeyIdentifier) : string
Parameters
- $apiKeyIdentifier : string
-
API key identifier (authentication scheme)
Return values
string —getCurlConnectTimeout()
Gets the HTTP connect timeout value
public
getCurlConnectTimeout() : string
Return values
string —HTTP connect timeout value
getCurlProxyHost()
Gets the HTTP Proxy Host
public
getCurlProxyHost() : string
Return values
string —getCurlProxyPassword()
Gets the HTTP Proxy Password
public
getCurlProxyPassword() : string
Return values
string —getCurlProxyPort()
Gets the HTTP Proxy Port
public
getCurlProxyPort() : int
Return values
int —getCurlProxyType()
Gets the HTTP Proxy Type
public
getCurlProxyType() : int
Return values
int —getCurlProxyUser()
Gets the HTTP Proxy User
public
getCurlProxyUser() : string
Return values
string —getCurlTimeout()
Gets the HTTP timeout value
public
getCurlTimeout() : string
Return values
string —HTTP timeout value
getDebug()
Gets the debug flag
public
getDebug() : bool
Return values
bool —getDebugFile()
Gets the debug file
public
getDebugFile() : string
Return values
string —getDefaultConfiguration()
Gets the default configuration instance
public
static getDefaultConfiguration() : Configuration
Return values
Configuration —getDefaultHeaders()
Gets the default header
public
getDefaultHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of default header(s)
getHost()
Gets the host
public
getHost() : string
Return values
string —Host
getPassword()
Gets the password for HTTP basic authentication
public
getPassword() : string
Return values
string —Password for HTTP basic authentication
getSSLVerification()
Gets if SSL verification should be enabled or disabled
public
getSSLVerification() : bool
Return values
bool —True if the certificate should be validated, false otherwise
getTempFolderPath()
Gets the temp folder path
public
getTempFolderPath() : string
Return values
string —Temp folder path
getUserAgent()
Gets the user agent of the api client
public
getUserAgent() : string
Return values
string —user agent
getUsername()
Gets the username for HTTP basic authentication
public
getUsername() : string
Return values
string —Username for HTTP basic authentication
setAccessToken()
Sets the access token for OAuth
public
setAccessToken(string $accessToken) : Configuration
Parameters
- $accessToken : string
-
Token for OAuth
Return values
Configuration —setApiKey()
Sets API key
public
setApiKey(string $apiKeyIdentifier, string $key) : Configuration
Parameters
- $apiKeyIdentifier : string
-
API key identifier (authentication scheme)
- $key : string
-
API key or token
Return values
Configuration —setApiKeyPrefix()
Sets the prefix for API key (e.g. Bearer)
public
setApiKeyPrefix(string $apiKeyIdentifier, string $prefix) : Configuration
Parameters
- $apiKeyIdentifier : string
-
API key identifier (authentication scheme)
- $prefix : string
-
API key prefix, e.g. Bearer
Return values
Configuration —setCurlConnectTimeout()
Sets the HTTP connect timeout value
public
setCurlConnectTimeout(int $seconds) : Configuration
Parameters
- $seconds : int
-
Number of seconds before connection times out [set to 0 for no timeout]
Return values
Configuration —setCurlProxyHost()
Sets the HTTP Proxy Host
public
setCurlProxyHost(string $proxyHost) : ApiClient
Parameters
- $proxyHost : string
-
HTTP Proxy URL
Return values
ApiClient —setCurlProxyPassword()
Sets the HTTP Proxy Password
public
setCurlProxyPassword(string $proxyPassword) : ApiClient
Parameters
- $proxyPassword : string
-
HTTP Proxy Password
Return values
ApiClient —setCurlProxyPort()
Sets the HTTP Proxy Port
public
setCurlProxyPort(int $proxyPort) : ApiClient
Parameters
- $proxyPort : int
-
HTTP Proxy Port
Return values
ApiClient —setCurlProxyType()
Sets the HTTP Proxy Type
public
setCurlProxyType(int $proxyType) : ApiClient
Parameters
- $proxyType : int
-
HTTP Proxy Type
Return values
ApiClient —setCurlProxyUser()
Sets the HTTP Proxy User
public
setCurlProxyUser(string $proxyUser) : ApiClient
Parameters
- $proxyUser : string
-
HTTP Proxy User
Return values
ApiClient —setCurlTimeout()
Sets the HTTP timeout value
public
setCurlTimeout(int $seconds) : Configuration
Parameters
- $seconds : int
-
Number of seconds before timing out [set to 0 for no timeout]
Return values
Configuration —setDebug()
Sets debug flag
public
setDebug(bool $debug) : Configuration
Parameters
- $debug : bool
-
Debug flag
Return values
Configuration —setDebugFile()
Sets the debug file
public
setDebugFile(string $debugFile) : Configuration
Parameters
- $debugFile : string
-
Debug file
Return values
Configuration —setDefaultConfiguration()
Sets the detault configuration instance
public
static setDefaultConfiguration(Configuration $config) : void
Parameters
- $config : Configuration
-
An instance of the Configuration Object
Return values
void —setHost()
Sets the host
public
setHost(string $host) : Configuration
Parameters
- $host : string
-
Host
Return values
Configuration —setPassword()
Sets the password for HTTP basic authentication
public
setPassword(string $password) : Configuration
Parameters
- $password : string
-
Password for HTTP basic authentication
Return values
Configuration —setSSLVerification()
Sets if SSL verification should be enabled or disabled
public
setSSLVerification(bool $sslVerification) : Configuration
Parameters
- $sslVerification : bool
-
True if the certificate should be validated, false otherwise
Return values
Configuration —setTempFolderPath()
Sets the temp folder path
public
setTempFolderPath(string $tempFolderPath) : Configuration
Parameters
- $tempFolderPath : string
-
Temp folder path
Return values
Configuration —setUserAgent()
Sets the user agent of the api client
public
setUserAgent(string $userAgent) : Configuration
Parameters
- $userAgent : string
-
the user agent of the api client
Return values
Configuration —setUsername()
Sets the username for HTTP basic authentication
public
setUsername(string $username) : Configuration
Parameters
- $username : string
-
Username for HTTP basic authentication
Return values
Configuration —toDebugReport()
Gets the essential information for debugging
public
static toDebugReport() : string
Return values
string —The report for debugging