ServerRequest

class AeonDigital\Http\Message\ServerRequest

Encapsula todos os objetos que representam na totalidade uma requisição recebida pelo servidor.

Instâncias desta classe são consideradas imutáveis; todos os métodos que podem vir a alterar

seu estado DEVEM ser implementados de forma a manter seu estado e retornar uma nova

instância com a alteração necessária para o novo estado.

Implementação AeonDigital da interface Psr\Http\Message\ServerRequestInterface.

Parent:AeonDigital\Http\Message\Request Implements:AeonDigital\Interfaces\Http\Message\iServerRequest Used traits:AeonDigitalHttpTraitsParseQualityHeaders AeonDigitalHttpTraitsMimeTypeData

Properties

Methods

public AeonDigital\Http\Message\ServerRequest::getNow()

Retorna a data e hora do instante em que a instância foi criada.

Returns:‹ \DateTime ›

public AeonDigital\Http\Message\ServerRequest::getServerParams()

Retorna os parametros de configuração do servidor para a requisição atual.

Returns:‹ array ›

public AeonDigital\Http\Message\ServerRequest::getCookieParams()

Retorna os cookies enviados pelo UA.

Será retornado um array associativo contendo chave/valor de cada cookie recebido.

Returns:‹ array ›

public AeonDigital\Http\Message\ServerRequest::withCookieParams($cookies)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo os objetos cookies especificado.

Parameters:

• ‹ array › $cookies
  Array associativo de cookies para serem usados pela nova instância.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para cookies.

public AeonDigital\Http\Message\ServerRequest::getQueryParams()

Retorna os querystrings enviados pelo UA.

Será retornado um array associativo contendo chave/valor de cada querystring recebido.

Returns:‹ array ›

public AeonDigital\Http\Message\ServerRequest::getQueryString($name)

Retorna o valor da querystring de nome indicado.

Retornará null caso ela não exista.

Parameters:

• ‹ string › $name
  Nome da querystring alvo.

Returns:

‹ ?string ›

public AeonDigital\Http\Message\ServerRequest::withQueryParams($query)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo os objetos querystrings especificado.

Parameters:

• ‹ array › $query
  Array associativo de querystrings para serem usados pela nova instância.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para query.

public AeonDigital\Http\Message\ServerRequest::getUploadedFiles()

Retorna os arquivos enviados pelo UA.

Returns:‹ array ›

public AeonDigital\Http\Message\ServerRequest::withUploadedFiles($uploadedFiles)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo os arquivos especificado.

Parameters:

• ‹ array › $uploadedFiles
  Array associativo de arquivos para serem usados pela nova instância.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para uploadedFiles.

public AeonDigital\Http\Message\ServerRequest::getPostedFields()

Retorna um array contendo todos os campos recebidos no corpo da requisição.

Trata-se de um alias para o método getParsedBody.

Returns:‹ ?array ›

public AeonDigital\Http\Message\ServerRequest::getPost($name)

Retorna o valor do campo de nome indicado.

Retornará null caso ele não exista.

Parameters:

• ‹ string › $name
  Nome do campo alvo.

Returns:

‹ ?string ›

public AeonDigital\Http\Message\ServerRequest::getCookie($name)

Retorna o objeto iCookie correspondente ao cookie de nome indicado.

Retornará null caso ele não exista.

Parameters:

• ‹ string › $name
  Nome do cookie alvo.

Returns:

‹ ?\AeonDigital\Interfaces\Http\Data\iCookie ›

public AeonDigital\Http\Message\ServerRequest::getCookieValue($name)

Retorna o valor do cookie de nome indicado.

Retornará null caso ele não exista.

Parameters:

• ‹ string › $name
  Nome do cookie alvo.

Returns:

‹ ?string ›

public AeonDigital\Http\Message\ServerRequest::getParam($name)

Retorna o valor do parametro da requisição de nome indicado.

A chave é procurada entre Cookies, Attributes, QueryStrings e Post Data respectivamente e

será retornada a primeira entre as coleções avaliadas.

Retornará null caso o nome da chave não seja encontrado.

Parameters:

• ‹ string › $name
  Nome do campo que está sendo requerido.

Returns:

‹ ?string ›

public AeonDigital\Http\Message\ServerRequest::__construct($httpMethod, $uri, $httpVersion, $headers, $body, $cookies, $queryStrings, $files, $serverParans, $attributes, $bodyParsers=null)

Inicia um novo objeto ServerRequest.

Parameters:

• ‹ string › $httpMethod
  Método Http que está sendo usado para a requisição. Este valor será substituido caso um parametro _method seja enviado em algum parametro da requisição (seja via GET, POST ou outra forma).
• ‹ AeonDigital\Interfaces\Http\Uri\iUrl › $uri
  Objeto que implementa a interface iUrl configurado com a URI que está sendo requisitada pelo UA.
• ‹ string › $httpVersion
  Versão do protocolo Http.
• ‹ AeonDigital\Interfaces\Http\Data\iHeaderCollection › $headers
  Objeto que implementa iHeaderCollection cotendo os cabeçalhos da requisição.
• ‹ AeonDigital\Interfaces\Stream\iStream › $body
  Objeto stream que faz parte do corpo da mensagem.
• ‹ AeonDigital\Interfaces\Http\Data\iCookieCollection › $cookies
  Objeto que implementa iCookieCollection cotendo os cookies da requisição.
• ‹ AeonDigital\Interfaces\Http\Data\iQueryStringCollection › $queryStrings
  Objeto que implementa iQueryStringCollection cotendo os queryStrings.
• ‹ AeonDigital\Interfaces\Http\Data\iFileCollection › $files
  Objeto que implementa iFileCollection cotendo os arquivos enviados nesta requisição.
• ‹ array › $serverParans
  Coleção de parametros definidos pelo servidor sobre o ambiente e requisição atual.
• ‹ AeonDigital\Interfaces\Collection\iCollection › $attributes
  Objeto que implementa iCollection contendo atributos personalizados para esta requisição.
• ‹ ?\AeonDigital\Interfaces\Collection\iCollection › $bodyParsers
  Objeto que implementa iCollection cotendo os closures que podem efetuar o processamento do body da requisição.

Throws:

‹ InvalidArgumentException ›

Throws:

‹ RuntimeException ›

Throws:

‹ InvalidArgumentException ›

Throws:

‹ RuntimeException ›

public AeonDigital\Http\Message\ServerRequest::getParsedBody()

Retorna qualquer parametro enviado no body da requisição atual

em um formato adequado para ser consumido.

Retornará null caso nenhum valor tenha sido submetido.

Returns:‹ null | array | object ›

public AeonDigital\Http\Message\ServerRequest::withParsedBody($data)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo os arquivos especificado.

Parameters:

• ‹ array › $data
  Array associativo de arquivos para serem usados pela nova instância.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido para uploadedFiles.

public AeonDigital\Http\Message\ServerRequest::getResponseMimes()

Retorna uma coleção de mimetypes que o UA definiu como opções válidas para responder

a esta requisição.

Este valor é definido a partir da avaliação qualitativa do Header accept.

Será retornado null caso não seja possível (por qualquer motivo) definir a coleção de

valores válidos.

Os valores retornados estarão na ordem de qualificação dos itens encontrados no Header

accept.

Returns:

‹ ?array ›
``` php

$arr = [

["mime" => "html", "mimetype" => "text/html"]

];

```

public AeonDigital\Http\Message\ServerRequest::getResponseLocales()

Retorna uma coleção de locales que o UA definiu como opções válidas para responder

a esta requisição.

Este valor é definido a partir da avaliação qualitativa do Header accept-language.

Será retornado null caso não seja possível (por qualquer motivo) definir a coleção

de valores válidos.

Os valores retornados estarão na ordem de qualificação dos itens encontrados no Header

accept-language.

Returns:‹ ?array ›

public AeonDigital\Http\Message\ServerRequest::getResponseLanguages()

Retorna uma coleção de languages que o UA definiu como opções válidos para responder

a esta requisição.

Este valor é definido a partir da avaliação qualitativa do Header accept-language.

Será retornado null caso não seja possível (por qualquer motivo) definir a coleção de

valores válidos.

Os valores retornados estarão na ordem de qualificação dos itens encontrados no Header

accept-language.

Returns:‹ ?array ›

public AeonDigital\Http\Message\ServerRequest::setInitialAttributes($attributes)

Define uma coleção de atributos iniciais para a requisição atual.

Este método só pode ser utilizado 1 vez.

Estes devem ser SEMPRE os primeiros atributos a serem definidos para a coleção.

Parameters:

• ‹ array › $attributes
  Array associativo contendo a coleção de atributos que serão definidos.

Returns:

‹ void ›

public AeonDigital\Http\Message\ServerRequest::getAttributes()

Coleção de atributos da requisição.

Os atributos de uma requisição podem ser valores variados como o resultado de uma

operação com o caminho requisitado, a decriptação de um cookie, o resultado da

desserialização de mensagens recebidas no body, etc.

Diferente das demais propriedades deste tipo de classe, neste caso atributos SÃO Mutáveis!

Returns:‹ array ›

public AeonDigital\Http\Message\ServerRequest::getAttribute($name, $default=null)

Retorna o valor de um determinado atributo da requisição a partir de seu nome.

Caso aquele atributo não seja encontrado será retornado o valor definido em default.

Parameters:

• ‹ string › $name
  O nome do atributo a ser retornado.
• ‹ mixed › $default
  Valor padrão para o atributo, caso não exista.

Returns:

‹ mixed ›

public AeonDigital\Http\Message\ServerRequest::withAttribute($name, $value)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

contendo os attributes especificados.

Parameters:

• ‹ string › $name
  Nome do atributo que será definido.
• ‹ mixed › $value
  Valor do atributo.

Returns:

‹ static ›

Throws:

‹ InvalidArgumentException ›
Caso seja definido um valor inválido.

public AeonDigital\Http\Message\ServerRequest::withoutAttribute($name)

Este método DEVE manter o estado da instância atual e retornar uma nova instância

sem o attribute especificado.

Parameters:

• ‹ string › $name
  Nome do atributo que será removido.

Returns:

‹ static ›