Response

class AeonDigital\Http\Message\Response

Representa uma resposta Http à uma requisição feita por um UA.

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\ResponseInterface.

Parent:AeonDigital\Http\Message\Abstracts\aMessage Implements:AeonDigital\Interfaces\Http\Message\iResponse Used traits:AeonDigitalHttpTraitsHttpRawStatusCode

Properties

Methods

public AeonDigital\Http\Message\Response::getStatusCode()

Retorna o código do status Http que está definido para esta resposta.

Returns:‹ int ›

public AeonDigital\Http\Message\Response::withStatus($code, $reasonPhrase="")

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

contendo o method especificado.

Parameters:

• ‹ int › $code
  Código do status Http a ser definido para a instância.
• ‹ string › $reasonPhrase
  Frase razão do status a ser enviada em conjunto na resposta. Se não for definida e o código informado for um código padrão, usará a frase razão correspondente.

Returns:

‹ static ›

Throws:

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

public AeonDigital\Http\Message\Response::getReasonPhrase()

Retorna a frase razão para o código de status definido nesta instância.

Returns:‹ string ›

public AeonDigital\Http\Message\Response::getViewData()

Retorna o objeto viewData contendo as informações obtidas durante o processamento da

rota alvo.

Este objeto traz dados a serem usados no corpo da view.

Returns:‹ ?\StdClass ›

public AeonDigital\Http\Message\Response::withViewData($viewData)

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

contendo o viewData especificado.

Parameters:

• ‹ ?\StdClass › $viewData
  Objeto viewData.

Returns:

‹ \AeonDigital\Interfaces\Http\Message\iResponse ›

public AeonDigital\Http\Message\Response::getViewConfig()

Retorna o objeto viewConfig contendo as informações obtidas durante o processamento da

rota alvo.

Este objeto traz dados que orientam a criação da view.

Returns:‹ ?\StdClass ›

public AeonDigital\Http\Message\Response::withViewConfig($viewConfig)

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

contendo o viewConfig especificado.

Parameters:

• ‹ ?\StdClass › $viewConfig
  Objeto viewConfig.

Returns:

‹ \AeonDigital\Interfaces\Http\Message\iResponse ›

public AeonDigital\Http\Message\Response::withHeaders($headers, $merge=false)

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

contendo os headers especificados.

Parameters:

• ‹ array › $headers
  Coleção de headers.
• ‹ bool › $merge
  Quando true irá manter os headers já definidos e apenas adicionar ou sobrescrever os definidos em $headers.

Returns:

‹ \AeonDigital\Interfaces\Http\Message\iResponse ›

public AeonDigital\Http\Message\Response::withActionProperties($viewData, $viewConfig, $headers)

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

contendo o viewData e o viewConfig especificados.

Parameters:

• ‹ ?\StdClass › $viewData
  Objeto viewData.
• ‹ ?\StdClass › $viewConfig
  Objeto viewConfig.
• ‹ ?array › $headers
  Coleção de headers. Irá executar um Merge com os headers existentes.

Returns:

‹ \AeonDigital\Interfaces\Http\Message\iResponse ›

public AeonDigital\Http\Message\Response::__construct($statusCode, $reasonPhrase, $httpVersion, $headers, $body, $viewData=null, $viewConfig=null)

Inicia um novo objeto Response.

Parameters:

• ‹ int › $statusCode
  Código do status Http.
• ‹ string › $reasonPhrase
  Frase razão do status Http. Se não for definida e o código informado for um código padrão, usará a frase razão correspondente.
• ‹ 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.
• ‹ ?\StdClass › $viewData
  Objeto viewData.
• ‹ ?\StdClass › $viewConfig
  Objeto viewConfig.

Throws:

‹ InvalidArgumentException ›