Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/butschster/entity-faker
Create fake entities based on your classes
https://github.com/butschster/entity-faker
entity-generator faker php
Last synced: about 2 months ago
JSON representation
Create fake entities based on your classes
- Host: GitHub
- URL: https://github.com/butschster/entity-faker
- Owner: butschster
- License: mit
- Created: 2021-07-15T13:19:00.000Z (over 3 years ago)
- Default Branch: 1.0
- Last Pushed: 2022-07-13T20:13:33.000Z (over 2 years ago)
- Last Synced: 2024-10-08T02:51:52.477Z (3 months ago)
- Topics: entity-generator, faker, php
- Language: PHP
- Homepage:
- Size: 44.9 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fake entities generator
[](https://patreon.com/butschster)
[](https://packagist.org/packages/butschster/entity-faker)
[](https://github.com/butschster/entity-faker/actions/workflows/php.yml)
[](https://packagist.org/packages/butschster/entity-faker)
[](https://packagist.org/packages/butschster/entity-faker)
This package will help you generate fake entities and persist them to your ORM.
```php
id = $id;
$this->username = $username;
$this->email = $email;
}
}
class SuperUser extends User
{
private bool $isAdmin = false;
public function __construct(string $id, string $username, string $email, bool $isAdmin)
{
parent::__construct($id, $username, $email);
$this->isAdmin = $isAdmin;
}
}
$factory->define(User::class, function (Faker $faker, array $attributes) {
return [
'id' => $faker->uuid,
'username' => $faker->username,
'email' => $faker->email
];
});
$factory->define(SuperUser::class, function (Faker $faker, array $attributes) use($factory) {
$userAttributes = $factory->raw(User::class);
return $userAttributes + [
'isAdmin' => $faker->boolean
];
});
```
### Create and persist an entity
```php
$user = $factory->of(User::class)->create();
//class User {
// private string $id = "0b13e52d-b058-32fb-8507-10dec634a07c";
// private string $username = "zetta86";
// private string $email = "[email protected]";
//}
```
### Create and persist multiply entities
```php
$users = $factory->of(User::class)->times(10)->create();
//[
// class User {
// private string $id = "0b13e52d-b058-32fb-8507-10dec634a07c";
// private string $username = "zetta86";
// private string $email = "[email protected]";
// },
// ...
//]
```
### Create and persist an entity with predefined attributes
```php
$user = $factory->of(User::class)->create([
'email' => '[email protected]'
]);
//class User {
// private string $id = "0b13e52d-b058-32fb-8507-10dec634a07c";
// private string $username = "zetta86";
// private string $email = "[email protected]";
//}
```
### Create an entity
```php
$user = $factory->of(User::class)->make();
//class User {
// private string $id = "0b13e52d-b058-32fb-8507-10dec634a07c";
// private string $username = "zetta86";
// private string $email = "[email protected]";
//}
```
### Create multiply entities
```php
$users = $factory->of(User::class)->times(10)->make();
//[
// class User {
// private string $id = "0b13e52d-b058-32fb-8507-10dec634a07c";
// private string $username = "zetta86";
// private string $email = "[email protected]";
// },
// ...
//]
```
### Create an entity with predefined attributes
```php
$user = $factory->of(User::class)->make([
'email' => '[email protected]'
]);
//class User {
// private string $id = "0b13e52d-b058-32fb-8507-10dec634a07c";
// private string $username = "zetta86";
// private string $email = "[email protected]";
//}
```
### Get raw attributes for entity
```php
$attributes = $factory->of(SuperUser::class)->raw();
//[
// 'id' => "0b13e52d-b058-32fb-8507-10dec634a07c",
// 'username' => 'zetta86',
// 'email' => '[email protected]',
//]
```
### Get raw attributes for entity with predefined values
```php
$attributes = $factory->of(SuperUser::class)->raw([
'email' => '[email protected]'
]);
//[
// 'id' => "0b13e52d-b058-32fb-8507-10dec634a07c",
// 'username' => 'zetta86',
// 'email' => '[email protected]',
//]
```
### Generate array of all defined entities
```php
$repository = $factory->make(1000);
$seeds = $repository->get(User::class)->random(100);
$seeds = $repository->get(SuperUser::class)->take(50);
```
### Generate array of raw data for all defined entities
```php
$repository = $factory->raw(1000);
$seeds = $repository->get(User::class)->random(100);
$seeds = $repository->get(SuperUser::class)->take(50);
```
### Export array of raw data to a file for given entity to php file
```php
$path = $factory->of(SuperUser::class)->times(1000)->export('path/to/store');
// path/to/store/SuperUser.php
```
### Export array of raw data to a files for all defined entities
```php
$repository = $factory->export('path/to/store', 1000);
$seeds = $repository->get(User::class)->random(100);
```
#### Custom entity builder
You can define your own EntityBuilder class with custom persist logic.
```php
use Butschster\EntityFaker\EntityFactoryInterface;
use Faker\Factory as Faker;
use Cycle\ORM\ORMInterface;
use Cycle\ORM\TransactionInterface;
class CycleOrmEntityFactory implements EntityFactoryInterface
{
private array $afterCreation = [];
private array $beforeCreation = [];
protected ORMInterface $orm;
protected Transaction $transaction;
public function __construct(ORMInterface $orm)
{
$this->orm = $orm;
$this->beforeCreation(function () {
$this->transaction = new Transaction($this->orm);
});
$this->afterCreation(function () {
$this->transaction->run();
});
}
public function store(object $entity): void
{
$this->transaction->persist($entity);
}
public function hydrate(object $entity, array $data): object
{
return $this->orm->getMapper($entity)->hydrate($entity, $data);
}
/**
* Add a callback to run after creating an entity or array of entities.
* @param callable $callback
*/
public function afterCreation(callable $callback): void
{
$this->afterCreation[] = $callback;
}
public function afterCreationCallbacks(): array
{
return $this->afterCreation;
}
/**
* Add a callback to run before creating an entity or array of entities.
* @param callable $callback
*/
public function beforeCreation(callable $callback): void
{
$this->beforeCreation[] = $callback;
}
public function beforeCreationCallbacks(): array
{
return $this->beforeCreation;
}
}
$factory = new \Butschster\EntityFaker\Factory(
new CycleOrmEntityFactory(...),
Faker::create()
);
```