response.md

Response

The response represents the server's HTTP response to the client. There are a couple of different types, listed below, each with an example of how the response from the controller action is built.

• String
• Rendered View
• Themed
• JSON
• Redirect
• Custom response and error pages
• Stream
• Download

String

To return a simple string response, use the response service.

public function indexAction()
{
    return $this['response']->create('My content');
}

Rendered View

Pagekit can render the view and return the response for you. Simply return an array, with a key $view set to an array containing a title and a view name.

All other parameters in the array, will be accessible in the view. Learn more about Views and Templating.

public function indexAction($name = '')
{
    return [
        '$view' => [
            'title' => 'Hello World',
            'name' => 'hello:views/index.php',
        ],
        'name' => $name
    ];
}

If you don't want this to render a themed response as explained below, set 'layout' => false in the $view array.

Themed

A themed response embeds the controller's result within a surrounding layout, usually defined by the theme. Simply return a string from the controller.

public function indexAction()
{
    return 'My content';
}

JSON

There are two ways to return a JSON response from the controller:

If the action either returns an array or an object that implements \JsonSerializable, a JsonResponse will be generated automatically.

public function jsonAction()
{
    return ['error' => true, 'message' => 'There is nothing here. Move along.'];
}

Of course, the response service can be used to achieve the same thing.

public function jsonAction()
{    
    return $this['response']->json(['error' => true, 'message' => 'There is nothing here. Move along.']);
}

Redirect

Use a redirect response to redirect the user.

public function redirectAction()
{
    return $this['response']->redirect('@hello/greet/name', ['name' => 'Someone']);
}

Custom response and error pages

Return any custom HTTP response using create.

public function forbiddenAction()
{
    return $this['response']->create('Permission denied.', 401);
}

Stream

The streamed response allows to stream the content back to the client. It takes a callback function as its first argument. Within that callback, a call to flush will be emitted directly to the client.

public function streamAction()
{
    return $this['response']->stream(function() {
        echo 'Hello World';
        flush();
        echo 'Hello Pagekit';
        flush();
    });
}

Download

The download response lets you send a file to the client. It sets Content-Disposition: attachment to force a Save as dialog in most browsers.

public function downloadAction()
{
    return $this['response']->download('extensions/hello/extension.svg');
}