leprz/boilerplate-generator

This package helps you generate any kind of file boilerplate including PHP classes

v0.2.0 2020-10-07 05:41 UTC

Requires

• php: >=7.4
• nette/php-generator: ^3.0
• nikic/php-parser: ^4.0
• symfony/filesystem: ^5.0

Requires (Dev)

• phpunit/phpunit: ^9.3
• squizlabs/php_codesniffer: ^3.0
• vimeo/psalm: ^3.0

MIT

• Przemek Łęczycki

• generator
• code generator
• scaffold
• boilerplate file

README

Generate files for CRUD, commands, handlers, ports, adapters, configuration - tailored to your needs.

leprz/boilerplate-generator

Introduction

This package helps you generate any kind of file boilerplate (php, yml, etc.). Contains a builder for PHP classes, interfaces, functions, methods, parameters and return types. Generated code is PSR-12 and PSR-4 complaint.

Installation:

composer require leprz/boilerplate-generator --dev

Requirements

PHP >= 7.4

Code

use Leprz\Boilerplate\PathNode\Folder;
use Leprz\Boilerplate\PathNode\Php\PhpClass;
use Leprz\Boilerplate\PathNode\Php\PhpMethod;
use Leprz\Boilerplate\PathNode\Php\PhpParameter;
use Leprz\Boilerplate\PathNode\Php\PhpType;
use Leprz\Boilerplate\Configuration;
use Leprz\Boilerplate\Generator;

$generator = new Generator(
    new Configuration(
        'AppPrefix',
        'src/'
    )
);

$command = (new Folder('Command'))
    ->addFolder(new Folder('ExampleUseCase'))
    ->addPhpClass(new PhpClass('ExampleCommand'));

$handler = (new Folder('Command'))
    ->addFolder(new Folder('ExampleUseCase'))
    ->addPhpClass(new PhpClass('ExampleHandler'))
    ->addMethod(new PhpMethod('__invoke', 'public', PhpType::void(), [
        new PhpParameter('command', PhpType::object($command))
    ]));

$generator->generate($command);
$generator->generate($handler);

will create file src/Command/ExampleUseCase/ExampleCommand.php

<?php

declare(strict_types=1);

namespace AppPrefix\Command\ExampleUseCase;

/**
 * @package AppPrefix\Command\ExampleUseCase
 */
class ExampleCommand
{
}

will create file src/Command/ExampleUseCase/ExampleHandler.php

<?php

declare(strict_types=1);

namespace AppPrefix\Command\ExampleUseCase;

/**
 * @package AppPrefix\Command\ExampleUseCase
 */
class ExampleHandler
{
    /**
     * @param \AppPrefix\Command\ExampleUseCase\ExampleCommand
     */
    public function __invoke(ExampleCommand $command): void
    {
    }
}

advanced example

use Leprz\Boilerplate\PathNode\BoundedContext;
use Leprz\Boilerplate\PathNode\Layer;
use Leprz\Boilerplate\PathNode\Folder;
use Leprz\Boilerplate\PathNode\Php\PhpClass;
use Leprz\Boilerplate\PathNode\Php\PhpInterface;
use Leprz\Boilerplate\PathNode\Php\PhpMethod;
use Leprz\Boilerplate\PathNode\Php\PhpParameter;
use Leprz\Boilerplate\PathNode\Php\PhpType;

$this->testClass1 = (new Folder('Sample'))
    ->addPhpClass(new PhpClass('TestClass1'));

$this->testInterface1 = (new Folder('Sample'))
    ->addPhpInterface(new PhpInterface('TestInterface1'));

$this->testInterface2 = (new Folder('Sample'))
    ->addPhpInterface(new PhpInterface('TestInterface2'))
    ->addMethod(new PhpMethod('test', 'public', PhpType::string()));

$this->testClass2 = (new BoundedContext('Domain'))
    ->addLayer(new Layer('Application'))
    ->addFolder(new Folder('Command'))
    ->addPhpClass(new PhpClass('TestClass2'))
    ->extends($this->testClass1)
    ->implements($this->testInterface1, $this->testInterface2)
    ->addMethod(new PhpMethod('doSomething', 'public', PhpType::void(), [
        new PhpParameter('testClass1', PhpType::object($this->testClass1)),
        new PhpParameter('test', PhpType::string())
    ]))
    ->addMethod(new PhpMethod('doSomethingElse', 'private', PhpType::object($this->testClass1)));