This plugin for version 3 the CakePHP Framework allows you to use the Twig Templating Language for your views.
In addition to enabling the use of most of Twig's features, the plugin is tightly integrated with the CakePHP view renderer giving you full access to helpers, objects and elements.
To install via Composer, use the command below, it will automatically detect the latest version and bind it with ~.
composer require wyrihaximus/twig-viewAdd the following to your config/bootstrap.php to load the plugin.
Plugin::load('WyriHaximus/TwigView', [
'bootstrap' => true,
]);Instead of extending from the View let AppView extend TwigView:
namespace App\View;
use WyriHaximus\TwigView\View\TwigView;
class AppView extends TwigView
{
}In Controller/AppController load your helpers:
public $helpers = ['Html', 'Form']; // And moreOr in your AppView file :
public function initialize()
{
parent::initialize();
$this->loadHelper('Html');
$this->loadHelper('Form');
}Note: TwigView will look for its templates with the extension .twig and then for .tpl (deprecated).
Replace Template/Layout/default.ctp by this Layout/default.twig
<!DOCTYPE html>
<html>
<head>
{{ Html.charset()|raw }}
<title>
{{ __('myTwigExample') }}
{{ _view.fetch('title')|raw }}
</title>
{{ Html.meta('icon')|raw }}
{{ Html.css('default.app.css')|raw }}
{{ Html.script('app')|raw }}
{{ _view.fetch('meta')|raw }}
{{ _view.fetch('css')|raw }}
{{ _view.fetch('script')|raw }}
</head>
<body>
<header>
{{ _view.fetch('header')|raw }}
</header>
{{ Flash.render()|raw }}
<section>
<h1>{{ _view.fetch('title')|raw }}</h1>
{{ _view.fetch('content')|raw }}
</section>
<footer>
{{ _view.fetch('footer')|raw }}
</footer>
</body>
</html>Create a template, for exemple Template/Users/index.twig like this
{{ _view.assign('title', __("I'm title")) }}
{{ _view.start('header') }}
<p>I'm header</p>
{{ _view.end() }}
{{ _view.start('footer') }}
<p>I'm footer</p>
{{ _view.end() }}
<p>I'm content</p>With twig $this is replaced by _view
For example, without using Twig writing
<?= $this->fetch('content') ?>But with Twig
{{ _view.fetch('content')|raw }}Any helper you defined in your controller.
public $helpers = ['Html', 'Form']; // ...Can be access by their CamelCase name, for example creating a form using the FormHelper:
{{ Html.link('Edit user', {'controller':'Users', 'action': 'edit' ~ '/' ~ user.id}, {'class':'myclass'})|raw }}Basic
{% element 'Element' %}With variables or options
{% element 'Plugin.Element' {
dataName: 'dataValue'
} {
optionName: 'optionValue'
} %}Store in context then echo it
{% cell cellObject = 'Plugin.Cell' {
dataName: 'dataValue'
} {
optionName: 'optionValue'
} %}
{{ cellObject|raw }}Fetch and directly echo it
{% cell 'Plugin.Cell' {
dataName: 'dataValue'
} {
optionName: 'optionValue'
} %}If i want extend to Common/demo.twig
<div id="sidebar">
{% block sidebar %}{% endblock %}
</div>
<div id="content">
{% block body %}{% endblock %}
</div>We can write in a view
{% extends 'Common/demo' %}
{% block sidebar %}
<ul>
<li>Item 1</li>
<li>Item 2</li>
<li>Item 3</li>
</ul>
{% endblock %}
{% block body %}
{{ _view.assign('title', __("I'm title")) }}
{{ _view.start('header') }}
<p>I'm header</p>
{{ _view.end() }}
{{ _view.start('footer') }}
<p>I'm footer</p>
{{ _view.end() }}
<p>I'm content</p>
{% endblock %}Note : the block body is required, it's equivalent to <?= $this->fetch('content') ?>
debugmaps todebugprmaps toprlowmaps tolowupmaps toupenvmaps toenvcountmaps tocountpluralizemaps 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::toReadableSizefromReadableSizemaps toCake\I18n\Number::fromReadableSizetoPercentagemaps toCake\I18n\Number::toPercentageformatmaps 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_decodenl2brmaps tonl2brstringcast tostring
in_arraymaps toin_arrayexplodemaps toexplodearraycast toarrayarray_pushmaps topusharray_addmaps toaddarray_prevmaps toprevarray_nextmaps tonextarray_currentmaps tocurrentarray_eachmaps toeach__maps to____dmaps to__d__nmaps to__n__xmaps to__x__dnmaps to__dndefaultCurrencymaps toCake\I18n\Number::defaultCurrencynumber_formattermaps toCake\I18n\Number::formatteruuidmaps toCake\Utility\Text::uuidtimepassed the first and optional second argument intonew \Cake\I18n\Time()timezonesmaps toCake\I18n\Time::listTimezoneselementExistsmaps toCake\View\View::elementExists,getVarsmaps toCake\View\View::getVarsgetmaps toCake\View\View::get
Visite Twig Documentaion for more tips
This plugin emits several events.
The default loader can be replace by listening to the WyriHaximus\TwigView\Event\LoaderEvent::EVENT, for example with twital:
<?php
use Cake\Event\EventListenerInterface;
use Goetas\Twital\TwitalLoader;
use WyriHaximus\TwigView\Event\ConstructEvent;
use WyriHaximus\TwigView\Event\LoaderEvent;
class LoaderListener implements EventListenerInterface
{
public function implementedEvents()
{
return [
LoaderEvent::EVENT => 'loader',
ConstructEvent::EVENT => 'construct',
];
}
public function loader(LoaderEvent $event)
{
$event->result = new TwitalLoader($event->getLoader());
}
/**
* We've also listening in on this event so we can add the needed extensions to check for to the view
*/
public function construct(ConstructEvent $event)
{
$event->getTwigView()->unshiftExtension('.twital.html');
$event->getTwigView()->unshiftExtension('.twital.xml');
$event->getTwigView()->unshiftExtension('.twital.xhtml');
}
}
Extensions can be added to the twig environment by listening to the WyriHaximus\TwigView\Event\ConstructEvent::EVENT, for example:
<?php
use Cake\Event\EventListenerInterface;
use WyriHaximus\TwigView\Event\ConstructEvent;
class LoaderListener implements EventListenerInterface
{
public function implementedEvents()
{
return [
ConstructEvent::EVENT => 'construct',
];
}
public function construct(ConstructEvent $event)
{
$event->getTwig()->addExtension(new YourTwigExtension);
}
}You can use Bake to generate your basic CRUD views using the theme option.
Let's say you have a TasksController for which you want to generate twig templates.
You can use the following command to generate your index, add, edit and view file formatted
using Twig :
bin/cake bake twig_template Tasks all -t WyriHaximus/TwigView
Copyright 2015 Cees-Jan Kiewiet
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.