Download the PHP package natitech/builder-generator without Composer

Builder generator

PHP standalone library to generate a builder pattern from a class.

Installation

By using composer on your project or globally

Usage

You can use the binary to generate a builder near a class :

OR you can use it inside another PHP script :

What will be generated

This will generate a builder class aside the built class.

Example :

The builder class may need to receive updates on codestyle, faker usages, infered types, namespace, etc. Also, to avoid producing unused code, there are no setters for builder properties. Your IDE should be able to easily fix all of that.

The generator will try to detect property types (php types, phpdoc types, doctrine orm attributes or annotations) and will try to detect the appropriate faker method based on the type and the name of the properties.

Faker

You can use the --faker option to try to set the most relevant values. In that case, Faker will be used as a dependency of the builder class.

Build strategies

There are many strategies to build a class : public properties, setter (fluent or not), constructor. A brief explanation on each strategies is given below, but you might prefer read unit tests to fully understand them.

By default, the generator will try to detect the most used strategy inside the built class and will use it for the entire builder class. If you are using setters on all properties but one, the generator will use setters on properties that support it and ignore the property that does not.

But you can also explictly pass a strategy using the '--strategy' option.

Public strategy

When properties are public. See example above.

Constructor strategy

When properties are protected/private and set inside the __construct method.

Setter strategy

When properties are protected/private but can be set using public setters. The setters can be fluent or not.

Build method strategy

This is a less conventionnal way to build a class. In that case, properties are protected/private and set by public domain methods. So, there is no easy way to set the built class in a certain state. If, for test purposes, you want to be able to quickly set the state of that object properties by properties, a solution is to add a static build() method in the built class.

Custom strategy / contributions

To create a custom strategy :

• you need to implement
  and add it to . This will decide HOW properties are built.
• you also need to complete . This will decide WHEN properties could be built with this strategy.

IDE / PHPStorm

You can use this tool as an external tool in your IDE.

For PHPStorm user, see https://www.jetbrains.com/help/phpstorm/configuring-third-party-tools.html. Example configuration :

• Name : Generate builder
• Description : Generate a builder class from a PHP class
• Program : /path/to/your/home/.composer/vendor/bin/generate-builder
• Arguments : $FilePath$
• Working directory : $FileDir$