localheinz/factory-girl-definition

Provides an interface for, and an easy way to find and register entity definitions for breerly/factory-girl-php.

factory-girl-definition

, _(*1)

, _(*2)

, _(*3)

Provides an interface for, and an easy way to find and register entity definitions for breerly/factory-girl-php., _(*4)

Installation

Run, _(*5)

$ composer require --dev ergebnis/factory-girl-definition

Usage

Create Definitions

Implement one of the, _(*6)

• Ergebnis\FactoryGirl\Definition\Definition
• Ergebnis\FactoryGirl\Definition\FakerAwareDefinition

interfaces and use the instance of FactoryGirl\Provider\Doctrine\FixtureFactory that is passed into accept() to define entities:, _(*7)

<?php

namespace Foo\Bar\Test\Fixture\Entity;

use Ergebnis\FactoryGirl\Definition\Definition;
use FactoryGirl\Provider\Doctrine\FixtureFactory;
use Foo\Bar\Entity;

final class UserDefinition implements Definition
{
    public function accept(FixtureFactory $fixtureFactory): void
    {
        $fixtureFactory->defineEntity(Entity\User::class, [
            // ...
        ]);
    }
}

:bulb: Any number of entities can be defined within a definition. However, it's probably a good idea to create a definition for each entity., _(*8)

Register Definitions

Lazily instantiate an instance of FactoryGirl\Provider\Doctrine\FixtureFactory and use Definitions to find definitions, register definitions with the fixture factory, and optionally provide definitions with an instance of Faker\Generator:, _(*9)

<?php

namespace Foo\Bar\Test\Integration;

use Doctrine\ORM;
use Ergebnis\FactoryGirl\Definition\Definitions;
use FactoryGirl\Provider\Doctrine\FixtureFactory;
use Faker\Generator;
use PHPUnit\Framework;

abstract class AbstractIntegrationTestCase extends Framework\TestCase
{
    /**
     * @var FixtureFactory
     */
    private $fixtureFactory;

    final protected function entityManager(): ORM\EntityManager
    {
        // ...
    }

    final protected function faker(): Generator
    {
        // ...
    }

    final protected function fixtureFactory(): FixtureFactory
    {
        if (null === $this->fixtureFactory) {
            $fixtureFactory = new FixtureFactory($this->entityManager());
            $fixtureFactory->persistOnGet(true);

            Definitions::in(__DIR__ . '/../Fixture')
                ->registerWith($fixtureFactory)
                ->provideWith($this->faker());

            $this->fixtureFactory = $fixtureFactory;
        }

        return $this->fixtureFactory;
    }
}

Contributing

Please have a look at CONTRIBUTING.md., _(*10)

Code of Conduct

Please have a look at CODE_OF_CONDUCT.md., _(*11)

This package is licensed using the MIT License., _(*12)

License

This package is licensed using the MIT License., _(*13)

Please have a look at LICENSE.md., _(*14)

Curious what I am building?

:mailbox_with_mail: Subscribe to my list, and I will occasionally send you an email to let you know what I am working on., _(*15)