RequestDecorator 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.
- getMethod() : string
- getProtocolVersion() : string
- getRequestTarget() : string
- getUri() : UriInterface
- hasHeader() : bool
- withAddedHeader() : MessageInterface
- withBody() : MessageInterface
- withHeader() : MessageInterface
- withMethod() : RequestInterface
- withoutHeader() : MessageInterface
- withProtocolVersion() : MessageInterface
- withRequest() : RequestInterface
- Exchanges the underlying request with another.
- withRequestTarget() : RequestInterface
- withUri() : RequestInterface
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
MessageInterfacegetMethod()
public
getMethod() : string
Return values
stringgetProtocolVersion()
public
getProtocolVersion() : string
Return values
stringgetRequestTarget()
public
getRequestTarget() : string
Return values
stringgetUri()
public
getUri() : UriInterface
Return values
UriInterfacehasHeader()
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
MessageInterfacewithMethod()
public
withMethod(string $method) : RequestInterface
Parameters
- $method : string
Return values
RequestInterfacewithoutHeader()
public
withoutHeader(string $header) : MessageInterface
Parameters
- $header : string
Return values
MessageInterfacewithProtocolVersion()
public
withProtocolVersion(string $version) : MessageInterface
Parameters
- $version : string
Return values
MessageInterfacewithRequest()
Exchanges the underlying request with another.
public
withRequest(RequestInterface $request) : RequestInterface
Parameters
- $request : RequestInterface
Return values
RequestInterfacewithRequestTarget()
public
withRequestTarget(string $requestTarget) : RequestInterface
Parameters
- $requestTarget : string
Return values
RequestInterfacewithUri()
public
withUri(UriInterface $uri[, bool $preserveHost = false ]) : RequestInterface
Parameters
- $uri : UriInterface
- $preserveHost : bool = false