README

Integrates Twig with PHPNomad's template strategy. It implements phpnomad/template's CanRender interface on top of Twig 3, so any code in your application that depends on CanRender can render .twig files without knowing Twig is doing the work. This is the default templating integration for PHPNomad applications that run outside WordPress.

Installation

composer require phpnomad/twig-integration

What this provides

TwigEngine, a CanRender implementation that loads templates through Twig's Environment and FilesystemLoader and auto-appends .twig to the template path you pass in.
TwigConfigProvider, an interface your application implements to tell the engine where its template directory lives.
Exception mapping so a missing template surfaces as TemplateNotFound and any other render failure surfaces as TemplateException, both from phpnomad/template.

Requirements

PHP 8.0 or later (inherited from twig/twig ^3.0)
phpnomad/template ^1.0
twig/twig ^3.0

Usage

Implement TwigConfigProvider to point at your templates directory, then bind TwigEngine to CanRender in your bootstrapper's class definitions.

<?php

namespace MyApp\Templates;

use PHPNomad\Twig\Integration\Interfaces\TwigConfigProvider;

class TemplateConfig implements TwigConfigProvider
{
    public function getTemplateDirectory(): string
    {
        return __DIR__ . '/templates';
    }
}

<?php

namespace MyApp;

use MyApp\Templates\TemplateConfig;
use PHPNomad\Loader\Interfaces\HasClassDefinitions;
use PHPNomad\Template\Interfaces\CanRender;
use PHPNomad\Twig\Integration\Interfaces\TwigConfigProvider;
use PHPNomad\Twig\Integration\Strategies\TwigEngine;

class TemplateInitializer implements HasClassDefinitions
{
    public function getClassDefinitions(): array
    {
        return [
            TwigEngine::class => CanRender::class,
            TemplateConfig::class => TwigConfigProvider::class,
        ];
    }
}

With those bindings in place, anywhere CanRender is injected you can call $template->render('emails/welcome', ['name' => $user->name]) and the engine will resolve templates/emails/welcome.twig.

Documentation

Bootstrapping and class definitions: phpnomad.com
Twig template syntax and features: twig.symfony.com

License

MIT. See LICENSE.txt.

phpnomad / twig-integration

Maintainers

Package info

Statistics

Security