Alice - Expressive fixtures generator
Relying on fzaninotto/Faker, Alice allows you to create a ton of fixtures/fake data for use while developing or testing your project. It gives you a few essential tools to make it very easy to generate complex data with constraints in a readable and easy to edit way, so that everyone on your team can tweak the fixtures if needed.
Warning: this doc is for alice 3.0. If you want to check the documentation for 2.x, head here.
2.x is in maintenance mode: PRs are accepted, but no active development is done on it by the maintainers any longer.
Table of Contents
- Installation
- Example
- Getting Started
- Complete Reference
- Handling Relations
- Keep Your Fixtures Dry
- Customize Data Generation
- Advanced Guide
- Third-party libraries
- Contribute
- Backward Compatibility Promise (BCP)
- Upgrade
Installation
This is installable via Composer as nelmio/alice:
composer require --dev nelmio/alice
Example
Here is a complete example of entity declaration:
Nelmio\Entity\User:
user{1..10}:
username: '<username()>'
fullname: '<firstName()> <lastName()>'
birthDate: '<date_create()>'
email: '<email()>'
favoriteNumber: '50%? <numberBetween(1, 200)>'
Nelmio\Entity\Group:
group1:
name: Admins
owner: '@user1'
members: '<numberBetween(1, 10)>x @user*'
created: '<dateTimeBetween("-200 days", "now")>'
updated: '<dateTimeBetween($created, "now")>'
You can then load them easily with:
$loader = new Nelmio\Alice\Loader\NativeLoader();
$objectSet = $loader->loadFile(__DIR__.'/fixtures.yml');
Or load an array right away:
$loader = new Nelmio\Alice\Loader\NativeLoader();
$objectSet = $loader->loadData([
\Nelmio\Entity\User::class => [
'user{1..10}' => [
'username' => '<username()>',
'fullname' => '<firstName()> <lastName()>',
'birthDate' => '<date_create()>',
'email' => '<email()>',
'favoriteNumber' => '50%? <numberBetween(1, 200)>',
],
],
\Nelmio\Entity\Group::class => [
'group1' => [
'name' => 'Admins',
'owner' => '@user1',
'members' => '<numberBetween(1, 10)>x @user*',
'created' => '<dateTimeBetween("-200 days", "now")>',
'updated' => '<dateTimeBetween($created, "now")>',
],
],
]);
For more information, refer to the documentation.
Third-party libraries
Framework Agnostic
Symfony
Nette
Zend Framework 2:
Contribute
Check the contribution guide.
Backward Compatibility Promise (BCP)
The policy is for the major part following the same as Symfony's one with a few changes or highlights:
- Code marked with
@private
or@internal
are excluded from the BCP Nelmio\Alice\Loader\NativeLoader
is excluded from the BCP: as it is the no DIC solution, registring a new service may require a new method, in which case your code may break if you have already declared that method. To avoid that, please beware of the naming of your methods to avoid any conflicts.
Upgrade
Check the upgrade guide.