Skip to content

Doctrine2.md

Latest commit

 

History

History
223 lines (133 loc) · 5.92 KB

Doctrine2.md

File metadata and controls

223 lines (133 loc) · 5.92 KB
layout doc
title Doctrine2 - Codeception - Documentation

Doctrine2

Access the database using Doctrine2 ORM.

When used with Zend Framework 2 or Symfony2, 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' - Doctrine2: depends: 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 use Symfony or Zend Framework, you need to specify a callback function to retrieve the Entity Manager:

{% highlight yaml %} modules: enabled: - Doctrine2: connection_callback: ['MyDb', 'createEntityManager'] cleanup: true # All doctrine queries will be wrapped in a transaction, which will be rolled back at the end of each test

{% endhighlight %}

This will use static method of MyDb::createEntityManager() to establish the Entity Manager.

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

Status

Config

Public Properties

  • em - Entity Manager

Actions

dontSeeInRepository

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

  • param $entity
  • param array $params

flushToDatabase

Performs $em->flush();

grabEntitiesFromRepository

Selects entities from repository. It builds query based on array of parameters. You can use entity associations to build complex queries.

Example:

{% highlight php %}

grabEntitiesFromRepository('AppBundle:User', array('name' => 'davert')); ?>

{% endhighlight %}

  • Available since 1.1
  • param $entity
  • param array $params
  • return array

grabEntityFromRepository

Selects a single entity from repository. It builds query based on array of parameters. You can use entity associations to build complex queries.

Example:

{% highlight php %}

grabEntityFromRepository('User', array('id' => '1234')); ?>

{% endhighlight %}

  • Available since 1.1
  • param $entity
  • param array $params
  • return object

grabFromRepository

Selects field value from repository. It builds query based on array of parameters. You can use entity associations to build complex queries.

Example:

{% highlight php %}

grabFromRepository('User', 'email', array('name' => 'davert')); ?>

{% endhighlight %}

  • Available since 1.1
  • param $entity
  • param $field
  • param array $params
  • return array

haveFakeRepository

Mocks the repository.

With this action you can redefine any method of any repository. Please, note: this fake repositories will be accessible through entity manager till the end of test.

Example:

{% highlight php %}

haveFakeRepository('Entity\User', array('findByUsername' => function($username) { return null; })); {% endhighlight %} This creates a stub class for Entity\User repository with redefined method findByUsername, which will always return the NULL value. * `param` $classname * `param array` $methods #### haveInRepository Persists record into repository. This method creates an entity, and sets its properties directly (via reflection). Setters of entity won't be executed, but you can create almost any entity and save it to database. Returns id using `getId` of newly created entity. {% highlight php %} $I->haveInRepository('Entity\User', array('name' => 'davert')); {% endhighlight %} #### onReconfigure @throws ModuleConfigException #### persistEntity Adds entity to repository and flushes. You can redefine it's properties with the second parameter. Example: {% highlight php %} persistEntity(new \Entity\User, array('name' => 'Miles')); $I->persistEntity($user, array('name' => 'Miles')); {% endhighlight %} * `param` $obj * `param array` $values #### seeInRepository Flushes changes to database, and executes a query with parameters defined in an array. You can use entity associations to build complex queries. Example: {% highlight php %} seeInRepository('AppBundle:User', array('name' => 'davert')); $I->seeInRepository('User', array('name' => 'davert', 'Company' => array('name' => 'Codegyre'))); $I->seeInRepository('Client', array('User' => array('Company' => array('name' => 'Codegyre'))); ?>

{% endhighlight %}

Fails if record for given criteria can't be found,

  • param $entity
  • param array $params

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference