-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[WCM] document the doctrine compiler pass #2507
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
.. index:: | ||
single: Doctrine; Mapping Model classes | ||
|
||
How to provide model classes for several Doctrine implementations | ||
================================================================= | ||
|
||
When building a bundle that could be used not only with Doctrine ORM but | ||
also the CouchDB ODM, MongoDB ODM or PHPCR ODM, you should still only | ||
write one model class. The Doctrine bundles provide a compiler pass to | ||
register the mappings for your model classes. | ||
|
||
.. note:: | ||
|
||
For non-reusable bundles, the easiest is to put your model classes in | ||
the default locations. ``Entity`` for Doctrine ORM, ``Document`` for one | ||
of the ODMs. For reusable bundles, rather than duplicate model classes | ||
just to get the auto mapping, use the compiler pass. | ||
|
||
.. versionadded:: 2.3 | ||
The base mapping compiler pass was added in Symfony 2.3, the doctrine bundles | ||
support it from DoctrineBundle >= 1.2.1, MongoDBBundle >= 3.0.0 | ||
|
||
|
||
In your bundle class, write the following code to register the compiler pass:: | ||
|
||
use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\DoctrineOrmMappingsPass; | ||
use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\DoctrineMongoDBMappingsPass; | ||
|
||
class FOSUserBundle extends Bundle | ||
{ | ||
public function build(ContainerBuilder $container) | ||
{ | ||
parent::build($container); | ||
// ... | ||
|
||
$modelDir = realpath(__DIR__.'/Resources/config/doctrine/model'); | ||
$mappings = array( | ||
$modelDir => 'FOS\UserBundle\Model', | ||
); | ||
|
||
$ormCompilerClass = 'Doctrine\Bundle\DoctrineBundle\DependencyInjection' | ||
. '\Compiler\DoctrineOrmMappingsPass'; | ||
if (class_exists($ormCompilerClass)) { | ||
$container->addCompilerPass( | ||
DoctrineOrmMappingsPass::createXmlMappingDriver( | ||
$mappings, 'fos_user.backend_type_orm' | ||
)); | ||
} | ||
|
||
$mongoCompilerClass = 'Doctrine\Bundle\MongoDBBundle\DependencyInjection' | ||
. '\Compiler\DoctrineMongoDBMappingsPass'; | ||
if (class_exists($mongoCompilerClass)) { | ||
$container->addCompilerPass( | ||
DoctrineMongoDBMappingsPass::createXmlMappingDriver( | ||
$mappings, 'fos_user.backend_type_mongodb' | ||
)); | ||
} | ||
|
||
// TODO: couch | ||
} | ||
} | ||
|
||
The compiler pass provides factory methods for all drivers provided by the | ||
bundle: Annotations, XML, Yaml, PHP and StaticPHP for Doctrine ORM, the ODM | ||
bundles sometimes do not have all of those drivers. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is still a bit too long. should i break it as well? and if so, how?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dbu no, namespaces (and CLI commands) are exceptions on this 85 characters rule. They can't be wrapped.