ResponseDecoratorTrait 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.
- getProtocolVersion() : string
- {@inheritdoc}
- getReasonPhrase() : string
- {@inheritdoc}
- getResponse() : ResponseInterface
- Returns the decorated response.
- getStatusCode() : int
- {@inheritdoc}
- hasHeader() : bool
- {@inheritdoc}
- withAddedHeader() : self
- {@inheritdoc}
- withBody() : self
- {@inheritdoc}
- withHeader() : self
- {@inheritdoc}
- withoutHeader() : self
- {@inheritdoc}
- withProtocolVersion() : self
- {@inheritdoc}
- withResponse() : self
- Exchanges the underlying response with another.
- withStatus() : 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
MessageInterfacegetProtocolVersion()
{@inheritdoc}
public
getProtocolVersion() : string
Return values
stringgetReasonPhrase()
{@inheritdoc}
public
getReasonPhrase() : string
Return values
stringgetResponse()
Returns the decorated response.
public
getResponse() : ResponseInterface
Since the underlying Response is immutable as well exposing it is not an issue, because it's state cannot be altered
Return values
ResponseInterfacegetStatusCode()
{@inheritdoc}
public
getStatusCode() : int
Return values
inthasHeader()
{@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
selfwithoutHeader()
{@inheritdoc}
public
withoutHeader(mixed $header) : self
Parameters
- $header : mixed
Return values
selfwithProtocolVersion()
{@inheritdoc}
public
withProtocolVersion(mixed $version) : self
Parameters
- $version : mixed
Return values
selfwithResponse()
Exchanges the underlying response with another.
public
withResponse(ResponseInterface $response) : self
Parameters
- $response : ResponseInterface
Return values
selfwithStatus()
{@inheritdoc}
public
withStatus(mixed $code[, mixed $reasonPhrase = '' ]) : self
Parameters
- $code : mixed
- $reasonPhrase : mixed = ''