You are browsing a version that is no longer maintained.

Complex References

Sometimes you may want to access related documents using custom criteria or from the inverse side of a relationship.

You can create an immutable reference to one or many documents and specify how that reference is to be loaded. The reference is immutable in that it is defined only in the mapping, unlike a typical reference where a MongoDBRef or identifier (for Simple References) is stored on the document itself.

The following options may be used for one and many reference mappings:

criteria - Query criteria to apply to the cursor.

repositoryMethod - The repository method used to create the cursor.

sort - Sort criteria for the cursor.

skip - Skip offset to apply to the cursor.

limit - Limit to apply to the cursor.

Basic Example

In the following example, $comments will refer to all Comments for the BlogPost and $last5Comments will refer to only the last five Comments. The mappedBy field is used to determine which Comment field should be used for querying by the BlogPost's ID.

1 <?php

/** @Document */
class BlogPost
{
    // ...

    /** @ReferenceMany(targetDocument="Comment", mappedBy="blogPost") */
    private $comments;

    /**
     * @ReferenceMany(
     *      targetDocument="Comment",
     *      mappedBy="blogPost",
     *      sort={"date"="desc"},
     *      limit=5
     * )
     */
    private $last5Comments;
}

/** @Document */
class Comment
{
    // ...

    /** @ReferenceOne(targetDocument="BlogPost", inversedBy="comments") */
    private $blogPost;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

You can also use mappedBy for referencing a single document, as in the following example:

1 <?php

/**
 * @ReferenceOne(
 *      targetDocument="Comment",
 *      mappedBy="blogPost",
 *      sort={"date"="desc"}
 * )
 */
private $lastComment;
2
3
4
5
6
7
8
9
10

`criteria` Example

Use criteria to further match referenced documents. In the following example, $commentsByAdmin will refer only comments created by administrators:

1 <?php

/**
 * @ReferenceMany(
 *      targetDocument="Comment",
 *      mappedBy="blogPost",
 *      criteria={"isByAdmin" : true}
 * )
 */
private $commentsByAdmin;
2
3
4
5
6
7
8
9
10

`repositoryMethod` Example

Alternatively, you can use repositoryMethod to specify a custom method to call on the Comment repository class to populate the reference.

1 <?php

/**
 * @ReferenceMany(
 *      targetDocument="Comment",
 *      mappedBy="blogPost",
 *      repositoryMethod="findSomeComments"
 * )
 */
private $someComments;
2
3
4
5
6
7
8
9
10

The Comment class will need to have a custom repository class configured:

1 <?php

/** @Document(repositoryClass="CommentRepository") */
class Comment
{
    // ...
}
2
3
4
5
6
7

Lastly, the CommentRepository class will need a findSomeComments() method which shall return Doctrine\MongoDB\CursorInterface. When this method is called to populate the reference, Doctrine will provide the Blogpost instance (i.e. owning document) as the first argument:

1 <?php

class CommentRepository extends \Doctrine\ODM\MongoDB\DocumentRepository
{
    /**
     * @return \Doctrine\ODM\MongoDB\Cursor
     */
    public function findSomeComments(BlogPost $blogPost)
    {
        return $this->createQueryBuilder()
            ->field('blogPost')->references($blogPost);
            ->getQuery()->execute();
    }
}
2
3
4
5
6
7
8
9
10
11
12
13
14

1	<?php /** @Document / class BlogPost { // ... /* @ReferenceMany(targetDocument="Comment", mappedBy="blogPost") / private $comments; /* * @ReferenceMany( * targetDocument="Comment", * mappedBy="blogPost", * sort={"date"="desc"}, * limit=5 * ) / private $last5Comments; } /* @Document / class Comment { // ... /* @ReferenceOne(targetDocument="BlogPost", inversedBy="comments") */ private $blogPost; }
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

1	<?php /** * @ReferenceOne( * targetDocument="Comment", * mappedBy="blogPost", * sort={"date"="desc"} * ) */ private $lastComment;
2
3
4
5
6
7
8
9
10

1	<?php /** * @ReferenceMany( * targetDocument="Comment", * mappedBy="blogPost", * criteria={"isByAdmin" : true} * ) */ private $commentsByAdmin;
2
3
4
5
6
7
8
9
10

1	<?php /** @Document(repositoryClass="CommentRepository") */ class Comment { // ... }
2
3
4
5
6
7

1	<?php class CommentRepository extends \Doctrine\ODM\MongoDB\DocumentRepository { /** * @return \Doctrine\ODM\MongoDB\Cursor */ public function findSomeComments(BlogPost $blogPost) { return $this->createQueryBuilder() ->field('blogPost')->references($blogPost); ->getQuery()->execute(); } }
2
3
4
5
6
7
8
9
10
11
12
13
14

Maintained

Unmaintained

Complex References

Basic Example

criteria Example

repositoryMethod Example

`criteria` Example

`repositoryMethod` Example