schumacherfm/magento-twig

Twig template engine for Magento 2

Magento 2 Twig Template Engine

Twig template engine for Magento2., _(*1)

This template engine is meant to be used additionally to the .phtml files and does not provide any .twig template file., _(*2)

A use case would be if you write your first Magento2 module you can require this package and write all your template files in Twig., _(*3)

Installation

1. Add dependency

composer require schumacherfm/magento-twig

1. Enable the module

bin/magento module:enable SchumacherFM_Twig

1. Update the database entries

bin/magento setup:upgrade

Events & Configuration

The Twig template engine class dispatches two events so that you can modify Twig., _(*4)

Event twig_loader with event object loader. You can set loader any other class which implements Twig_LoaderInterface. http://twig.sensiolabs.org/doc/api.html#loaders, _(*5)

Event twig_init with event object twig. You can add here more functions, filters, tags, etc. http://twig.sensiolabs.org/doc/advanced.html, _(*6)

Configuration options can be found Stores -> Settings -> Configuration -> Advanced -> Developer -> Twig., _(*7)

Frontend Integration

Your template files must have the file extension .twig to get automatically recognized., _(*8)

In your layout xml files or blocks please specify the new template, _(*9)

<referenceBlock name="top.links">
    <block class="Magento\Theme\Block\Html\Header" template="html/header.twig" name="header" as="header" before="-">
        <arguments>
            <argument name="show_part" xsi:type="string">welcome</argument>
        </arguments>
    </block>
</referenceBlock>

Example header.phtml converted to header.twig

<?php switch ($this->getShowPart()):
    case 'welcome': ?>
        <li class="greet welcome"><?php echo $this->getWelcome() ?></li>
    <?php break; ?>
    <?php case 'other': ?>
        <?php echo $this->getChildHtml(); ?>
    <?php break; ?>
<?php endswitch; ?>

{% if getShowPart() == 'welcome' %}
    <li class="greet welcome">{{ getWelcome() }}</li>
{% endif %}

{% if getShowPart() == 'other' %}
    {{ getChildHtml()|raw }}
{% endif %}

Example breadcrumbs.phtml converted to breadcrumbs.twig

<?php if ($crumbs && is_array($crumbs)) : ?>
<div class="breadcrumbs">
    <ul class="items">
        <?php foreach ($crumbs as $crumbName => $crumbInfo) : ?>
            <li class="item <?php echo $crumbName ?>">
            <?php if ($crumbInfo['link']) : ?>
                <a href="<?php echo $crumbInfo['link'] ?>" title="<?php echo $this->escapeHtml($crumbInfo['title']) ?>">
                    <?php echo $this->escapeHtml($crumbInfo['label']) ?>
                </a>
            <?php elseif ($crumbInfo['last']) : ?>
                <strong><?php echo $this->escapeHtml($crumbInfo['label']) ?></strong>
            <?php else: ?>
                <?php echo $this->escapeHtml($crumbInfo['label']) ?>
            <?php endif; ?>
            </li>
        <?php endforeach; ?>
    </ul>
</div>
<?php endif; ?>

{% if crumbs %}
<div class="breadcrumbs">
    <ul class="items">
    {% for crumbName,crumbInfo in crumbs %}
        <li class="item {{ crumbName }}">
            {% if crumbInfo.link %}
                <a href="{{ crumbInfo.link }}" title="{{ crumbInfo.title }}">
                    {{ crumbInfo.label }}
                </a>
            {% elseif crumbInfo.last %}
                <strong>{{ crumbInfo.label }}</strong>
            {% else %}
                {{ crumbInfo.label }}
            {% endif %}
        </li>
    {% endfor %}
    </ul>
</div>
{% endif %}

Access helper methods

Write in your .twig file:, _(*10)

{{ helper("Magento\\Core\\Helper\\Url").getHomeUrl() }}

Tests

@todo, _(*11)

Support / Contribution

Report a bug using the issue tracker or send us a pull request., _(*12)

Instead of forking I can add you as a Collaborator IF you really intend to develop on this module. Just ask :-), _(*13)

I am using that model: A successful Git branching model, _(*14)

For versioning have a look at Semantic Versioning 2.0.0, _(*15)

History

2.0.0

• Added Magento 2.4.0 compatibility
• Removed helper functions from app/functions.php since the file is no longer available in Magento 2.4
• Removed deprecated function layoutBlock from twig environment
• Updated to twig to 3.0.*

Compatibility

• Magento >= 2
• php >= 5.4.0

License

OSL-30, _(*16)

Author

Cyrill Schumacher, _(*17)

My pgp public key, _(*18)