tebru/dynamo

Generates PHP classes from an interface based on doctrine annotations

v0.3.3 2016-03-22 19:58 UTC

Requires

• php: >= 5.4
• doctrine/annotations: ~1.0
• doctrine/collections: ^1.3
• nikic/php-parser: ~1.3
• symfony/event-dispatcher: ^2.3|~3.0
• symfony/filesystem: ~2.3|~3.0
• tebru/assert: ^0.2

Requires (Dev)

• php: >= 5.5
• mockery/mockery: ^0.9.4
• phpunit/phpunit: ^4.7
• satooshi/php-coveralls: ^0.6.1

MIT

• Nate Brunette

README

Dynamo

This library allows you to take an interface annotated with Doctrine annotations and generate a class. It handles all of the parsing, and provides events to hook into in order to create the method body based on the annotations.

Installation

composer require tebru/dynamo

Usage

Create a new generator object using the builder

$generator = \Tebru\Dynamo\Generator::builder()
    ->namespacePrefix('My\Custom\Library')
    ->setCacheDir('path/to/cache/vendor-name')
    ->build();

There are many different options to use with the builder, however, for most all cases, the defaults outside of the namespace prefix and cache dir will be fine.

The namespace prefix is required in order to get around class name conflicts. The generator uses the full interface name plus the prefix as the generated class name. The prefix defaults to Dynamo.

The cache directory defaults to /system/dir/dynamo

After you have a generator, you can pass your interface name into it and it will create a file in your cache directory

$generator->createAndWrite(MyInterface::class);

Events

It's essential to subscribe to at least the MethodEvent as it is what allows you to add a method body to the method. The MethodModel and AnnotationCollection are available on the event.

The two other events are StartEvent and EndEvent, both of which provide access to the ClassModel.

$eventDispatcher = new \Symfony\Component\EventDispatcher\EventDispatcher();
$eventDispatcher->addListener(new MethodListener());
    
$generator = \Tebru\Dynamo\Generator::builder()
    ->namespacePrefix('My\Custom\Library')
    ->setCacheDir('path/to/cache/vendor-name')
    ->setEventDispatcher($eventDispatcher)
    ->build();

Sample listener

Here is a skeleton of a method listener

<?php
    
namespace Foo;

use Tebru\Dynamo\Event\MethodEvent;

class MethodListener
{
    public function __invoke(MethodEvent $event)
    {
        $methodModel = $event->getMethodModel();
        $annotationCollection = $event->getAnnotationCollection();
        
        $body = [];
        if ($annotation->collection->exists(MyAnnotation::class)) {
            $body[] = '$var = "annotation exists";';
        } else {
            $body[] = '$var = "annotation not exists";';
        }
        
        $methodModel->setBody(implode($body));
    }
}