HumHub Documentation (unofficial)

HttpOptions
in package

A helper providing autocompletion for available options.

Tags
see
HttpClientInterface

for a description of each options.

author

Nicolas Grekas p@tchwork.com

Table of Contents

Properties

$options  : mixed

Methods

bindTo()  : $this
buffer()  : $this
capturePeerCertChain()  : $this
resolve()  : $this
setAuthBasic()  : $this
setAuthBearer()  : $this
setBaseUri()  : $this
setBody()  : $this
setCaFile()  : $this
setCaPath()  : $this
setCiphers()  : $this
setExtra()  : $this
setHeaders()  : $this
setHttpVersion()  : $this
setJson()  : $this
setLocalCert()  : $this
setLocalPk()  : $this
setMaxDuration()  : $this
setMaxRedirects()  : $this
setNoProxy()  : $this
setOnProgress()  : $this
setPassphrase()  : $this
setPeerFingerprint()  : $this
setProxy()  : $this
setQuery()  : $this
setTimeout()  : $this
setUserData()  : $this
toArray()  : array<string|int, mixed>
verifyHost()  : $this
verifyPeer()  : $this

Properties

Methods

bindTo()

public bindTo(string $bindto) : $this
Parameters
$bindto : string
Return values
$this

buffer()

public buffer(bool $buffer) : $this
Parameters
$buffer : bool
Return values
$this

capturePeerCertChain()

public capturePeerCertChain(bool $capture) : $this
Parameters
$capture : bool
Return values
$this

resolve()

public resolve(array<string|int, mixed> $hostIps) : $this
Parameters
$hostIps : array<string|int, mixed>
Return values
$this

setAuthBasic()

public setAuthBasic(string $user[, string $password = '' ]) : $this
Parameters
$user : string
$password : string = ''
Return values
$this

setAuthBearer()

public setAuthBearer(string $token) : $this
Parameters
$token : string
Return values
$this

setBaseUri()

public setBaseUri(string $uri) : $this
Parameters
$uri : string
Return values
$this

setBody()

public setBody(array<string|int, mixed>|string|resource|Traversable|Closure $body) : $this
Parameters
$body : array<string|int, mixed>|string|resource|Traversable|Closure
Return values
$this

setCaFile()

public setCaFile(string $cafile) : $this
Parameters
$cafile : string
Return values
$this

setCaPath()

public setCaPath(string $capath) : $this
Parameters
$capath : string
Return values
$this

setCiphers()

public setCiphers(string $ciphers) : $this
Parameters
$ciphers : string
Return values
$this

setExtra()

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

setHeaders()

public setHeaders(iterable<string|int, mixed> $headers) : $this
Parameters
$headers : iterable<string|int, mixed>
Return values
$this

setHttpVersion()

public setHttpVersion(string $version) : $this
Parameters
$version : string
Return values
$this

setJson()

public setJson(mixed $json) : $this
Parameters
$json : mixed
Return values
$this

setLocalCert()

public setLocalCert(string $cert) : $this
Parameters
$cert : string
Return values
$this

setLocalPk()

public setLocalPk(string $pk) : $this
Parameters
$pk : string
Return values
$this

setMaxDuration()

public setMaxDuration(float $maxDuration) : $this
Parameters
$maxDuration : float
Return values
$this

setMaxRedirects()

public setMaxRedirects(int $max) : $this
Parameters
$max : int
Return values
$this

setNoProxy()

public setNoProxy(string $noProxy) : $this
Parameters
$noProxy : string
Return values
$this

setOnProgress()

public setOnProgress(callable $callback) : $this
Parameters
$callback : callable
Return values
$this

setPassphrase()

public setPassphrase(string $passphrase) : $this
Parameters
$passphrase : string
Return values
$this

setPeerFingerprint()

public setPeerFingerprint(string|array<string|int, mixed> $fingerprint) : $this
Parameters
$fingerprint : string|array<string|int, mixed>
Return values
$this

setProxy()

public setProxy(string $proxy) : $this
Parameters
$proxy : string
Return values
$this

setQuery()

public setQuery(array<string|int, mixed> $query) : $this
Parameters
$query : array<string|int, mixed>
Return values
$this

setTimeout()

public setTimeout(float $timeout) : $this
Parameters
$timeout : float
Return values
$this

setUserData()

public setUserData(mixed $data) : $this
Parameters
$data : mixed
Return values
$this

toArray()

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

verifyHost()

public verifyHost(bool $verify) : $this
Parameters
$verify : bool
Return values
$this

verifyPeer()

public verifyPeer(bool $verify) : $this
Parameters
$verify : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results