ResponseDecorator uses trait:short
Tags
Table of Contents
Properties
Methods
- getBody() : StreamInterface
- getHeader() : array<string|int, mixed>
- getHeaderLine() : string
- getHeaders() : array<string|int, mixed>
- getMessage() : MessageInterface
- Returns the decorated message.
- getProtocolVersion() : string
- getReasonPhrase() : string
- getStatusCode() : int
- hasHeader() : bool
- withAddedHeader() : MessageInterface
- withBody() : MessageInterface
- withHeader() : MessageInterface
- withoutHeader() : MessageInterface
- withProtocolVersion() : MessageInterface
- withResponse() : ResponseInterface
- Exchanges the underlying response with another.
- withStatus() : ResponseInterface
Properties
$message
private
MessageInterface
$message
Methods
getBody()
public
getBody() : StreamInterface
Return values
StreamInterfacegetHeader()
public
getHeader(string $header) : array<string|int, mixed>
Parameters
- $header : string
Return values
array<string|int, mixed>getHeaderLine()
public
getHeaderLine(string $header) : string
Parameters
- $header : string
Return values
stringgetHeaders()
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()
public
getProtocolVersion() : string
Return values
stringgetReasonPhrase()
public
getReasonPhrase() : string
Return values
stringgetStatusCode()
public
getStatusCode() : int
Return values
inthasHeader()
public
hasHeader(string $header) : bool
Parameters
- $header : string
Return values
boolwithAddedHeader()
public
withAddedHeader(string $header, mixed $value) : MessageInterface
Parameters
- $header : string
- $value : mixed
Return values
MessageInterfacewithBody()
public
withBody(StreamInterface $body) : MessageInterface
Parameters
- $body : StreamInterface
Return values
MessageInterfacewithHeader()
public
withHeader(string $header, mixed $value) : MessageInterface
Parameters
- $header : string
- $value : mixed
Return values
MessageInterfacewithoutHeader()
public
withoutHeader(string $header) : MessageInterface
Parameters
- $header : string
Return values
MessageInterfacewithProtocolVersion()
public
withProtocolVersion(string $version) : MessageInterface
Parameters
- $version : string
Return values
MessageInterfacewithResponse()
Exchanges the underlying response with another.
public
withResponse(ResponseInterface $response) : ResponseInterface
Parameters
- $response : ResponseInterface
Return values
ResponseInterfacewithStatus()
public
withStatus(int $code[, string $reasonPhrase = '' ]) : ResponseInterface
Parameters
- $code : int
- $reasonPhrase : string = ''