Views

---

1Presentation

The view is the software layer that takes care of formatting the data that is returned by the server after processing.

By default, Temma uses the Smarty template engine, which makes it very easy to generate HTML pages from the data exported by the controllers.

Temma also natively provides a view used to generate JSON feeds, which can be very practical in the context of AJAX communications, as well as views offering CSV, RSS, INI and iCal exports.

---

2Using a templated view

Some views use templates to process data and generate outgoing flows. As seen in the introduction, Temma will look for a file whose name corresponds to that of the requested action (with the ".tpl" extension), placed in a directory whose name is that of the controller being executed; all placed in the templates/ directory of the project.

To work around this automatic behavior, an action can specify the template to use:

class User extends \Temma\Web\Controller {
    public function list($type=null) {
        // processings...

        // redefining the template in a particular case
        if ($type == 'all')
            $this->_template('user/listAll.tpl');
        // in the other cases, the template will be "user/list.tpl"
    }
}

---

3View definition

It is possible to specify the view to use, individually for each action.

Here is an example of an action whose data is exported in JSON format:

class User extends \Temma\Web\Controller {
    public function get($id) {
        // processings...

        // set the data that will be sent
        // in the JSON stream
        $this['json'] = $data;

        // definition of the used view
        $this->_view('\Temma\Views\Json');
    }
}

When the view used is a standard view (supplied by Temma), it is possible to shorten its writing by using the tilde character (~) to replace the \Temma\Views\ prefix:

class User extends \Temma\Web\Controller {
    public function get($id) {
        // processings...
        $this->_view('~Json');
    }
}

Temma also offers the \Temma\Attributes\View attribute, which makes it easy to define the view to be used for all controller actions and/or for specific actions:

use \Temma\Attributes\View as TµView;

// controller that uses the JSON view by default
#[TµView('~Json')]
class User extends \Temma\Web\Controller {
    // action that uses the JSON view defined at the controller level
    public function get($id) {
        // processings...
    }

    // action that specifically uses the RSS view
    #[TµView('~Rss')]
    public function stream() {
        // processings...
    }
}

---

4Configuration of the default view

You have the possibility to change the default view, by modifying the etc/temma.php configuration file.

For example, if you create a webservice, you will never send HTML, but always JSON. You will then want to use the \Temma\Views\Json view instead of the usual Smarty view, you have to add the defaultView directive in the etc/temma.php file:

<?php

return [
    'application' => [
        // usual configuration (dsn, defaultController, ...)

        // configuration of the default view
        'defaultView' => '\Temma\Views\Json'
    ]
];

As seen above, it is possible to replace the \Temma\Views\ prefix with the tilde character (~):

<?php

return [
    'application' => [
        // configuration of the default view
        'defaultView' => '~Json'
    ]
];

---

5Setting default HTTP headers

In the etc/temma.php configuration file, you can specify the HTTP headers to be sent with each response, by listing them with the default key in the x-headers extended configuration. They can be written as key-value pairs or as strings containing the header name and its value:

<?php

return [
    'x-headers' => [
        // default HTTP headers
        'default' => [
            'Cache-Control' => 'no-cache',
            'Sec-Purpose: prefetch',
        ]
    ]
];