ac/model-traits

Traits to reduce boilerplate when creating models.

0.2.0 2014-01-31 19:49 UTC

Requires

• php: >=5.4.0
• doctrine/annotations: >=1.1.2

MIT

• Evan Villemez

• model
• factory
• trait
• getter
• setter

README

This is a small convenience library for reusing some common patterns in model classes. Each trait is defined in a section below.

Installing

Just require "ac/model-traits": "0.2.0" in your composer.json and run composer update ac/model-traits.

AutoGetterSetterTrait

This will use some reflection magic to allow you to use getters/setters for any property, without having to define them yourself. Of course you are still free to explicitly override any getters/setters for properties where you want or need custom logic. Some assumptions are baked into this:

• public and protected properties are both settable and gettable
• private properties are only gettable

Example:

use AC\ModelTraits\AutoGetterSetterTrait;

class MyModel
{
    use AutoGetterSetterTrait;

    private $id;
    protected $name;
    protected $age;

    public function __construct($id = null)
    {
        $this->id = $id;
    }
}

$m = new MyModel(5);
$m->setName('John');
$m->setAge(23);

echo $m->getId();       //5
echo $m->getName();     //John
echo $m->getAge();      //23

AnnotatedGetterSetterTrait

If you want to more precisely specify which properties will have getters/setters created, you can use the annotation-based trait:

use AC\ModelTraits\AnnotatedGetterSetterTrait;
use AC\ModelTraits\Annotation as MT;

class MyModel
{
    use AnnotatedGetterSetterTrait;

    /**
     * @MT\Getter
     */
    private $id

    /**
     * @MT\GetterAndSetter
     */
    private $name;

    /**
     * @MT\GetterAndSetter
     */
    protected $age;
}

Properties can have any combination of access level (public, protected, or private) and accessor methods (getter and/or setter).

ArrayFactoryTrait

This adds a static factory method to allow creating an instance of a model with a map of property names to values. It does assume that any exhibiting model does not require custom arguments in its constructor. This will allow setting private properties during creation.

Example:

use AC\ModelTraits\GetterSetterTrait
use AC\ModelTraits\ArrayFactoryTrait;

class MyModel
{
    use ArrayFactoryTrait, GetterSetterTrait;

    private $id;
    protected $name;
    protected $description;
}

$m = MyModel::createFromArray([
    'id' => 5,
    'name' => 'John',
    'age' => 23
]);

echo $m->getId();       //5
echo $m->getName();     //John
echo $m->getAge();      //23