Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 132 lines (101 sloc) 4.952 kB
4698346 @beberlei Finialized ReST doc changes, merged changes from latest Markdown docs.
beberlei authored
1 Welcome to Doctrine 2 ORM's documentation!
2 ==========================================
3
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
4 The Doctrine documentation is comprised of tutorials, a reference section and
5 cookbook articles that explain different parts of the Object Relational mapper.
6
7 Doctrine DBAL and Doctrine Common both have their own documentation.
8
9 Getting Help
10 ------------
11
12 If this documentation is not helping to answer questions you have about
13 Doctrine ORM don't panic. You can get help from different sources:
14
15 - There is a :doc:`FAQ <reference/faq>` with answers to frequent questions.
16 - The `Doctrine Mailing List <http://groups.google.com/group/doctrine-user>`_
bc37ceb @eventhorizonpl fix warnings p1
eventhorizonpl authored
17 - Internet Relay Chat (IRC) in #doctrine on Freenode
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
18 - Report a bug on `JIRA <http://www.doctrine-project.org/jira>`_.
19 - On `Twitter <https://twitter.com/search/%23doctrine2>`_ with ``#doctrine2``
20 - On `StackOverflow <http://stackoverflow.com/questions/tagged/doctrine2>`_
21
22 If you need more structure over the different topics you can browse the :doc:`table
23 of contents <toc>`.
24
25 Getting Started
4698346 @beberlei Finialized ReST doc changes, merged changes from latest Markdown docs.
beberlei authored
26 ---------------
27
6fa7580 @beberlei Add tutorial about Pagination
beberlei authored
28 * **Tutorial**:
bd96441 @beberlei Remove models/database first tutorials for now
beberlei authored
29 :doc:`Getting Started with Doctrine <tutorials/getting-started>`
30
31 * **Setup**:
32 :doc:`Installation & Configuration <reference/configuration>`
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
33
34 Mapping Objects onto a Database
35 -------------------------------
36
63ebaea @beberlei Some more work on index
beberlei authored
37 * **Mapping**:
38 :doc:`Objects <reference/basic-mapping>` |
19b7d4d @beberlei Simplify section names even more
beberlei authored
39 :doc:`Associations <reference/association-mapping>` |
0ee7b68 @schmittjoh small fix
schmittjoh authored
40 :doc:`Inheritance <reference/inheritance-mapping>`
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
41
63ebaea @beberlei Some more work on index
beberlei authored
42 * **Drivers**:
43 :doc:`Docblock Annotations <reference/annotations-reference>` |
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
44 :doc:`XML <reference/xml-mapping>` |
45 :doc:`YAML <reference/yaml-mapping>` |
63ebaea @beberlei Some more work on index
beberlei authored
46 :doc:`PHP <reference/php-mapping>`
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
47
48 Working with Objects
49 --------------------
50
51 * **Basic Reference**:
19b7d4d @beberlei Simplify section names even more
beberlei authored
52 :doc:`Entities <reference/working-with-objects>` |
579774f Fixed typo "Assocations"
Augusto Pascutti authored
53 :doc:`Associations <reference/working-with-associations>` |
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
54 :doc:`Events <reference/events>`
4698346 @beberlei Finialized ReST doc changes, merged changes from latest Markdown docs.
beberlei authored
55
6fa7580 @beberlei Add tutorial about Pagination
beberlei authored
56 * **Query Reference**:
63ebaea @beberlei Some more work on index
beberlei authored
57 :doc:`DQL <reference/dql-doctrine-query-language>` |
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
58 :doc:`QueryBuilder <reference/query-builder>` |
63ebaea @beberlei Some more work on index
beberlei authored
59 :doc:`Native SQL <reference/native-sql>`
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
60
63ebaea @beberlei Some more work on index
beberlei authored
61 * **Internals**:
62 :doc:`Internals explained <reference/unitofwork>` |
63 :doc:`Associations <reference/unitofwork-associations>`
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
64
65 Advanced Topics
66 ---------------
67
a90311c @mnapoli Fixed documentation rendering
mnapoli authored
68 * :doc:`Architecture <reference/architecture>`
69 * :doc:`Advanced Configuration <reference/advanced-configuration>`
8ad6853 @flack Spelling fix
flack authored
70 * :doc:`Limitations and known issues <reference/limitations-and-known-issues>`
a90311c @mnapoli Fixed documentation rendering
mnapoli authored
71 * :doc:`Commandline Tools <reference/tools>`
72 * :doc:`Transactions and Concurrency <reference/transactions-and-concurrency>`
73 * :doc:`Filters <reference/filters>`
74 * :doc:`NamingStrategy <reference/namingstrategy>`
75 * :doc:`Improving Performance <reference/improving-performance>`
76 * :doc:`Caching <reference/caching>`
77 * :doc:`Partial Objects <reference/partial-objects>`
78 * :doc:`Change Tracking Policies <reference/change-tracking-policies>`
79 * :doc:`Best Practices <reference/best-practices>`
80 * :doc:`Metadata Drivers <reference/metadata-drivers>`
0edf2bc @beberlei Add missing link to batch processing chapter
beberlei authored
81 * :doc:`Batch Processing <reference/batch-processing>`
3140593 @FabioBatSilva Second level cache
FabioBatSilva authored
82 * :doc:`Second Level Cache <reference/second-level-cache>`
63ebaea @beberlei Some more work on index
beberlei authored
83
84 Tutorials
85 ---------
86
a90311c @mnapoli Fixed documentation rendering
mnapoli authored
87 * :doc:`Indexed associations <tutorials/working-with-indexed-associations>`
88 * :doc:`Extra Lazy Associations <tutorials/extra-lazy-associations>`
89 * :doc:`Composite Primary Keys <tutorials/composite-primary-keys>`
90 * :doc:`Ordered associations <tutorials/ordered-associations>`
91 * :doc:`Pagination <tutorials/pagination>`
92 * :doc:`Override Field/Association Mappings In Subclasses <tutorials/override-field-association-mappings-in-subclasses>`
9ad376c @schmittjoh adds docs
schmittjoh authored
93 * :doc:`Embeddables <tutorials/embeddables>`
c0cefa8 @beberlei Fixed TOCTree for tutorial on indexed associations.
beberlei authored
94
79ba8c6 @beberlei Add Changelog/Migration to 2.5 documentation chapter.
beberlei authored
95 Changelogs
96 ----------
97
98 * :doc:`Migration to 2.5 <changelog/migration_2_5>`
99
4698346 @beberlei Finialized ReST doc changes, merged changes from latest Markdown docs.
beberlei authored
100 Cookbook
101 --------
102
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
103 * **Patterns**:
104 :doc:`Aggregate Fields <cookbook/aggregate-fields>` |
105 :doc:`Decorator Pattern <cookbook/decorator-pattern>` |
63ebaea @beberlei Some more work on index
beberlei authored
106 :doc:`Strategy Pattern <cookbook/strategy-cookbook-introduction>`
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
107
108 * **DQL Extension Points**:
109 :doc:`DQL Custom Walkers <cookbook/dql-custom-walkers>` |
110 :doc:`DQL User-Defined-Functions <cookbook/dql-user-defined-functions>`
111
112 * **Implementation**:
113 :doc:`Array Access <cookbook/implementing-arrayaccess-for-domain-objects>` |
114 :doc:`Notify ChangeTracking Example <cookbook/implementing-the-notify-changetracking-policy>` |
115 :doc:`Using Wakeup Or Clone <cookbook/implementing-wakeup-or-clone>` |
116 :doc:`Working with DateTime <cookbook/working-with-datetime>` |
117 :doc:`Validation <cookbook/validation-of-entities>` |
32dd7f1 @mnapoli Missing link to a cookbook in the docs
mnapoli authored
118 :doc:`Entities in the Session <cookbook/entities-in-session>` |
2eff096 @mnapoli Typo
mnapoli authored
119 :doc:`Keeping your Modules independent <cookbook/resolve-target-entity-listener>`
d5a97c0 @beberlei Add fancy new index page, moving toc to toc.rst
beberlei authored
120
121 * **Integration into Frameworks/Libraries**
122 :doc:`CodeIgniter <cookbook/integrating-with-codeigniter>`
123
124 * **Hidden Gems**
125 :doc:`Prefixing Table Name <cookbook/sql-table-prefixes>`
126
127 * **Custom Datatypes**
128 :doc:`MySQL Enums <cookbook/mysql-enums>`
129 :doc:`Advanced Field Value Conversion <cookbook/advanced-field-value-conversion-using-custom-mapping-types>`
48acbf7 @beberlei Reference new cookbook entry
beberlei authored
130
bc37ceb @eventhorizonpl fix warnings p1
eventhorizonpl authored
131 .. include:: toc.rst
Something went wrong with that request. Please try again.