memio/model

Memio's models, used to describe the code to generate

Memio's Models

Describe PHP code (classes/interfaces with their constants, properties, methods, method arguments and even PHPdoc) by constructing "Model" objects., _(*1)

Note: This package is part of Memio, a highly opinionated PHP code generator. Have a look at the main repository., _(*2)

Installation

Install it using Composer:, _(*3)

composer require memio/model:^3.0

Example

Let's say we want to describe the following method:, _(*4)

    /**
     * @api
     */
    public function doSomething(ValueObject $valueObject, int $type = self::TYPE_ONE, bool $option = true);

In order to do so, we'd need to write the following:, _(*5)

<?php

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

use Memio\Model\Argument;
use Memio\Model\Method;
use Memio\Model\Phpdoc\ApiTag;
use Memio\Model\Phpdoc\MethodPhpdoc;
use Memio\Model\Phpdoc\ParameterTag;

$method = (new Method('doSomething'))
    ->setPhpdoc((new MethodPhpdoc())
        ->addParameterTag(new ParameterTag('Vendor\Project\ValueObject', 'valueObject'))
        ->addParameterTag(new ParameterTag('int', 'type'))
        ->addParameterTag(new ParameterTag('bool', 'option'))

        ->addApiTag(new ApiTag())
    )
    ->addArgument(new Argument('Vendor\Project\ValueObject', 'valueObject'))
    ->addArgument((new Argument('int', 'type'))
        ->setDefaultValue('self::TYPE_ONE')
    )
    ->addArgument((new Argument('bool', 'option'))
        ->setDefaultValue('true')
    )
;

Usually models aren't described manually like this, they would be built dynamically:, _(*6)

// Let's say we've received the following two parameters:
$methodName = 'doSomething';
$arguments = [new \Vendor\Project\ValueObject(), ValueObject::TYPE_ONE, true];

$method = new Method($methodName);
$phpdoc = (new MethodPhpdoc())->setApiTag(new ApiTag());
$index = 1;
foreach ($arguments as $rawArgument) {
    $type = is_object($rawArgument) ? get_class($argument) : gettype($rawArgument);
    $name = 'argument'.$index++;
    $argument = new Argument($type, $name);

    $method->addArgument($argument);
    $phpdoc->addParameterTag(new ParameterTag($type, $name));
}
$method->setPhpdoc($phpdoc);

We can build dynamically the models using a configuration file, user input, existing source code... Possibilities are endless!, _(*7)

Once built these models can be further tweaked, and converted to another format: an array, source code, etc... Again, the possibilities are endless!, _(*8)

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

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:, _(*10)

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

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

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

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

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

Roadmap

• get rid of Type
• extract Import (use statement) from FullyQualifiedName
• get rid of FullyQualifiedName
• support more PHPdoc stuff
• support annotations