Download the PHP package vcn/symfony-autofactory without Composer

vcn/symfony-autofactory

vcn/symfony-autofactory makes it easy to define service factory classes for Symfony.

Usage

Please make sure you have a good understanding of how dependency injection works in Symfony. You can find their documentation here.

To start using vcn/symfony-autofactory, the easiest approach is to install the vcn/symfony-autofactory-bundle. If you ensure all AutoFactory-instances are autoconfigured, the rest will work automatically.

If you do not want to use the bundle, you need to:

• add the AutoFactoryPass to your kernel compiler passes
• ensure that your AutoFactory-instances all have the tag you configured in the AutoFactoryPass

Usage

Basic usage

To create an AutoFactory, create a class that implements the AutoFactory interface. For a class method to be considered a factory it MUST be public, it MUST be static, and it MUST define a class return type.

Configuration

The factories can be fine tuned using annotations.

@​Alias

The concept of aliases is demonstrated here in the Symfony documentation. You can add one or more aliases to your dependency by adding one or more @Alias-annotations to your factory method. The annotation MUST receive two named arguments: id: string and public: bool. The names are self-explanatory.

@​Autoconfigure

The concept of autoconfiguration is explained here in the Symfony documentation. By default, factories are autoconfigured. You can change this at class-level and at method-level with the @Autoconfigure-annotation. The annotation takes one unnamed boolean parameter.

@​Autowire

The concept of autowiring is explained here and here in the Symfony documentation. By default, factories are autowired. You can change this at class-level and at method-level with the @Autowire-annotation. The annotation takes one unnamed boolean parameter.

@​Bind

The concept of binding arguments is explained here in the Symfony documentation. To bind parameters of a factory method to a dependency specified by id, you can use the @Bind-annotation. The annotation MUST receive two named arguments: arg: string and id: string. The value for arg refers to the name of the argument of the factory method being bound, and should include the leading dollar-sign. The id should refer to a valid service id.

@​Id

The concept of ids is hinted at here in the Symfony documentation. When no @Id-annotation is used, the fully-qualified class name of the dependency is used as id. You can override this with the @Id-annotation. The annotation MUST receive one unnamed string argument, containing the id to set. Having two or more @Id-annotations is not possible. For the use cases where a dependency should be adressable with multiple ids, please use the @Alias-annotation.

@​IsPublic

The concept of publicness is explained here in the Symfony documentation. By default, factories are not public. You can change this at class-level and at method-level with the @IsPublic-annotation. The annotation MUST received one unnamed boolean argument.

@​Tag

The concept of tags is explained here in the Symfony documentation. You can add one or more @Tag-annotations to any factory method. Every @Tag-annotation MUST have one unnamed string argument defining the name, and MAY have more named arguments defining additional tag attributes.

Examples

Examples can be found in the examples-directory.