You are browsing a version that is no longer maintained. |
Embedded Mapping
This chapter explains how embedded documents are mapped in Doctrine.
Embed One
Embed a single document:
- PHP
- XML
1 <?xml version="1.0" encoding="UTF-8"?> <doctrine-mongo-mapping xmlns="http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping.xsd"> <document name="Documents\User"> <embed-one field="address" target-document="Address" /> </document> </doctrine-mongo-mapping> 2 3 4 5 6 7 8 9 - YAML
Embed Many
Embed many documents:
- PHP
- XML
1 <?xml version="1.0" encoding="UTF-8"?> <doctrine-mongo-mapping xmlns="http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping.xsd"> <document name="Documents\User"> <embed-many field="phonenumbers" target-document="Phonenumber" /> </document> </doctrine-mongo-mapping> 2 3 4 5 6 7 8 9 - YAML
Mixing Document Types
If you want to store different types of embedded documents in the same field,
you can simply omit the targetDocument
option:
- PHP
- XML
1 <embed-many field="tasks" /> - YAML
Now the $tasks
property can store any type of document! The class name will
be automatically stored in a field named _doctrine_class_name
within
the embedded document. The field name can be customized with the
discriminatorField
option:
- PHP
- XML
- YAML
You can also specify a discriminator map to avoid storing the FQCN in each embedded document:
- PHP
- XML
- YAML
If you have embedded documents without a discriminator value that need to be treated correctly you can optionally specify a default value for the discriminator:
- PHP
- XML
- YAML
Cascading Operations
All operations on embedded documents are automatically cascaded. This is because embedded documents are part of their parent document and cannot exist without those by nature.