Skip to content

Latest commit

 

History

History
187 lines (112 loc) · 5.28 KB

File metadata and controls

187 lines (112 loc) · 5.28 KB
layout doc
title Doctrine2 - Codeception - Documentation

Doctrine2

Allows integration and testing for projects with Doctrine2 ORM. Doctrine2 uses EntityManager to perform all database operations.

When using with Zend Framework 2 or Symfony2 Doctrine connection is automatically retrieved from Service Locator. In this case you should include either Symfony or ZF2 module and specify it as dependent for Doctrine:

{% highlight yaml %} modules: enabled: - Symfony - Doctrine2: depends: Symfony

{% endhighlight %}

If you don't use any of frameworks above, you should specify a callback function to receive entity manager:

{% highlight yaml %} modules: enabled: - Doctrine2: connection_callback: ['MyDb', 'createEntityManager']

{% endhighlight %}

This will use static method of MyDb::createEntityManager() to establish EntityManager.

By default module will wrap everything into transaction for each test and rollback it afterwards. By doing this tests won't write anything to database, and so will run much faster and will be isolate dfrom each other. This behavior can be changed by specifying cleanup: false in config.

Status

Config

  • cleanup: true - all doctrine queries will be run in transaction, which will be rolled back at the end of test.
  • connection_callback: - callable that will return an instance of EntityManager. This is a must if you run Doctrine without Zend2 or Symfony2 frameworks

Example (functional.suite.yml)

 modules:
    enabled: [Doctrine2]
    config:
       Doctrine2:
          cleanup: false

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();

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 crates 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 %} #### 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 executes a query defined by array. It builds query based on array of parameters. You can use entity associations to build complex queries. Example: {% highlight php %} seeInRepository('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