wyrihaximus/twig-view

Twig powered View for CakePHP3

TwigView plugin for CakePHP

, _(*1)

This plugin allows you to use the Twig Templating Language for your views., _(*2)

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., _(*3)

DEPRECATED: Use cakephp/twig-view instead., _(*4)

Installation

To install via Composer, use the command below., _(*5)

composer require wyrihaximus/twig-view

Configuration

Load Plugin

Run the following CLI command:, _(*6)

bin/cake plugin load WyriHaximus/TwigView

Use View class

Instead of extending from the View let AppView extend TwigView:, _(*7)

namespace App\View;

use WyriHaximus\TwigView\View\TwigView;

class AppView extends TwigView
{
}

Quick Start

TwigView will look for its templates with the extension .twig., _(*8)

Layout

Replace templates/layout/default.php by this templates/layout/default.twig, _(*9)

``` twig , <sub>(*10)</sub>

<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 }}

, <sub>(*11)</sub>

{{ Flash.render()|raw }}

<section>

    <h1>{{ _view.fetch('title')|raw }}</h1>

    {{ _view.fetch('content')|raw }}
</section>

<footer>
    {{ _view.fetch('footer')|raw }}
</footer>

, <sub>(*12)</sub>

### Template View
Create a template, for example `templates/Users/index.twig` like this
```Twig
{{ _view.assign('title', __("I'm title")) }}

{{ _view.start('header') }}


I'm header, (*13)


{{ _view.end() }}

{{ _view.start('footer') }}


I'm footer, (*14)


{{ _view.end() }}



I'm content, (*15)

Usage

Use $this

With twig $this is replaced by _view, <sub>(*16)</sub>

For example, without using Twig writing, <sub>(*17)</sub>

<?= $this->fetch('content') ?>

But with Twig, <sub>(*18)</sub>

{{ _view.fetch('content')|raw }}

Helpers

Any helper can be access by their CamelCase name, for example:, <sub>(*19)</sub>

{{ Html.link('Edit user', {'controller':'Users', 'action': 'edit' ~ '/' ~ user.id}, {'class':'myclass'})|raw }}

Elements

Basic, <sub>(*20)</sub>

{% element 'Element' %}

With variables or options, <sub>(*21)</sub>

{% element 'Plugin.Element' {
    dataName: 'dataValue'
} {
    optionName: 'optionValue'
} %}

Cells

Store in context then echo it, <sub>(*22)</sub>

{% cell cellObject = 'Plugin.Cell' {
    dataName: 'dataValue'
} {
    optionName: 'optionValue'
} %}

{{ cellObject|raw }}

Fetch and directly echo it, <sub>(*23)</sub>

{% cell 'Plugin.Cell' {
    dataName: 'dataValue'
} {
    optionName: 'optionValue'
} %}

Extends

If i want extend to Common/demo.twig, <sub>(*24)</sub>

    {% block sidebar %}{% endblock %}







    {% block body %}{% endblock %}

We can write in a view, <sub>(*25)</sub>

{% extends 'Common/demo' %}

{% block sidebar %}

• Item 1
• Item 2
• Item 3

Note : the block body is required, it's equivalent to <?= $this->fetch('content') ?>, <sub>(*26)</sub>

Filters

• debug maps to debug
• pr maps to pr
• low maps to strtolower
• up maps to strtoupper
• env maps to env
• count maps to count
• pluralize maps to Cake\Utility\Inflector::pluralize
• singularize maps to Cake\Utility\Inflector::singularize
• camelize maps to Cake\Utility\Inflector::camelize
• underscore maps to Cake\Utility\Inflector::underscore
• humanize maps to Cake\Utility\Inflector::humanize
• tableize maps to Cake\Utility\Inflector::tableize
• classify maps to Cake\Utility\Inflector::classify
• variable maps to Cake\Utility\Inflector::variable
• slug maps to Cake\Utility\Inflector::slug
• toReadableSize maps to Cake\I18n\Number::toReadableSize
• toPercentage maps to Cake\I18n\Number::toPercentage
• number_format maps to Cake\I18n\Number::format
• formatDelta maps to Cake\I18n\Number::formatDelta
• currency maps to Cake\I18n\Number::currency
• substr maps to substr
• tokenize maps to Cake\Utility\Text::tokenize
• insert maps to Cake\Utility\Text::insert
• cleanInsert maps to Cake\Utility\Text::cleanInsert
• wrap maps to Cake\Utility\Text::wrap
• wrapBlock maps to Cake\Utility\Text::wrapBlock
• wordWrap maps to Cake\Utility\Text::wordWrap
• highlight maps to Cake\Utility\Text::highlight
• tail maps to Cake\Utility\Text::tail
• truncate maps to Cake\Utility\Text::truncate
• excerpt maps to Cake\Utility\Text::excerpt
• toList maps to Cake\Utility\Text::toList
• stripLinks maps to Cake\Utility\Text::stripLinks
• isMultibyte maps to Cake\Utility\Text::isMultibyte
• utf8 maps to Cake\Utility\Text::utf8
• ascii maps to Cake\Utility\Text::ascii
• parseFileSize maps to Cake\Utility\Text::parseFileSize
• serialize maps to serialize
• unserialize maps to unserialize
• md5 maps to md5
• base64_encode maps to base64_encode
• base64_decode maps to base64_decode
• nl2br maps to nl2br
• string cast to string

Functions

• in_array maps to in_array
• explode maps to explode
• array cast to array
• array_push maps to push
• array_prev maps to prev
• array_next maps to next
• array_current maps to current
• __ maps to __
• __d maps to __d
• __n maps to __n
• __x maps to __x
• __dn maps to __dn
• defaultCurrency maps to Cake\I18n\Number::defaultCurrency
• number_formatter maps to Cake\I18n\Number::formatter
• uuid maps to Cake\Utility\Text::uuid
• time passed the first and optional second argument into new \Cake\I18n\Time()
• timezones maps to Cake\I18n\Time::listTimezones
• elementExists maps to Cake\View\View::elementExists,
• getVars maps to Cake\View\View::getVars
• get maps to Cake\View\View::get

Twig

Visite Twig Documentaion for more tips, <sub>(*27)</sub>

Extra included extensions

• jasny/twig-extensions
• twig/markdown-extra

Events

This plugin emits several events., <sub>(*28)</sub>

Loaders

The default loader can be replace by listening to the WyriHaximus\TwigView\Event\LoaderEvent::EVENT, for example with twital:, <sub>(*29)</sub>

<?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(): array
    {
        return [
            LoaderEvent::EVENT => 'loader',
            ConstructEvent::EVENT => 'construct',
        ];
    }

    public function loader(LoaderEvent $event): void
    {
        $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): void
    {
        $event->getTwigView()->unshiftExtension('.twital.html');
        $event->getTwigView()->unshiftExtension('.twital.xml');
        $event->getTwigView()->unshiftExtension('.twital.xhtml');
    }
}

Extensions

Extensions can be added to the twig environment by listening to the WyriHaximus\TwigView\Event\ConstructEvent::EVENT, for example:, <sub>(*30)</sub>

<?php

use Cake\Event\EventListenerInterface;
use WyriHaximus\TwigView\Event\ConstructEvent;

class LoaderListener implements EventListenerInterface
{
    public function implementedEvents(): array
    {
        return [
            ConstructEvent::EVENT => 'construct',
        ];
    }

    public function construct(ConstructEvent $event): void
    {
        $event->getTwig()->addExtension(new YourTwigExtension);
    }
}

Bake

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 :, <sub>(*31)</sub>

bin/cake bake twig_template Tasks all -t WyriHaximus/TwigView

Screenshots

Profiler

, <sub>(*32)</sub>

Templates found

, <sub>(*33)</sub>

License

Copyright 2015 Cees-Jan Kiewiet, <sub>(*34)</sub>

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:, <sub>(*35)</sub>

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software., <sub>(*36)</sub>

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., <sub>(*37)</sub>