Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ergebnis/factory-bot
🤖 Provides a composer package with a fixture factory for doctrine/orm entities.
https://github.com/ergebnis/factory-bot
doctrine entity factory fixture orm
Last synced: 4 days ago
JSON representation
🤖 Provides a composer package with a fixture factory for doctrine/orm entities.
- Host: GitHub
- URL: https://github.com/ergebnis/factory-bot
- Owner: ergebnis
- License: mit
- Created: 2020-03-08T10:10:08.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-08T16:21:43.000Z (15 days ago)
- Last Synced: 2025-01-13T01:03:21.865Z (11 days ago)
- Topics: doctrine, entity, factory, fixture, orm
- Language: PHP
- Size: 5.28 MB
- Stars: 79
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# factory-bot
[](https://github.com/ergebnis/factory-bot/actions)
[](https://github.com/ergebnis/factory-bot/actions)
[](https://github.com/ergebnis/factory-bot/actions)
[](https://github.com/ergebnis/factory-bot/actions)
[](https://codecov.io/gh/ergebnis/factory-bot)
[](https://shepherd.dev/github/ergebnis/factory-bot)
[](https://packagist.org/packages/ergebnis/factory-bot)
[](https://packagist.org/packages/ergebnis/factory-bot)
[](https://packagist.org/packages/ergebnis/factory-bot)
This project provides a [`composer`](https://getcomposer.org) package with a fixture factory for [`doctrine/orm`](https://github.com/doctrine/orm) entities.
## Installation
Run
```sh
composer require --dev ergebnis/factory-bot
```
## Usage
The entry point of `ergebnis/factory-bot` is the [`FixtureFactory`](src/FixtureFactory.php).
You will use the fixture factory to create entity definitions and to create Doctrine entities populated with fake data.
- [Examples](#examples)
- [Creating a fixture factory](#creating-a-fixture-factory)
- [Creating entity definitions](#creating-entity-definitions)
- [Loading entity definitions](#loading-entity-definitions)
- [Registering entity definitions](#registering-entity-definitions)
- [Creating entities](#creating-entities)
- [Persisting entities](#persisting-entities)
- [Flushing entities](#flushing-entities)
### Examples
You can find examples in
- the directory [`example/`](example/)
- the repository [`ergebnis/factory-bot-example`](https://github.com/ergebnis/factory-bot-example)
### Creating a fixture factory
The fixture factory requires an instance of `Doctrine\ORM\EntityManagerInterface` (for reading class metadata from Doctrine entities, and for persisting Doctrine entities when necessary) and an instance of `Faker\Generator` for generating fake data.
```php
seed(9001);
return $faker;
}
final protected static function fixtureFactory(): FactoryBot\FixtureFactory
{
$fixtureFactory = new FactoryBot\FixtureFactory(
static::entityManager(),
static::faker()
);
// create or load entity definitions
return $fixtureFactory;
}
}
```
### Creating entity definitions
Now that you have access to a fixture factory, you can create definitions for Doctrine entities.
```php
define(Entity\User::class);
```
This simple definition might work when all entity fields have default values, but typically, you will want to provide a map of entity field names to field definitions.
```php
define(Entity\User::class, [
'avatar' => FactoryBot\FieldDefinition::reference(Entity\Avatar::class),
'id' => FactoryBot\FieldDefinition::closure(static function (Generator $faker): string {
return $faker->uuid;
}),
'location' => FactoryBot\FieldDefinition::optionalClosure(static function (Generator $faker): string {
return $faker->city;
}),
'login' => FactoryBot\FieldDefinition::closure(static function (Generator $faker): string {
return $faker->userName;
}),
]);
```
In addition to the map of field names to field definitions, you can specify a closure that the fixture factory will invoke after creating the entity. The closure accepts the freshly created entity and the map of field names to field values that the fixture factory used to populate the entity.
```php
define(
Entity\User::class,
[
'avatar' => FactoryBot\FieldDefinition::reference(Entity\Avatar::class),
'id' => FactoryBot\FieldDefinition::closure(static function (Generator $faker): string {
return $faker->uuid;
}),
'location' => FactoryBot\FieldDefinition::optionalClosure(static function (Generator $faker): string {
return $faker->city;
}),
'login' => FactoryBot\FieldDefinition::closure(static function (Generator $faker): string {
return $faker->userName;
}),
],
static function (Entity\User $user, array $fieldValues): void {
if (is_string($fieldValues['location')) {
// ...
}
}
);
```
#### Field Definitions
A field definition can be
- an implementation of [`FieldDefinition\Resolvable`](src/FieldDefinition/Resolvable.php)
- a closure (will be normalized to [`FieldDefinition\Closure`](src/FieldDefinition/Closure.php))
- an arbitrary value (will be normalized to [`FieldDefinition\Value`](src/FieldDefinition/Value.php))
You can use the [`FieldDefinition`](src/FieldDefinition.php) factory to create field definitions shipped with this package or implement the `FieldDefinition\Resolvable` interface yourself.
:bulb: Custom field definitions can be useful when you are dealing with identical field definitions over and over again.
#### Non-nullable fields
When you are working with non-nullable fields, you can use the following field definitions, all of which will resolve to concrete references or values:
- [`FieldDefinition::closure()`](#fielddefinitionclosure)
- [`FieldDefinition::reference()`](#fielddefinitionreference)
- [`FieldDefinition::references()`](#fielddefinitionreferences)
- [`FieldDefinition::sequence()`](#fielddefinitionsequence)
- [`FieldDefinition::value()`](#fielddefinitionvalue)
#### Nullable fields
When you are working with nullable fields, you can use the following field definitions, all of which will either resolve to `null` or to a concrete reference or value (depending on the [strategy](#creating-entities):
- [`FieldDefinition::optionalClosure()`](#fielddefinitionoptionalclosure)
- [`FieldDefinition::optionalReference()`](#fielddefinitionoptionalreference)
- [`FieldDefinition::optionalSequence()`](#fielddefinitionoptionalsequence)
- [`FieldDefinition::optionalValue()`](#fielddefinitionoptionalvalue)
##### `FieldDefinition::closure()`
`FieldDefinition::closure()` accepts a closure.
```php
define(Entity\User::class, [
'id' => FactoryBot\FieldDefinition::closure(static function (Generator $faker): string {
return $faker->uuid;
}),
'organizations' => FactoryBot\FieldDefinition::closure(static function (Generator $faker, FactoryBot\FixtureFactory $fixtureFactory): array {
return $fixtureFactory->createMany(
Entity\Organization::class,
FactoryBot\Count::exact($faker->numberBetween(
1,
5
))
);
}),
]);
/** @var Entity\User $user */
$user = $fixtureFactory->createOne(Entity\User::class);
var_dump($user->id()); // string
var_dump($user->organizations()); // array with 1-5 instances of Entity\Organization
```
:bulb: It is possible to specify a closure only (will be normalized to `FieldDefinition\Closure`):
```php
define(Entity\User::class, [
'id' => static function (Generator $faker): string {
return $faker->uuid;
},
'organizations' => static function (Generator $faker, FactoryBot\FixtureFactory $fixtureFactory): array {
return $fixtureFactory->createMany(
Entity\Organization::class,
FactoryBot\Count::exact($faker->numberBetween(
1,
5
))
);
},
]);
/** @var Entity\User $user */
$user = $fixtureFactory->createOne(Entity\User::class);
var_dump($user->id()); // string
var_dump($user->organizations()); // array with 1-5 instances of Entity\Organization
```
##### `FieldDefinition::optionalClosure()`
`FieldDefinition::optionalClosure()` accepts a closure.
```php
define(Entity\User::class, [
'location' => FactoryBot\FieldDefinition::optionalClosure(static function (Generator $faker): string {
return $faker->city;
}),
]);
/** @var Entity\User $user */
$user = $fixtureFactory->createOne(Entity\User::class);
var_dump($user->location()); // null or a random city
```
A fixture factory using the [`Strategy\WithOptionalStrategy`](#strategywithoptionalstrategy) will resolve the field definition to the return value of invoking the closure with the instance of `Faker\Generator` composed into the fixture factory.
```php
define(Entity\User::class, [
'location' => FactoryBot\FieldDefinition::optionalClosure(static function (Generator $faker): string {
return $faker->city;
}),
]);
$withOptionalFixtureFactory = $fixtureFactory->withOptional();
/** @var Entity\User $user */
$user = $withOptionalFixtureFactory->createOne(Entity\User::class);
var_dump($user->location()); // a random city
```
A fixture factory using the [`Strategy\WithoutOptionalStrategy`](#strategywithoutoptionalstrategy) will resolve the field definition to `null`.
```php
define(Entity\User::class, [
'location' => FactoryBot\FieldDefinition::optionalClosure(static function (Generator $faker): string {
return $faker->city;
}),
]);
$withoutOptionalFixtureFactory = $fixtureFactory->withoutOptional();
/** @var Entity\User $user */
$user = $withoutOptionalFixtureFactory->createOne(Entity\User::class);
var_dump($user->location()); // null
```
##### `FieldDefinition::reference()`
`FieldDefinition::reference()` accepts the class name of an entity or embeddable, and optionally an array of field definition overrides.
Every fixture factory will resolve the field definition to an instance of the entity or embeddable class populated through the fixture factory.
```php
define(Entity\User::class, [
'avatar' => FactoryBot\FieldDefinition::reference(Entity\Avatar::class),
]);
/** @var Entity\User $user */
$user = $fixtureFactory->createOne(Entity\User::class);
var_dump($user->avatar()); // an instance of Entity\Avatar
```
When field definition overrides are specified, they will be used to override exsting field definitions of the referenced entity.
```php
define(Entity\User::class, [
'avatar' => FactoryBot\FieldDefinition::reference(
Entity\Avatar::class,
[
'height' => 300,
'width' => 200,
]
),
]);
/** @var Entity\User $user */
$user = $fixtureFactory->createOne(Entity\User::class);
var_dump($user->avatar()); // an instance of Entity\Avatar with height set to 300 and width set to 200
```
:exclamation: When resolving the reference, the fixture factory needs to be aware of the referenced entity or embeddable.
##### `FieldDefinition::optionalReference()`
`FieldDefinition::optionalReference()` accepts the class name of an entity or embeddable, and optionally an array of field definition overrides.
A fixture factory using the [`Strategy\DefaultStrategy`](#strategydefaultstrategy) will resolve the field definition to `null` or an instance of the entity or embeddable class populated through the fixture factory.
```php
define(Entity\Repository::class, [
'template' => FactoryBot\FieldDefinition::optionalReference(Entity\Repository::class),
]);
/** @var Entity\Repository $repository */
$repository = $fixtureFactory->createOne(Entity\Repository::class);
var_dump($repository->template()); // null or an instance of Entity\Repository
```
A fixture factory using the [`Strategy\WithOptionalStrategy`](#strategywithoptionalstrategy) will resolve the field definition to an instance of the entity or embeddable class populated through the fixture factory.
```php
define(Entity\Repository::class, [
'template' => FactoryBot\FieldDefinition::optionalReference(Entity\Repository::class),
]);
$withOptionalFixtureFactory = $fixtureFactory->withOptional();
/** @var Entity\Repository $repository */
$repository = $withOptionalFixtureFactory->createOne(Entity\Repository::class);
var_dump($repository->template()); // an instance of Entity\Repository
```
A fixture factory using the [`Strategy\WithoutOptionalStrategy`](#strategywithoutoptionalstrategy) will resolve the field definition to `null`.
```php
define(Entity\Repository::class, [
'template' => FactoryBot\FieldDefinition::optionalReference(Entity\Repository::class),
]);
$withoutOptionalFixtureFactory = $fixtureFactory->withoutOptional();
/** @var Entity\Repository $repository */
$repository = $withoutOptionalFixtureFactory->createOne(Entity\Repository::class);
var_dump($repository->template()); // null
```
:exclamation: When resolving the reference, the fixture factory needs to be aware of the referenced entity or embeddable.
##### `FieldDefinition::references()`
`FieldDefinition::references()` accepts the class name of an entity or embeddable, the count of desired references, and optionally an array of field definition overrides.
You can create the count from an exact number, or minimum and maximum values.
```php
define(Entity\Organization::class, [
'members' => FactoryBot\FieldDefinition::references(
Entity\User::class,
FactoryBot\Count::exact(5)
),
'repositories' => FactoryBot\FieldDefinition::references(
Entity\Repository::class,
FactoryBot\Count::between(0, 20),
[
'codeOfConduct' => null,
]
),
]);
/** @var Entity\Organization $organization */
$organization = $fixtureFactory->createOne(Entity\Organization::class);
var_dump($organization->members()); // array with 5 instances of Entity\User
var_dump($organization->repositories()); // array with 0-20 instances of Entity\Repository
```
A fixture factory using the [`Strategy\WithOptionalStrategy`](#strategywithoptionalstrategy) will resolve the field definition to an array containing at least one instance of the entity or embeddable class populated through the fixture factory, unless `$count` uses an exact value, see [`FixtureFactory::createMany()`](#fixturefactorycreatemany).
```php
define(Entity\Organization::class, [
'members' => FactoryBot\FieldDefinition::references(
Entity\User::class,
FactoryBot\Count::exact(5)
),
'repositories' => FactoryBot\FieldDefinition::references(
Entity\Repository::class,
FactoryBot\Count::between(0, 20)
),
]);
$withOptionalFixtureFactory = $fixtureFactory->withOptional();
/** @var Entity\Organization $organization */
$organization = $withOptionalFixtureFactory->createOne(Entity\Organization::class);
var_dump($organization->members()); // array with 5 instances of Entity\User
var_dump($organization->repositories()); // array with 1-20 instances of Entity\Repository
```
A fixture factory using the [`Strategy\WithoutOptionalStrategy`](#strategywithoutoptionalstrategy) will resolve the field definition to an empty array, unless `$count` uses an exact value, see [`FixtureFactory::createMany()`](#fixturefactorycreatemany).
```php
define(Entity\Organization::class, [
'members' => FactoryBot\FieldDefinition::references(
Entity\User::class,
FactoryBot\Count::exact(5)
),
'repositories' => FactoryBot\FieldDefinition::references(
Entity\Repository::class,
FactoryBot\Count::between(0, 20)
),
]);
$withoutOptionalFixtureFactory = $fixtureFactory->withoutOptional();
/** @var Entity\Organization $organization */
$organization = $withoutOptionalFixtureFactory->createOne(Entity\Organization::class);
var_dump($organization->members()); // array with 5 instances of Entity\User
var_dump($organization->repositories()); // empty array
```
:exclamation: When resolving the references, the fixture factory needs to be aware of the referenced entity or embeddable.
##### `FieldDefinition::sequence()`
`FieldDefinition::sequence()` accepts a string containing the `%d` placeholder at least once and an optional initial number (defaults to `1`).
Every fixture factory will resolve the field definition by replacing all occurrences of the placeholder `%d` in the string with the sequential number's current value. The sequential number will then be incremented by `1` for the next run.
```php
define(Entity\User::class, [
'login' => FactoryBot\FieldDefinition::sequence(
'user-%d',
1
),
]);
/** @var Entity\User $userOne */
$userOne = $fixtureFactory->createOne(Entity\User::class);
/** @var Entity\User $userTwo */
$userTwo = $fixtureFactory->createOne(Entity\User::class);
var_dump($userOne->login()); // 'user-1'
var_dump($userTwo->login()); // 'user-2'
```
##### `FieldDefinition::optionalSequence()`
`FieldDefinition::optionalSequence()` accepts a string containing the `%d` placeholder at least once and an optional initial number (defaults to `1`).
A fixture factory using the [`Strategy\DefaultStrategy`](#strategydefaultstrategy) will resolve the field definition to `null` or by replacing all occurrences of the placeholder `%d` in the string with the sequential number's current value. The sequential number will then be incremented by `1` for the next run.
```php
define(Entity\User::class, [
'location' => FactoryBot\FieldDefinition::optionalSequence(
'City %d',
1
),
]);
/** @var Entity\User $userOne */
$userOne = $fixtureFactory->createOne(Entity\User::class);
/** @var Entity\User $userTwo */
$userTwo = $fixtureFactory->createOne(Entity\User::class);
var_dump($userOne->location()); // null or 'City 1'
var_dump($userTwo->location()); // null or 'City 1' or 'City 2'
```
A fixture factory using the [`Strategy\WithOptionalStrategy`](#strategywithoptionalstrategy) will resolve the field definition by replacing all occurrences of the placeholder `%d` in the string with the sequential number's current value. The sequential number will then be incremented by `1` for the next run.
```php
define(Entity\User::class, [
'location' => FactoryBot\FieldDefinition::optionalSequence(
'City %d',
1
),
]);
$withOptionalFixtureFactory = $fixtureFactory->withOptional();
/** @var Entity\User $userOne */
$userOne = $withOptionalFixtureFactory->createOne(Entity\User::class);
/** @var Entity\User $userTwo */
$userTwo = $withOptionalFixtureFactory->createOne(Entity\User::class);
var_dump($userOne->location()); // 'City 1'
var_dump($userTwo->location()); // 'City 2'
```
A fixture factory using the [`Strategy\WithoutOptionalStrategy`](#strategywithoutoptionalstrategy) will resolve the field definition to `null`.
```php
define(Entity\User::class, [
'location' => FactoryBot\FieldDefinition::optionalSequence(
'City %d',
1
),
]);
$withOptionalFixtureFactory = $fixtureFactory->withOptional();
/** @var Entity\User $userOne */
$userOne = $withOptionalFixtureFactory->createOne(Entity\User::class);
/** @var Entity\User $userTwo */
$userTwo = $withOptionalFixtureFactory->createOne(Entity\User::class);
var_dump($userOne->location()); // null
var_dump($userTwo->location()); // null
```
##### `FieldDefinition::value()`
`FieldDefinition::value()` accepts an arbitrary value.
The fixture factory will resolve the field definition to the value.
```php
define(Entity\User::class, [
'login' => FactoryBot\FieldDefinition::value('localheinz'),
]);
/** @var Entity\User $user */
$user = $fixtureFactory->createOne(Entity\User::class);
var_dump($user->login()); // 'localheinz'
```
:bulb: It is also possible to specify a value only:
```php
define(Entity\User::class, [
'login' => 'localheinz',
]);
/** @var Entity\User $user */
$user = $fixtureFactory->createOne(Entity\User::class);
var_dump($user->login()); // 'localheinz'
```
##### `FieldDefinition::optionalValue()`
`FieldDefinition::optionalValue()` accepts an arbitrary value.
A fixture factory using the [`Strategy\DefaultStrategy`](#strategydefaultstrategy) will resolve the field definition to `null` or the value.
```php
define(Entity\User::class, [
'location' => FactoryBot\FieldDefinition::optionalValue('Berlin'),
]);
/** @var Entity\User $user */
$user = $fixtureFactory->create(Entity\User::class);
var_dump($user->location()); // null or 'Berlin'
```
A fixture factory using the [`Strategy\WithOptionalStrategy`](#strategywithoptionalstrategy) will resolve the field definition to the value.
```php
define(Entity\User::class, [
'location' => FactoryBot\FieldDefinition::optionalValue('Berlin'),
]);
$withOptionalFixtureFactory = $fixtureFactory->withOptional();
/** @var Entity\User $user */
$user = $withOptionalFixtureFactory->create(Entity\User::class);
var_dump($user->location()); // 'Berlin'
```
A fixture factory using the [`Strategy\WithoutOptionalStrategy`](#strategywithoutoptionalstrategy) will resolve the field definition to `null`.
```php
define(Entity\User::class, [
'location' => FactoryBot\FieldDefinition::optionalValue('Berlin'),
]);
$withoutOptionalFixtureFactory = $fixtureFactory->withoutOptional();
/** @var Entity\User $user */
$user = $withoutOptionalFixtureFactory->create(Entity\User::class);
var_dump($user->location()); // null
```
### Loading entity definitions
Instead of creating entity definitions inline, you can implement the [`EntityDefinitionProvider`](src/EntityDefinitionProvider.php) interface and load entity definitions contained within a directory with the fixture factory.
First, create concrete definition providers.
```php
define(Entity\User::class, [
// ...
]);
}
}
```
:bulb: While you can use a single entity definition provider to provide definitions for all entities, I recommend using one definition provider per entity. Then you can quickly implement an [auto-review test](example/test/AutoReview/FixtureTest.php) to enforce that an entity definition provider exists for each entity.
Second, adjust your abstract test case to load definitions from entity definition providers contained in a directory.
```php
load(__DIR__ . '/../Fixture');
return $fixtureFactory;
}
// ...
}
```
### Registering entity definitions
Instead of loading entity definition providers contained within a directory with the fixture factory, you can also register entity definition providers that you have already instantiated.
```php
register(new Fixture\UserDefinitionProvider());
return $fixtureFactory;
}
// ...
}
```
### Creating entities
Now that you have created (or loaded) entity definitions, you can create Doctrine entities populated with fake data.
The fixture factory allows to create entities using the following strategies:
[`Strategy\DefaultStrategy`](#strategydefaultstrategy)
[`Strategy\WithOptionalStrategy`](#strategywithoptionalstrategy)
[`Strategy\WithoutOptionalStrategy`](#strategywithoutoptionalstrategy)
#### `Strategy\DefaultStrategy`
The `Strategy\DefaultStrategy` involves random behavior, and based on randomness, the fixture factory might or might not resolve optional field references:
- [`FieldDefinition::optionalClosure()`](#fielddefinitionoptionalclosure) might be resolved to `null` or a concrete value
- [`FieldDefinition::optionalReference()`](#fielddefinitionoptionalreference) might be resolved to `null` or a concrete reference
- [`FieldDefinition::optionalSequence()`](#fielddefinitionoptionalsequence) might be resolved to `null` or a concrete value
- [`FieldDefinition::optionalValue()`](#fielddefinitionoptionalvalue) might be resolved to `null` or a concrete value
- [`FieldDefinition::references()`](#fielddefinitionreferences) might be resolved to an `array` of zero or more references
The fixture factory uses the `Strategy\DefaultStrategy` by default.
#### `Strategy\WithOptionalStrategy`
The `Strategy\WithOptionalStrategy` involves random behavior, but the fixture factory will resolve optional field references:
- [`FieldDefinition::optionalClosure()`](#fielddefinitionoptionalclosure) will be resolved to a concrete value
- [`FieldDefinition::optionalReference()`](#fielddefinitionoptionalreference) will be resolved to a concrete reference
- [`FieldDefinition::optionalSequence()`](#fielddefinitionoptionalsequence) will be resolved to a concrete value
- [`FieldDefinition::optionalValue()`](#fielddefinitionoptionalvalue) will be resolved to a concrete value
- [`FieldDefinition::references()`](#fielddefinitionreferences) will be resolved to an `array` containing at least one reference, unless `$count` uses an exact value, see [`FixtureFactory::createMany()`](#fixturefactorycreatemany)
To create a fixture factory using the `Strategy\WithOptionalStrategy` out of an available fixture factory, invoke `withOptional()`:
```php
withOptional();
```
#### `Strategy\WithoutOptionalStrategy`
The `Strategy\WithoutOptionalStrategy` involves random behavior, but the fixture factory will not resolve optional field references:
- [`FieldDefinition::optionalClosure()`](#fielddefinitionoptionalclosure) will be resolved to `null`
- [`FieldDefinition::optionalReference()`](#fielddefinitionoptionalreference) will be resolved to `null`
- [`FieldDefinition::optionalSequence()`](#fielddefinitionoptionalsequence) will be resolved to `null`
- [`FieldDefinition::optionalValue()`](#fielddefinitionoptionalvalue) will be resolved to `null`
- [`FieldDefinition::references()`](#fielddefinitionreferences) will be resolved to an empty `array`, unless `$count` uses an exact value, see [`FixtureFactory::createMany()`](#fixturefactorycreatemany)
To create a fixture factory using the `Strategy\WithoutOptionalStrategy` out of an available fixture factory, invoke `withoutOptional()`:
```php
withoutOptional();
```
#### `FixtureFactory::createOne()`
`FixtureFactory::createOne()` accepts the class name of an entity and optionally, a map of entity field names to field definitions that should override the field definitions for that specific entity.
The fixture factory will return a single entity.
```php
define(Entity\User::class, [
'login' => FactoryBot\FieldDefinition::closure(static function (Generator $faker): string {
return $faker->userName;
}),
]);
/** @var Entity\User $userOne */
$userOne = $fixtureFactory->createOne(Entity\User::class);
/** @var Entity\User $userTwo */
$userTwo = $fixtureFactory->createOne(Entity\User::class, [
'login' => FactoryBot\FieldDefinition::value('localheinz'),
]);
/** @var Entity\User $userThree */
$userThree = $fixtureFactory->createOne(Entity\User::class, [
'login' => 'ergebnis-bot',
]);
var_dump($userOne->login()); // random user name
var_dump($userTwo->login()); // 'localheinz'
var_dump($userThree->login()); // 'ergebnis-bot'
```
A field definition override can be
- an implementation of [`FieldDefinition\Resolvable`](src/FieldDefinition/Resolvable.php)
- a closure (will be normalized to `FieldDefinition\Closure`)
- an arbitrary value (will be normalized to `FieldDefinition\Value`)
Also see [Creating entity definitions](#creating-entity-definitions).
#### `FixtureFactory::createMany()`
`FixtureFactory::createMany()` accepts the class name of an entity, the count of desired entities, and an optional map of entity field names to field definitions that should override the field definitions for that specific entity.
You can create the count from an exact number:
```php
define(Entity\User::class, [
'login' => FieldDefinition\Closure(static function (Generator $faker): string {
return $faker->username;
}),
]);
/** @var array $users */
$users = $fixtureFactory->createMany(
Entity\User::class,
FactoryBot\Count::exact(5)
);
/** @var array $otherUsers */
$otherUsers = $fixtureFactory->createMany(
Entity\User::class,
FactoryBot\Count::exact(5),
[
'login' => FactoryBot\FieldDefinition::sequence('user-%d'),
]
);
$normalize = static function (array $users): array {
return array_map(static function (Entity\User $user): string {
return $user->login();
}, $users);
};
var_dump($normalize($users)); // random user names
var_dump($normalize($otherUsers)); // 'user-1', 'user-2', ...
```
A field definition override can be
- an implementation of [`FieldDefinition\Resolvable`](src/FieldDefinition/Resolvable.php)
- a closure (will be normalized to `FieldDefinition\Closure`)
- an arbitrary value (will be normalized to `FieldDefinition\Value`)
Also see [Creating entity definitions](#creating-entity-definitions).
### Persisting entities
When the fixture factory creates entities, the fixture factory does not persist them by default.
To create a fixture factory that persists entities out of an available fixture factory, invoke `persisting()`:
```php
persisting();
```
After this point, the fixture factory will automatically persist every entity it creates.
:exclamation: You need to flush the entity manager yourself.
### Flushing entities
The fixture factory will not flush the entity manager - you need to flush it yourself.
## Changelog
The maintainers of this project record notable changes to this project in a [changelog](CHANGELOG.md).
## Contributing
The maintainers of this project suggest following the [contribution guide](.github/CONTRIBUTING.md).
## Code of Conduct
The maintainers of this project ask contributors to follow the [code of conduct](https://github.com/ergebnis/.github/blob/main/CODE_OF_CONDUCT.md).
## General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by [sponsoring @localheinz](https://github.com/sponsors/localheinz) or [requesting an invoice for services related to this project](mailto:[email protected]?subject=ergebnis/factory-bot:%20Requesting%20invoice%20for%20services).
## PHP Version Support Policy
This project supports PHP versions with [active and security support](https://www.php.net/supported-versions.php).
The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.
## Security Policy
This project has a [security policy](.github/SECURITY.md).
## License
This project uses the [MIT license](LICENSE.md).
## Credits
This project is based on [`breerly/factory-girl-php@0e6f1b6`](https://github.com/GoodPete/factory-girl-php/tree/0e6f1b6724d39108a2e7cef68a74668b7a77b856) (originally licensed under MIT by [Grayson Koonce](https://github.com/unhashable)), which is based on [`xi/doctrine`](https://github.com/xi-project/xi-doctrine) (originally licensed under MIT by [Xi](https://github.com/xi-project)), which in turn provided a port of [`factory_bot`](https://github.com/thoughtbot/factory_girl) (originally licensed under MIT by [Joe Ferris](https://github.com/jferris) and [thoughtbot, Inc.](https://github.com/thoughtbot)).
## Social
Follow [@localheinz](https://twitter.com/intent/follow?screen_name=localheinz) and [@ergebnis](https://twitter.com/intent/follow?screen_name=ergebnis) on Twitter.