runopencode/abstract-builder

Simple prototype class for implementing builder pattern.

1.0.6 2017-03-24 07:26 UTC

Requires

• php: >=7.0
• roave/security-advisories: dev-master

Requires (Dev)

• escapestudios/symfony2-coding-standard: ~2.0
• pdepend/pdepend: ~2.5
• phploc/phploc: dev-master
• phpmd/phpmd: @stable
• phpunit/phpunit: ~6.0
• sebastian/phpcpd: dev-master
• squizlabs/php_codesniffer: ~2.0
• theseer/phpdox: dev-master

MIT

• RunOpenCode members
• Nikola Svitlica a.k.a TheCelavi

• builder
• design pattern
• abstract builder

README

If you intend to use builder pattern in your project (see article on Wikipedia) you can use a prototype implementation of builder pattern from this library.

In order to do so, you have to create your own builder class, extend RunOpenCode\AbstractBuilder\AbstractBuilder and implement methods configureParameters and getObjectFqcn.

For those extra lazy developers, there is a RunOpenCode\AbstractBuilder\ReflectiveAbstractBuilder as well, which implements configureParameters method by introspecting constructor parameters and default values.

NOTE: Builder class MUST NOT validate provided parameters. Class which ought to be builded must do such validation, because construction process of any instance of any class must be valid whether is executed with or without builder implementation.

Implementation example

Let's say that we have some class Message for which we have to provide a builder class. Here is how to do so:

<?php

class Message
{
    private $id;
    private $message;
    private $timestamp;

    public function __construct($id, $message, $timestamp)
    {
        $this->id = $id;
        $this->message = $message;
        $this->timestamp = $timestamp;
    }
}

final class MessageBuilder extends \RunOpenCode\AbstractBuilder\AbstractBuilder
{
    /**
     * Get builded message.
     *
     * Alias to \RunOpenCode\AbstractBuilder\AbstractBuilder::build() method.
     *
     * @see \RunOpenCode\AbstractBuilder\AbstractBuilder::build()
     *
     * @return object
     */
    public function getMessage()
    {
        return $this->build();
    }

    /**
     * {@inheritdoc}
     */
    protected function configureParameters()
    {
        return array(
            'id' => null,
            'message' => null,
            'timestamp' => new \DateTime('now')
        );
    }

    /**
     * {@inheritdoc}
     */
    protected function getObjectFqcn()
    {
        return Message::class;
    }
}

Builder usage example

Start with creating a builder, you can use plain constructor:

$builder = new MessageBuilder();

or you can use a static method for that:

$builder = MessageBuilder::create();

You can get/set each individual configured builder property via:

Property access:

$builder->id = 1;
$id = $builder->id;

Setter method:

$builder->setId(1);
$id = $builder->getId();

Array access:

$builder['id'] = 1;
$id = $builder['id'];

Multiple properties, via array:

$builder->fromArray([ 'id' => 1, 'message' => 'Some message' ]);
$allProperties = $builder->toArray();
$someProperties = $builder->toArray([ 'id', 'message' ]);

And finaly, you can build conrete object by calling build() method, or invoking builder as method:

$message = $builder->build();
$message = $builder();

Chaining (fluent interface)

Fluent interface is supported for setter methods, so you can chain them, example:

$message = MessageBuilder::create()
                ->setId(1)
                ->setMessage('Some message')
                ->setTimestamp(new \DateTime('now'))
                ->build();