https://github.com/dotkernel/dot-data-fixtures
Provide a CLI to allow fixtures
https://github.com/dotkernel/dot-data-fixtures
Last synced: 8 months ago
JSON representation
Provide a CLI to allow fixtures
- Host: GitHub
- URL: https://github.com/dotkernel/dot-data-fixtures
- Owner: dotkernel
- License: mit
- Created: 2022-08-22T09:22:44.000Z (over 3 years ago)
- Default Branch: 1.0
- Last Pushed: 2025-02-28T05:41:23.000Z (10 months ago)
- Last Synced: 2025-05-04T18:51:29.571Z (8 months ago)
- Language: PHP
- Homepage: https://docs.dotkernel.org/dot-data-fixtures/
- Size: 121 KB
- Stars: 7
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# dot-data-fixtures
`dot-data-fixtures` provides a CLI interface for interacting with doctrine/data-fixtures.
> dot-data-fixtures is a wrapper on top of [doctrine/data-fixtures](https://github.com/doctrine/data-fixtures)
## Documentation
Documentation is available at: https://docs.dotkernel.org/dot-data-fixtures/.
## Badges
[](https://github.com/dotkernel/dot-data-fixtures/issues)
[](https://github.com/dotkernel/dot-data-fixtures/network)
[](https://github.com/dotkernel/dot-data-fixtures/stargazers)
[](https://github.com/dotkernel/dot-data-fixtures/blob/1.0/LICENSE)
[](https://github.com/dotkernel/dot-data-fixtures/actions/workflows/continuous-integration.yml)
[](https://codecov.io/gh/dotkernel/dot-data-fixtures)
[](https://github.com/dotkernel/dot-data-fixtures/actions/workflows/static-analysis.yml)
This package provides a CLI interface for interacting with doctrine/data-fixtures.
**Executing fixtures will **append** data to the tables.**
## Requirements
- **PHP**: 8.2, 8.3 or 8.4
- **doctrine/orm**: => 3.0
- **doctrine/data-fixtures**: => 2.0
## Installation
Run the following command in you project directory
```shell
composer require dotkernel/dot-data-fixtures
```
Next, register the package's ConfigProvider into your application config.
```php
\Dot\DataFixtures\ConfigProvider::class,
```
In `doctrine.global.php` (or your custom doctrine config file) add a new key `fixtures`, in the `doctrine` array, the value should be a valid path to a folder where your fixtures can be found.
**Make sure the path is valid before proceeding to the next step.**
### Example
```php
return [
'dependencies' => [ ... ],
'doctrine' => [
...,
'fixtures' => getcwd() . '/data/doctrine/fixtures',
],
];
```
The last step is to register the commands.
We can register the commands to work with the default CLI that doctrine provides us.
Create a new php file `bin/doctrine` (if you don't already have this file feel free to copy it from the below example)
```php
get(\Doctrine\ORM\EntityManager::class);
$commands = [
$container->get(Dot\DataFixtures\Command\ExecuteFixturesCommand::class),
$container->get(Dot\DataFixtures\Command\ListFixturesCommand::class),
];
ConsoleRunner::run(
new SingleManagerProvider($entityManager),
$commands
);
```
## Usage
**List fixtures command** - will list all the available fixtures, by order of execution.
````shell
php ./bin/doctrine fixtures:list
````
**Execute fixtures command** - this command will execute all or one fixture.
To execute all the fixtures run:
```shell
php ./bin/doctrine fixtures:execute
```
To execute a specific fixture run:
```shell
php ./bin/doctrine fixtures:execute --class=RoleLoader
```
## Creating fixtures
When creating a new fixture we have 2 requirements:
- Fixtures should be created in the folder we configured earlier: `data/doctrine/fixtures`
- Fixtures should implement `FixtureInterface` and have a `load` method.
- Create a new php file and copy the below code-block.
### Example
```php
setName('admin');
$userRole = new UserRole();
$userRole->setName('user');
$guestRole = new UserRole();
$guestRole->setName('guest');
$manager->persist($adminRole);
$manager->persist($userRole);
$manager->persist($guestRole);
$manager->flush();
}
}
```
## Ordering fixtures
Fixtures can we ordered using 2 methods :
- by order
- by dependencies
Please refer to this link for further details on ordering fixtures:
https://www.doctrine-project.org/projects/doctrine-data-fixtures/en/latest/how-to/fixture-ordering.html#fixture-ordering