memio/twig-template-engine

Memio's Twig templates, used to generate PHP code from given Model

Memio's TwigTemplateEngine

Memio is a highly opinionated PHP code generator library. It is composed of small independent packages, one being PrettyPrinter: the actual code generator., _(*1)

PrettyPrinter relies on an interface, TemplateEngine, but doesn't provide any implementation to avoid direct coupling to any templating libraries., _(*2)

This package, TwigTemplateEngine, provides an implementation and templates for Twig., _(*3)

Note: This package is part of Memio. Have a look at the main repository., _(*4)

Installation

Install it using Composer:, _(*5)

composer require memio/twig-template-engine:^3.0

Example

We're going to generate a class with a constructor and two attributes:, _(*6)

<?php

require __DIR__.'/vendor/autoload.php';

use Memio\Model\File;
use Memio\Model\Objekt;
use Memio\Model\Property;
use Memio\Model\Method;
use Memio\Model\Argument;

// Initialize the code generator
$loader = new \Twig\Loader\FilesystemLoader(__DIR__.'/templates');
$twig = new \Twig\Environment($loader);

$line = new Memio\TwigTemplateEngine\TwigExtension\Line\Line();
$line->add(new Memio\TwigTemplateEngine\TwigExtension\Line\ContractLineStrategy());
$line->add(new Memio\TwigTemplateEngine\TwigExtension\Line\FileLineStrategy());
$line->add(new Memio\TwigTemplateEngine\TwigExtension\Line\MethodPhpdocLineStrategy());
$line->add(new Memio\TwigTemplateEngine\TwigExtension\Line\ObjectLineStrategy());
$line->add(new Memio\TwigTemplateEngine\TwigExtension\Line\StructurePhpdocLineStrategy());

$twig->addExtension(new Memio\TwigTemplateEngine\TwigExtension\Type());
$twig->addExtension(new Memio\TwigTemplateEngine\TwigExtension\Whitespace($line));

$templateEngine = new Memio\TwigTemplateEngine\TwigTemplateEngine($twig);
$prettyPrinter = new Memio\PrettyPrinter\PrettyPrinter($templateEngine);

// Describe the code you want to generate using "Models"
$myService = (new File('src/Vendor/Project/MyService.php'))
    ->setStructure(
        (new Objekt('Vendor\Project\MyService'))
            ->addProperty(new Property('createdAt'))
            ->addProperty(new Property('filename'))
            ->addMethod(
                (new Method('__construct'))
                    ->addArgument(new Argument('DateTime', 'createdAt'))
                    ->addArgument(new Argument('string', 'filename'))
            )
    )
;

// Generate the code and display in the console
echo $prettyPrinter->generateCode($myService);

// Or display it in a browser
// echo '

'.htmlspecialchars($prettyPrinter->generateCode($myService)).'

';

With this simple example, we get the following output:, _(*7)

<?php

namespace Vendor\Project;

class MyService
{
    private $createdAt;
    private $filename;

    public function __construct(DateTime $createdAt, string $filename)
    {
    }
}

Have a look at the main respository to discover the full power of Memio., _(*8)

Want to know more?

Memio uses phpspec, which means the tests also provide the documentation. Not convinced? Then clone this repository and run the following commands:, _(*9)

$ composer install
$ ./vendor/bin/phpspec run -n -f pretty

You can see the current and past versions using one of the following:, _(*10)

• the git tag command
• the releases page on Github
• the file listing the changes between versions

And finally some meta documentation:, _(*11)

• copyright and MIT license
• versioning and branching models
• contribution instructions