v3.0
3.8 3.7 3.6 3.5 3.4 3.3 3.2 3.1 3.0 2.14 2.13 2.12 2.11 2.10 2.9 2.8 1.0
Version: 3.0
3.8 3.7 3.6 3.5 3.4 3.3 3.2 3.1 3.0 2.14 2.13 2.12 2.11 2.10 2.9 2.8 1.0
Revision: Mon, 25 Sep 2023 09:33:18 GMT
v3.0 – outdated
This version of the documentation is outdated. Consider upgrading your project to Spiral Framework 3.8
Edit this page

Views - Rendering Views

To render a view, you must obtain an instance of Spiral\Views\ViewsInterface.

Note
The component is available via the prototyped property views.

Rendering

To render a view in the controller or other service, simply invoke the render method of ViewsInterface. The view name does not need to include an extension or namespace (default to be used).

php
use Spiral\Views\ViewsInterface;

// ...

public function index(ViewsInterface $views): string
{
    return $views->render('home');
}

To render the view with the passed data, use the second array argument:

php
use Spiral\Views\ViewsInterface;

// ...

public function index(ViewsInterface $views): string
{
    return $views->render('home', [
        'key' => 'value'
    ]);
}

Namespaces

To render a view from a specific namespace, prepend it to the view name using : separator:

php
return $views->render('namespace:home', [
    'key' => 'value'
]);

View Object

In some cases it might be more performant to cache the view in a stateless component, obtain the view object (Spiral\Views\ViewInterface) using the method get of ViewsInterface:

php
$view = $views->get('home');

To render obtained view call render method:

php
return $view->render([
    'key' => 'value'
]);

Global variables

You can add global variables that will be available in all views. There are several ways to add a global variable. You can use the configuration file app/config/views.php.

php
return [
    'globalVariables' => [
        'some_var' => env('SOME_VALUE'),
        'other_var' => 'other_value'
    ]
];

Or you can use Spiral\Views\GlobalVariablesInterface.

php
namespace App\Bootloader;

use Spiral\Boot\Bootloader\Bootloader;
use Spiral\Views\GlobalVariablesInterface ;
use Spiral\Boot\EnvironmentInterface;

class AppBootloader extends Bootloader 
{
    public function boot(GlobalVariablesInterface $vars, EnvironmentInterface $env): void
    {
         $vars->set('some_var', $env->get('SOME_VALUE'));
         $vars->set('other_var', 'other_value');
    }
}

After that, you can use the variable in the view.

php
<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>
    <?=$some_var?>

    <?=$other_var?>
</body>
</html>

Events

Event Description
Spiral\Views\Event\ViewNotFound The Event will be fired when the view is not found.