This plugin allows you to use the Twig Templating Language for your views.
It provides wrappers for common View opertions and many helpful extensions that expose CakePHP functions and jasny/twig-extensions helpers.
To install with Composer, use the command below.
composer require cakephp/twig-viewThen, load the Cake/TwigView plugin
in your Application bootstrap just like other Cake plugins.
TwigView allows you to configure the Twig Environment through View options. You can set these through ViewBuilder
in the Controller or set them directly in TwigView.
// In controller
public function initialize(): void
{
$this->viewBuilder()->setOption('environment', ['cache' => false]);
}
// In your AppView
public function initialize(): void
{
$this->setConfig('environment', ['cache' => false]);
// Call parent TwigView initialize
parent::initialize();
}-
environmentDefaults to empty.
-
markdownWhich markdown engine is used for
markdown_to_htmlfilter. Set todefaultto useDefaultMarkdownor set custom Twig Markdown extensionMarkdownInterfaceinstance.If using
default, require one of: -erusev/parsedown-league/commonmark-michelf/php-markdownDefaults to disabled.
To start using Twig templates in your application, simply extend TwigView in your AppView.
In general, it is safe to add your application's setup in AppView::initialize().
namespace App\View;
use Cake\TwigView\View\TwigView;
class AppView extends TwigView
{
public function initialize(): void
{
parent::initialize();
// Add application-specific extensions
}
}You can override several parts of TwigView initialization to create a custom Twig setup.
-
File Extensions
You can specify the file extensions used to search for templates by overriding the
$extensionsproperty.class AppView extends TwigView { protected $extensions = [ '.custom', ]; }
-
Twig Loader
You can override the template loader used by Twig.
protected function createLoader(): \Twig\Loader\LoaderInterface { // Return a custom Twig template loader }
-
Twig Extensions
You can override the Twig Extensions loading. If you want to use the built-in
Viewwrappers, make sure you loadCake\TwigView\Twig\Extensions\ViewExtension.protected function initializeExtensions(): void { // Load only specific extensions }
-
Twig Profiler
You can override the Twig profiler used when
DebugKitis loaded.protected function initializeProfiler(): void { parent::initializeProfiler(); // Add custom profiler logging using $this->getProfile() }
You can create views using Twig templates much like you can with standard CakePHP templates.
Templates are loaded the same way wherever they are used and follow the View path conventions.
{% extends 'Common/base' %}
{{ include('Common/helper') }}- Template names are always relative to
App.path.templatesnot the current file. - File extensions are automatically generated. Defaults to '.twig'.
- Templates can be loaded from plugins the same as
Viewtemplates.
Layout templates are supported and loaded the same way as View layouts.
templates/layout/default.twig:
<!DOCTYPE html>
<html>
<head>
<title>
{{ fetch('title') }}
</title>
{{ fetch('meta') }}
{{ fetch('css') }}
{{ fetch('script') }}
</head>
<body>
{{ fetch('content') }}
</body>
</html>The layout can be set from the template using the layout tag.
{% layout 'Error' %}You can access the View instance using the _view global.
TwigView provides wrappers for fetch(), cell() and element() rendering.
Cell and element templates are always loaded from cell/ and element/ sub-directories
the same as View templates.
{{ fetch('content')}}
{{ cell('myCell')}}
{{ element('myElement') }}TwigView also provides wrappers for any loaded helper using a special naming convention - helper_Name_function().
{{ helper_Text_autoParagraph('some text for a paragarph') }}All wrapper functions are pre-escaped and do not require using |raw filter. However, keep in mind that Twig keeps the whitespace when using {{ }} to print. Please read the Twig documentation on how to remove the extra white space when needed.
lowmaps tostrtolowerupmaps tostrtoupperenvmaps toenvpluralizemaps toCake\Utility\Inflector::pluralizesingularizemaps toCake\Utility\Inflector::singularizecamelizemaps toCake\Utility\Inflector::camelizeunderscoremaps toCake\Utility\Inflector::underscorehumanizemaps toCake\Utility\Inflector::humanizetableizemaps toCake\Utility\Inflector::tableizeclassifymaps toCake\Utility\Inflector::classifyvariablemaps toCake\Utility\Inflector::variableslugmaps toCake\Utility\Inflector::slugtoReadableSizemaps toCake\I18n\Number::toReadableSizetoPercentagemaps toCake\I18n\Number::toPercentagecake_number_formatmaps toCake\I18n\Number::formatformatDeltamaps toCake\I18n\Number::formatDeltacurrencymaps toCake\I18n\Number::currencysubstrmaps tosubstrtokenizemaps toCake\Utility\Text::tokenizeinsertmaps toCake\Utility\Text::insertcleanInsertmaps toCake\Utility\Text::cleanInsertwrapmaps toCake\Utility\Text::wrapwrapBlockmaps toCake\Utility\Text::wrapBlockwordWrapmaps toCake\Utility\Text::wordWraphighlightmaps toCake\Utility\Text::highlighttailmaps toCake\Utility\Text::tailtruncatemaps toCake\Utility\Text::truncateexcerptmaps toCake\Utility\Text::excerpttoListmaps toCake\Utility\Text::toListstripLinksmaps toCake\Utility\Text::stripLinksisMultibytemaps toCake\Utility\Text::isMultibyteutf8maps toCake\Utility\Text::utf8asciimaps toCake\Utility\Text::asciiparseFileSizemaps toCake\Utility\Text::parseFileSizeserializemaps toserializeunserializemaps tounserializemd5maps tomd5base64_encodemaps tobase64_encodebase64_decodemaps tobase64_decodestringcast tostring
See jasny/twig-extensions for the filters they provide.
in_arraymaps toin_arrayexplodemaps toexplodearraycast toarrayarray_pushmaps topusharray_prevmaps toprevarray_nextmaps tonextarray_currentmaps tocurrent__maps to____dmaps to__d__nmaps to__n__xmaps to__x__dnmaps to__dndefaultCurrencymaps toCake\I18n\Number::getDefaultCurrencyuuidmaps toCake\Utility\Text::uuidtimepassed the first and optional second argument intonew \Cake\I18n\FrozenTime()timezonesmaps toCake\I18n\FrozenTime::listTimezones
See jasny/twig-extensions for the functions they provide.