HumHub Documentation (unofficial)

Request
in package

FinalYes

Representation of an HTTP Request.

Tags
author

Jérémy Derussé jeremy@derusse.com

Table of Contents

Properties

$body  : RequestStream
$endpoint  : string
$headers  : array<string, string>
$hostPrefix  : string
$method  : string
$parsed  : array{scheme: string, host: string, port: int|null}|null
$query  : array<string, string>
$queryString  : string|null
$uri  : string

Methods

__construct()  : mixed
getBody()  : RequestStream
getEndpoint()  : string
getHeader()  : string|null
getHeaders()  : array<string, string>
getHostPrefix()  : string
getMethod()  : string
getQuery()  : array<string, string>
getQueryAttribute()  : string|null
getUri()  : string
hasHeader()  : bool
hasQueryAttribute()  : bool
removeHeader()  : void
removeQueryAttribute()  : void
setBody()  : void
setEndpoint()  : void
setHeader()  : void
setHostPrefix()  : void
setMethod()  : void
setQueryAttribute()  : void
getQueryString()  : string

Properties

$headers

private array<string, string> $headers

$hostPrefix

private string $hostPrefix

$parsed

private array{scheme: string, host: string, port: int|null}|null $parsed

$query

private array<string, string> $query

$queryString

private string|null $queryString

Methods

__construct()

public __construct(string $method, string $uri, array<string, string> $query, array<string, string> $headers, RequestStream $body[, string $hostPrefix = '' ]) : mixed
Parameters
$method : string
$uri : string
$query : array<string, string>
$headers : array<string, string>
$body : RequestStream
$hostPrefix : string = ''

getEndpoint()

public getEndpoint() : string
Return values
string

getHeader()

public getHeader(string $name) : string|null
Parameters
$name : string
Return values
string|null

getHeaders()

public getHeaders() : array<string, string>
Return values
array<string, string>

getHostPrefix()

public getHostPrefix() : string
Return values
string

getMethod()

public getMethod() : string
Return values
string

getQuery()

public getQuery() : array<string, string>
Return values
array<string, string>

getQueryAttribute()

public getQueryAttribute(string $name) : string|null
Parameters
$name : string
Return values
string|null

getUri()

public getUri() : string
Return values
string

hasHeader()

public hasHeader(string $name) : bool
Parameters
$name : string
Return values
bool

hasQueryAttribute()

public hasQueryAttribute(string $name) : bool
Parameters
$name : string
Return values
bool

removeHeader()

public removeHeader(string $name) : void
Parameters
$name : string

removeQueryAttribute()

public removeQueryAttribute(string $name) : void
Parameters
$name : string

setEndpoint()

public setEndpoint(string $endpoint) : void
Parameters
$endpoint : string

setHeader()

public setHeader(string $name, string $value) : void
Parameters
$name : string
$value : string

setHostPrefix()

public setHostPrefix(string $hostPrefix) : void
Parameters
$hostPrefix : string

setMethod()

public setMethod(string $method) : void
Parameters
$method : string

setQueryAttribute()

public setQueryAttribute(string $name, string $value) : void
Parameters
$name : string
$value : string

getQueryString()

private getQueryString() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results