yiisoft / yii-view-renderer
PSR-7 compatible view renderer
Fund package maintenance!
Opencollective
yiisoft
Installs: 217
Dependents: 2
Suggesters: 0
Security: 0
Stars: 16
Watchers: 17
Forks: 10
Open Issues: 2
Requires
- php: ^8.0
- psr/container: ^1.0|^2.0
- yiisoft/aliases: ^2.0|^3.0
- yiisoft/csrf: ^1.2|^2.0
- yiisoft/data-response: ^1.0|^2.0
- yiisoft/friendly-exception: ^1.0
- yiisoft/html: ^2.5|^3.0
- yiisoft/strings: ^2.0
- yiisoft/view: ^10.0
Requires (Dev)
- httpsoft/http-message: ^1.0
- maglnet/composer-require-checker: ^4.3
- nyholm/psr7: ^1.5
- phpunit/phpunit: ^9.5
- rector/rector: 1.0.*
- roave/infection-static-analysis-plugin: ^1.25
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.30|^5.25
- yiisoft/di: ^1.2
- yiisoft/psr-dummy-provider: ^1.0
- yiisoft/test-support: ^3.0
- yiisoft/yii-debug: dev-master|dev-php80
README
Yii View Renderer
The package is an extension of the Yii View rendering library. It adds WEB-specific functionality and compatibility with PSR-7 interfaces.
Requirements
- PHP 8.0 or higher.
Installation
The package could be installed with Composer:
composer require yiisoft/yii-view-renderer
General usage
There are two ways to render a view:
- Return an instance of the
Yiisoft\DataResponse\DataResponse
class with deferred rendering. - Render immediately and return the rendered result as a string.
Rendering result as a PSR-7 response
The Yiisoft\DataResponse\DataResponse
class is an implementation of the Psr\Http\Message\ResponseInterface
. For
more information about this class, see the yiisoft/data-response package.
You can get an instance of a response with deferred rendering as follows:
/** * @var \Yiisoft\Aliases\Aliases $aliases * @var \Yiisoft\DataResponse\DataResponseFactoryInterface $dataResponseFactory * @var \Yiisoft\View\WebView $webView */ $viewRenderer = new \Yiisoft\Yii\View\Renderer\ViewRenderer( $dataResponseFactory, $aliases, $webView, '/path/to/views', // Full path to the directory of view templates or its alias. 'layouts/main.php', // Default is null, which means not to use a layout. ); // Rendering a view with a layout. $response = $viewRenderer->render('site/page', [ 'parameter-name' => 'parameter-value', ]);
The rendering will be performed directly when calling getBody()
or getData()
methods of the
Yiisoft\DataResponse\DataResponse
. If a layout is set, but you need to render a view
without the layout, you can use an immutable setter withLayout()
:
$viewRenderer = $viewRenderer->withLayout(null); // Rendering a view without a layout. $response = $viewRenderer->render('site/page', [ 'parameter-name' => 'parameter-value', ]);
Or use renderPartial()
method, which will call withLayout(null)
:
// Rendering a view without a layout. $response = $viewRenderer->renderPartial('site/page', [ 'parameter-name' => 'parameter-value', ]);
Rendering result as a string
To render immediately and return the rendering result as a string,
use renderAsString()
and renderPartialAsString()
methods:
// Rendering a view with a layout. $result = $viewRenderer->renderAsString('site/page', [ 'parameter-name' => 'parameter-value', ]); // Rendering a view without a layout. $result = $viewRenderer->renderPartialAsString('site/page', [ 'parameter-name' => 'parameter-value', ]);
Change view templates path
You can change view templates path in runtime as follows:
$viewRenderer = $viewRenderer->withViewPath('/new/path/to/views');
You can specify full path to the views directory or its alias. For more information about path aliases, see description of the yiisoft/aliases package.
Use in the controller
If the view renderer is used in a controller, you can either specify controller name explicitly using
withControllerName()
or determine name automatically by passing a controller instance to withController()
.
In this case the name is determined as follows:
App\Controller\FooBar\BazController -> foo-bar/baz
App\Controllers\FooBar\BazController -> foo-bar/baz
App\AllControllers\MyController\FooBar\BazController -> foo-bar/baz
App\AllControllers\MyController\BazController -> baz
Path\To\File\BlogController -> blog
With this approach, you do not need to specify the directory name each time when rendering a view template:
use Psr\Http\Message\ResponseInterface; use Yiisoft\Yii\View\Renderer\ViewRenderer; class SiteController { private ViewRenderer $viewRenderer; public function __construct(ViewRenderer $viewRenderer) { // Specify the name of the controller: $this->viewRenderer = $viewRenderer->withControllerName('site'); // or specify an instance of the controller: //$this->viewRenderer = $viewRenderer->withController($this); } public function index(): ResponseInterface { return $this->viewRenderer->render('index'); } public function contact(): ResponseInterface { // Some actions. return $this->viewRenderer->render('contact', [ 'parameter-name' => 'parameter-value', ]); } }
This is very convenient if there are many methods (actions) in the controller.
Injection of additional data to the views
In addition to parameters passed directly when rendering the view template, you can set extra parameters that will be available in all views. In order to do it you need a class implementing at least one of the injection interfaces:
use Yiisoft\Yii\View\Renderer\CommonParametersInjectionInterface; use Yiisoft\Yii\View\Renderer\LayoutParametersInjectionInterface; final class MyParametersInjection implements CommonParametersInjectionInterface, LayoutParametersInjectionInterface { // Pass both to view template and to layout public function getCommonParameters(): array { return [ 'common-parameter-name' => 'common-parameter-value', ]; } // Pass only to layout public function getLayoutParameters(): array { return [ 'layout-parameter-name' => 'layout-parameter-value', ]; } }
Link tags and meta tags should be organized in the same way.
use Yiisoft\Html\Html; use Yiisoft\View\WebView; use Yiisoft\Yii\View\Renderer\LinkTagsInjectionInterface; use Yiisoft\Yii\View\Renderer\MetaTagsInjectionInterface; final class MyTagsInjection implements LinkTagsInjectionInterface, MetaTagsInjectionInterface { public function getLinkTags(): array { return [ Html::link()->toCssFile('/main.css'), 'favicon' => Html::link('/myicon.png', [ 'rel' => 'icon', 'type' => 'image/png', ]), 'themeCss' => [ '__position' => WebView::POSITION_END, Html::link()->toCssFile('/theme.css'), ], 'userCss' => [ '__position' => WebView::POSITION_BEGIN, 'rel' => 'stylesheet', 'href' => '/user.css', ], ]; } public function getMetaTags(): array { return [ Html::meta() ->name('http-equiv') ->content('public'), 'noindex' => Html::meta() ->name('robots') ->content('noindex'), [ 'name' => 'description', 'content' => 'This website is about funny raccoons.', ], 'keywords' => [ 'name' => 'keywords', 'content' => 'yii,framework', ], ]; } }
You can pass instances of these classes as the sixth optional parameter to the constructor when
creating a view renderer, or use the withInjections()
and withAddedInjections
methods.
$parameters = new MyParametersInjection(); $tags = new MyTagsInjection(); $viewRenderer = $viewRenderer->withInjections($parameters, $tags); // Or append it: $viewRenderer = $viewRenderer->withAddedInjections($parameters, $tags);
The parameters passed to render()
method have more priority
and will overwrite the injected content parameters if their names match.
Injections lazy loading
You can use lazy loading for injections. Injections will be created by container that implements
Yiisoft\Yii\View\Renderer\InjectionContainerInterface
. Out of the box, it is available in InjectionContainer
that is based on PSR-11 compatible
container.
- Add injection container to
ViewRenderer
constructor:
use Yiisoft\Yii\View\Renderer\ViewRenderer; use Yiisoft\Yii\View\Renderer\InjectionContainer\InjectionContainer; /** * @var Psr\Container\ContainerInterface $container */ $viewRenderer = new ViewRenderer( injectionContainer: new InjectionContainer($container) )
- Use injection class names instead of instances.
$viewRenderer->withInjections(MyParametersInjection::class, MyTagsInjection::class);
Localize view file
You can set a specific locale that will be used to localize view files with withLocale()
method:
$viewRenderer = $viewRenderer->withLocale('de_DE');
For more information about localization, see at the localization section in yiisoft/view package.
Yii Config parameters
'yiisoft/yii-view-renderer' => [ // The full path to the directory of views or its alias. // If null, relative view paths in `ViewRenderer::render()` is not available. 'viewPath' => null, // The full path to the layout file to be applied to views. // If null, the layout will not be applied. 'layout' => null, // The injection instances or class names. 'injections' => [], ],
Documentation
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii View Renderer is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.