Documentation

ServerRequestDecoratorTrait uses trait:short

Trait ServerRequestDecoratorTrait

Table of Contents

Methods

getAttribute()  : mixed
getAttributes()  : mixed
getCookieParams()  : mixed
getMethod()  : string
{@inheritdoc}
getParsedBody()  : mixed
getQueryParams()  : mixed
getRequest()  : ServerRequestInterface
Returns the decorated request.
getRequestTarget()  : string
{@inheritdoc}
getServerParams()  : mixed
getUploadedFiles()  : mixed
getUri()  : UriInterface
{@inheritdoc}
withAttribute()  : mixed
withAttributes()  : ServerRequestInterface
withCookieParams()  : mixed
withMethod()  : self
{@inheritdoc}
withoutAttribute()  : mixed
withParsedBody()  : mixed
withQueryParams()  : mixed
withRequest()  : self
Exchanges the underlying request with another.
withRequestTarget()  : self
{@inheritdoc}
withUploadedFiles()  : mixed
withUri()  : self
{@inheritdoc}

Methods

getAttribute()

public getAttribute(mixed $name[, mixed $default = null ]) : mixed
Parameters
$name : mixed
$default : mixed = null
Tags
inheritdoc

getRequest()

Returns the decorated request.

public getRequest() : ServerRequestInterface

Since the underlying Request is immutable as well exposing it is not an issue, because it's state cannot be altered

Return values
ServerRequestInterface

withAttribute()

public withAttribute(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Tags
inheritdoc

withAttributes()

public withAttributes(array<string|int, mixed> $attributes) : ServerRequestInterface
Parameters
$attributes : array<string|int, mixed>
Return values
ServerRequestInterface

withCookieParams()

public withCookieParams(array<string|int, mixed> $cookies) : mixed
Parameters
$cookies : array<string|int, mixed>
Tags
inheritdoc

withMethod()

{@inheritdoc}

public withMethod(mixed $method) : self
Parameters
$method : mixed
Return values
self

withQueryParams()

public withQueryParams(array<string|int, mixed> $query) : mixed
Parameters
$query : array<string|int, mixed>
Tags
inheritdoc

withRequest()

Exchanges the underlying request with another.

public withRequest(RequestInterface $request) : self
Parameters
$request : RequestInterface
Return values
self

withRequestTarget()

{@inheritdoc}

public withRequestTarget(mixed $requestTarget) : self
Parameters
$requestTarget : mixed
Return values
self

withUploadedFiles()

public withUploadedFiles(array<string|int, mixed> $uploadedFiles) : mixed
Parameters
$uploadedFiles : array<string|int, mixed>
Tags
inheritdoc

withUri()

{@inheritdoc}

public withUri(UriInterface $uri[, mixed $preserveHost = false ]) : self
Parameters
$uri : UriInterface
$preserveHost : mixed = false
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results