docs/en/index.rst
The Doctrine documentation is comprised of tutorials, a reference section and cookbook articles that explain different parts of the Object Relational mapper.
Doctrine DBAL and Doctrine Common both have their own documentation.
If this documentation is not helping to answer questions you have about Doctrine ORM don't panic. You can get help from different sources:
FAQ <reference/faq> with answers to frequent questions.#orm <https://www.doctrine-project.org/slack>_GitHub <https://github.com/doctrine/orm/issues>_.StackOverflow <https://stackoverflow.com/questions/tagged/doctrine-orm>_If you need more structure over the different topics you can browse the table of contents.
Tutorial:
:doc:Getting Started with Doctrine <tutorials/getting-started>
Setup:
:doc:Installation & Configuration <reference/configuration>
Mapping:
:doc:Objects <reference/basic-mapping> |
:doc:Associations <reference/association-mapping> |
:doc:Inheritance <reference/inheritance-mapping>
Drivers:
:doc:Attributes <reference/attributes-reference> |
:doc:XML <reference/xml-mapping> |
:doc:PHP <reference/php-mapping>
Basic Reference:
:doc:Entities <reference/working-with-objects> |
:doc:Associations <reference/working-with-associations> |
:doc:Events <reference/events>
Query Reference:
:doc:DQL <reference/dql-doctrine-query-language> |
:doc:QueryBuilder <reference/query-builder> |
:doc:Native SQL <reference/native-sql>
Internals:
:doc:Internals explained <reference/unitofwork> |
:doc:Associations <reference/unitofwork-associations>
Architecture <reference/architecture>Advanced Configuration <reference/advanced-configuration>Limitations and known issues <reference/limitations-and-known-issues>Commandline Tools <reference/tools>Transactions and Concurrency <reference/transactions-and-concurrency>Filters <reference/filters>NamingStrategy <reference/namingstrategy>TypedFieldMapper <reference/typedfieldmapper>Improving Performance <reference/improving-performance>Caching <reference/caching>Partial Hydration <reference/partial-hydration>Partial Objects <reference/partial-objects>Change Tracking Policies <reference/change-tracking-policies>Best Practices <reference/best-practices>Metadata Drivers <reference/metadata-drivers>Batch Processing <reference/batch-processing>Second Level Cache <reference/second-level-cache>Indexed associations <tutorials/working-with-indexed-associations>Extra Lazy Associations <tutorials/extra-lazy-associations>Composite Primary Keys <tutorials/composite-primary-keys>Ordered associations <tutorials/ordered-associations>Pagination <tutorials/pagination>Override Field/Association Mappings In Subclasses <tutorials/override-field-association-mappings-in-subclasses>Embeddables <tutorials/embeddables>Upgrade <https://github.com/doctrine/orm/blob/HEAD/UPGRADE.md>_Patterns:
:doc:Aggregate Fields <cookbook/aggregate-fields> |
:doc:Generated/Virtual Columns <cookbook/generated-columns> |
:doc:Decorator Pattern <cookbook/decorator-pattern> |
:doc:Strategy Pattern <cookbook/strategy-cookbook-introduction>
DQL Extension Points:
:doc:DQL Custom Walkers <cookbook/dql-custom-walkers> |
:doc:DQL User-Defined-Functions <cookbook/dql-user-defined-functions>
Implementation:
:doc:Array Access <cookbook/implementing-arrayaccess-for-domain-objects> |
:doc:Working with DateTime <cookbook/working-with-datetime> |
:doc:Validation <cookbook/validation-of-entities> |
:doc:Entities in the Session <cookbook/entities-in-session> |
:doc:Keeping your Modules independent <cookbook/resolve-target-entity-listener>
Hidden Gems
:doc:Prefixing Table Name <cookbook/sql-table-prefixes>
Custom Datatypes
:doc:MySQL Enums <cookbook/mysql-enums>
:doc:Custom Mapping Types <cookbook/custom-mapping-types>
:doc:Advanced Field Value Conversion <cookbook/advanced-field-value-conversion-using-custom-mapping-types>