DoctrineMongoDBBundle

Creating a Document Class

Suppose you're building an application where products need to be displayed. Without even thinking about Doctrine or MongoDB, you already know that you need a Product object to represent those products. Create this class inside the Document directory of your AcmeStoreBundle:

// src/Acme/StoreBundle/Document/Product.php
namespace Acme\StoreBundle\Document;

class Product
{
    protected $name;

    protected $price;
}

The class - often called a document, meaning a basic class that holds data - is simple and helps fulfill the business requirement of needing products in your application. This class can't be persisted to Doctrine MongoDB yet - it's just a simple PHP class.

Add Mapping Information

Doctrine allows you to work with MongoDB in a much more interesting way than just fetching data back and forth as an array. Instead, Doctrine allows you to persist entire objects to MongoDB and fetch entire objects out of MongoDB. This works by mapping a PHP class and its properties to entries of a MongoDB collection.

For Doctrine to be able to do this, you just have to create metadata, or configuration that tells Doctrine exactly how the Product class and its properties should be mapped to MongoDB. This metadata can be specified in a number of different formats including YAML, XML or directly inside the Product class via annotations:

Doctrine allows you to choose from a wide variety of different field types, each with their own options. For information on the available field types, see the DoctrineMongoDBBundle section.

Generating Getters and Setters

Even though Doctrine now knows how to persist a Product object to MongoDB the class itself isn't really useful yet. Since Product is just a regular PHP class, you need to create getter and setter methods (e.g. getName(), setName()) in order to access its properties (since the properties are protected). Fortunately, Doctrine can do this for you by running:

$ php app/console doctrine:mongodb:generate:documents AcmeStoreBundle

This command makes sure that all of the getters and setters are generated for the Product class. This is a safe command - you can run it over and over again: it only generates getters and setters that don't exist (i.e. it doesn't replace your existing methods).

Persisting Objects to MongoDB

Now that you have a mapped Product document complete with getter and setter methods, you're ready to persist data to MongoDB. From inside a controller, this is pretty easy. Add the following method to the DefaultController of the bundle:

1
// src/Acme/StoreBundle/Controller/DefaultController.php
use Acme\StoreBundle\Document\Product;
use Symfony\Component\HttpFoundation\Response;
// ...

public function createAction()
{
    $product = new Product();
    $product->setName('A Foo Bar');
    $product->setPrice('19.99');

    $dm = $this->get('doctrine.odm.mongodb.document_manager');
    $dm->persist($product);
    $dm->flush();

    return new Response('Created product id '.$product->getId());
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Let's walk through this example:

• lines 8-10 In this section, you instantiate and work with the $product object like any other, normal PHP object;
• line 12 This line fetches Doctrine's document manager object, which is responsible for handling the process of persisting and fetching objects to and from MongoDB;
• line 13 The persist() method tells Doctrine to "manage" the $product object. This does not actually cause a query to be made to MongoDB (yet).
• line 14 When the flush() method is called, Doctrine looks through all of the objects that it's managing to see if they need to be persisted to MongoDB. In this example, the $product object has not been persisted yet, so the document manager makes a query to MongoDB, which adds a new entry.

When creating or updating objects, the workflow is always the same. In the next section, you'll see how Doctrine is smart enough to update entries if they already exist in MongoDB.

Fetching Objects from MongoDB

Fetching an object back out of MongoDB is even easier. For example, suppose you've configured a route to display a specific Product based on its id value:

public function showAction($id)
{
    $product = $this->get('doctrine.odm.mongodb.document_manager')
        ->getRepository('AcmeStoreBundle:Product')
        ->find($id);

    if (!$product) {
        throw $this->createNotFoundException('No product found for id '.$id);
    }

    // do something, like pass the $product object into a template
}

When you query for a particular type of object, you always use what's known as its repository. You can think of a repository as a PHP class whose only job is to help you fetch objects of a certain class. You can access the repository object for a document class via:

$repository = $this->get('doctrine.odm.mongodb.document_manager')
    ->getRepository('AcmeStoreBundle:Product');

Once you have your repository, you have access to all sorts of helpful methods:

// query by the primary key (usually "id")
$product = $repository->find($id);

// dynamic method names to find based on a column value
$product = $repository->findOneById($id);
$product = $repository->findOneByName('foo');

// find *all* products
$products = $repository->findAll();

// find a group of products based on an abitrary column value
$products = $repository->findByPrice(19.99);

You can also take advantage of the useful findBy and findOneBy methods to easily fetch objects based on multiple conditions:

// query for one product matching be name and price
$product = $repository->findOneBy(array('name' => 'foo', 'price' => 19.99));

// query for all prdocuts matching the name, ordered by price
$product = $repository->findBy(
    array('name' => 'foo'),
    array('price', 'ASC')
);

Updating an Object

Once you've fetched an object from Doctrine, updating it is easy. Suppose you have a route that maps a product id to an update action in a controller:

public function updateAction($id)
{
    $dm = $this->get('doctrine.odm.mongodb.document_manager');
    $product = $dm->getRepository('AcmeStoreBundle:Product')->find($id);

    if (!$product) {
        throw $this->createNotFoundException('No product found for id '.$id);
    }

    $product->setName('New product name!');
    $dm->flush();

    return $this->redirect($this->generateUrl('homepage'));
}

Updating an object involves just three steps:

1. fetching the object from Doctrine;
2. modifying the object;
3. calling flush() on the document manager

Notice that calling $dm->persist($product) isn't necessary. Recall that this method simply tells Doctrine to manage or watch the $product object. In this case, since you fetched the $product object from Doctrine, it's already managed.

Deleting an Object

Deleting an object is very similar, but requires a call to the remove() method of the document manager:

$dm->remove($product);
$dm->flush();

As you might expect, the remove() method notifies Doctrine that you'd like to remove the given document from the MongoDB. The actual delete operation however, isn't actually executed until the flush() method is called.

Using the Query Builder

Doctrine's ODM ships with a query Builder object, which allows you to construct a query for exactly which documents you want to return. If you use an IDE, you can also take advantage of auto-completion as you type the method names. From inside a controller:

$products = $this->get('doctrine.odm.mongodb.document_manager')
    ->createQueryBuilder('AcmeStoreBundle:Product')
    ->field('name')->equals('foo')
    ->limit(10)
    ->sort('price', 'ASC')
    ->getQuery()
    ->execute()

In this case, 10 products with a name of foo, ordered from lowest price to highest price are returned.

The QueryBuilder object contains every method necessary to build your query. For more information on Doctrine's Query Builder, consult Doctrine's Query Builder documentation. For a list of the available conditions you can place on the query, see the Conditional Operators documentation specifically.

Custom Repository Classes

In the previous section, you began constructing and using more complex queries from inside a controller. In order to isolate, test and reuse these queries, it's a good idea to create a custom repository class for your document and add methods with your query logic there.

To do this, add the name of the repository class to your mapping definition.

Doctrine can generate the repository class for you by running :

$ php app/console doctrine:mongodb:generate:repositories AcmeStoreBundle

Next, add a new method - findAllOrderedByName() - to the newly generated repository class. This method will query for all of the Product documents, ordered alphabetically.

1
// src/Acme/StoreBundle/Repository/ProductRepository.php
namespace Acme\StoreBundle\Repository;

use Doctrine\ODM\MongoDB\DocumentRepository;

class ProductRepository extends DocumentRepository
{
    public function findAllOrderedByName()
    {
        return $this->createQueryBuilder()
            ->sort('name', 'ASC')
            ->getQuery()
            ->execute();
    }
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15

You can use this new method just like the default finder methods of the repository:

$product = $this->get('doctrine.odm.mongodb.document_manager')
    ->getRepository('AcmeStoreBundle:Product')
    ->findAllOrderedByName();

Registering Event Listeners and Subscribers

Doctrine allows you to register listeners and subscribers that are notified when different events occur inside Doctrine's ODM. For more information, see Doctrine's Event Documentation.

In Symfony, you can register a listener or subscriber by creating a service and then tagging it with a specific tag.

• event listener: Use the doctrine.odm.mongodb.<connection>_event_listener tag, where <connection> name is replaced by the name of your connection (usually default). Also, be sure to add an event key to the tag specifying which event to listen to. Assuming your connection is called default, then:

  • YAML

    1
    services:
        my_doctrine_listener:
            class:   Acme\HelloBundle\Listener\MyDoctrineListener
            # ...
            tags:
                -  { name: doctrine.odm.mongodb.default_event_listener, event: postPersist }
    2
    3
    4
    5
    6

  • XML

    1
    <service id="my_doctrine_listener" class="Acme\HelloBundle\Listener\MyDoctrineListener">
        <!-- ... -->
        <tag name="doctrine.odm.mongodb.default_event_listener" event="postPersist" />
    </service>.
    2
    3
    4

  • PHP

    1
    $definition = new Definition('Acme\HelloBundle\Listener\MyDoctrineListener');
    // ...
    $definition->addTag('doctrine.odm.mongodb.default_event_listener');
    $container->setDefinition('my_doctrine_listener', $definition);
    2
    3
    4

• event subscriber: Use the doctrine.odm.mongodb.<connection>_event_subscriber tag. No other keys are needed in the tag.