Documentation

Message
in package
implements MessageInterface

Implements a HTTP message

Tags
see
https://datatracker.ietf.org/doc/html/rfc7230
see
https://datatracker.ietf.org/doc/html/rfc7231
see
https://datatracker.ietf.org/doc/html/rfc9110
see
https://datatracker.ietf.org/doc/html/rfc9112

Table of Contents

Interfaces

MessageInterface

Properties

$body  : StreamInterface
$headers  : array<string, array{name: string, value: string[]}>
$version  : string

Methods

__construct()  : mixed
Message constructor.
getBody()  : StreamInterface
getHeader()  : array<string|int, mixed>
getHeaderLine()  : string
getHeaders()  : array<string|int, mixed>
getProtocolVersion()  : string
hasHeader()  : bool
withAddedHeader()  : static
withBody()  : static
withHeader()  : static
withoutHeader()  : static
withProtocolVersion()  : static
checkName()  : string
checks/cleans a header name
checkValue()  : array<string|int, string>

Properties

$body

protected StreamInterface $body

$headers

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

$version

protected string $version = '1.1'

Methods

__construct()

Message constructor.

public __construct([StreamInterface|string|null $body = null ]) : mixed
Parameters
$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>

getProtocolVersion()

public getProtocolVersion() : string
Return values
string

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

withoutHeader()

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

withProtocolVersion()

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

        
On this page

Search results