Download the PHP package teamneusta/pimcore-fixture-bundle without Composer

Pimcore Fixture Bundle

Provides a way to manage and execute the loading of data fixtures in Pimcore.

It can be useful for testing purposes or for seeding a database with initial data.

Installation

1. Require the bundle

2. Enable the bundle

   Add the Bundle to your config/bundles.php:

3. Register your Fixtures Folder for Service autoconfiguration

   Depending on where you want to create your Fixtures, or if they should only be accessible during test execution.

Upgrading From an Earlier Version

Fixtures are now considered actual services and are loaded through Dependency Injection (DI). To align with this approach, you’ll need to update your Fixture classes by moving service dependencies from the create method to the constructor. If your Fixture relies on other Fixtures, implement the HasDependencies interface.

Here are the key changes:

1. Fixture Interface Update
   The old fixture interface Neusta\Pimcore\FixtureBundle\Fixture has been replaced with Neusta\Pimcore\FixtureBundle\Fixture\Fixture. You can also extend from Neusta\Pimcore\FixtureBundle\Fixture\AbstractFixture to implement your Fixtures.

2. Fixtures as Services
   Fixtures must be made available in the Dependency Injection container to be discovered. To do this, tag them with neusta_pimcore_fixture.fixture, or use autoconfiguration for automatic tagging.

3. Change of the create Method
   The signature of the create method has been modified. It no longer takes any arguments, meaning all dependencies must be specified via HasDependencies.

4. Specifying Inter-Fixture Dependencies
   If your Fixture depends on others, use the HasDependencies interface to specify these dependencies. Additional guidance is available in the section "Referencing Fixtures and Depending on Other Fixtures".

Make sure to update your Fixture classes according to these changes to ensure proper functionality and compatibility with this Bundle.

Usage

Writing Fixtures

Data fixtures are PHP service classes where you create objects and persist them to the database.

Imagine that you want to add some Product objects to your database. To do this, create a fixture class and start adding products:

Referencing Fixtures and Depending on Other Fixtures

Suppose you want to link a Product fixture to a Group fixture. To do this, you need to create a Group fixture first and keep a reference to it. Later you can use this reference when creating the Product fixture.

This process requires the Group fixture to exist before the Product fixture. You can achieve this ordering by implementing the HasDependencies interface.

Loading Fixtures

In Tests

To load fixtures in Tests, we offer the SelectiveFixtureLoader. To streamline your test setup, we recommend creating a base class with a method to load fixtures via the SelectiveFixtureLoader. Here’s an example demonstrating how to implement this.

Use the base class as follows:

As Initial Data in Your Project

To load fixtures in your local environment or as part of a deployment, two commands are provided:

• neusta:pimcore-fixture:load (Loads a defined fixture class.)
• neusta:pimcore-fixtures:load (Loads all defined fixture classes.)

Beware that loading a large number of objects may lead to high memory consumption. Should you encounter memory issues when running the commands in dev environments you may want to try setting the environment to prod. Disabling the debug mode also seems beneficial in terms of memory consumption.

For example, provide these options when using the symfony console:

Accessing Services From the Fixtures

As the Fixtures are just normal PHP services, you can use all DI features like constructor, setter, or property injection as usual.

Extension and Customization Through Events

The Bundle provides the following events to facilitate extensions and customization:

1. BeforeLoadFixtures
   This event is dispatched before any fixture is executed. It contains all the fixtures that are scheduled for execution, accessible via $event->fixtures. You can alter the list of fixtures to be loaded by modifying it $event->fixtures = ....

2. BeforeExecuteFixture
   This event is dispatched for each fixture just before it is executed. Using this event, you can prevent the execution of a specific fixture by setting $event->preventExecution = true.

3. AfterExecuteFixture
   This event is dispatched for each fixture after it has been executed.

4. AfterLoadFixtures
   This event is dispatched after all relevant fixtures have been executed. It carries the fixtures that have been successfully loaded, which can be accessed through $event->loadedFixtures.

Contribution

Feel free to open issues for any bug, feature request, or other ideas.

Please remember to create an issue before creating large pull requests.

Local Development

To develop on a local machine, the vendor dependencies are required.

We use composer scripts for our main quality tools. They can be executed via the bin/composer file as well.