memio/memio

A highly opinionated PHP code generator library

v3.0.0 2024-08-14 21:19 UTC

Requires

• php: ^7.2 || ^8.0
• memio/linter: ^3.0
• memio/model: ^3.0.1
• memio/pretty-printer: ^3.0
• memio/twig-template-engine: ^3.0
• memio/validator: ^3.0.1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpunit/phpunit: ^8.5

MIT

• Loïc Faugeron

• generator
• php
• code

README

Memio is a library, it allows you to describe PHP code by building "Model" classes (e.g. new Method('__construct')) and then to generate it using a PrettyPrinter!

Note: The actual generation logic is held in Twig templates. If the coding style provided doesn't appeal to you, you can overwrite those templates easily.

Installation

Install using Composer:

$ composer require memio/memio:^3.0

Full example

We're going to generate a class with a constructor and two attributes:

<?php

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

use Memio\Memio\Config\Build;
use Memio\Model\File;
use Memio\Model\Object;
use Memio\Model\Property;
use Memio\Model\Method;
use Memio\Model\Argument;

// Describe the code you want to generate using "Models"
$file = (new File('src/Vendor/Project/MyService.php'))
    ->setStructure(
        (new Object('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
$prettyPrinter = Build::prettyPrinter();
$generatedCode = $prettyPrinter->generateCode($file);
echo $generatedCode;

// Or display it in a browser
// echo '<pre>'.htmlspecialchars($prettyPrinter->generateCode($file)).'</pre>';

With this simple example, we get the following output:

<?php

namespace Vendor\Project;

class MyService
{
    private $createdAt;
    private $filename;

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

Want to know more?

Memio can be quite powerful, discover how by reading the docs:

• Model Tutorial
• PHPdoc Tutorial
• Validation Tutorial
• Examples
• Templates
• Packages

You can see the current and past versions using one of the following:

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

And finally some meta documentation:

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

Roadmap

• commands (e.g. add use statement, add PHPdoc, injecting dependency, etc)
• parsing existing code (using nikic's PHP-Parser)