AbstractMessage
in package
implements
MessageInterface
Abstract HTTP request/response message
Table of Contents
Interfaces
- MessageInterface
- Request and response message interface
Properties
- $headerFactory : HeaderFactoryInterface
- $headers : array<string|int, mixed>
- $params : Collection
- $protocol : string
- $protocolVersion : string
Methods
- __construct() : mixed
- addCacheControlDirective() : mixed
- addHeader() : self
- Add a header to an existing collection of headers.
- addHeaders() : self
- Add and merge in an array of HTTP headers.
- getCacheControlDirective() : mixed
- getHeader() : Header|null
- Retrieve an HTTP header by name. Performs a case-insensitive search of all headers.
- getHeaderLines() : array<string|int, mixed>
- Get an array of message header lines (e.g. ["Host: example.com", ...])
- getHeaders() : HeaderCollection
- Get all headers as a collection
- getParams() : Collection
- Get application and plugin specific parameters set on the message.
- getTokenizedHeader() : mixed
- hasCacheControlDirective() : mixed
- hasHeader() : bool
- Check if the specified header is present.
- removeCacheControlDirective() : mixed
- removeHeader() : self
- Remove a specific HTTP header.
- setHeader() : self
- Set an HTTP header and overwrite any existing value for the header
- setHeaderFactory() : self
- Set the header factory to use to create headers
- setHeaders() : self
- Overwrite all HTTP headers with the supplied array of headers
- setTokenizedHeader() : mixed
Properties
$headerFactory
protected
HeaderFactoryInterface
$headerFactory
$headers
protected
array<string|int, mixed>
$headers
HTTP header collection
$params
protected
Collection
$params
Custom message parameters that are extendable by plugins
$protocol
protected
string
$protocol
= 'HTTP'
Message protocol
$protocolVersion
protected
string
$protocolVersion
= '1.1'
HTTP protocol version of the message
Methods
__construct()
public
__construct() : mixed
addCacheControlDirective()
public
addCacheControlDirective(mixed $directive[, mixed $value = true ]) : mixed
Parameters
- $directive : mixed
- $value : mixed = true
Tags
addHeader()
Add a header to an existing collection of headers.
public
addHeader(mixed $header, mixed $value) : self
Parameters
- $header : mixed
-
Header name to add
- $value : mixed
-
Value of the header
Return values
selfaddHeaders()
Add and merge in an array of HTTP headers.
public
addHeaders(array<string|int, mixed> $headers) : self
Parameters
- $headers : array<string|int, mixed>
-
Associative array of header data.
Return values
selfgetCacheControlDirective()
public
getCacheControlDirective(mixed $directive) : mixed
Parameters
- $directive : mixed
Tags
getHeader()
Retrieve an HTTP header by name. Performs a case-insensitive search of all headers.
public
getHeader(mixed $header) : Header|null
Parameters
- $header : mixed
-
Header to retrieve.
Return values
Header|nullgetHeaderLines()
Get an array of message header lines (e.g. ["Host: example.com", ...])
public
getHeaderLines() : array<string|int, mixed>
Return values
array<string|int, mixed>getHeaders()
Get all headers as a collection
public
getHeaders() : HeaderCollection
Return values
HeaderCollectiongetParams()
Get application and plugin specific parameters set on the message.
public
getParams() : Collection
Return values
CollectiongetTokenizedHeader()
public
getTokenizedHeader(mixed $header[, mixed $token = ';' ]) : mixed
Use $message->getHeader()->parseParams()
Parameters
- $header : mixed
- $token : mixed = ';'
Tags
hasCacheControlDirective()
public
hasCacheControlDirective(mixed $directive) : mixed
Parameters
- $directive : mixed
Tags
hasHeader()
Check if the specified header is present.
public
hasHeader(mixed $header) : bool
Parameters
- $header : mixed
-
The header to check.
Return values
boolremoveCacheControlDirective()
public
removeCacheControlDirective(mixed $directive) : mixed
Parameters
- $directive : mixed
Tags
removeHeader()
Remove a specific HTTP header.
public
removeHeader(mixed $header) : self
Parameters
- $header : mixed
-
HTTP header to remove.
Return values
selfsetHeader()
Set an HTTP header and overwrite any existing value for the header
public
setHeader(mixed $header, mixed $value) : self
Parameters
- $header : mixed
-
Name of the header to set.
- $value : mixed
-
Value to set.
Return values
selfsetHeaderFactory()
Set the header factory to use to create headers
public
setHeaderFactory(HeaderFactoryInterface $factory) : self
Parameters
- $factory : HeaderFactoryInterface
Return values
selfsetHeaders()
Overwrite all HTTP headers with the supplied array of headers
public
setHeaders(array<string|int, mixed> $headers) : self
Parameters
- $headers : array<string|int, mixed>
-
Associative array of header data.
Return values
selfsetTokenizedHeader()
public
setTokenizedHeader(mixed $header, mixed $data[, mixed $token = ';' ]) : mixed
Parameters
- $header : mixed
- $data : mixed
- $token : mixed = ';'