{% highlight yaml %} composer require --dev codeception/module-doctrine

{% endhighlight %}

Upgrading from Module "Doctrine2":

• In your composer.json: Replace "codeception/module-doctrine2" with "codeception/module-doctrine"
• In your Acceptance.suite.yml, Functional.suite.yml, and Unit.suite.yml: Replace - Doctrine2: with - Doctrine:
• In any file in Support/Helper/: Change $this->getModule('Doctrine2') to $this->getModule('Doctrine')

Access the database using Doctrine ORM.

When used with Symfony or Zend Framework 2, Doctrine's Entity Manager is automatically retrieved from Service Locator. Set up your Functional.suite.yml like this:

{% highlight yaml %}

modules: enabled: - Symfony # 'ZF2' or 'Symfony' - Doctrine: depends: Symfony # Tells Doctrine to fetch the Entity Manager through Symfony cleanup: true # All doctrine queries will be wrapped in a transaction, which will be rolled back at the end of each test

{% endhighlight %}

If you don't provide a depends key, you need to specify a callback function to retrieve the Entity Manager:

{% highlight yaml %}

modules: enabled: - Doctrine: connection_callback: ['MyDb', 'createEntityManager'] # Call the static method MyDb::createEntityManager() to get the Entity Manager

{% endhighlight %}

By default, the module will wrap everything into a transaction for each test and roll it back afterwards (this is controlled by the cleanup setting). By doing this, tests will run much faster and will be isolated from each other.

To use the Doctrine Module in acceptance tests, set up your acceptance.suite.yml like this:

{% highlight yaml %}

modules: enabled: - Symfony: part: SERVICES - Doctrine: depends: Symfony

{% endhighlight %}

You cannot use cleanup: true in an acceptance test, since Codeception and your app (i.e. browser) are using two different connections to the database, so Codeception can't wrap changes made by the app into a transaction.

Set the SQL statement that Doctrine fixtures (doctrine/data-fixtures) are using to purge the database tables: {% highlight yaml %}

modules: enabled: - Doctrine: purge_mode: 1 # 1: DELETE (=default), 2: TRUNCATE

{% endhighlight %}

For Symfony users, the recommended way to query for entities is not to use this module's grab...() methods, but rather "inject" Doctrine's repository:

{% highlight php %}

public function _before(FunctionalTester $I): void { $this->fooRepository = $I->grabService(FooRepository::class); }

{% endhighlight %}

Now you have access to all your familiar repository methods in your tests, e.g.:

{% highlight php %}

$greenFoo = $this->fooRepository->findOneBy(['color' => 'green']);

{% endhighlight %}

• em - Entity Manager

Every method that expects some query parameters (see...(), dontSee...(), grab...()) also accepts an instance of \Doctrine\Common\Collections\Criteria for more flexibility, e.g.:

{% highlight php %}

$I->seeInRepository(User::class, [ 'name' => 'John', Criteria::create()->where( Criteria::expr()->endsWith('email', '@domain.com') ), ]);

{% endhighlight %}

If criteria is just a ->where(...) construct, you can pass just expression without criteria wrapper:

{% highlight php %}

$I->seeInRepository(User::class, [ 'name' => 'John', Criteria::expr()->endsWith('email', '@domain.com'), ]);

{% endhighlight %}

Criteria can be used not only to filter data, but also to change the order of results:

{% highlight php %}

$I->grabEntitiesFromRepository('User', [ 'status' => 'active', Criteria::create()->orderBy(['name' => 'asc']), ]);

{% endhighlight %}

Note that key is ignored, because actual field name is part of criteria and/or expression.

• return void

Performs $em->clear():

{% highlight php %}

$I->clearEntityManager();

{% endhighlight %}

• param class-string $entity
• param array $params
• return void

Flushes changes to database and performs findOneBy() call for current repository.

• return void

Performs $em->flush();

• template T of object
• param class-string<T> $entity
• param array $params . For IS NULL, use ['field' => null]
• return list<T>

Selects entities from repository.

It builds a query based on an array of parameters. You can use entity associations to build complex queries. For Symfony users, it's recommended to use the entity's repository instead

Example:

{% highlight php %}