Documentation

Request extends Message
in package
implements RequestInterface, RequestMethodInterface

Implements a HTTP request message

Table of Contents

Interfaces

RequestInterface
RequestMethodInterface

Properties

$body  : StreamInterface
$headers  : array<string, array{name: string, value: string[]}>
$method  : string
$requestTarget  : string|null
$uri  : UriInterface
$version  : string

Methods

__construct()  : mixed
Request constructor.
getBody()  : StreamInterface
getHeader()  : array<string|int, mixed>
getHeaderLine()  : string
getHeaders()  : array<string|int, mixed>
getMethod()  : string
getProtocolVersion()  : string
getRequestTarget()  : string
getUri()  : UriInterface
hasHeader()  : bool
withAddedHeader()  : static
withBody()  : static
withHeader()  : static
withMethod()  : static
withoutHeader()  : static
withProtocolVersion()  : static
withRequestTarget()  : static
withUri()  : static
checkName()  : string
checks/cleans a header name
checkValue()  : array<string|int, string>
updateHostFromUri()  : void

Properties

$body

protected StreamInterface $body

$headers

protected array<string, array{name: string, value: string[]}> $headers = []

$requestTarget

protected string|null $requestTarget = null

$version

protected string $version = '1.1'

Methods

__construct()

Request constructor.

public __construct(string $method, UriInterface|string $uri[, StreamInterface|string|null $body = null ]) : mixed
Parameters
$method : string
$uri : UriInterface|string
$body : StreamInterface|string|null = null

getBody()

public getBody() : StreamInterface
Return values
StreamInterface

getHeader()

public getHeader(string $name) : array<string|int, mixed>
Parameters
$name : string
Return values
array<string|int, mixed>

getHeaderLine()

public getHeaderLine(string $name) : string
Parameters
$name : string
Return values
string

getHeaders()

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

getMethod()

public getMethod() : string
Return values
string

getProtocolVersion()

public getProtocolVersion() : string
Return values
string

getRequestTarget()

public getRequestTarget() : string
Return values
string

getUri()

public getUri() : UriInterface
Return values
UriInterface

hasHeader()

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

withAddedHeader()

public withAddedHeader(string $name, mixed $value) : static
Parameters
$name : string
$value : mixed
Return values
static

withBody()

public withBody(StreamInterface $body) : static
Parameters
$body : StreamInterface
Return values
static

withHeader()

public withHeader(string $name, mixed $value) : static
Parameters
$name : string
$value : mixed
Return values
static

withMethod()

public withMethod(string $method) : static
Parameters
$method : string
Return values
static

withoutHeader()

public withoutHeader(string $name) : static
Parameters
$name : string
Return values
static

withProtocolVersion()

public withProtocolVersion(string $version) : static
Parameters
$version : string
Return values
static

withRequestTarget()

public withRequestTarget(string $requestTarget) : static
Parameters
$requestTarget : string
Return values
static

withUri()

public withUri(UriInterface $uri[, bool $preserveHost = false ]) : static
Parameters
$uri : UriInterface
$preserveHost : bool = false
Return values
static

updateHostFromUri()

protected updateHostFromUri() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results