Documentation

ScopedClientConfig
in package

This class is automatically generated to help in creating a config.

Table of Contents

Properties

$_usedProperties  : mixed
$authBasic  : mixed
$authBearer  : mixed
$authNtlm  : mixed
$baseUri  : 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
$query  : mixed
$resolve  : mixed
$retryFailed  : mixed
$scope  : mixed
$timeout  : mixed
$verifyHost  : mixed
$verifyPeer  : mixed

Methods

__construct()  : mixed
authBasic()  : $this
An HTTP Basic authentication "username:password".
authBearer()  : $this
A token enabling HTTP Bearer authorization.
authNtlm()  : $this
A "username:password" pair to use Microsoft NTLM authentication (requires the cURL extension).
baseUri()  : $this
The URI to resolve relative URLs, following rules in RFC 3985, section 2.
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.
query()  : $this
resolve()  : $this
retryFailed()  : RetryFailedConfig|$this
scope()  : $this
The regular expression that the request URL must match before adding the other options. When none is provided, the base URI is used instead.
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

Methods

__construct()

public __construct([array<string|int, mixed> $value = [] ]) : mixed
Parameters
$value : array<string|int, mixed> = []

ciphers()

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
default

null

Return values
$this

header()

public header(string $name, mixed $value) : $this
Parameters
$name : string
$value : mixed
Return values
$this

query()

public query(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this

resolve()

public resolve(string $host, mixed $value) : $this
Parameters
$host : string
$value : mixed
Return values
$this

scope()

The regular expression that the request URL must match before adding the other options. When none is provided, the base URI is used instead.

public scope(ParamConfigurator|mixed $value) : $this
Parameters
$value : ParamConfigurator|mixed
Tags
default

null

Return values
$this

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results