Response

HTTP response has status code and message, a set of headers and a body:

HTTP/1.1 200 OK
Date: Mon, 27 Jul 2009 12:28:53 GMT
Server: Apache/2.2.14 (Win32)
Last-Modified: Wed, 22 Jul 2009 19:15:56 GMT
Content-Length: 6 
Content-Type: text/html
Connection: Closed

Hello!

Yii uses PSR-7 Response in the web application to represent response.

The object should be constructed and returned as a result of execution of controller actions or other middleware. Usually, the middleware has a response factory injected into its constructor.

use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

class PostAction
{
    private ResponseFactoryInterface $responseFactory;

    public function __construct(ResponseFactoryInterface $responseFactory)
    {
        $this->responseFactory = $responseFactory;
    }

    public function view(ServerRequestInterface $request): ResponseInterface
    {
        $response = $this->responseFactory->createResponse();
        $response->getBody()->write('Hello!');
        return $response;
    }
}

Status code

You can set status code like the following:

use Yiisoft\Http\Status;

$response = $response->withStatus(Status::NOT_FOUND);

Majority of status codes are available from Status class for convenience and readability.

Headers

You can set headers like this:

$response = $response->withHeader('Content-type', 'application/json');

If there is a need to append a header value to existing header:

$response = $response->withAddedHeader('Set-Cookie', 'qwerty=219ffwef9w0f; Domain=somecompany.co.uk; Path=/; Expires=Wed, 30 Aug 2019 00:00:00 GMT');

And, if needed, headers could be removed:

$response = $response->withoutHeader('Set-Cookie');

Body

Response body is an object implementing Psr\Http\Message\StreamInterface.

You can write to it via the interface itself:

$body = $response->getBody();
$body->write('Hello');

Examples

Redirecting

use Yiisoft\Http\Status;

return $response
  ->withStatus(Status::PERMANENT_REDIRECT)
  ->withHeader('Location', 'https://www.example.com');

Responding with JSON

use Yiisoft\Json\Json;

$data = [
    'account' => 'samdark',
    'value' => 42
];

$response->getBody()->write(Json::encode($data));
return $response
          ->withStatus(200)
          ->withHeader('Content-Type', 'application/json');