DefaultOptionsConfig
in package
This class is automatically generated to help in creating a config.
Table of Contents
Properties
- $_usedProperties : mixed
- $bindto : mixed
- $cafile : mixed
- $capath : mixed
- $ciphers : mixed
- $headers : mixed
- $httpVersion : mixed
- $localCert : mixed
- $localPk : mixed
- $maxDuration : mixed
- $maxRedirects : mixed
- $noProxy : mixed
- $passphrase : mixed
- $peerFingerprint : mixed
- $proxy : mixed
- $resolve : mixed
- $retryFailed : mixed
- $timeout : mixed
- $verifyHost : mixed
- $verifyPeer : mixed
Methods
- __construct() : mixed
- bindto() : $this
- A network interface name, IP address, a host name or a UNIX socket to bind to.
- cafile() : $this
- A certificate authority file.
- capath() : $this
- A directory that contains multiple certificate authority files.
- ciphers() : $this
- A list of SSL/TLS ciphers separated by colons, commas or spaces (e.g. "RC3-SHA:TLS13-AES-128-GCM-SHA256"...)
- header() : $this
- httpVersion() : $this
- The default HTTP version, typically 1.1 or 2.0, leave to null for the best version.
- localCert() : $this
- A PEM formatted certificate file.
- localPk() : $this
- A private key file.
- maxDuration() : $this
- The maximum execution time for the request+response as a whole.
- maxRedirects() : $this
- The maximum number of redirects to follow.
- noProxy() : $this
- A comma separated list of hosts that do not require a proxy to be reached.
- passphrase() : $this
- The passphrase used to encrypt the "local_pk" file.
- peerFingerprint() : PeerFingerprintConfig
- proxy() : $this
- The URL of the proxy to pass requests through or null for automatic detection.
- resolve() : $this
- retryFailed() : RetryFailedConfig|$this
- timeout() : $this
- The idle timeout, defaults to the "default_socket_timeout" ini parameter.
- toArray() : array<string|int, mixed>
- verifyHost() : $this
- Indicates if the host should exist as a certificate common name.
- verifyPeer() : $this
- Indicates if the peer should be verified in an SSL/TLS context.
Properties
$_usedProperties
private
mixed
$_usedProperties
= []
$bindto
private
mixed
$bindto
$cafile
private
mixed
$cafile
$capath
private
mixed
$capath
$ciphers
private
mixed
$ciphers
$headers
private
mixed
$headers
$httpVersion
private
mixed
$httpVersion
$localCert
private
mixed
$localCert
$localPk
private
mixed
$localPk
$maxDuration
private
mixed
$maxDuration
$maxRedirects
private
mixed
$maxRedirects
$noProxy
private
mixed
$noProxy
$passphrase
private
mixed
$passphrase
$peerFingerprint
private
mixed
$peerFingerprint
$proxy
private
mixed
$proxy
$resolve
private
mixed
$resolve
$retryFailed
private
mixed
$retryFailed
$timeout
private
mixed
$timeout
$verifyHost
private
mixed
$verifyHost
$verifyPeer
private
mixed
$verifyPeer
Methods
__construct()
public
__construct([array<string|int, mixed> $value = [] ]) : mixed
Parameters
- $value : array<string|int, mixed> = []
bindto()
A network interface name, IP address, a host name or a UNIX socket to bind to.
public
bindto(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thiscafile()
A certificate authority file.
public
cafile(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thiscapath()
A directory that contains multiple certificate authority files.
public
capath(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisciphers()
A list of SSL/TLS ciphers separated by colons, commas or spaces (e.g. "RC3-SHA:TLS13-AES-128-GCM-SHA256"...)
public
ciphers(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisheader()
public
header(string $name, mixed $value) : $this
Parameters
- $name : string
- $value : mixed
Return values
$thishttpVersion()
The default HTTP version, typically 1.1 or 2.0, leave to null for the best version.
public
httpVersion(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thislocalCert()
A PEM formatted certificate file.
public
localCert(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thislocalPk()
A private key file.
public
localPk(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thismaxDuration()
The maximum execution time for the request+response as a whole.
public
maxDuration(ParamConfigurator|float $value) : $this
Parameters
- $value : ParamConfigurator|float
Tags
Return values
$thismaxRedirects()
The maximum number of redirects to follow.
public
maxRedirects(ParamConfigurator|int $value) : $this
Parameters
- $value : ParamConfigurator|int
Tags
Return values
$thisnoProxy()
A comma separated list of hosts that do not require a proxy to be reached.
public
noProxy(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thispassphrase()
The passphrase used to encrypt the "local_pk" file.
public
passphrase(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thispeerFingerprint()
public
peerFingerprint([array<string|int, mixed> $value = [] ]) : PeerFingerprintConfig
Parameters
- $value : array<string|int, mixed> = []
Return values
PeerFingerprintConfigproxy()
The URL of the proxy to pass requests through or null for automatic detection.
public
proxy(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisresolve()
public
resolve(string $host, mixed $value) : $this
Parameters
- $host : string
- $value : mixed
Return values
$thisretryFailed()
public
retryFailed([mixed $value = [] ]) : RetryFailedConfig|$this
Parameters
- $value : mixed = []
Return values
RetryFailedConfig|$thistimeout()
The idle timeout, defaults to the "default_socket_timeout" ini parameter.
public
timeout(ParamConfigurator|float $value) : $this
Parameters
- $value : ParamConfigurator|float
Tags
Return values
$thistoArray()
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>verifyHost()
Indicates if the host should exist as a certificate common name.
public
verifyHost(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thisverifyPeer()
Indicates if the peer should be verified in an SSL/TLS context.
public
verifyPeer(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool