https://github.com/ekvedaras/class-factory
🏭 Factory for creating objects via constructor arguments
https://github.com/ekvedaras/class-factory
class entities factory php value-objects
Last synced: about 1 year ago
JSON representation
🏭 Factory for creating objects via constructor arguments
- Host: GitHub
- URL: https://github.com/ekvedaras/class-factory
- Owner: ekvedaras
- License: mit
- Created: 2022-08-30T17:25:48.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T22:34:06.000Z (almost 2 years ago)
- Last Synced: 2024-08-09T05:14:07.548Z (almost 2 years ago)
- Topics: class, entities, factory, php, value-objects
- Language: PHP
- Homepage:
- Size: 78.1 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Factory for creating objects via constructor arguments
[](https://packagist.org/packages/ekvedaras/class-factory)
[](https://github.com/ekvedaras/class-factory/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/ekvedaras/class-factory)
A factory class that passes each property directly to constructor.
This way your class does not need to deal with received array to create itself from and there is no reflection magic involved.
This is mostly useful for creating plain classes like value objects, entities, DTOs, etc.
## Installation
You can install the package via composer:
```bash
composer require --dev ekvedaras/class-factory
```
## PhpStorm plugin
Provides autocomplete and refactoring capabillities for PhpStorm.
* Plugin: [ClassFactory](https://plugins.jetbrains.com/plugin/19824-classfactory)
* Repository: [class-factory-phpstorm](https://github.com/ekvedaras/class-factory-phpstorm)
## Usage
```php
use EKvedaras\ClassFactory\ClassFactory;
use EKvedaras\ClassFactory\ClosureValue;
class Account {
public function __construct(
public readonly int $id,
public string $name,
public array $orders,
public \Closure $monitor,
) {
}
}
/** @extends ClassFactory */
class AccountFactory extends ClassFactory {
protected string $class = Account::class;
protected function definition(): array
{
return [
'id' => 1,
'name' => 'John Doe',
'orders' => [
OrderFactory::new()->state(['id' => 1]),
OrderFactory::new()->state(['id' => 2]),
],
'monitor' => new ClosureValue(fn () => true),
];
}
public function johnSmith(): static
{
return $this->state([
'id' => 2,
'name' => 'John Smith',
]);
}
}
$account = AccountFactory::new()
->johnSmith() // Can use predefiened states
->state(['name' => 'John Smitgh Jnr']) // Can override factory state on the fly
->state(['name' => fn (array $attributes) => "{$attributes['name']}."]) // Can use closures and have access to already defined attributes
->state(function (array $attributes) { // Can use closures and modify state of multiple attributes by returning an array
$id = $attributes['id'] + 1;
return ['id' => $id];
})
->after(fn (Account $account) => sort($account->orders)) // Can modify constructed object after it was created
->state(['monitor' => new ClosureValue(fn () => false)]) // Can set state of closure type properties using `ClosureValue` wrapper
->make(['id' => 3]) // Can provide final modifications and return the new object
```
### Customising class creation
If you don't want class to be created by directly passing attributes to constructor, you can override `newInstance` method in the factory and do change the behavior.
```php
protected function newInstance(array $properties): object
{
return Account::makeUsingProperties($properties);
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Ernestas Kvedaras](https://github.com/ekvedaras)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.