RequestDecoratorTrait uses trait:short
Tags
Table of Contents
Properties
- $message : MessageInterface
Methods
- getBody() : StreamInterface
- {@inheritdoc}
- getHeader() : array<string|int, mixed>
- {@inheritdoc}
- getHeaderLine() : string
- {@inheritdoc}
- getHeaders() : array<string|int, mixed>
- {@inheritdoc}
- getMessage() : MessageInterface
- Returns the decorated message.
- getMethod() : string
- {@inheritdoc}
- getProtocolVersion() : string
- {@inheritdoc}
- getRequest() : RequestInterface
- Returns the decorated request.
- getRequestTarget() : string
- {@inheritdoc}
- getUri() : UriInterface
- {@inheritdoc}
- hasHeader() : bool
- {@inheritdoc}
- withAddedHeader() : self
- {@inheritdoc}
- withBody() : self
- {@inheritdoc}
- withHeader() : self
- {@inheritdoc}
- withMethod() : self
- {@inheritdoc}
- withoutHeader() : self
- {@inheritdoc}
- withProtocolVersion() : self
- {@inheritdoc}
- withRequest() : self
- Exchanges the underlying request with another.
- withRequestTarget() : self
- {@inheritdoc}
- withUri() : self
- {@inheritdoc}
Properties
$message
private
MessageInterface
$message
Methods
getBody()
{@inheritdoc}
public
getBody() : StreamInterface
Return values
StreamInterfacegetHeader()
{@inheritdoc}
public
getHeader(mixed $header) : array<string|int, mixed>
Parameters
- $header : mixed
Return values
array<string|int, mixed>getHeaderLine()
{@inheritdoc}
public
getHeaderLine(mixed $header) : string
Parameters
- $header : mixed
Return values
stringgetHeaders()
{@inheritdoc}
public
getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed>getMessage()
Returns the decorated message.
public
getMessage() : MessageInterface
Since the underlying Message is immutable as well exposing it is not an issue, because it's state cannot be altered
Return values
MessageInterfacegetMethod()
{@inheritdoc}
public
getMethod() : string
Return values
stringgetProtocolVersion()
{@inheritdoc}
public
getProtocolVersion() : string
Return values
stringgetRequest()
Returns the decorated request.
public
getRequest() : RequestInterface
Since the underlying Request is immutable as well exposing it is not an issue, because it's state cannot be altered
Return values
RequestInterfacegetRequestTarget()
{@inheritdoc}
public
getRequestTarget() : string
Return values
stringgetUri()
{@inheritdoc}
public
getUri() : UriInterface
Return values
UriInterfacehasHeader()
{@inheritdoc}
public
hasHeader(mixed $header) : bool
Parameters
- $header : mixed
Return values
boolwithAddedHeader()
{@inheritdoc}
public
withAddedHeader(mixed $header, mixed $value) : self
Parameters
- $header : mixed
- $value : mixed
Return values
selfwithBody()
{@inheritdoc}
public
withBody(StreamInterface $body) : self
Parameters
- $body : StreamInterface
Return values
selfwithHeader()
{@inheritdoc}
public
withHeader(mixed $header, mixed $value) : self
Parameters
- $header : mixed
- $value : mixed
Return values
selfwithMethod()
{@inheritdoc}
public
withMethod(mixed $method) : self
Parameters
- $method : mixed
Return values
selfwithoutHeader()
{@inheritdoc}
public
withoutHeader(mixed $header) : self
Parameters
- $header : mixed
Return values
selfwithProtocolVersion()
{@inheritdoc}
public
withProtocolVersion(mixed $version) : self
Parameters
- $version : mixed
Return values
selfwithRequest()
Exchanges the underlying request with another.
public
withRequest(RequestInterface $request) : self
Parameters
- $request : RequestInterface
Return values
selfwithRequestTarget()
{@inheritdoc}
public
withRequestTarget(mixed $requestTarget) : self
Parameters
- $requestTarget : mixed
Return values
selfwithUri()
{@inheritdoc}
public
withUri(UriInterface $uri[, mixed $preserveHost = false ]) : self
Parameters
- $uri : UriInterface
- $preserveHost : mixed = false