From 1bfeaf3eafe8af3f621c88bbee541093e4364df5 Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Mon, 1 Nov 2010 21:16:12 +0100 Subject: [PATCH 01/10] Initial conversion from Markdown to ReST - Finalized Cookbook --- convert.sh | 14 + cookbook/en.rst | 34 + cookbook/en.txt | 22 +- cookbook/en/Makefile | 89 + cookbook/en/aggregate-fields.rst | 374 +++++ cookbook/en/aggregate-fields.txt | 318 ---- cookbook/en/conf.py | 194 +++ cookbook/en/dql-custom-walkers.rst | 216 +++ cookbook/en/dql-custom-walkers.txt | 174 -- cookbook/en/dql-user-defined-functions.rst | 239 +++ cookbook/en/dql-user-defined-functions.txt | 198 --- cookbook/en/getting-started-xml-edition.rst | 1037 ++++++++++++ cookbook/en/getting-started-xml-edition.txt | 784 --------- ...enting-arrayaccess-for-domain-objects.rst} | 77 +- ...ting-the-notify-changetracking-policy.rst} | 42 +- cookbook/en/implementing-wakeup-or-clone.rst | 76 + cookbook/en/implementing-wakeup-or-clone.txt | 63 - cookbook/en/index.rst | 32 + ...r.txt => integrating-with-codeigniter.rst} | 104 +- cookbook/en/make.bat | 113 ++ cookbook/en/sql-table-prefixes.rst | 73 + cookbook/en/sql-table-prefixes.txt | 51 - ...txt => strategy-cookbook-introduction.rst} | 144 +- cookbook/en/validation-of-entities.rst | 141 ++ cookbook/en/validation-of-entities.txt | 114 -- generate-docs.sh | 2 + manual/en.rst | 79 + manual/en.txt | 52 +- manual/en/annotations-reference.rst | 769 +++++++++ manual/en/annotations-reference.txt | 104 +- manual/en/architecture.rst | 125 ++ manual/en/architecture.txt | 14 +- manual/en/association-mapping.rst | 969 +++++++++++ manual/en/association-mapping.txt | 74 +- manual/en/basic-mapping.rst | 483 ++++++ manual/en/basic-mapping.txt | 46 +- manual/en/batch-processing.rst | 166 ++ manual/en/batch-processing.txt | 28 +- manual/en/best-practices.rst | 124 ++ manual/en/best-practices.txt | 22 +- manual/en/caching.rst | 479 ++++++ manual/en/caching.txt | 96 +- manual/en/change-tracking-policies.rst | 151 ++ manual/en/change-tracking-policies.txt | 14 +- manual/en/configuration.rst | 465 ++++++ manual/en/configuration.txt | 68 +- manual/en/dql-doctrine-query-language.rst | 1488 +++++++++++++++++ manual/en/dql-doctrine-query-language.txt | 212 +-- manual/en/events.rst | 603 +++++++ manual/en/events.txt | 58 +- manual/en/improving-performance.rst | 38 + manual/en/improving-performance.txt | 8 +- manual/en/inheritance-mapping.rst | 255 +++ manual/en/inheritance-mapping.txt | 24 +- manual/en/introduction.rst | 401 +++++ manual/en/introduction.txt | 38 +- manual/en/limitations-and-known-issues.rst | 267 +++ manual/en/limitations-and-known-issues.txt | 26 +- manual/en/metadata-drivers.rst | 187 +++ manual/en/metadata-drivers.txt | 22 +- manual/en/native-sql.rst | 353 ++++ manual/en/native-sql.txt | 38 +- manual/en/partial-objects.rst | 65 + manual/en/partial-objects.txt | 6 +- manual/en/php-mapping.rst | 248 +++ manual/en/php-mapping.txt | 42 +- manual/en/query-builder.rst | 490 ++++++ manual/en/query-builder.txt | 42 +- manual/en/tools.rst | 376 +++++ manual/en/tools.txt | 44 +- manual/en/transactions-and-concurrency.rst | 351 ++++ manual/en/transactions-and-concurrency.txt | 34 +- manual/en/working-with-associations.rst | 521 ++++++ manual/en/working-with-associations.txt | 34 +- manual/en/working-with-objects.rst | 765 +++++++++ manual/en/working-with-objects.txt | 80 +- manual/en/xml-mapping.rst | 716 ++++++++ manual/en/xml-mapping.txt | 36 +- manual/en/yaml-mapping.rst | 90 + manual/en/yaml-mapping.txt | 6 +- 80 files changed, 14545 insertions(+), 2472 deletions(-) create mode 100755 convert.sh create mode 100644 cookbook/en.rst create mode 100644 cookbook/en/Makefile create mode 100644 cookbook/en/aggregate-fields.rst delete mode 100644 cookbook/en/aggregate-fields.txt create mode 100644 cookbook/en/conf.py create mode 100644 cookbook/en/dql-custom-walkers.rst delete mode 100644 cookbook/en/dql-custom-walkers.txt create mode 100644 cookbook/en/dql-user-defined-functions.rst delete mode 100644 cookbook/en/dql-user-defined-functions.txt create mode 100644 cookbook/en/getting-started-xml-edition.rst delete mode 100644 cookbook/en/getting-started-xml-edition.txt rename cookbook/en/{implementing-arrayaccess-for-domain-objects.txt => implementing-arrayaccess-for-domain-objects.rst} (60%) rename cookbook/en/{implementing-the-notify-changetracking-policy.txt => implementing-the-notify-changetracking-policy.rst} (55%) create mode 100644 cookbook/en/implementing-wakeup-or-clone.rst delete mode 100644 cookbook/en/implementing-wakeup-or-clone.txt create mode 100644 cookbook/en/index.rst rename cookbook/en/{integrating-with-codeigniter.txt => integrating-with-codeigniter.rst} (56%) create mode 100644 cookbook/en/make.bat create mode 100644 cookbook/en/sql-table-prefixes.rst delete mode 100644 cookbook/en/sql-table-prefixes.txt rename cookbook/en/{strategy-cookbook-introduction.txt => strategy-cookbook-introduction.rst} (64%) create mode 100644 cookbook/en/validation-of-entities.rst delete mode 100644 cookbook/en/validation-of-entities.txt create mode 100755 generate-docs.sh create mode 100644 manual/en.rst create mode 100644 manual/en/annotations-reference.rst create mode 100644 manual/en/architecture.rst create mode 100644 manual/en/association-mapping.rst create mode 100644 manual/en/basic-mapping.rst create mode 100644 manual/en/batch-processing.rst create mode 100644 manual/en/best-practices.rst create mode 100644 manual/en/caching.rst create mode 100644 manual/en/change-tracking-policies.rst create mode 100644 manual/en/configuration.rst create mode 100644 manual/en/dql-doctrine-query-language.rst create mode 100644 manual/en/events.rst create mode 100644 manual/en/improving-performance.rst create mode 100644 manual/en/inheritance-mapping.rst create mode 100644 manual/en/introduction.rst create mode 100644 manual/en/limitations-and-known-issues.rst create mode 100644 manual/en/metadata-drivers.rst create mode 100644 manual/en/native-sql.rst create mode 100644 manual/en/partial-objects.rst create mode 100644 manual/en/php-mapping.rst create mode 100644 manual/en/query-builder.rst create mode 100644 manual/en/tools.rst create mode 100644 manual/en/transactions-and-concurrency.rst create mode 100644 manual/en/working-with-associations.rst create mode 100644 manual/en/working-with-objects.rst create mode 100644 manual/en/xml-mapping.rst create mode 100644 manual/en/yaml-mapping.rst diff --git a/convert.sh b/convert.sh new file mode 100755 index 000000000..27e4a5b85 --- /dev/null +++ b/convert.sh @@ -0,0 +1,14 @@ +#!/bin/bash +FILES=`find -iname *.txt -print` +for FILE in $FILES +do + # replace the + to # chars + sed -i -r 's/^([+]{4})\s/#### /' $FILE + sed -i -r 's/^([+]{3})\s/### /' $FILE + sed -i -r 's/^([+]{2})\s/## /' $FILE + sed -i -r 's/^([+]{1})\s/# /' $FILE + sed -i -r 's/(\[php\])/ ${FILE%.txt}.rst +done \ No newline at end of file diff --git a/cookbook/en.rst b/cookbook/en.rst new file mode 100644 index 000000000..2c5786b1d --- /dev/null +++ b/cookbook/en.rst @@ -0,0 +1,34 @@ +Getting Started XML-Edition +=========================== + +Implementing ArrayAccess for domain objects +=========================================== + +Implementing the NOTIFY change-tracking policy +============================================== + +Validation of Entities +====================== + +Implementing wakeup or clone +============================ + +Integrating with CodeIgniter +============================ + +DQL Custom Walkers +================== + +DQL User Defined Functions +========================== + +SQL Table Prefixes +================== + +Strategy Cookbook Introduction +============================== + +Aggregate Fields +================ + + diff --git a/cookbook/en.txt b/cookbook/en.txt index e7ee1629b..6a77ba99d 100644 --- a/cookbook/en.txt +++ b/cookbook/en.txt @@ -1,11 +1,11 @@ -+ Getting Started XML-Edition -+ Implementing ArrayAccess for domain objects -+ Implementing the NOTIFY change-tracking policy -+ Validation of Entities -+ Implementing wakeup or clone -+ Integrating with CodeIgniter -+ DQL Custom Walkers -+ DQL User Defined Functions -+ SQL Table Prefixes -+ Strategy Cookbook Introduction -+ Aggregate Fields \ No newline at end of file +# Getting Started XML-Edition +# Implementing ArrayAccess for domain objects +# Implementing the NOTIFY change-tracking policy +# Validation of Entities +# Implementing wakeup or clone +# Integrating with CodeIgniter +# DQL Custom Walkers +# DQL User Defined Functions +# SQL Table Prefixes +# Strategy Cookbook Introduction +# Aggregate Fields \ No newline at end of file diff --git a/cookbook/en/Makefile b/cookbook/en/Makefile new file mode 100644 index 000000000..987598317 --- /dev/null +++ b/cookbook/en/Makefile @@ -0,0 +1,89 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Doctrine2ORMCookbook.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Doctrine2ORMCookbook.qhc" + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ + "run these through (pdf)latex." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/cookbook/en/aggregate-fields.rst b/cookbook/en/aggregate-fields.rst new file mode 100644 index 000000000..ef91a4d62 --- /dev/null +++ b/cookbook/en/aggregate-fields.rst @@ -0,0 +1,374 @@ +Aggregate Fields +================ + +You will often come across the requirement to display aggregate +values of data that can be computed by using the MIN, MAX, COUNT or +SUM SQL functions. For any ORM this is a tricky issue +traditionally. Doctrine 2 offers several ways to get access to +these values and this article will describe all of them from +different perspectives. + +You will see that aggregate fields can become very explicit +features in your domain model and how this potentially complex +business rules can be easily tested. + +An example model +---------------- + +Say you want to model a bank account and all their entries. Entries +into the account can either be of positive or negative money +values. Each account has a credit limit and the account is never +allowed to have a balance below that value. + +For simplicity we live in a world were money is composed of +integers only. Also we omit the receiver/sender name, stated reason +for transfer and the execution date. These all would have to be +added on the ``Entry`` object. + +Our entities look like: + +:: + + no = $no; + $this->maxCredit = $maxCredit; + $this->entries = new \Doctrine\Common\Collections\ArrayCollection(); + } + } + + /** + * @Entity + */ + class Entry + { + /** @Id @GeneratedValue @Column(type="integer") */ + private $id; + + /** + * @ManyToOne(targetEntity="Account", inversedBy="entries") + */ + private $account; + + /** + * @Column(type="integer") + */ + private $amount; + + public function __construct($account, $amount) + { + $this->account = $account; + $this->amount = $amount; + // more stuff here, from/to whom, stated reason, execution date and such + } + + public function getAmount() + { + return $this->amount; + } + } + +Using DQL +--------- + +The Doctrine Query Language allows you to select for aggregate +values computed from fields of your Domain Model. You can select +the current balance of your account by calling: + +:: + + createQuery($dql) + ->setParameter(1, $myAccountId) + ->getSingleScalarResult(); + +The ``$em`` variable in this (and forthcoming) example holds the +Doctrine ``EntityManager``. We create a query for the SUM of all +amounts (negative amounts are withdraws) and retrieve them as a +single scalar result, essentially return only the first column of +the first row. + +This approach is simple and powerful, however it has a serious +drawback. We have to execute a specific query for the balance +whenever we need it. + +To implement a powerful domain model we would rather have access to +the balance from our ``Account`` entity during all times (even if +the Account was not persisted in the database before!). + +Also an additional requirement is the max credit per ``Account`` +rule. + +We cannot reliably enforce this rule in our ``Account`` entity with +the DQL retrieval of the balance. There are many different ways to +retrieve accounts. We cannot guarantee that we can execute the +aggregation query for all these use-cases, let alone that a +userland programmer checks this balance against newly added +entries. + +Using your Domain Model +----------------------- + +``Account`` and all the ``Entry`` instances are connected through a +collection, which means we can compute this value at runtime: + +:: + + entries AS $entry) { + $balance += $entry->getAmount(); + } + return $balance; + } + } + +Now we can always call ``Account::getBalance()`` to access the +current account balance. + +To enforce the max credit rule we have to implement the "Aggregate +Root" pattern as described in Eric Evans book on Domain Driven +Design. Described with one sentence, an aggregate root controls the +instance creation, access and manipulation of its children. + +In our case we want to enforce that new entries can only added to +the ``Account`` by using a designated method. The ``Account`` is +the aggregate root of this relation. We can also enforce the +correctness of the bi-directional ``Account`` <-> ``Entry`` +relation with this method: + +:: + + assertAcceptEntryAllowed($amount); + + $e = new Entry($this, $amount); + $this->entries[] = $e; + return $e; + } + } + +Now look at the following test-code for our entities: + +:: + + assertEquals(0, $account->getBalance()); + + $account->addEntry(500); + $this->assertEquals(500, $account->getBalance()); + + $account->addEntry(-700); + $this->assertEquals(-200, $account->getBalance()); + } + + public function testExceedMaxLimit() + { + $account = new Account("123456", $maxCredit = 200); + + $this->setExpectedException("Exception"); + $account->addEntry(-1000); + } + } + +To enforce our rule we can now implement the assertion in +``Account::addEntry``: + +:: + + getBalance() + $amount; + $allowedMinimalBalance = ($this->maxCredit * -1); + if ($futureBalance < $allowedMinimalBalance) { + throw new Exception("Credit Limit exceeded, entry is not allowed!"); + } + } + } + +We haven't talked to the entity manager for persistence of our +account example before. You can call +``EntityManager::persist($account)`` and then +``EntityManager::flush()`` at any point to save the account to the +database. All the nested ``Entry`` objects are automatically +flushed to the database also. + +:: + + addEntry(500); + $account->addEntry(-200); + $em->persist($account); + $em->flush(); + +The current implementation has a considerable drawback. To get the +balance, we have to initialize the complete ``Account::$entries`` +collection, possibly a very large one. This can considerably hurt +the performance of your application. + +Using an Aggregate Field +------------------------ + +To overcome the previously mentioned issue (initializing the whole +entries collection) we want to add an aggregate field called +"balance" on the Account and adjust the code in +``Account::getBalance()`` and ``Account:addEntry()``: + +:: + + balance; + } + + public function addEntry($amount) + { + $this->assertAcceptEntryAllowed($amount); + + $e = new Entry($this, $amount); + $this->entries[] = $e; + $this->balance += $amount; + return $e; + } + } + +This is a very simple change, but all the tests still pass. Our +account entities return the correct balance. Now calling the +``Account::getBalance()`` method will not occur the overhead of +loading all entries anymore. Adding a new Entry to the +``Account::$entities`` will also not initialize the collection +internally. + +Adding a new entry is therefore very performant and explicitly +hooked into the domain model. It will only update the account with +the current balance and insert the new entry into the database. + +Tackling Race Conditions with Aggregate Fields +---------------------------------------------- + +Whenever you denormalize your database schema race-conditions can +potentially lead to inconsistent state. See this example: + +:: + + find('Bank\Entities\Account', $accId); + + // request 2 account + $account2 = $em->find('Bank\Entities\Account', $accId); + + $account1->addEntry(-200); + $account2->addEntry(-200); + + // now request 1 and 2 both flush the changes. + +The aggregate field ``Account::$balance`` is now -200, however the +SUM over all entries amounts yields -400. A violation of our max +credit rule. + +You can use both optimistic or pessimistic locking to save-guard +your aggregate fields against this kind of race-conditions. Reading +Eric Evans DDD carefully he mentions that the "Aggregate Root" +(Account in our example) needs a locking mechanism. + +Optimistic locking is as easy as adding a version column: + +:: + + find('Bank\Entities\Account', $accId, LockMode::PESSIMISTIC_READ); + +Keeping Updates and Deletes in Sync +----------------------------------- + +The example shown in this article does not allow changes to the +value in ``Entry``, which considerably simplifies the effort to +keep ``Account::$balance`` in sync. If your use-case allows fields +to be updated or related entities to be removed you have to +encapsulate this logic in your "Aggregate Root" entity and adjust +the aggregate field accordingly. + +Conclusion +---------- + +This article described how to obtain aggregate values using DQL or +your domain model. It showed how you can easily add an aggregate +field that offers serious performance benefits over iterating all +the related objects that make up an aggregate value. Finally I +showed how you can ensure that your aggregate fields do not get out +of sync due to race-conditions and concurrent access. + + diff --git a/cookbook/en/aggregate-fields.txt b/cookbook/en/aggregate-fields.txt deleted file mode 100644 index 18e445034..000000000 --- a/cookbook/en/aggregate-fields.txt +++ /dev/null @@ -1,318 +0,0 @@ -# Aggregate Fields - -You will often come across the requirement to display aggregate values of data that -can be computed by using the MIN, MAX, COUNT or SUM SQL functions. For any ORM this is a tricky issue traditionally. Doctrine 2 offers several ways to get access to these values and this article will describe all of them from different perspectives. - -You will see that aggregate fields can become very explicit -features in your domain model and how this potentially complex business rules -can be easily tested. - -## An example model - -Say you want to model a bank account and all their entries. Entries -into the account can either be of positive or negative money values. -Each account has a credit limit and the account is never allowed -to have a balance below that value. - -For simplicity we live in a world were money is composed of integers -only. Also we omit the receiver/sender name, stated reason for transfer -and the execution date. These all would have to be added on the `Entry` -object. - -Our entities look like: - - [php] - namespace Bank\Entities; - - /** - * @Entity - */ - class Account - { - /** @Id @GeneratedValue @Column(type="integer") */ - private $id; - - /** @Column(type="string", unique=true) */ - private $no; - - /** - * @OneToMany(targetEntity="Entry", mappedBy="entries", cascade={"persist"}) - */ - private $entries; - - /** - * @Column(type="integer") - */ - private $maxCredit = 0; - - public function __construct($no, $maxCredit = 0) - { - $this->no = $no; - $this->maxCredit = $maxCredit; - $this->entries = new \Doctrine\Common\Collections\ArrayCollection(); - } - } - - /** - * @Entity - */ - class Entry - { - /** @Id @GeneratedValue @Column(type="integer") */ - private $id; - - /** - * @ManyToOne(targetEntity="Account", inversedBy="entries") - */ - private $account; - - /** - * @Column(type="integer") - */ - private $amount; - - public function __construct($account, $amount) - { - $this->account = $account; - $this->amount = $amount; - // more stuff here, from/to whom, stated reason, execution date and such - } - - public function getAmount() - { - return $this->amount; - } - } - -## Using DQL - -The Doctrine Query Language allows you to select for aggregate values computed from -fields of your Domain Model. You can select the current balance of your account by -calling: - - [php] - $dql = "SELECT SUM(e.amount) AS balance FROM Bank\Entities\Entry e " . - "WHERE e.account = ?1"; - $balance = $em->createQuery($dql) - ->setParameter(1, $myAccountId) - ->getSingleScalarResult(); - -The `$em` variable in this (and forthcoming) example holds the Doctrine `EntityManager`. -We create a query for the SUM of all amounts (negative amounts are withdraws) and -retrieve them as a single scalar result, essentially return only the first column -of the first row. - -This approach is simple and powerful, however it has a serious drawback. We have -to execute a specific query for the balance whenever we need it. - -To implement a powerful domain model we would rather have access to the balance from -our `Account` entity during all times (even if the Account was not persisted -in the database before!). - -Also an additional requirement is the max credit per `Account` rule. - -We cannot reliably enforce this rule in our `Account` entity with the DQL retrieval -of the balance. There are many different ways to retrieve accounts. We cannot -guarantee that we can execute the aggregation query for all these use-cases, -let alone that a userland programmer checks this balance against newly added -entries. - -## Using your Domain Model - -`Account` and all the `Entry` instances are connected through a collection, -which means we can compute this value at runtime: - - [php] - class Account - { - // .. previous code - public function getBalance() - { - $balance = 0; - foreach ($this->entries AS $entry) { - $balance += $entry->getAmount(); - } - return $balance; - } - } - -Now we can always call `Account::getBalance()` to access the current account balance. - -To enforce the max credit rule we have to implement the "Aggregate Root" pattern as -described in Eric Evans book on Domain Driven Design. Described with one sentence, -an aggregate root controls the instance creation, access and manipulation of its children. - -In our case we want to enforce that new entries can only added to the `Account` by -using a designated method. The `Account` is the aggregate root of this relation. -We can also enforce the correctness of the bi-directional `Account` <-> `Entry` -relation with this method: - - [php] - class Account - { - public function addEntry($amount) - { - $this->assertAcceptEntryAllowed($amount); - - $e = new Entry($this, $amount); - $this->entries[] = $e; - return $e; - } - } - -Now look at the following test-code for our entities: - - [php] - class AccountTest extends \PHPUnit_Framework_TestCase - { - public function testAddEntry() - { - $account = new Account("123456", $maxCredit = 200); - $this->assertEquals(0, $account->getBalance()); - - $account->addEntry(500); - $this->assertEquals(500, $account->getBalance()); - - $account->addEntry(-700); - $this->assertEquals(-200, $account->getBalance()); - } - - public function testExceedMaxLimit() - { - $account = new Account("123456", $maxCredit = 200); - - $this->setExpectedException("Exception"); - $account->addEntry(-1000); - } - } - -To enforce our rule we can now implement the assertion in `Account::addEntry`: - - [php] - class Account - { - private function assertAcceptEntryAllowed($amount) - { - $futureBalance = $this->getBalance() + $amount; - $allowedMinimalBalance = ($this->maxCredit * -1); - if ($futureBalance < $allowedMinimalBalance) { - throw new Exception("Credit Limit exceeded, entry is not allowed!"); - } - } - } - -We haven't talked to the entity manager for persistence of our account example before. -You can call `EntityManager::persist($account)` and then `EntityManager::flush()` -at any point to save the account to the database. All the nested `Entry` objects -are automatically flushed to the database also. - - [php] - $account = new Account("123456", 200); - $account->addEntry(500); - $account->addEntry(-200); - $em->persist($account); - $em->flush(); - -The current implementation has a considerable drawback. To get the balance, we -have to initialize the complete `Account::$entries` collection, possibly a very -large one. This can considerably hurt the performance of your application. - -## Using an Aggregate Field - -To overcome the previously mentioned issue (initializing the whole entries collection) -we want to add an aggregate field called "balance" on the Account and adjust the -code in `Account::getBalance()` and `Account:addEntry()`: - - [php] - class Account - { - /** - * @Column(type="integer") - */ - private $balance = 0; - - public function getBalance() - { - return $this->balance; - } - - public function addEntry($amount) - { - $this->assertAcceptEntryAllowed($amount); - - $e = new Entry($this, $amount); - $this->entries[] = $e; - $this->balance += $amount; - return $e; - } - } - -This is a very simple change, but all the tests still pass. Our account entities return -the correct balance. Now calling the `Account::getBalance()` method will not occur the -overhead of loading all entries anymore. Adding a new Entry to the `Account::$entities` -will also not initialize the collection internally. - -Adding a new entry is therefore very performant and explicitly hooked into the domain model. -It will only update the account with the current balance and insert the new entry into the database. - -## Tackling Race Conditions with Aggregate Fields - -Whenever you denormalize your database schema race-conditions can potentially lead to -inconsistent state. See this example: - - [php] - // The Account $accId has a balance of 0 and a max credit limit of 200: - // request 1 account - $account1 = $em->find('Bank\Entities\Account', $accId); - - // request 2 account - $account2 = $em->find('Bank\Entities\Account', $accId); - - $account1->addEntry(-200); - $account2->addEntry(-200); - - // now request 1 and 2 both flush the changes. - -The aggregate field `Account::$balance` is now -200, however the SUM over all -entries amounts yields -400. A violation of our max credit rule. - -You can use both optimistic or pessimistic locking to save-guard -your aggregate fields against this kind of race-conditions. Reading Eric Evans -DDD carefully he mentions that the "Aggregate Root" (Account in our example) -needs a locking mechanism. - -Optimistic locking is as easy as adding a version column: - - [php] - class Amount - { - /** @Column(type="integer") @Version */ - private $version; - } - -The previous example would then throw an exception in the face of whatever request -saves the entity last (and would create the inconsistent state). - -Pessimistic locking requires an additional flag set on the `EntityManager::find()` -call, enabling write locking directly in the database using a FOR UPDATE. - - [php] - use Doctrine\DBAL\LockMode; - - $account = $em->find('Bank\Entities\Account', $accId, LockMode::PESSIMISTIC_READ); - -## Keeping Updates and Deletes in Sync - -The example shown in this article does not allow changes to the value in `Entry`, -which considerably simplifies the effort to keep `Account::$balance` in sync. -If your use-case allows fields to be updated or related entities to be removed -you have to encapsulate this logic in your "Aggregate Root" entity and adjust -the aggregate field accordingly. - -## Conclusion - -This article described how to obtain aggregate values using DQL or your domain model. -It showed how you can easily add an aggregate field that offers serious performance -benefits over iterating all the related objects that make up an aggregate value. -Finally I showed how you can ensure that your aggregate fields do not get out -of sync due to race-conditions and concurrent access. \ No newline at end of file diff --git a/cookbook/en/conf.py b/cookbook/en/conf.py new file mode 100644 index 000000000..58e36054e --- /dev/null +++ b/cookbook/en/conf.py @@ -0,0 +1,194 @@ +# -*- coding: utf-8 -*- +# +# Doctrine 2 ORM Cookbook documentation build configuration file, created by +# sphinx-quickstart on Mon Nov 1 21:13:13 2010. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.append(os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Doctrine 2 ORM Cookbook' +copyright = u'2010, Doctrine Project Team' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '2.0' +# The full version, including alpha/beta/rc tags. +release = '2.0.0-BETA4' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directory, that shouldn't be searched +# for source files. +exclude_trees = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_use_modindex = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Doctrine2ORMCookbookdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Doctrine2ORMCookbook.tex', u'Doctrine 2 ORM Cookbook Documentation', + u'Doctrine Project Team', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True diff --git a/cookbook/en/dql-custom-walkers.rst b/cookbook/en/dql-custom-walkers.rst new file mode 100644 index 000000000..c92447dba --- /dev/null +++ b/cookbook/en/dql-custom-walkers.rst @@ -0,0 +1,216 @@ +Extending DQL in Doctrine 2: Custom AST Walkers +=============================================== + +The Doctrine Query Language (DQL) is a proprietary sql-dialect that +substitutes tables and columns for Entity names and their fields. +Using DQL you write a query against the database using your +entities. With the help of the metadata you can write very concise, +compact and powerful queries that are then translated into SQL by +the Doctrine ORM. + +In Doctrine 1 the DQL language was not implemented using a real +parser. This made modifications of the DQL by the user impossible. +Doctrine 2 in contrast has a real parser for the DQL language, +which transforms the DQL statement into an +`Abstract Syntax Tree `_ +and generates the appropriate SQL statement for it. Since this +process is deterministic Doctrine heavily caches the SQL that is +generated from any given DQL query, which reduces the performance +overhead of the parsing process to zero. + +You can modify the Abstract syntax tree by hooking into DQL parsing +process by adding a Custom Tree Walker. A walker is an interface +that walks each node of the Abstract syntax tree, thereby +generating the SQL statement. + +There are two types of custom tree walkers that you can hook into +the DQL parser: + + +- An output walker. This one actually generates the SQL, and there + is only ever one of them. We implemented the default SqlWalker + implementation for it. +- A tree walker. There can be many tree walkers, they cannot + generate the sql, however they can modify the AST before its + rendered to sql. + +Now this is all awfully technical, so let me come to some use-cases +fast to keep you motivated. Using walker implementation you can for +example: + + +- Modify the AST to generate a Count Query to be used with a + paginator for any given DQL query. +- Modify the Output Walker to generate vendor-specific SQL + (instead of ANSI). +- Modify the AST to add additional where clauses for specific + entities (example ACL, country-specific content...) +- Modify the Output walker to pretty print the SQL for debugging + purposes. + +In this cookbook-entry I will show examples on the first two +points. There are probably much more use-cases. + +Generic count query for pagination +---------------------------------- + +Say you have a blog and posts all with one category and one author. +A query for the front-page or any archive page might look something +like: + +.. code-clock:: sql + + SELECT p, c, a FROM BlogPost p JOIN p.category c JOIN p.author a WHERE ... + +Now in this query the blog post is the root entity, meaning its the +one that is hydrated directly from the query and returned as an +array of blog posts. In contrast the comment and author are loaded +for deeper use in the object tree. + +A pagination for this query would want to approximate the number of +posts that match the WHERE clause of this query to be able to +predict the number of pages to show to the user. A draft of the DQL +query for pagination would look like: + +.. code-clock:: sql + + SELECT count(DISTINCT p.id) FROM BlogPost p JOIN p.category c JOIN p.author a WHERE ... + +Now you could go and write each of these queries by hand, or you +can use a tree walker to modify the AST for you. Lets see how the +API would look for this use-case: + +:: + + createQuery($dql); + $query->setFirstResult( ($pageNum-1) * 20)->setMaxResults(20); + + $totalResults = Paginate::count($query); + $results = $query->getResult(); + +The ``Paginate::count(Query $query)`` looks like: + +:: + + setHint(Query::HINT_CUSTOM_TREE_WALKERS, array('DoctrineExtensions\Paginate\CountSqlWalker')); + $countQuery->setFirstResult(null)->setMaxResults(null); + + return $countQuery->getSingleScalarResult(); + } + } + +It clones the query, resets the limit clause first and max results +and registers the ``CountSqlWalker`` customer tree walker which +will modify the AST to execute a count query. The walkers +implementation is: + +:: + + _getQueryComponents() AS $dqlAlias => $qComp) { + if ($qComp['parent'] === null && $qComp['nestingLevel'] == 0) { + $parent = $qComp; + $parentName = $dqlAlias; + break; + } + } + + $pathExpression = new PathExpression( + PathExpression::TYPE_STATE_FIELD | PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION, $parentName, array( + $parent['metadata']->getSingleIdentifierFieldName()) + ); + $pathExpression->type = PathExpression::TYPE_STATE_FIELD; + + $AST->selectClause->selectExpressions = array( + new SelectExpression( + new AggregateExpression('count', $pathExpression, true), null + ) + ); + } + } + +This will delete any given select expressions and replace them with +a distinct count query for the root entities primary key. This will +only work if your entity has only one identifier field (composite +keys won't work). + +Modify the Output Walker to generate Vendor specific SQL +-------------------------------------------------------- + +Most RMDBS have vendor-specific features for optimizing select +query execution plans. You can write your own output walker to +introduce certain keywords using the Query Hint API. A query hint +can be set via ``Query::setHint($name, $value)`` as shown in the +previous example with the ``HINT_CUSTOM_TREE_WALKERS`` query hint. + +We will implement a custom Output Walker that allows to specify the +SQL\_NO\_CACHE query hint. + +:: + + createQuery($dql); + $query->setQueryHint(Query::HINT_CUSTOM_OUTPUT_WALKER, 'DoctrineExtensions\Query\MysqlWalker'); + $query->setQueryHint("mysqlWalker.sqlNoCache", true); + $results = $query->getResult(); + +Our ``MysqlWalker`` will extend the default ``SqlWalker``. We will +modify the generation of the SELECT clause, adding the +SQL\_NO\_CACHE on those queries that need it: + +:: + + getQuery()->getHint('mysqlWalker.sqlNoCache') === true) { + if ($selectClause->isDistinct) { + $sql = str_replace('SELECT DISTINCT', 'SELECT DISTINCT SQL_NO_CACHE', $sql); + } else { + $sql = str_replace('SELECT', 'SELECT SQL_NO_CACHE', $sql); + } + } + + return $sql; + } + } + +Writing extensions to the Output Walker requires a very deep +understanding of the DQL Parser and Walkers, but may offer your +huge benefits with using vendor specific features. This would still +allow you write DQL queries instead of NativeQueries to make use of +vendor specific features. + + diff --git a/cookbook/en/dql-custom-walkers.txt b/cookbook/en/dql-custom-walkers.txt deleted file mode 100644 index 2f314cd78..000000000 --- a/cookbook/en/dql-custom-walkers.txt +++ /dev/null @@ -1,174 +0,0 @@ -# Extending DQL in Doctrine 2: Custom AST Walkers - -The Doctrine Query Language (DQL) is a proprietary sql-dialect that substitutes -tables and columns for Entity names and their fields. Using DQL you write a query -against the database using your entities. With the help of the metadata you -can write very concise, compact and powerful queries that are then translated -into SQL by the Doctrine ORM. - -In Doctrine 1 the DQL language was not implemented using a real parser. This -made modifications of the DQL by the user impossible. Doctrine 2 in contrast -has a real parser for the DQL language, which transforms the DQL statement -into an [Abstract Syntax Tree](http://en.wikipedia.org/wiki/Abstract_syntax_tree) -and generates the appropriate SQL statement for it. Since this process is -deterministic Doctrine heavily caches the SQL that is generated from any given DQL query, -which reduces the performance overhead of the parsing process to zero. - -You can modify the Abstract syntax tree by hooking into DQL parsing process -by adding a Custom Tree Walker. A walker is an interface that walks each -node of the Abstract syntax tree, thereby generating the SQL statement. - -There are two types of custom tree walkers that you can hook into the DQL parser: - -- An output walker. This one actually generates the SQL, and there is only ever one of them. We implemented the default SqlWalker implementation for it. -- A tree walker. There can be many tree walkers, they cannot generate the sql, however they can modify the AST before its rendered to sql. - -Now this is all awfully technical, so let me come to some use-cases fast -to keep you motivated. Using walker implementation you can for example: - -* Modify the AST to generate a Count Query to be used with a paginator for any given DQL query. -* Modify the Output Walker to generate vendor-specific SQL (instead of ANSI). -* Modify the AST to add additional where clauses for specific entities (example ACL, country-specific content...) -* Modify the Output walker to pretty print the SQL for debugging purposes. - -In this cookbook-entry I will show examples on the first two points. There -are probably much more use-cases. - -## Generic count query for pagination - -Say you have a blog and posts all with one category and one author. A query -for the front-page or any archive page might look something like: - - [sql] - SELECT p, c, a FROM BlogPost p JOIN p.category c JOIN p.author a WHERE ... - -Now in this query the blog post is the root entity, meaning its the one that -is hydrated directly from the query and returned as an array of blog posts. -In contrast the comment and author are loaded for deeper use in the object tree. - -A pagination for this query would want to approximate the number of posts that -match the WHERE clause of this query to be able to predict the number of pages -to show to the user. A draft of the DQL query for pagination would look like: - - [sql] - SELECT count(DISTINCT p.id) FROM BlogPost p JOIN p.category c JOIN p.author a WHERE ... - -Now you could go and write each of these queries by hand, or you can use a tree -walker to modify the AST for you. Lets see how the API would look for this use-case: - - [php] - $pageNum = 1; - $query = $em->createQuery($dql); - $query->setFirstResult( ($pageNum-1) * 20)->setMaxResults(20); - - $totalResults = Paginate::count($query); - $results = $query->getResult(); - -The `Paginate::count(Query $query)` looks like: - - [php] - class Paginate - { - static public function count(Query $query) - { - /* @var $countQuery Query */ - $countQuery = clone $query; - - $countQuery->setHint(Query::HINT_CUSTOM_TREE_WALKERS, array('DoctrineExtensions\Paginate\CountSqlWalker')); - $countQuery->setFirstResult(null)->setMaxResults(null); - - return $countQuery->getSingleScalarResult(); - } - } - -It clones the query, resets the limit clause first and max results and registers the `CountSqlWalker` -customer tree walker which will modify the AST to execute a count query. The walkers -implementation is: - - [php] - class CountSqlWalker extends TreeWalkerAdapter - { - /** - * Walks down a SelectStatement AST node, thereby generating the appropriate SQL. - * - * @return string The SQL. - */ - public function walkSelectStatement(SelectStatement $AST) - { - $parent = null; - $parentName = null; - foreach ($this->_getQueryComponents() AS $dqlAlias => $qComp) { - if ($qComp['parent'] === null && $qComp['nestingLevel'] == 0) { - $parent = $qComp; - $parentName = $dqlAlias; - break; - } - } - - $pathExpression = new PathExpression( - PathExpression::TYPE_STATE_FIELD | PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION, $parentName, array( - $parent['metadata']->getSingleIdentifierFieldName()) - ); - $pathExpression->type = PathExpression::TYPE_STATE_FIELD; - - $AST->selectClause->selectExpressions = array( - new SelectExpression( - new AggregateExpression('count', $pathExpression, true), null - ) - ); - } - } - -This will delete any given select expressions and replace them with a distinct count -query for the root entities primary key. This will only work if your entity has -only one identifier field (composite keys won't work). - -## Modify the Output Walker to generate Vendor specific SQL - -Most RMDBS have vendor-specific features for optimizing select query -execution plans. You can write your own output walker to introduce certain -keywords using the Query Hint API. A query hint can be set via `Query::setHint($name, $value)` -as shown in the previous example with the `HINT_CUSTOM_TREE_WALKERS` query hint. - -We will implement a custom Output Walker that allows to specify the SQL_NO_CACHE -query hint. - - [php] - $dql = "SELECT p, c, a FROM BlogPost p JOIN p.category c JOIN p.author a WHERE ..."; - $query = $m->createQuery($dql); - $query->setQueryHint(Query::HINT_CUSTOM_OUTPUT_WALKER, 'DoctrineExtensions\Query\MysqlWalker'); - $query->setQueryHint("mysqlWalker.sqlNoCache", true); - $results = $query->getResult(); - -Our `MysqlWalker` will extend the default `SqlWalker`. We will modify the generation -of the SELECT clause, adding the SQL_NO_CACHE on those queries that need it: - - [php] - class MysqlWalker extends SqlWalker - { - /** - * Walks down a SelectClause AST node, thereby generating the appropriate SQL. - * - * @param $selectClause - * @return string The SQL. - */ - public function walkSelectClause($selectClause) - { - $sql = parent::walkSelectClause($selectClause); - - if ($this->getQuery()->getHint('mysqlWalker.sqlNoCache') === true) { - if ($selectClause->isDistinct) { - $sql = str_replace('SELECT DISTINCT', 'SELECT DISTINCT SQL_NO_CACHE', $sql); - } else { - $sql = str_replace('SELECT', 'SELECT SQL_NO_CACHE', $sql); - } - } - - return $sql; - } - } - -Writing extensions to the Output Walker requires a very deep understanding -of the DQL Parser and Walkers, but may offer your huge benefits with using vendor specific -features. This would still allow you write DQL queries instead of NativeQueries -to make use of vendor specific features. diff --git a/cookbook/en/dql-user-defined-functions.rst b/cookbook/en/dql-user-defined-functions.rst new file mode 100644 index 000000000..d39cda9f2 --- /dev/null +++ b/cookbook/en/dql-user-defined-functions.rst @@ -0,0 +1,239 @@ +DQL User Defined Functions +========================== + +By default DQL supports a limited subset of all the vendor-specific +SQL functions common between all the vendors. However in many cases +once you have decided on a specific database vendor, you will never +change it during the life of your project. This decision for a +specific vendor potentially allows you to make use of powerful SQL +features that are unique to the vendor. + + **Note** + + It is worth to mention that Doctrine 2 also allows you to handwrite + your SQL instead of extending the DQL parser, which is sort of an + advanced extension point. You can map arbitrary SQL to your objects + and gain access to vendor specific functionalities using the + ``EntityManager#createNativeQuery()`` API. + + +The DQL Parser has hooks to register functions that can then be +used in your DQL queries and transformed into SQL, allowing to +extend Doctrines Query capabilities to the vendors strength. This +post explains the Used-Defined Functions API (UDF) of the Dql +Parser and shows some examples to give you some hints how you would +extend DQL. + +There are three types of functions in DQL, those that return a +numerical value, those that return a string and those that return a +Date. Your custom method has to be registered as either one of +those. The return type information is used by the DQL parser to +check possible syntax errors during the parsing process, for +example using a string function return value in a math expression. + +Registering your own DQL functions +---------------------------------- + +You can register your functions adding them to the ORM +configuration: + +:: + + addCustomStringFunction($name, $class); + $config->addCustomNumericFunction($name, $class); + $config->addCustomDatetimeFunction($name, $class); + + $em = EntityManager::create($dbParams, $config); + +The ``$name`` is the name the function will be referred to in the +DQL query. ``$class`` is a string of a class-name which has to +extend ``Doctrine\ORM\Query\Node\FunctionNode``. This is a class +that offers all the necessary API and methods to implement a UDF. + +In this post we will implement some MySql specific Date calculation +methods, which are quite handy in my opinion: + +Date Diff +--------- + +`Mysql's DateDiff function `_ +takes two dates as argument and calculates the difference in days +with ``date1-date2``. + +The DQL parser is a top-down recursive descent parser to generate +the Abstract-Syntax Tree (AST) and uses a TreeWalker approach to +generate the appropriate SQL from the AST. This makes reading the +Parser/TreeWalker code manageable in a finite amount of time. + +The ``FunctionNode`` class I referred to earlier requires you to +implement two methods, one for the parsing process (obviously) +called ``parse`` and one for the TreeWalker process called +``getSql()``. I show you the code for the DateDiff method and +discuss it step by step: + +:: + + match(Lexer::T_IDENTIFIER); // (2) + $parser->match(Lexer::T_OPEN_PARENTHESIS); // (3) + $this->firstDateExpression = $parser->ArithmeticPrimary(); // (4) + $parser->match(Lexer::T_COMMA); // (5) + $this->secondDateExpression = $parser->ArithmeticPrimary(); // (6) + $parser->match(Lexer::T_CLOSE_PARENTHESIS); // (3) + } + + public function getSql(\Doctrine\ORM\Query\SqlWalker $sqlWalker) + { + return 'DATEDIFF(' . + $this->firstDateExpression->dispatch($sqlWalker) . ', ' . + $this->secondDateExpression->dispatch($sqlWalker) . + ')'; // (7) + } + } + +The Parsing process of the DATEDIFF function is going to find two +expressions the date1 and the date2 values, whose AST Node +representations will be saved in the variables of the DateDiff +FunctionNode instance at (1). + +The parse() method has to cut the function call "DATEDIFF" and its +argument into pieces. Since the parser detects the function using a +lookahead the T\_IDENTIFIER of the function name has to be taken +from the stack (2), followed by a detection of the arguments in +(4)-(6). The opening and closing parenthesis have to be detected +also. This happens during the Parsing process and leads to the +generation of a DateDiff FunctionNode somewhere in the AST of the +dql statement. + +The ``ArithmeticPrimary`` method call is the most common +denominator of valid EBNF tokens taken from the +`DQL EBNF grammar `_ +that matches our requirements for valid input into the DateDiff Dql +function. Picking the right tokens for your methods is a tricky +business, but the EBNF grammar is pretty helpful finding it, as is +looking at the Parser source code. + +Now in the TreeWalker process we have to pick up this node and +generate SQL from it, which apparently is quite easy looking at the +code in (7). Since we don't know which type of AST Node the first +and second Date expression are we are just dispatching them back to +the SQL Walker to generate SQL from and then wrap our DATEDIFF +function call around this output. + +Now registering this DateDiff FunctionNode with the ORM using: + +:: + + addCustomStringFunction('DATEDIFF', 'DoctrineExtensions\Query\MySql\DateDiff'); + +We can do fancy stuff like: + +.. code-clock:: sql + + SELECT p FROM DoctrineExtensions\Query\BlogPost p WHERE DATEDIFF(CURRENT_TIME(), p.created) < 7 + +Date Add +-------- + +Often useful it the ability to do some simple date calculations in +your DQL query using +`MySql's DATE\_ADD function `_. + +I'll skip the blah and show the code for this function: + +:: + + match(Lexer::T_IDENTIFIER); + $parser->match(Lexer::T_OPEN_PARENTHESIS); + + $this->firstDateExpression = $parser->ArithmeticPrimary(); + + $parser->match(Lexer::T_COMMA); + $parser->match(Lexer::T_IDENTIFIER); + + $this->intervalExpression = $parser->ArithmeticPrimary(); + + $parser->match(Lexer::T_IDENTIFIER); + + /* @var $lexer Lexer */ + $lexer = $parser->getLexer(); + $this->unit = $lexer->token['value']; + + $parser->match(Lexer::T_CLOSE_PARENTHESIS); + } + + public function getSql(\Doctrine\ORM\Query\SqlWalker $sqlWalker) + { + return 'DATE_ADD(' . + $this->firstDateExpression->dispatch($sqlWalker) . ', INTERVAL ' . + $this->intervalExpression->dispatch($sqlWalker) . ' ' . $this->unit . + ')'; + } + } + +The only difference compared to the DATEDIFF here is, we +additionally need the ``Lexer`` to access the value of the +``T_IDENTIFIER`` token for the Date Interval unit, for example the +MONTH in: + +.. code-clock:: sql + + SELECT p FROM DoctrineExtensions\Query\BlogPost p WHERE DATE_ADD(CURRENT_TIME(), INTERVAL 4 MONTH) > p.created + +The above method now only supports the specification using +``INTERVAL``, to also allow a real date in DATE\_ADD we need to add +some decision logic to the parsing process (makes up for a nice +exercise). + +Now as you see, the Parsing process doesn't catch all the possible +SQL errors, here we don't match for all the valid inputs for the +interval unit. However where necessary we rely on the database +vendors SQL parser to show us further errors in the parsing +process, for example if the Unit would not be one of the supported +values by MySql. + +Conclusion +---------- + +Now that you all know how you can implement vendor specific SQL +functionalities in DQL, we would be excited to see user extensions +that add vendor specific function packages, for example more math +functions, XML + GIS Support, Hashing functions and so on. + +For 2.0 we will come with the current set of functions, however for +a future version we will re-evaluate if we can abstract even more +vendor sql functions and extend the DQL languages scope. + +Code for this Extension to DQL and other Doctrine Extensions can be +found +`in my Github DoctrineExtensions repository `_. + + diff --git a/cookbook/en/dql-user-defined-functions.txt b/cookbook/en/dql-user-defined-functions.txt deleted file mode 100644 index 811a5cf36..000000000 --- a/cookbook/en/dql-user-defined-functions.txt +++ /dev/null @@ -1,198 +0,0 @@ -By default DQL supports a limited subset of all the vendor-specific SQL functions -common between all the vendors. However in many cases once you have decided on a -specific database vendor, you will never change it during the life of your project. -This decision for a specific vendor potentially allows you to make use of powerful -SQL features that are unique to the vendor. - -> **Note** -> -> It is worth to mention that Doctrine 2 also allows you to handwrite your SQL instead of extending -> the DQL parser, which is sort of an advanced extension point. You can map arbitrary SQL to your -> objects and gain access to vendor specific functionalities using the `EntityManager#createNativeQuery()` API. - -The DQL Parser has hooks to register functions that can then be used in your DQL queries and transformed into SQL, -allowing to extend Doctrines Query capabilities to the vendors strength. This post explains the -Used-Defined Functions API (UDF) of the Dql Parser and shows some examples to give you -some hints how you would extend DQL. - -There are three types of functions in DQL, those that return a numerical value, -those that return a string and those that return a Date. Your custom method -has to be registered as either one of those. The return type information -is used by the DQL parser to check possible syntax errors during the parsing -process, for example using a string function return value in a math expression. - -## Registering your own DQL functions - -You can register your functions adding them to the ORM configuration: - - [php] - $config = new \Doctrine\ORM\Configuration(); - $config->addCustomStringFunction($name, $class); - $config->addCustomNumericFunction($name, $class); - $config->addCustomDatetimeFunction($name, $class); - - $em = EntityManager::create($dbParams, $config); - -The `$name` is the name the function will be referred to in the DQL query. `$class` is a -string of a class-name which has to extend `Doctrine\ORM\Query\Node\FunctionNode`. -This is a class that offers all the necessary API and methods to implement -a UDF. - -In this post we will implement some MySql specific Date calculation methods, -which are quite handy in my opinion: - -## Date Diff - -[Mysql's DateDiff function](http://dev.mysql.com/doc/refman/5.1/en/date-and-time-functions.html#function_datediff) -takes two dates as argument and calculates the difference in days with `date1-date2`. - -The DQL parser is a top-down recursive descent parser to generate the -Abstract-Syntax Tree (AST) and uses a TreeWalker approach to generate the appropriate -SQL from the AST. This makes reading the Parser/TreeWalker code manageable -in a finite amount of time. - -The `FunctionNode` class I referred to earlier requires you to implement -two methods, one for the parsing process (obviously) called `parse` and -one for the TreeWalker process called `getSql()`. I show you the code for -the DateDiff method and discuss it step by step: - - [php] - /** - * DateDiffFunction ::= "DATEDIFF" "(" ArithmeticPrimary "," ArithmeticPrimary ")" - */ - class DateDiff extends FunctionNode - { - // (1) - public $firstDateExpression = null; - public $secondDateExpression = null; - - public function parse(\Doctrine\ORM\Query\Parser $parser) - { - $parser->match(Lexer::T_IDENTIFIER); // (2) - $parser->match(Lexer::T_OPEN_PARENTHESIS); // (3) - $this->firstDateExpression = $parser->ArithmeticPrimary(); // (4) - $parser->match(Lexer::T_COMMA); // (5) - $this->secondDateExpression = $parser->ArithmeticPrimary(); // (6) - $parser->match(Lexer::T_CLOSE_PARENTHESIS); // (3) - } - - public function getSql(\Doctrine\ORM\Query\SqlWalker $sqlWalker) - { - return 'DATEDIFF(' . - $this->firstDateExpression->dispatch($sqlWalker) . ', ' . - $this->secondDateExpression->dispatch($sqlWalker) . - ')'; // (7) - } - } - -The Parsing process of the DATEDIFF function is going to find two expressions -the date1 and the date2 values, whose AST Node representations will be saved -in the variables of the DateDiff FunctionNode instance at (1). - -The parse() method has to cut the function call "DATEDIFF" and its argument -into pieces. Since the parser detects the function using a lookahead the -T_IDENTIFIER of the function name has to be taken from the stack (2), followed -by a detection of the arguments in (4)-(6). The opening and closing parenthesis -have to be detected also. This happens during the Parsing process and leads -to the generation of a DateDiff FunctionNode somewhere in the AST of the -dql statement. - -The `ArithmeticPrimary` method call is the most common denominator of valid -EBNF tokens taken from the [DQL EBNF grammar](http://www.doctrine-project.org/documentation/manual/2_0/en/dql-doctrine-query-language#ebnf) -that matches our requirements for valid input into the DateDiff Dql function. -Picking the right tokens for your methods is a tricky business, but the EBNF -grammar is pretty helpful finding it, as is looking at the Parser source code. - -Now in the TreeWalker process we have to pick up this node and generate SQL -from it, which apparently is quite easy looking at the code in (7). Since -we don't know which type of AST Node the first and second Date expression -are we are just dispatching them back to the SQL Walker to generate SQL from -and then wrap our DATEDIFF function call around this output. - -Now registering this DateDiff FunctionNode with the ORM using: - - [php] - $config = new \Doctrine\ORM\Configuration(); - $config->addCustomStringFunction('DATEDIFF', 'DoctrineExtensions\Query\MySql\DateDiff'); - -We can do fancy stuff like: - - [sql] - SELECT p FROM DoctrineExtensions\Query\BlogPost p WHERE DATEDIFF(CURRENT_TIME(), p.created) < 7 - -## Date Add - -Often useful it the ability to do some simple date calculations in your DQL query -using [MySql's DATE_ADD function](http://dev.mysql.com/doc/refman/5.1/en/date-and-time-functions.html#function_date-add). - -I'll skip the blah and show the code for this function: - - [php] - /** - * DateAddFunction ::= - * "DATE_ADD" "(" ArithmeticPrimary ", INTERVAL" ArithmeticPrimary Identifier ")" - */ - class DateAdd extends FunctionNode - { - public $firstDateExpression = null; - public $intervalExpression = null; - public $unit = null; - - public function parse(\Doctrine\ORM\Query\Parser $parser) - { - $parser->match(Lexer::T_IDENTIFIER); - $parser->match(Lexer::T_OPEN_PARENTHESIS); - - $this->firstDateExpression = $parser->ArithmeticPrimary(); - - $parser->match(Lexer::T_COMMA); - $parser->match(Lexer::T_IDENTIFIER); - - $this->intervalExpression = $parser->ArithmeticPrimary(); - - $parser->match(Lexer::T_IDENTIFIER); - - /* @var $lexer Lexer */ - $lexer = $parser->getLexer(); - $this->unit = $lexer->token['value']; - - $parser->match(Lexer::T_CLOSE_PARENTHESIS); - } - - public function getSql(\Doctrine\ORM\Query\SqlWalker $sqlWalker) - { - return 'DATE_ADD(' . - $this->firstDateExpression->dispatch($sqlWalker) . ', INTERVAL ' . - $this->intervalExpression->dispatch($sqlWalker) . ' ' . $this->unit . - ')'; - } - } - -The only difference compared to the DATEDIFF here is, we additionally need the `Lexer` to access -the value of the `T_IDENTIFIER` token for the Date Interval unit, for example the MONTH in: - - [sql] - SELECT p FROM DoctrineExtensions\Query\BlogPost p WHERE DATE_ADD(CURRENT_TIME(), INTERVAL 4 MONTH) > p.created - -The above method now only supports the specification using `INTERVAL`, to also -allow a real date in DATE_ADD we need to add some decision logic to the parsing -process (makes up for a nice exercise). - -Now as you see, the Parsing process doesn't catch all the possible SQL errors, -here we don't match for all the valid inputs for the interval unit. -However where necessary we rely on the database vendors SQL parser to show us further errors -in the parsing process, for example if the Unit would not be one of the supported values -by MySql. - -## Conclusion - -Now that you all know how you can implement vendor specific SQL functionalities in DQL, -we would be excited to see user extensions that add vendor specific function packages, -for example more math functions, XML + GIS Support, Hashing functions and so on. - -For 2.0 we will come with the current set of functions, however for a future -version we will re-evaluate if we can abstract even more vendor sql functions -and extend the DQL languages scope. - -Code for this Extension to DQL and other Doctrine Extensions can be found -[in my Github DoctrineExtensions repository](http://github.com/beberlei/DoctrineExtensions). \ No newline at end of file diff --git a/cookbook/en/getting-started-xml-edition.rst b/cookbook/en/getting-started-xml-edition.rst new file mode 100644 index 000000000..2a9d845bf --- /dev/null +++ b/cookbook/en/getting-started-xml-edition.rst @@ -0,0 +1,1037 @@ +Getting Started (XML Edition) +============================= + +Doctrine 2 is a project that aims to handle the persistence of the +domain model in a non-interfering way. The Data Mapper pattern is +at the heart of this project, aiming for a complete separation of +the domain/business logic from the persistence in a relational +database management system. The benefit of Doctrine for the +programmer is the possibility can focus solely on the business and +worry about persistence only as a secondary task. This doesn't mean +persistence is not important to Doctrine 2, however it is our +belief that there are considerable benefits for object-oriented +programming, if persistence and entities are kept perfectly +separated. + +What are Entities? +------------------ + +Entities are lightweight PHP Objects that don't need to extend any +abstract base class or interface. An entity class must not be final +or contain final methods. Additionally it must not implement +**clone nor**wakeup or +`do so safely `_. + +An entity contains persistable properties. A persistable property +is an instance variable of the entity that contains the data which +is persisted and retrieved by Doctrine's data mapping +capabilities. + +An Example Model: Bug Tracker +----------------------------- + +For this Getting Started Guide for Doctrine we will implement the +Bug Tracker domain model from the +`Zend\_Db\_Table `_ +documentation. Reading their documentation we can extract the +requirements to be: + + +- A Bugs has a description, creation date, status, reporter and + engineer +- A bug can occur on different products (platforms) +- Products have a name. +- Bug Reporter and Engineers are both Users of the System. +- A user can create new bugs. +- The assigned engineer can close a bug. +- A user can see all his reported or assigned bugs. +- Bugs can be paginated through a list-view. + +.. warning:: + + This tutorial is incrementally building up your Doctrine 2 + knowledge and even lets you make some mistakes, to show some common + pitfalls in mapping Entities to a database. Don't blindly + copy-paste the examples here, it is not production ready without + the additional comments and knowledge this tutorial teaches. + + +A first prototype +----------------- + +A first simplified design for this domain model might look like the +following set of classes: + +:: + + products = new ArrayCollection(); + } + } + + class User + { + public $reportedBugs = null; + public $assignedBugs = null; + + public function __construct() + { + $this->reportedBugs = new ArrayCollection(); + $this->assignedBugs = new ArrayCollection(); + } + } + +Whenever an entity is recreated from the database, an Collection +implementation of the type Doctrine is injected into your entity +instead of an array. Compared to the ArrayCollection this +implementation helps the Doctrine ORM understand the changes that +have happened to the collection which are noteworthy for +persistence. + +.. warning:: + + Lazy load proxies always contain an instance of + Doctrine's EntityManager and all its dependencies. Therefore a + var\_dump() will possibly dump a very large recursive structure + which is impossible to render and read. You have to use + ``Doctrine\Common\Util\Debug::dump()`` to restrict the dumping to a + human readable level. Additionally you should be aware that dumping + the EntityManager to a Browser may take several minutes, and the + Debug::dump() method just ignores any occurrences of it in Proxy + instances. + + +Because we only work with collections for the references we must be +careful to implement a bidirectional reference in the domain model. +The concept of owning or inverse side of a relation is central to +this notion and should always be kept in mind. The following +assumptions are made about relations and have to be followed to be +able to work with Doctrine 2. These assumptions are not unique to +Doctrine 2 but are best practices in handling database relations +and Object-Relational Mapping. + + +- Changes to Collections are saved or updated, when the entity on + the *owning* side of the collection is saved or updated. +- Saving an Entity at the inverse side of a relation never + triggers a persist operation to changes to the collection. +- In a one-to-one relation the entity holding the foreign key of + the related entity on its own database table is *always* the owning + side of the relation. +- In a many-to-many relation, both sides can be the owning side of + the relation. However in a bi-directional many-to-many relation + only one is allowed to be. +- In a many-to-one relation the Many-side is the owning side by + default, because it holds the foreign key. +- The OneToMany side of a relation is inverse by default, since + the foreign key is saved on the Many side. A OneToMany relation can + only be the owning side, if its implemented using a ManyToMany + relation with join table and restricting the one side to allow only + UNIQUE values per database constraint. + +.. note:: + + Consistency of bi-directional references on the inverse side of a + relation have to be managed in userland application code. Doctrine + cannot magically update your collections to be consistent. + + +In the case of Users and Bugs we have references back and forth to +the assigned and reported bugs from a user, making this relation +bi-directional. We have to change the code to ensure consistency of +the bi-directional reference: + +:: + + assignedToBug($this); + $this->engineer = $engineer; + } + + public function setReporter($reporter) + { + $reporter->addReportedBug($this); + $this->reporter = $reporter; + } + + public function getEngineer() + { + return $this->engineer; + } + + public function getReporter() + { + return $this->reporter; + } + } + class User + { + public function addReportedBug($bug) + { + $this->reportedBugs[] = $bug; + } + + public function assignedToBug($bug) + { + $this->assignedBugs[] = $bug; + } + } + +I chose to name the inverse methods in past-tense, which should +indicate that the actual assigning has already taken place and the +methods are only used for ensuring consistency of the references. +You can see from ``User::addReportedBug()`` and +``User::assignedToBug()`` that using this method in userland alone +would not add the Bug to the collection of the owning side in +Bug:::math:`$reporter or Bug::$`engineer. Using these methods and +calling Doctrine for persistence would not update the collections +representation in the database. + +Only using ``Bug::setEngineer()`` or ``Bug::setReporter()`` +correctly saves the relation information. We also set both +collection instance variables to protected, however with PHP 5.3's +new features Doctrine is still able to use Reflection to set and +get values from protected and private properties. + +The ``Bug::$reporter`` and ``Bug::$engineer`` properties are +Many-To-One relations, which point to a User. In a normalized +relational model the foreign key is saved on the Bug's table, hence +in our object-relation model the Bug is at the owning side of the +relation. You should always make sure that the use-cases of your +domain model should drive which side is an inverse or owning one in +your Doctrine mapping. In our example, whenever a new bug is saved +or an engineer is assigned to the bug, we don't want to update the +User to persist the reference, but the Bug. This is the case with +the Bug being at the owning side of the relation. + +Bugs reference Products by a uni-directional ManyToMany relation in +the database that points from from Bugs to Products. + +:: + + products[] = $product; + } + + public function getProducts() + { + return $this->products; + } + } + +We are now finished with the domain model given the requirements. +From the simple model with public properties only we had to do +quite some work to get to a model where we encapsulated the +references between the objects to make sure we don't break its +consistent state when using Doctrine. + +However up to now the assumptions Doctrine imposed on our business +objects have not restricting us much in our domain modelling +capabilities. Actually we would have encapsulated access to all the +properties anyways by using object-oriented best-practices. + +Metadata Mappings for our Entities +---------------------------------- + +Up to now we have only implemented our Entities as Data-Structures +without actually telling Doctrine how to persist them in the +database. If perfect in-memory databases would exist, we could now +finish the application using these entities by implementing code to +fulfil all the requirements. However the world isn't perfect and we +have to persist our entities in some storage to make sure we don't +loose their state. Doctrine currently serves Relational Database +Management Systems. In the future we are thinking to support NoSQL +vendors like CouchDb or MongoDb, however this is still far in the +future. + +The next step for persistence with Doctrine is to describe the +structure of our domain model entities to Doctrine using a metadata +language. The metadata language describes how entities, their +properties and references should be persisted and what constraints +should be applied to them. + +Metadata for entities are loaded using a +``Doctrine\ORM\Mapping\Driver\Driver`` implementation and Doctrine +2 already comes with XML, YAML and Annotations Drivers. In this +Getting Started Guide I will use the XML Mapping Driver. I think +XML beats YAML because of schema validation, and my favorite IDE +netbeans offers me auto-completion for the XML mapping files which +is awesome to work with and you don't have to look up all the +different metadata mapping commands all the time. + +Since we haven't namespaced our three entities, we have to +implement three mapping files called Bug.dcm.xml, Product.dcm.xml +and User.dcm.xml and put them into a distinct folder for mapping +configurations. + +The first discussed definition will be for the Product, since it is +the most simple one: + +:: + + [xml] + + + + + + + + + + + + +The top-level ``entity`` definition tag specifies information about +the class and table-name. The primitive type ``Product::$name`` is +defined as ``field`` attributes. The Id property is defined with +the ``id`` tag. The id has a ``generator`` tag nested inside which +defines that the primary key generation mechanism automatically +uses the database platforms native id generation strategy, for +example AUTO INCREMENT in the case of MySql or Sequences in the +case of PostgreSql and Oracle. + +We then go on specifying the definition of a Bug: + +:: + + [xml] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Here again we have the entity, id and primitive type definitions. +The column names are used from the Zend\_Db\_Table examples and +have different names than the properties on the Bug class. +Additionally for the "created" field it is specified that it is of +the Type "DATETIME", which translates the YYYY-mm-dd HH:mm:ss +Database format into a PHP DateTime instance and back. + +After the field definitions the two qualified references to the +user entity are defined. They are created by the ``many-to-one`` +tag. The class name of the related entity has to be specified with +the ``target-entity`` attribute, which is enough information for +the database mapper to access the foreign-table. The +``join-column`` tags are used to specify how the foreign and +referenced columns are named, an information Doctrine needs to +construct joins between those two entities correctly. Since +``reporter`` and ``engineer`` are on the owning side of a +bi-directional relation we also have to specify the ``inversed-by`` +attribute. They have to point to the field names on the inverse +side of the relationship. + +The last missing property is the ``Bug::$products`` collection. It +holds all products where the specific bug is occurring in. Again +you have to define the ``target-entity`` and ``field`` attributes +on the ``many-to-many`` tag. Furthermore you have to specify the +details of the many-to-many join-table and its foreign key columns. +The definition is rather complex, however relying on the XML +auto-completion I got it working easily, although I forget the +schema details all the time. + +The last missing definition is that of the User entity: + +:: + + [xml] + + + + + + + + + + + + + + + + +Here are some new things to mention about the ``one-to-many`` tags. +Remember that we discussed about the inverse and owning side. Now +both reportedBugs and assignedBugs are inverse relations, which +means the join details have already been defined on the owning +side. Therefore we only have to specify the property on the Bug +class that holds the owning sides. + +This example has a fair overview of the most basic features of the +metadata definition language. + +Obtaining the EntityManager +--------------------------- + +Doctrine's public interface is the EntityManager, it provides the +access point to the complete lifecycle management of your entities +and transforms entities from and back to persistence. You have to +configure and create it to use your entities with Doctrine 2. I +will show the configuration steps and then discuss them step by +step: + +:: + + register(); + + $config = new Doctrine\ORM\Configuration(); // (2) + + // Proxy Configuration (3) + $config->setProxyDir(__DIR__.'/lib/MyProject/Proxies'); + $config->setProxyNamespace('MyProject\Proxies'); + $config->setAutoGenerateProxyClasses((APPLICATION_ENV == "development")); + + // Mapping Configuration (4) + $driverImpl = new Doctrine\ORM\Mapping\Driver\XmlDriver(__DIR__."/config/mappings"); + $config->setMetadataDriverImpl($driverImpl); + + // Caching Configuration (5) + if (APPLICATION_ENV == "development") { + $cache = new \Doctrine\Common\Cache\ArrayCache(); + } else { + $cache = new \Doctrine\Common\Cache\ApcCache(); + } + $config->setMetadataCacheImpl($cache); + $config->setQueryCacheImpl($cache); + + // database configuration parameters (6) + $conn = array( + 'driver' => 'pdo_sqlite', + 'path' => __DIR__ . '/db.sqlite', + ); + + // obtaining the entity manager (7) + $evm = new Doctrine\Common\EventManager() + $entityManager = \Doctrine\ORM\EntityManager::create($conn, $config, $evm); + +The first block sets up the autoloading capabilities of Doctrine. I +am registering the Doctrine namespace to the given path. To add +your own namespace you can instantiate another ``ClassLoader`` with +different namespace and path arguments. There is no requirement to +use the Doctrine ``ClassLoader`` for your autoloading needs, you +can use whatever suits you best. + +The second block contains of the instantiation of the ORM +Configuration object. Besides the configuration shown in the next +blocks there are several others with are all explained in the +`Configuration section of the manual `_. + +The Proxy Configuration is a required block for your application, +you have to specify where Doctrine writes the PHP code for Proxy +Generation. Proxies are children of your entities generated by +Doctrine to allow for type-safe lazy loading. We will see in a +later chapter how exactly this works. Besides the path to the +proxies we also specify which namespace they will reside under as +well as a flag ``autoGenerateProxyClasses`` indicating that proxies +should be re-generated on each request, which is recommended for +development. In production this should be prevented at all costs, +the proxy class generation can be quite costly. + +The fourth block contains the mapping driver details. We will use +XML Mapping in this example, so we configure the ``XmlDriver`` +instance with a path to mappings configuration folder where we put +the Bug.dcm.xml, Product.dcm.xml and User.dcm.xml. + +In the 5th block the caching configuration is set. In production we +use caching only on a per request-basis using the ArrayCache. In +production it is literally required to use Apc, Memcache or XCache +to get the full speed out of Doctrine. Internally Doctrine uses +caching heavily for the Metadata and DQL Query Language so make +sure you use a caching mechanism. + +The 6th block shows the configuration options required to connect +to a database, in my case a file-based sqlite database. All the +configuration options for all the shipped drivers are given in the +`DBAL Configuration section of the manual `_. + +The last block shows how the ``EntityManager`` is obtained from a +factory method, Here we also pass in an ``EventManager`` instance +which is optional. However using the EventManager you can hook in +to the lifecycle of entities, which is a common use-case, so you +know how to configure it already. + +Generating the Database Schema +------------------------------ + +Now that we have defined the Metadata Mappings and bootstrapped the +EntityManager we want to generate the relational database schema +from it. Doctrine has a Command-Line-Interface that allows you to +access the SchemaTool, a component that generates the required +tables to work with the metadata. + +For the command-line tool to work a cli-config.php file has to be +present in the project root directory, where you will execute the +doctrine command. Its a fairly simple file: + +:: + + new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($entityManager) + )); + $cli->setHelperSet($helperSet); + +You can then change into your project directory and call the +Doctrine command-line tool: + +:: + + [console] + doctrine@my-desktop> cd myproject/ + doctrine@my-desktop> doctrine orm:schema-tool:create + +.. note:: + + The ``doctrine`` command will only be present if you installed + Doctrine from PEAR. Otherwise you will have to dig into the + ``bin/doctrine.php`` code of your Doctrine 2 directory to setup + your doctrine command-line client. + + See the + `Tools section of the manual `_ + on how to setup the Doctrine console correctly. + + +During the development you probably need to re-create the database +several times when changing the Entity metadata. You can then +either re-create the database: + +:: + + [console] + doctrine@my-desktop> doctrine orm:schema-tool:drop + doctrine@my-desktop> doctrine orm:schema-tool:create + +Or use the update functionality: + +:: + + [console] + doctrine@my-desktop> doctrine orm:schema-tool:update + +The updating of databases uses a Diff Algorithm for a given +Database Schema, a cornerstone of the ``Doctrine\DBAL`` package, +which can even be used without the Doctrine ORM package. However +its not available in SQLite since it does not support ALTER TABLE. + +Writing Entities into the Database +---------------------------------- + +Having created the schema we can now start and save entities in the +database. For starters we need a create user use-case: + +:: + + name = $newUsername; + + $entityManager->persist($user); + $entityManager->flush(); + +Products can also be created: + +:: + + name = $newProductName; + + $entityManager->persist($product); + $entityManager->flush(); + +So what is happening in those two snippets? In both examples the +class creation is pretty standard, the interesting bits are the +communication with the ``EntityManager``. To notify the +EntityManager that a new entity should be inserted into the +database you have to call ``persist()``. However the EntityManager +does not act on this, its merely notified. You have to explicitly +call ``flush()`` to have the EntityManager write those two entities +to the database. + +You might wonder why does this distinction between persist +notification and flush exist? Doctrine 2 uses the UnitOfWork +pattern to aggregate all writes (INSERT, UDPATE, DELETE) into one +single fast transaction, which is executed when flush is called. +Using this approach the write-performance is significantly faster +than in a scenario where updates are done for each entity in +isolation. In more complex scenarios than the previous two, you are +free to request updates on many different entities and all flush +them at once. + +Doctrine's UnitOfWork detects entities that have changed after +retrieval from the database automatically when the flush operation +is called, so that you only have to keep track of those entities +that are new or to be removed and pass them to +``EntityManager#persist()`` and ``EntityManager#remove()`` +respectively. This comparison to find dirty entities that need +updating is using a very efficient algorithm that has almost no +additional memory overhead and can even save you computing power by +only updating those database columns that really changed. + +We are now getting to the "Create a New Bug" requirement and the +code for this scenario may look like this: + +:: + + find("User", $theReporterId); + $engineer = $entityManager->find("User", $theDefaultEngineerId); + + $bug = new Bug(); + $bug->description = "Something does not work!"; + $bug->created = new DateTime("now"); + $bug->status = "NEW"; + + foreach ($productIds AS $productId) { + $product = $entityManager->find("Product", $productId); + $bug->assignToProduct($product); + } + + $bug->setReporter($reporter); + $bug->setEngineer($engineer); + + $entityManager->persist($bug); + $entityManager->flush(); + + echo "Your new Bug Id: ".$bug->id."\n"; + +This is the first contact with the read API of the EntityManager, +showing that a call to ``EntityManager#find($name, $id)`` returns a +single instance of an entity queried by primary key. Besides this +we see the persist + flush pattern again to save the Bug into the +database. + +See how simple relating Bug, Reporter, Engineer and Products is +done by using the discussed methods in the "A first prototype" +section. The UnitOfWork will detect this relations when flush is +called and relate them in the database appropriately. + +Queries for Application Use-Cases +--------------------------------- + +List of Bugs +~~~~~~~~~~~~ + +Using the previous examples we can fill up the database quite a +bit, however we now need to discuss how to query the underlying +mapper for the required view representations. When opening the +application, bugs can be paginated through a list-view, which is +the first read-only use-case: + +:: + + createQuery($dql); + $query->setMaxResults(30); + $bugs = $query->getResult(); + + foreach($bugs AS $bug) { + echo $bug->description." - ".$bug->created->format('d.m.Y')."\n"; + echo " Reported by: ".$bug->getReporter()->name."\n"; + echo " Assigned to: ".$bug->getEngineer()->name."\n"; + foreach($bug->getProducts() AS $product) { + echo " Platform: ".$product->name."\n"; + } + echo "\n"; + } + +The DQL Query in this example fetches the 30 most recent bugs with +their respective engineer and reporter in one single SQL statement. +The console output of this script is then: + +:: + + Something does not work! - 02.04.2010 + Reported by: beberlei + Assigned to: beberlei + Platform: My Product + +.. note:: + + **Dql is not Sql** + + You may wonder why we start writing SQL at the beginning of this + use-case. Don't we use an ORM to get rid of all the endless + hand-writing of SQL? Doctrine introduces DQL which is best + described as **object-query-language** and is a dialect of + `OQL `_ and + similar to `HQL `_ or + `JPQL `_. + It does not know the concept of columns and tables, but only those + of Entity-Class and property. Using the Metadata we defined before + it allows for very short distinctive and powerful queries. + + An important reason why DQL is favourable to the Query API of most + ORMs is its similarity to SQL. The DQL language allows query + constructs that most ORMs don't, GROUP BY even with HAVING, + Sub-selects, Fetch-Joins of nested classes, mixed results with + entities and scalar data such as COUNT() results and much more. + Using DQL you should seldom come to the point where you want to + throw your ORM into the dumpster, because it doesn't support some + the more powerful SQL concepts. + + Besides handwriting DQL you can however also use the + ``QueryBuilder`` retrieved by calling + ``$entityManager->createQueryBuilder()`` which is a Query Object + around the DQL language. + + As a last resort you can however also use Native SQL and a + description of the result set to retrieve entities from the + database. DQL boils down to a Native SQL statement and a + ``ResultSetMapping`` instance itself. Using Native SQL you could + even use stored procedures for data retrieval, or make use of + advanced non-portable database queries like PostgreSql's recursive + queries. + + +Array Hydration of the Bug List +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In the previous use-case we retrieved the result as their +respective object instances. We are not limited to retrieving +objects only from Doctrine however. For a simple list view like the +previous one we only need read access to our entities and can +switch the hydration from objects to simple PHP arrays instead. +This can obviously yield considerable performance benefits for +read-only requests. + +Implementing the same list view as before using array hydration we +can rewrite our code: + +:: + + createQuery($dql); + $bugs = $query->getArrayResult(); + + foreach ($bugs AS $bug) { + echo $bug['description'] . " - " . $bug['created']->format('d.m.Y')."\n"; + echo " Reported by: ".$bug['reporter']['name']."\n"; + echo " Assigned to: ".$bug['engineer']['name']."\n"; + foreach($bug['products'] AS $product) { + echo " Platform: ".$product['name']."\n"; + } + echo "\n"; + } + +There is one significant difference in the DQL query however, we +have to add an additional fetch-join for the products connected to +a bug. The resulting SQL query for this single select statement is +pretty large, however still more efficient to retrieve compared to +hydrating objects. + +Find by Primary Key +~~~~~~~~~~~~~~~~~~~ + +The next Use-Case is displaying a Bug by primary key. This could be +done using DQL as in the previous example with a where clause, +however there is a convenience method on the Entity Manager that +handles loading by primary key, which we have already seen in the +write scenarios: + +:: + + find("Bug", (int)$theBugId); + +However we will soon see another problem with our entities using +this approach. Try displaying the engineer's name: + +:: + + description."\n"; + echo "Engineer: ".$bug->getEngineer()->name."\n"; + +It will be null! What is happening? It worked in the previous +example, so it can't be a problem with the persistence code of +Doctrine. What is it then? You walked in the public property trap. + +Since we only retrieved the bug by primary key both the engineer +and reporter are not immediately loaded from the database but are +replaced by LazyLoading proxies. Sample code of this proxy +generated code can be found in the specified Proxy Directory, it +looks like: + +:: + + _load(); + return parent::addReportedBug($bug); + } + + public function assignedToBug($bug) + { + $this->_load(); + return parent::assignedToBug($bug); + } + } + +See how upon each method call the proxy is lazily loaded from the +database? Using public properties however we never call a method +and Doctrine has no way to hook into the PHP Engine to detect a +direct access to a public property and trigger the lazy load. We +need to rewrite our entities, make all the properties private or +protected and add getters and setters to get a working example: + +:: + + getDescription()."\n"; + echo "Engineer: ".$bug->getEngineer()->getName()."\n"; + + /** + Bug: Something does not work! + Engineer: beberlei + */ + +Being required to use private or protected properties Doctrine 2 +actually enforces you to encapsulate your objects according to +object-oriented best-practices. + +Dashboard of the User +--------------------- + +For the next use-case we want to retrieve the dashboard view, a +list of all open bugs the user reported or was assigned to. This +will be achieved using DQL again, this time with some WHERE clauses +and usage of bound parameters: + +:: + + createQuery($dql) + ->setParameter(1, $theUserId) + ->setMaxResults(15) + ->getResult(); + + foreach ($myBugs AS $bug) { + echo $bug->getDescription()."\n"; + } + +That is it for the read-scenarios of this example, we will continue +with the last missing bit, engineers being able to close a bug. + +Number of Bugs +-------------- + +Until now we only retrieved entities or their array representation. +Doctrine also supports the retrieval of non-entities through DQL. +These values are called "scalar result values" and may even be +aggregate values using COUNT, SUM, MIN, MAX or AVG functions. + +We will need this knowledge to retrieve the number of open bugs +grouped by product: + +:: + + createQuery($dql)->getScalarResult(); + + foreach($productBugs as $productBug) { + echo $productBug['name']." has " . $productBug['openBugs'] . " open bugs!\n"; + } + +Updating Entities +----------------- + +There is a single use-case missing from the requirements, Engineers +should be able to close a bug. This looks like: + +:: + + find("Bug", (int)$theBugId); + $bug->close(); + + $entityManager->flush(); + +When retrieving the Bug from the database it is inserted into the +IdentityMap inside the UnitOfWork of Doctrine. This means your Bug +with exactly this id can only exist once during the whole request +no matter how often you call ``EntityManager#find()``. It even +detects entities that are hydrated using DQL and are already +present in the Identity Map. + +When flush is called the EntityManager loops over all the entities +in the identity map and performs a comparison between the values +originally retrieved from the database and those values the entity +currently has. If at least one of these properties is different the +entity is scheduled for an UPDATE against the database. Only the +changed columns are updated, which offers a pretty good performance +improvement compared to updating all the properties. + +This tutorial is over here, I hope you had fun. Additional content +will be added to this tutorial incrementally, topics will include: + +:: + + * Entity Repositories + * More on Association Mappings + * Lifecycle Events triggered in the UnitOfWork + * Ordering of Collections + +Additional details on all the topics discussed here can be found in +the respective manual chapters. + + diff --git a/cookbook/en/getting-started-xml-edition.txt b/cookbook/en/getting-started-xml-edition.txt deleted file mode 100644 index 74e637b0c..000000000 --- a/cookbook/en/getting-started-xml-edition.txt +++ /dev/null @@ -1,784 +0,0 @@ -Doctrine 2 is a project that aims to handle the persistence of the domain model in a non-interfering way. -The Data Mapper pattern is at the heart of this project, aiming for a complete separation of the domain/business logic -from the persistence in a relational database management system. The benefit of Doctrine for the programmer is the -possibility can focus solely on the business and worry about persistence only as a secondary task. This doesn't mean -persistence is not important to Doctrine 2, however it is our belief that there are considerable benefits for object-oriented -programming, if persistence and entities are kept perfectly separated. - -## What are Entities? - -Entities are lightweight PHP Objects that don't need to extend any abstract base class or interface. -An entity class must not be final or contain final methods. Additionally it must not implement __clone -nor __wakeup or [do so safely](http://www.doctrine-project.org/documentation/cookbook/2_0/en/implementing-wakeup-or-clone). - -An entity contains persistable properties. A persistable property is an instance variable of the entity -that contains the data which is persisted and retrieved by Doctrine's data mapping capabilities. - -## An Example Model: Bug Tracker - -For this Getting Started Guide for Doctrine we will implement the Bug Tracker domain model from the [Zend_Db_Table](http://framework.zend.com/manual/en/zend.db.table.html) -documentation. Reading their documentation we can extract the requirements to be: - -* A Bugs has a description, creation date, status, reporter and engineer -* A bug can occur on different products (platforms) -* Products have a name. -* Bug Reporter and Engineers are both Users of the System. -* A user can create new bugs. -* The assigned engineer can close a bug. -* A user can see all his reported or assigned bugs. -* Bugs can be paginated through a list-view. - -> **WARNING** -> -> This tutorial is incrementally building up your Doctrine 2 knowledge and even lets you make some mistakes, to -> show some common pitfalls in mapping Entities to a database. Don't blindly copy-paste the examples here, it -> is not production ready without the additional comments and knowledge this tutorial teaches. - -## A first prototype - -A first simplified design for this domain model might look like the following set of classes: - - [php] - class Bug - { - public $id; - public $description; - public $created; - public $status; - public $products = array(); - public $reporter; - public $engineer; - } - class Product - { - public $id; - public $name; - } - class User - { - public $id; - public $name; - public $reportedBugs = array(); - public $assignedBugs = array(); - } - -> **WARNING** -> -> This is only a prototype, please don't use public properties with Doctrine 2 at all, -> the "Queries for Application Use-Cases" section shows you why. In combination with proxies -> public properties can make up for pretty nasty bugs. - -Because we will focus on the mapping aspect, no effort is being made to encapsulate the business logic in this example. -All persistable properties are public in visibility. We will soon see that this is not the best solution in combination -with Doctrine 2, one restriction that actually forces you to encapsulate your properties. For persistence Doctrine 2 -actually uses Reflection to access the values in all your entities properties. - -Many of the fields are single scalar values, for example the 3 ID fields of the entities, their names, description, -status and change dates. Doctrine 2 can easily handle these single values as can any other ORM. From a point of our -domain model they are ready to be used right now and we will see at a later stage how they are mapped to the database. - -There are also several references between objects in this domain model, whose semantics are discussed case by case at this point -to explain how Doctrine handles them. In general each OneToOne or ManyToOne Relation in the Database is replaced by an -instance of the related object in the domain model. Each OneToMany or ManyToMany Relation is replaced by a collection -of instances in the domain model. - -If you think this through carefully you realize Doctrine 2 will load up the complete database in memory if you access -one object. However by default Doctrine generates Lazy Load proxies of entities or collections of all the relations -that haven't been explicitly retrieved from the database yet. - -To be able to use lazyload with collections, simple PHP arrays have to be replaced by a generic collection -interface Doctrine\Common\Collections\Collection which tries to act as array as much as possible using ArrayAccess, -IteratorAggregate and Countable interfaces. The class \Doctrine\Common\Collections\ArrayCollection is the most simple -implementation of this interface. - -Now that we know this, we have to clear up our domain model to cope with the assumptions about related collections: - - [php] - use Doctrine\Common\Collections\ArrayCollection; - - class Bug - { - public $products = null; - - public function __construct() - { - $this->products = new ArrayCollection(); - } - } - - class User - { - public $reportedBugs = null; - public $assignedBugs = null; - - public function __construct() - { - $this->reportedBugs = new ArrayCollection(); - $this->assignedBugs = new ArrayCollection(); - } - } - -Whenever an entity is recreated from the database, an Collection implementation of the type -Doctrine\ORM\PersistantCollection is injected into your entity instead of an array. Compared -to the ArrayCollection this implementation helps the Doctrine ORM understand the changes that -have happened to the collection which are noteworthy for persistence. - -> **Warning** -> Lazy load proxies always contain an instance of Doctrine's EntityManager and all its dependencies. Therefore a var_dump() -> will possibly dump a very large recursive structure which is impossible to render and read. You have to use -> `Doctrine\Common\Util\Debug::dump()` to restrict the dumping to a human readable level. Additionally you should be aware -> that dumping the EntityManager to a Browser may take several minutes, and the Debug::dump() method just ignores any -> occurrences of it in Proxy instances. - -Because we only work with collections for the references we must be careful to implement a bidirectional reference in -the domain model. The concept of owning or inverse side of a relation is central to this notion and should always -be kept in mind. The following assumptions are made about relations and have to be followed to be able to work with Doctrine 2. -These assumptions are not unique to Doctrine 2 but are best practices in handling database relations and Object-Relational Mapping. - -* Changes to Collections are saved or updated, when the entity on the *owning* side of the collection is saved or updated. -* Saving an Entity at the inverse side of a relation never triggers a persist operation to changes to the collection. -* In a one-to-one relation the entity holding the foreign key of the related entity on its own database table is *always* the owning side of the relation. -* In a many-to-many relation, both sides can be the owning side of the relation. However in a bi-directional many-to-many relation only one is allowed to be. -* In a many-to-one relation the Many-side is the owning side by default, because it holds the foreign key. -* The OneToMany side of a relation is inverse by default, since the foreign key is saved on the Many side. A OneToMany relation can only be the owning side, if its implemented using a ManyToMany relation with join table and restricting the one side to allow only UNIQUE values per database constraint. - -> **Important** -> -> Consistency of bi-directional references on the inverse side of a relation have to be managed in userland application code. -> Doctrine cannot magically update your collections to be consistent. - -In the case of Users and Bugs we have references back and forth to the assigned and reported bugs from a user, -making this relation bi-directional. We have to change the code to ensure consistency of the bi-directional reference: - - [php] - class Bug - { - protected $engineer; - protected $reporter; - - public function setEngineer($engineer) - { - $engineer->assignedToBug($this); - $this->engineer = $engineer; - } - - public function setReporter($reporter) - { - $reporter->addReportedBug($this); - $this->reporter = $reporter; - } - - public function getEngineer() - { - return $this->engineer; - } - - public function getReporter() - { - return $this->reporter; - } - } - class User - { - public function addReportedBug($bug) - { - $this->reportedBugs[] = $bug; - } - - public function assignedToBug($bug) - { - $this->assignedBugs[] = $bug; - } - } - -I chose to name the inverse methods in past-tense, which should indicate that the actual assigning has already taken -place and the methods are only used for ensuring consistency of the references. You can see from `User::addReportedBug()` -and `User::assignedToBug()` that using this method in userland alone would not add the Bug to the collection of the owning -side in Bug::$reporter or Bug::$engineer. Using these methods and calling Doctrine for persistence would not update -the collections representation in the database. - -Only using `Bug::setEngineer()` or `Bug::setReporter()` correctly saves the relation information. We also set both collection -instance variables to protected, however with PHP 5.3's new features Doctrine is still able to use Reflection to set and get values -from protected and private properties. - -The `Bug::$reporter` and `Bug::$engineer` properties are Many-To-One relations, which point to a User. In a normalized -relational model the foreign key is saved on the Bug's table, hence in our object-relation model the Bug is at the owning -side of the relation. You should always make sure that the use-cases of your domain model should drive which side -is an inverse or owning one in your Doctrine mapping. In our example, whenever a new bug is saved or an engineer is assigned -to the bug, we don't want to update the User to persist the reference, but the Bug. -This is the case with the Bug being at the owning side of the relation. - -Bugs reference Products by a uni-directional ManyToMany relation in the database that points from from Bugs to Products. - - [php] - class Bug - { - protected $products = null; // Set protected for encapsulation - - public function assignToProduct($product) - { - $this->products[] = $product; - } - - public function getProducts() - { - return $this->products; - } - } - -We are now finished with the domain model given the requirements. From the simple model with public properties only -we had to do quite some work to get to a model where we encapsulated the references between the objects to make sure -we don't break its consistent state when using Doctrine. - -However up to now the assumptions Doctrine imposed on our business objects have not restricting us much in our domain -modelling capabilities. Actually we would have encapsulated access to all the properties anyways by using -object-oriented best-practices. - -## Metadata Mappings for our Entities - -Up to now we have only implemented our Entities as Data-Structures without actually telling Doctrine how to persist -them in the database. If perfect in-memory databases would exist, we could now finish the application using these entities -by implementing code to fulfil all the requirements. However the world isn't perfect and we have to persist our -entities in some storage to make sure we don't loose their state. Doctrine currently serves Relational Database Management Systems. -In the future we are thinking to support NoSQL vendors like CouchDb or MongoDb, however this is still far in the future. - -The next step for persistence with Doctrine is to describe the structure of our domain model entities to Doctrine -using a metadata language. The metadata language describes how entities, their properties and references should be -persisted and what constraints should be applied to them. - -Metadata for entities are loaded using a `Doctrine\ORM\Mapping\Driver\Driver` implementation and Doctrine 2 already comes -with XML, YAML and Annotations Drivers. In this Getting Started Guide I will use the XML Mapping Driver. I think XML -beats YAML because of schema validation, and my favorite IDE netbeans offers me auto-completion for the XML mapping files -which is awesome to work with and you don't have to look up all the different metadata mapping commands all the time. - -Since we haven't namespaced our three entities, we have to implement three mapping files called Bug.dcm.xml, -Product.dcm.xml and User.dcm.xml and put them into a distinct folder for mapping configurations. - -The first discussed definition will be for the Product, since it is the most simple one: - - [xml] - - - - - - - - - - - - -The top-level `entity` definition tag specifies information about the class and table-name. The -primitive type `Product::$name` is defined as `field` attributes. The Id property is defined with the `id` tag. -The id has a `generator` tag nested inside which defines that the primary key generation mechanism -automatically uses the database platforms native id generation strategy, for example AUTO INCREMENT -in the case of MySql or Sequences in the case of PostgreSql and Oracle. - -We then go on specifying the definition of a Bug: - - [xml] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Here again we have the entity, id and primitive type definitions. -The column names are used from the Zend_Db_Table examples and have different names than the properties -on the Bug class. Additionally for the "created" field it is specified that it is of the Type "DATETIME", -which translates the YYYY-mm-dd HH:mm:ss Database format into a PHP DateTime instance and back. - -After the field definitions the two qualified references to the user entity are defined. They are created by -the `many-to-one` tag. The class name of the related entity has to be specified with the `target-entity` -attribute, which is enough information for the database mapper to access the foreign-table. The -`join-column` tags are used to specify how the foreign and referenced columns are named, an information -Doctrine needs to construct joins between those two entities correctly. Since `reporter` and `engineer` -are on the owning side of a bi-directional relation we also have to specify the `inversed-by` attribute. -They have to point to the field names on the inverse side of the relationship. - -The last missing property is the `Bug::$products` collection. It holds all products where the specific -bug is occurring in. Again you have to define the `target-entity` and `field` attributes on the `many-to-many` -tag. Furthermore you have to specify the details of the many-to-many join-table and its foreign key columns. -The definition is rather complex, however relying on the XML auto-completion I got it working easily, although -I forget the schema details all the time. - -The last missing definition is that of the User entity: - - [xml] - - - - - - - - - - - - - - - - -Here are some new things to mention about the `one-to-many` tags. Remember that we discussed about -the inverse and owning side. Now both reportedBugs and assignedBugs are inverse relations, -which means the join details have already been defined on the owning side. Therefore we only -have to specify the property on the Bug class that holds the owning sides. - -This example has a fair overview of the most basic features of the metadata definition language. - -## Obtaining the EntityManager - -Doctrine's public interface is the EntityManager, it provides the access point to the complete -lifecycle management of your entities and transforms entities from and back to persistence. You -have to configure and create it to use your entities with Doctrine 2. I will show the configuration -steps and then discuss them step by step: - - [php] - // Setup Autoloader (1) - require '/path/to/lib/Doctrine/Common/ClassLoader.php'; - $loader = new Doctrine\Common\ClassLoader("Doctrine", '/path/to/Doctrine/trunk/lib/'); - $loader->register(); - - $config = new Doctrine\ORM\Configuration(); // (2) - - // Proxy Configuration (3) - $config->setProxyDir(__DIR__.'/lib/MyProject/Proxies'); - $config->setProxyNamespace('MyProject\Proxies'); - $config->setAutoGenerateProxyClasses((APPLICATION_ENV == "development")); - - // Mapping Configuration (4) - $driverImpl = new Doctrine\ORM\Mapping\Driver\XmlDriver(__DIR__."/config/mappings"); - $config->setMetadataDriverImpl($driverImpl); - - // Caching Configuration (5) - if (APPLICATION_ENV == "development") { - $cache = new \Doctrine\Common\Cache\ArrayCache(); - } else { - $cache = new \Doctrine\Common\Cache\ApcCache(); - } - $config->setMetadataCacheImpl($cache); - $config->setQueryCacheImpl($cache); - - // database configuration parameters (6) - $conn = array( - 'driver' => 'pdo_sqlite', - 'path' => __DIR__ . '/db.sqlite', - ); - - // obtaining the entity manager (7) - $evm = new Doctrine\Common\EventManager() - $entityManager = \Doctrine\ORM\EntityManager::create($conn, $config, $evm); - -The first block sets up the autoloading capabilities of Doctrine. I am registering the Doctrine -namespace to the given path. To add your own namespace you can instantiate another `ClassLoader` -with different namespace and path arguments. There is no requirement to use the Doctrine `ClassLoader` -for your autoloading needs, you can use whatever suits you best. - -The second block contains of the instantiation of the ORM Configuration object. Besides the -configuration shown in the next blocks there are several others with are all explained -in the [Configuration section of the manual](http://www.doctrine-project.org/documentation/manual/2_0/en/configuration#configuration-options). - -The Proxy Configuration is a required block for your application, you have to specify where -Doctrine writes the PHP code for Proxy Generation. Proxies are children of your entities generated -by Doctrine to allow for type-safe lazy loading. We will see in a later chapter how exactly this works. -Besides the path to the proxies we also specify which namespace they will reside under as well as -a flag `autoGenerateProxyClasses` indicating that proxies should be re-generated on each request, -which is recommended for development. In production this should be prevented at all costs, -the proxy class generation can be quite costly. - -The fourth block contains the mapping driver details. We will use XML Mapping in this example, so -we configure the `XmlDriver` instance with a path to mappings configuration folder where we put -the Bug.dcm.xml, Product.dcm.xml and User.dcm.xml. - -In the 5th block the caching configuration is set. In production we use caching only on a per request-basis -using the ArrayCache. In production it is literally required to use Apc, Memcache or XCache to get the full -speed out of Doctrine. Internally Doctrine uses caching heavily for the Metadata and DQL Query Language -so make sure you use a caching mechanism. - -The 6th block shows the configuration options required to connect to a database, in my case a file-based -sqlite database. All the configuration options for all the shipped drivers are given in the [DBAL Configuration -section of the manual](http://www.doctrine-project.org/documentation/manual/2_0/en/dbal). - -The last block shows how the `EntityManager` is obtained from a factory method, Here we also pass -in an `EventManager` instance which is optional. However using the EventManager you can hook in to the lifecycle -of entities, which is a common use-case, so you know how to configure it already. - -## Generating the Database Schema - -Now that we have defined the Metadata Mappings and bootstrapped the EntityManager -we want to generate the relational database schema from it. -Doctrine has a Command-Line-Interface that allows you to access the SchemaTool, a component that generates -the required tables to work with the metadata. - -For the command-line tool to work a cli-config.php file has to be present in the project root directory, -where you will execute the doctrine command. Its a fairly simple file: - - [php] - $helperSet = new \Symfony\Components\Console\Helper\HelperSet(array( - 'em' => new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($entityManager) - )); - $cli->setHelperSet($helperSet); - -You can then change into your project directory and call the Doctrine command-line tool: - - [console] - doctrine@my-desktop> cd myproject/ - doctrine@my-desktop> doctrine orm:schema-tool:create - -> **NOTE** -> -> The `doctrine` command will only be present if you installed Doctrine from PEAR. -> Otherwise you will have to dig into the `bin/doctrine.php` code of your Doctrine 2 -> directory to setup your doctrine command-line client. -> -> See the [Tools section of the manual](http://www.doctrine-project.org/projects/orm/2.0/docs/reference/tools/en) -> on how to setup the Doctrine console correctly. - -During the development you probably need to re-create the database several times when changing the Entity -metadata. You can then either re-create the database: - - [console] - doctrine@my-desktop> doctrine orm:schema-tool:drop - doctrine@my-desktop> doctrine orm:schema-tool:create - -Or use the update functionality: - - [console] - doctrine@my-desktop> doctrine orm:schema-tool:update - -The updating of databases uses a Diff Algorithm for a given Database Schema, a cornerstone of the `Doctrine\DBAL` -package, which can even be used without the Doctrine ORM package. However its not available in SQLite since -it does not support ALTER TABLE. - -## Writing Entities into the Database - -Having created the schema we can now start and save entities in the database. For starters we need a create user use-case: - - [php] - $newUsername = "beberlei"; - - $user = new User(); - $user->name = $newUsername; - - $entityManager->persist($user); - $entityManager->flush(); - -Products can also be created: - - [php] - $newProductName = "My Product"; - - $product = new Product(); - $product->name = $newProductName; - - $entityManager->persist($product); - $entityManager->flush(); - -So what is happening in those two snippets? In both examples the class creation is pretty standard, the interesting -bits are the communication with the `EntityManager`. To notify the EntityManager that a new entity should be inserted -into the database you have to call `persist()`. However the EntityManager does not act on this, its merely notified. -You have to explicitly call `flush()` to have the EntityManager write those two entities to the database. - -You might wonder why does this distinction between persist notification and flush exist? Doctrine 2 uses the -UnitOfWork pattern to aggregate all writes (INSERT, UDPATE, DELETE) into one single fast transaction, which -is executed when flush is called. Using this approach the write-performance is significantly faster than -in a scenario where updates are done for each entity in isolation. In more complex scenarios than the -previous two, you are free to request updates on many different entities and all flush them at once. - -Doctrine's UnitOfWork detects entities that have changed after retrieval from the database automatically when -the flush operation is called, so that you only have to keep track of those entities that are new or to be removed and pass them to -`EntityManager#persist()` and `EntityManager#remove()` respectively. This comparison to find dirty -entities that need updating is using a very efficient algorithm that has almost no additional -memory overhead and can even save you computing power by only updating those database columns -that really changed. - -We are now getting to the "Create a New Bug" requirement and the code for this scenario may look like this: - - [php] - $reporter = $entityManager->find("User", $theReporterId); - $engineer = $entityManager->find("User", $theDefaultEngineerId); - - $bug = new Bug(); - $bug->description = "Something does not work!"; - $bug->created = new DateTime("now"); - $bug->status = "NEW"; - - foreach ($productIds AS $productId) { - $product = $entityManager->find("Product", $productId); - $bug->assignToProduct($product); - } - - $bug->setReporter($reporter); - $bug->setEngineer($engineer); - - $entityManager->persist($bug); - $entityManager->flush(); - - echo "Your new Bug Id: ".$bug->id."\n"; - -This is the first contact with the read API of the EntityManager, showing that a call to -`EntityManager#find($name, $id)` returns a single instance of an entity queried by primary key. -Besides this we see the persist + flush pattern again to save the Bug into the database. - -See how simple relating Bug, Reporter, Engineer and Products is done by using the discussed methods -in the "A first prototype" section. The UnitOfWork will detect this relations when flush -is called and relate them in the database appropriately. - -## Queries for Application Use-Cases - -### List of Bugs - -Using the previous examples we can fill up the database quite a bit, however we now need to discuss how to query the underlying -mapper for the required view representations. When opening the application, bugs can be paginated through a list-view, which is the first -read-only use-case: - - [php] - $dql = "SELECT b, e, r FROM Bug b JOIN b.engineer e JOIN b.reporter r ORDER BY b.created DESC"; - - $query = $entityManager->createQuery($dql); - $query->setMaxResults(30); - $bugs = $query->getResult(); - - foreach($bugs AS $bug) { - echo $bug->description." - ".$bug->created->format('d.m.Y')."\n"; - echo " Reported by: ".$bug->getReporter()->name."\n"; - echo " Assigned to: ".$bug->getEngineer()->name."\n"; - foreach($bug->getProducts() AS $product) { - echo " Platform: ".$product->name."\n"; - } - echo "\n"; - } - -The DQL Query in this example fetches the 30 most recent bugs with their respective engineer and reporter -in one single SQL statement. The console output of this script is then: - - Something does not work! - 02.04.2010 - Reported by: beberlei - Assigned to: beberlei - Platform: My Product - -> **NOTE** -> -> **Dql is not Sql** -> -> You may wonder why we start writing SQL at the beginning of this use-case. Don't we use an ORM to get rid -> of all the endless hand-writing of SQL? Doctrine introduces DQL which is best described -> as **object-query-language** and is a dialect of [OQL](http://en.wikipedia.org/wiki/Object_Query_Language) and -> similar to [HQL](http://www.hibernate.org) or [JPQL](http://en.wikipedia.org/wiki/Java_Persistence_Query_Language). -> It does not know the concept of columns and tables, but only those -> of Entity-Class and property. Using the Metadata we defined before it allows for very short distinctive -> and powerful queries. -> -> An important reason why DQL is favourable to the Query API of most ORMs is its similarity to SQL. The DQL language -> allows query constructs that most ORMs don't, GROUP BY even with HAVING, Sub-selects, Fetch-Joins of nested -> classes, mixed results with entities and scalar data such as COUNT() results and much more. Using -> DQL you should seldom come to the point where you want to throw your ORM into the dumpster, because it -> doesn't support some the more powerful SQL concepts. -> -> Besides handwriting DQL you can however also use the `QueryBuilder` retrieved by calling `$entityManager->createQueryBuilder()` -> which is a Query Object around the DQL language. -> -> As a last resort you can however also use Native SQL and a description of the result set to retrieve -> entities from the database. DQL boils down to a Native SQL statement and a `ResultSetMapping` instance itself. -> Using Native SQL you could even use stored procedures for data retrieval, or make use of advanced non-portable -> database queries like PostgreSql's recursive queries. - -### Array Hydration of the Bug List - -In the previous use-case we retrieved the result as their respective object instances. -We are not limited to retrieving objects only from Doctrine however. For a simple list view -like the previous one we only need read access to our entities and can switch the hydration -from objects to simple PHP arrays instead. This can obviously yield considerable performance benefits for read-only requests. - -Implementing the same list view as before using array hydration we can rewrite our code: - - [php] - $dql = "SELECT b, e, r, p FROM Bug b JOIN b.engineer e ". - "JOIN b.reporter r JOIN b.products p ORDER BY b.created DESC"; - $query = $em->createQuery($dql); - $bugs = $query->getArrayResult(); - - foreach ($bugs AS $bug) { - echo $bug['description'] . " - " . $bug['created']->format('d.m.Y')."\n"; - echo " Reported by: ".$bug['reporter']['name']."\n"; - echo " Assigned to: ".$bug['engineer']['name']."\n"; - foreach($bug['products'] AS $product) { - echo " Platform: ".$product['name']."\n"; - } - echo "\n"; - } - -There is one significant difference in the DQL query however, we have -to add an additional fetch-join for the products connected to a bug. The resulting -SQL query for this single select statement is pretty large, however still -more efficient to retrieve compared to hydrating objects. - -### Find by Primary Key - -The next Use-Case is displaying a Bug by primary key. This could be done using DQL as in the previous example with a where clause, -however there is a convenience method on the Entity Manager that handles loading by primary key, which we have already -seen in the write scenarios: - - [php] - $bug = $entityManager->find("Bug", (int)$theBugId); - -However we will soon see another problem with our entities using this approach. Try displaying the engineer's name: - - [php] - echo "Bug: ".$bug->description."\n"; - echo "Engineer: ".$bug->getEngineer()->name."\n"; - -It will be null! What is happening? It worked in the previous example, so it can't be a problem with the persistence -code of Doctrine. What is it then? You walked in the public property trap. - -Since we only retrieved the bug by primary key both the engineer and reporter are not immediately loaded -from the database but are replaced by LazyLoading proxies. Sample -code of this proxy generated code can be found in the specified Proxy Directory, it looks like: - - [php] - namespace MyProject\Proxies; - - /** - * THIS CLASS WAS GENERATED BY THE DOCTRINE ORM. DO NOT EDIT THIS FILE. - */ - class UserProxy extends \User implements \Doctrine\ORM\Proxy\Proxy - { - // .. lazy load code here - - public function addReportedBug($bug) - { - $this->_load(); - return parent::addReportedBug($bug); - } - - public function assignedToBug($bug) - { - $this->_load(); - return parent::assignedToBug($bug); - } - } - -See how upon each method call the proxy is lazily loaded from the database? Using public properties however -we never call a method and Doctrine has no way to hook into the PHP Engine to detect a direct access to a public property -and trigger the lazy load. We need to rewrite our entities, make all the properties private or protected and add getters -and setters to get a working example: - - [php] - echo "Bug: ".$bug->getDescription()."\n"; - echo "Engineer: ".$bug->getEngineer()->getName()."\n"; - - /** - Bug: Something does not work! - Engineer: beberlei - */ - -Being required to use private or protected properties Doctrine 2 actually enforces you to encapsulate -your objects according to object-oriented best-practices. - -## Dashboard of the User - -For the next use-case we want to retrieve the dashboard view, a list of all open bugs the user reported or -was assigned to. This will be achieved using DQL again, this time with some WHERE clauses and usage of bound parameters: - - [php] - $dql = "SELECT b, e, r FROM Bug b JOIN b.engineer e JOIN b.reporter r ". - "WHERE b.status = 'OPEN' AND e.id = ?1 OR r.id = ?1 ORDER BY b.created DESC"; - - $myBugs = $entityManager->createQuery($dql) - ->setParameter(1, $theUserId) - ->setMaxResults(15) - ->getResult(); - - foreach ($myBugs AS $bug) { - echo $bug->getDescription()."\n"; - } - -That is it for the read-scenarios of this example, we will continue with the last missing bit, engineers -being able to close a bug. - -## Number of Bugs - -Until now we only retrieved entities or their array representation. Doctrine also supports the retrieval -of non-entities through DQL. These values are called "scalar result values" and may even be aggregate -values using COUNT, SUM, MIN, MAX or AVG functions. - -We will need this knowledge to retrieve the number of open bugs grouped by product: - - [php] - $dql = "SELECT p.id, p.name, count(b.id) AS openBugs FROM Bug b ". - "JOIN b.products p WHERE b.status = 'OPEN' GROUP BY p.id"; - $productBugs = $em->createQuery($dql)->getScalarResult(); - - foreach($productBugs as $productBug) { - echo $productBug['name']." has " . $productBug['openBugs'] . " open bugs!\n"; - } - -## Updating Entities - -There is a single use-case missing from the requirements, Engineers should be able to close a bug. This looks like: - - [php] - $bug = $entityManager->find("Bug", (int)$theBugId); - $bug->close(); - - $entityManager->flush(); - -When retrieving the Bug from the database it is inserted into the IdentityMap inside the UnitOfWork of Doctrine. -This means your Bug with exactly this id can only exist once during the whole request no matter how often you -call `EntityManager#find()`. It even detects entities that are hydrated using DQL and are already present in -the Identity Map. - -When flush is called the EntityManager loops over all the entities in the identity map and performs a comparison -between the values originally retrieved from the database and those values the entity currently has. If at -least one of these properties is different the entity is scheduled for an UPDATE against the database. -Only the changed columns are updated, which offers a pretty good performance improvement compared to updating -all the properties. - -This tutorial is over here, I hope you had fun. Additional content will be added to this tutorial -incrementally, topics will include: - - * Entity Repositories - * More on Association Mappings - * Lifecycle Events triggered in the UnitOfWork - * Ordering of Collections - -Additional details on all the topics discussed here can be found in the respective manual chapters. diff --git a/cookbook/en/implementing-arrayaccess-for-domain-objects.txt b/cookbook/en/implementing-arrayaccess-for-domain-objects.rst similarity index 60% rename from cookbook/en/implementing-arrayaccess-for-domain-objects.txt rename to cookbook/en/implementing-arrayaccess-for-domain-objects.rst index 4f295420d..aeb9a7ada 100644 --- a/cookbook/en/implementing-arrayaccess-for-domain-objects.txt +++ b/cookbook/en/implementing-arrayaccess-for-domain-objects.rst @@ -1,47 +1,61 @@ +Implementing ArrayAccess for Domain Objects +=========================================== -This recipe will show you how to implement ArrayAccess for your domain objects in order to allow more uniform access, for example in templates. In these examples we will implement ArrayAccess on a [Layer Supertype](http://martinfowler.com/eaaCatalog/layerSupertype.html) for all our domain objects. +This recipe will show you how to implement ArrayAccess for your +domain objects in order to allow more uniform access, for example +in templates. In these examples we will implement ArrayAccess on a +`Layer Supertype `_ +for all our domain objects. -++ Option 1 +Option 1 +-------- -In this implementation we will make use of PHPs highly dynamic nature to dynamically access properties of a subtype in a supertype at runtime. Note that this implementation has 2 main caveats: +In this implementation we will make use of PHPs highly dynamic +nature to dynamically access properties of a subtype in a supertype +at runtime. Note that this implementation has 2 main caveats: -* It will not work with private fields -* It will not go through any getters/setters -- +- It will not work with private fields +- It will not go through any getters/setters - [php] +:: + + $offset); } - + public function offsetSet($offset, $value) { $this->$offset = $value; } - + public function offsetGet($offset) { return $this->$offset; } - + public function offsetUnset($offset) { $this->$offset = null; } } +Option 2 +-------- -++ Option 2 +In this implementation we will dynamically invoke getters/setters. +Again we use PHPs dynamic nature to invoke methods on a subtype +from a supertype at runtime. This implementation has the following +caveats: -In this implementation we will dynamically invoke getters/setters. Again we use PHPs dynamic nature to invoke methods on a subtype from a supertype at runtime. This implementation has the following caveats: -* It relies on a naming convention -* The semantics of offsetExists can differ -* offsetUnset will not work with typehinted setters +- It relies on a naming convention +- The semantics of offsetExists can differ +- offsetUnset will not work with typehinted setters -- +:: - [php] + {"get$offset"}(); return $value !== null; } - + public function offsetSet($offset, $value) { $this->{"set$offset"}($value); } - + public function offsetGet($offset) { return $this->{"get$offset"}(); } - + public function offsetUnset($offset) { $this->{"set$offset"}(null); } } - -++ Read-only -You can slightly tweak option 1 or option 2 in order to make array access read-only. This will also circumvent some of the caveats of each option. Simply make offsetSet and offsetUnset throw an exception (i.e. BadMethodCallException). +Read-only +--------- - [php] +You can slightly tweak option 1 or option 2 in order to make array +access read-only. This will also circumvent some of the caveats of +each option. Simply make offsetSet and offsetUnset throw an +exception (i.e. BadMethodCallException). + +:: + + `_ +for all our domain objects. -++ Implementing NotifyPropertyChanged +Implementing NotifyPropertyChanged +---------------------------------- -The NOTIFY policy is based on the assumption that the entities notify interested listeners of changes to their properties. For that purpose, a class that wants to use this policy needs to implement the `NotifyPropertyChanged` interface from the `Doctrine\Common` namespace. +The NOTIFY policy is based on the assumption that the entities +notify interested listeners of changes to their properties. For +that purpose, a class that wants to use this policy needs to +implement the ``NotifyPropertyChanged`` interface from the +``Doctrine\Common`` namespace. - [php] +:: + + _listeners[] = $listener; } - + /** Notifies listeners of a change. */ protected function _onPropertyChanged($propName, $oldValue, $newValue) { if ($this->_listeners) { @@ -27,15 +41,19 @@ The NOTIFY policy is based on the assumption that the entities notify interested } } -Then, in each property setter of concrete, derived domain classes, you need to invoke _onPropertyChanged as follows to notify listeners: +Then, in each property setter of concrete, derived domain classes, +you need to invoke \_onPropertyChanged as follows to notify +listeners: - [php] +:: + + data) { // check: is it actually modified? $this->_onPropertyChanged('data', $this->data, $data); @@ -44,5 +62,9 @@ Then, in each property setter of concrete, derived domain classes, you need to i } } -The check whether the new value is different from the old one is not mandatory but recommended. That way you can avoid unnecessary updates and also have full control over when you consider a property changed. +The check whether the new value is different from the old one is +not mandatory but recommended. That way you can avoid unnecessary +updates and also have full control over when you consider a +property changed. + diff --git a/cookbook/en/implementing-wakeup-or-clone.rst b/cookbook/en/implementing-wakeup-or-clone.rst new file mode 100644 index 000000000..f93fbfe93 --- /dev/null +++ b/cookbook/en/implementing-wakeup-or-clone.rst @@ -0,0 +1,76 @@ +Implementing Wakeup or Clone +============================ + +As explained in the +`restrictions for entity classes in the manual `_, +it is usually not allowed for an entity to implement ``__wakeup`` +or ``__clone``, because Doctrine makes special use of them. +However, it is quite easy to make use of these methods in a safe +way by guarding the custom wakeup or clone code with an entity +identity check, as demonstrated in the following sections. + +Safely implementing \_\_wakeup +------------------------------ + +To safely implement ``__wakeup``, simply enclose your +implementation code in an identity check as follows: + +:: + + id) { + // ... Your code here as normal ... + } + // otherwise do nothing, do NOT throw an exception! + } + + //... + } + +Safely implementing \_\_clone +----------------------------- + +Safely implementing ``__clone`` is pretty much the same: + +:: + + id) { + // ... Your code here as normal ... + } + // otherwise do nothing, do NOT throw an exception! + } + + //... + } + +Summary +------- + +As you have seen, it is quite easy to safely make use of +``__wakeup`` and ``__clone`` in your entities without adding any +really Doctrine-specific or Doctrine-dependant code. + +These implementations are possible and safe because when Doctrine +invokes these methods, the entities never have an identity (yet). +Furthermore, it is possibly a good idea to check for the identity +in your code anyway, since it's rarely the case that you want to +unserialize or clone an entity with no identity. + + diff --git a/cookbook/en/implementing-wakeup-or-clone.txt b/cookbook/en/implementing-wakeup-or-clone.txt deleted file mode 100644 index efdefa7c3..000000000 --- a/cookbook/en/implementing-wakeup-or-clone.txt +++ /dev/null @@ -1,63 +0,0 @@ - -As explained in the [restrictions for entity classes in the manual](http://www.doctrine-project.org/documentation/manual/2_0/en/architecture#entities), -it is usually not allowed for an entity to implement `__wakeup` or `__clone`, because Doctrine -makes special use of them. However, it is quite easy to make use of these methods in a safe way -by guarding the custom wakeup or clone code with an entity identity check, as demonstrated in the following sections. - -++ Safely implementing __wakeup - -To safely implement `__wakeup`, simply enclose your implementation code in an identity check -as follows: - - [php] - class MyEntity - { - private $id; // This is the identifier of the entity. - //... - - public function __wakeup() - { - // If the entity has an identity, proceed as normal. - if ($this->id) { - // ... Your code here as normal ... - } - // otherwise do nothing, do NOT throw an exception! - } - - //... - } - -++ Safely implementing __clone - -Safely implementing `__clone` is pretty much the same: - - [php] - class MyEntity - { - private $id; // This is the identifier of the entity. - //... - - public function __clone() - { - // If the entity has an identity, proceed as normal. - if ($this->id) { - // ... Your code here as normal ... - } - // otherwise do nothing, do NOT throw an exception! - } - - //... - } - -++ Summary - -As you have seen, it is quite easy to safely make use of `__wakeup` and `__clone` in your entities -without adding any really Doctrine-specific or Doctrine-dependant code. - -These implementations are possible and safe because when Doctrine invokes these methods, -the entities never have an identity (yet). Furthermore, it is possibly a good idea to check -for the identity in your code anyway, since it's rarely the case that you want to unserialize -or clone an entity with no identity. - - - diff --git a/cookbook/en/index.rst b/cookbook/en/index.rst new file mode 100644 index 000000000..4c4be6adc --- /dev/null +++ b/cookbook/en/index.rst @@ -0,0 +1,32 @@ +.. Doctrine 2 ORM Cookbook documentation master file, created by + sphinx-quickstart on Mon Nov 1 21:13:13 2010. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Doctrine 2 ORM Cookbook's documentation! +=================================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + getting-started-xml-edition + implementing-arrayaccess-for-domain-objects + implementing-the-notify-changetracking-policy + validations-of-entities + implementing-wakeup-or-clone + integrating-with-codeigniter + dql-custom-walkers + dql-user-defined-functions + sql-table-prefixes + strategy-cookbook-introdution + aggregates-fields + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/cookbook/en/integrating-with-codeigniter.txt b/cookbook/en/integrating-with-codeigniter.rst similarity index 56% rename from cookbook/en/integrating-with-codeigniter.txt rename to cookbook/en/integrating-with-codeigniter.rst index e058ec6b9..105df85f9 100644 --- a/cookbook/en/integrating-with-codeigniter.txt +++ b/cookbook/en/integrating-with-codeigniter.rst @@ -1,78 +1,92 @@ -This is recipe for using Doctrine 2 in your [CodeIgniter](http://www.codeigniter.com) framework. +Integrating with CodeIgniter +============================ + +This is recipe for using Doctrine 2 in your +`CodeIgniter `_ framework. + +.. note:: + + This might not work for all CodeIgniter versions and may require + slight adjustments. -> **NOTE** -> -> This might not work for all CodeIgniter versions and may require slight adjustments. Here is how to set it up: -Make a CodeIgniter library that is both a wrapper and a bootstrap for Doctrine 2. +Make a CodeIgniter library that is both a wrapper and a bootstrap +for Doctrine 2. -++ Setting up the file structure +Setting up the file structure +----------------------------- Here are the steps: -* Add a php file to your system/application/libraries folder called Doctrine.php. This is going to be your wrapper/bootstrap for the D2 entity manager. -* Put the Doctrine folder (the one that contains Common, DBAL, and ORM) inside that same libraries folder. -* Your system/application/libraries folder now looks like this: - system/applications/libraries - -Doctrine - -Doctrine.php - -index.html +- Add a php file to your system/application/libraries folder + called Doctrine.php. This is going to be your wrapper/bootstrap for + the D2 entity manager. +- Put the Doctrine folder (the one that contains Common, DBAL, and + ORM) inside that same libraries folder. +- Your system/application/libraries folder now looks like this: -* If you want, open your config/autoload.php file and autoload your Doctrine library. + system/applications/libraries -Doctrine -Doctrine.php -index.html - [php] - $autoload['libraries'] = array('doctrine'); +- If you want, open your config/autoload.php file and autoload + your Doctrine library. -++ Creating your Doctrine CodeIgniter library + register(); $entitiesClassLoader = new ClassLoader('models', rtrim(APPPATH, "/" )); $entitiesClassLoader->register(); $proxiesClassLoader = new ClassLoader('Proxies', APPPATH.'models/proxies'); $proxiesClassLoader->register(); - + // Set up caches $config = new Configuration; $cache = new ArrayCache; $config->setMetadataCacheImpl($cache); $config->setQueryCacheImpl($cache); - + // Proxy configuration $config->setProxyDir(APPPATH.'/models/proxies'); $config->setProxyNamespace('Proxies'); - + // Set up logger $logger = new EchoSqlLogger; $config->setSqlLogger($logger); - + $config->setAutoGenerateProxyClasses( TRUE ); - + // Database connection information $connectionOptions = array( 'driver' => 'pdo_mysql', @@ -81,28 +95,42 @@ Now, here is what your Doctrine.php file should look like. Customize it to your 'host' => $db['default']['hostname'], 'dbname' => $db['default']['database'] ); - + // Create EntityManager $this->em = EntityManager::create($connectionOptions, $config); } } -Please note that this is a development configuration; for a production system you'll want to use a real caching system like APC, get rid of EchoSqlLogger, and turn off autoGenerateProxyClasses. +Please note that this is a development configuration; for a +production system you'll want to use a real caching system like +APC, get rid of EchoSqlLogger, and turn off +autoGenerateProxyClasses. -For more details, consult the [Doctrine 2 Configuration documentation](http://www.doctrine-project.org/documentation/manual/2_0/en/configuration#configuration-options). +For more details, consult the +`Doctrine 2 Configuration documentation `_. -++ Now to use it +Now to use it +------------- -Whenever you need a reference to the entity manager inside one of your controllers, views, or models you can do this: +Whenever you need a reference to the entity manager inside one of +your controllers, views, or models you can do this: - [php] +:: + + doctrine->em; -That's all there is to it. Once you get the reference to your EntityManager do your Doctrine 2.0 voodoo as normal. +That's all there is to it. Once you get the reference to your +EntityManager do your Doctrine 2.0 voodoo as normal. -Note: If you do not choose to autoload the Doctrine library, you will need to put this line before you get a reference to it: +Note: If you do not choose to autoload the Doctrine library, you +will need to put this line before you get a reference to it: - [php] +:: + + load->library('doctrine'); Good luck! + + diff --git a/cookbook/en/make.bat b/cookbook/en/make.bat new file mode 100644 index 000000000..9f1a938d9 --- /dev/null +++ b/cookbook/en/make.bat @@ -0,0 +1,113 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +set SPHINXBUILD=sphinx-build +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Doctrine2ORMCookbook.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Doctrine2ORMCookbook.ghc + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end diff --git a/cookbook/en/sql-table-prefixes.rst b/cookbook/en/sql-table-prefixes.rst new file mode 100644 index 000000000..8f3ee3809 --- /dev/null +++ b/cookbook/en/sql-table-prefixes.rst @@ -0,0 +1,73 @@ +SQL-Table Prefixes +================== + +This recipe is intended as an example of implementing a +loadClassMetadata listener to provide a Table Prefix option for +your application. The method used below is not a hack, but fully +integrates into the Doctrine system, all SQL generated will include +the appropriate table prefix. + +In most circumstances it is desirable to separate different +applications into individual databases, but in certain cases, it +may be beneficial to have a table prefix for your Entities to +separate them from other vendor products in the same database. + +Implementing the listener +------------------------- + +The listener in this example has been set up with the +DoctrineExtensions namespace. You create this file in your +library/DoctrineExtensions directory, but will need to set up +appropriate autoloaders. + +:: + + _prefix = (string) $prefix; + } + + public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs) + { + $classMetadata = $eventArgs->getClassMetadata(); + $classMetadata->setTableName($this->_prefix . $classMetadata->getTableName()); + } + } + +Telling the EntityManager about our listener +-------------------------------------------- + +A listener of this type must be set up before the EntityManager has +been initialised, otherwise an Entity might be created or cached +before the prefix has been set. + +.. note:: + + If you set this listener up, be aware that you will need + to clear your caches and drop then recreate your database schema. + + +:: + + addEventListener(\Doctrine\ORM\Events::loadClassMetadata, $tablePrefix); + + $em = \Doctrine\ORM\EntityManager::create($connectionOptions, $config, $evm); + + diff --git a/cookbook/en/sql-table-prefixes.txt b/cookbook/en/sql-table-prefixes.txt deleted file mode 100644 index eb7929959..000000000 --- a/cookbook/en/sql-table-prefixes.txt +++ /dev/null @@ -1,51 +0,0 @@ -This recipe is intended as an example of implementing a loadClassMetadata listener to provide a Table Prefix option for your application. The method used below is not a hack, but fully integrates into the Doctrine system, all SQL generated will include the appropriate table prefix. - -In most circumstances it is desirable to separate different applications into individual databases, but in certain cases, it may be beneficial to have a table prefix for your Entities to separate them from other vendor products in the same database. - -++ Implementing the listener - -The listener in this example has been set up with the DoctrineExtensions namespace. You create this file in your library/DoctrineExtensions directory, but will need to set up appropriate autoloaders. - - [php] - _prefix = (string) $prefix; - } - - public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs) - { - $classMetadata = $eventArgs->getClassMetadata(); - $classMetadata->setTableName($this->_prefix . $classMetadata->getTableName()); - } - } - -++ Telling the EntityManager about our listener - -A listener of this type must be set up before the EntityManager has been initialised, otherwise an Entity might be created or cached before the prefix has been set. - -> **Note** -> If you set this listener up, be aware that you will need to clear your caches -> and drop then recreate your database schema. - - [php] - addEventListener(\Doctrine\ORM\Events::loadClassMetadata, $tablePrefix); - - $em = \Doctrine\ORM\EntityManager::create($connectionOptions, $config, $evm); - diff --git a/cookbook/en/strategy-cookbook-introduction.txt b/cookbook/en/strategy-cookbook-introduction.rst similarity index 64% rename from cookbook/en/strategy-cookbook-introduction.txt rename to cookbook/en/strategy-cookbook-introduction.rst index 18cd0fe58..48a2a5366 100644 --- a/cookbook/en/strategy-cookbook-introduction.txt +++ b/cookbook/en/strategy-cookbook-introduction.rst @@ -1,39 +1,75 @@ +Strategy-Pattern +================ -This recipe will give you a short introduction on how to design similar entities without using expensive (i.e. slow) inheritance but with not more than -* the well-known strategy pattern -* event listeners +This recipe will give you a short introduction on how to design +similar entities without using expensive (i.e. slow) inheritance +but with not more than \* the well-known strategy pattern \* event +listeners -++ Scenario / Problem +Scenario / Problem +------------------ -Given a Content-Management-System, we probably want to add / edit some so-called "blocks" and "panels". What are they for? +Given a Content-Management-System, we probably want to add / edit +some so-called "blocks" and "panels". What are they for? -* A block might be a registration form, some text content, a table with information. A good example might also be a small calendar. -* A panel is by definition a block that can itself contain blocks. A good example for a panel might be a sidebar box: You could easily add a small calendar into it. -So, in this scenario, when building your CMS, you will surely add lots of blocks and panels to your pages and you will find yourself highly uncomfortable because of the following: +- A block might be a registration form, some text content, a table + with information. A good example might also be a small calendar. +- A panel is by definition a block that can itself contain blocks. + A good example for a panel might be a sidebar box: You could easily + add a small calendar into it. -* Every existing page needs to know about the panels it contains - therefore, you'll have an association to your panels. But if you've got several types of panels - what do you do? Add an association to -every panel-type? This wouldn't be flexible. You might be tempted to add an AbstractPanelEntity and an AbstractBlockEntity that use class inheritance. Your page could then only confer to the AbstractPanelType and Doctrine 2 would do the rest for you, i.e. load the right entities. But - you'll for sure have lots of panels and blocks, and even worse, you'd have to edit the discriminator map *manually* every time you or another developer implements a new block / entity. This would tear down any effort of modular programming. +So, in this scenario, when building your CMS, you will surely add +lots of blocks and panels to your pages and you will find yourself +highly uncomfortable because of the following: + + +- Every existing page needs to know about the panels it contains - + therefore, you'll have an association to your panels. But if you've + got several types of panels - what do you do? Add an association to + every panel-type? This wouldn't be flexible. You might be tempted + to add an AbstractPanelEntity and an AbstractBlockEntity that use + class inheritance. Your page could then only confer to the + AbstractPanelType and Doctrine 2 would do the rest for you, i.e. + load the right entities. But - you'll for sure have lots of panels + and blocks, and even worse, you'd have to edit the discriminator + map *manually* every time you or another developer implements a new + block / entity. This would tear down any effort of modular + programming. Therefore, we need something thats far more flexible. -++ Solution +Solution +-------- -The solution itself is pretty easy. We will have one base class that will be loaded via the page and that has specific behaviour - a Block class might render the front-end and even the backend, for example. Now, every block that you'll write might look different or need different data - therefore, we'll offer an API to these methods but internally, we use a strategy that exactly knows what to do. +The solution itself is pretty easy. We will have one base class +that will be loaded via the page and that has specific behaviour - +a Block class might render the front-end and even the backend, for +example. Now, every block that you'll write might look different or +need different data - therefore, we'll offer an API to these +methods but internally, we use a strategy that exactly knows what +to do. -First of all, we need to make sure that we have an interface that contains every needed action. Such actions would be rendering the front-end or the backend, solving dependencies (blocks that are supposed to be placed in the sidebar could refuse to be placed in the middle of your page, for example). +First of all, we need to make sure that we have an interface that +contains every needed action. Such actions would be rendering the +front-end or the backend, solving dependencies (blocks that are +supposed to be placed in the sidebar could refuse to be placed in +the middle of your page, for example). Such an interface could look like this: - [php] - /** - * This interface defines the basic actions that a block / panel needs to support. - * - * Every blockstrategy is *only* responsible for rendering a block and declaring some basic - * support, but *not* for updating its configuration etc. For this purpose, use controllers - * and models. - */ - interface BlockStrategyInterface { + +:: + + blockStrategy. Will not be persisted by Doctrine 2 + * This var contains an instance of $this->blockStrategy. Will not be persisted by Doctrine 2. + * * @var BlockStrategyInterface */ protected $strategyInstance; @@ -139,7 +175,7 @@ As you can see, we have a method "setBlockEntity" which ties a potential strateg public function getStrategyClassName() { return $this->strategyClassName; } - + /** * Returns the instantiated strategy * @@ -148,7 +184,7 @@ As you can see, we have a method "setBlockEntity" which ties a potential strateg public function getStrategyInstance() { return $this->strategyInstance; } - + /** * Sets the strategy this block / panel should work as. Make sure that you've used * this method before persisting the block! @@ -161,35 +197,42 @@ As you can see, we have a method "setBlockEntity" which ties a potential strateg $strategy->setBlockEntity($this); } -Now, the important point is that $strategyClassName is a Doctrine 2 field, i.e. Doctrine will persist this value. This is only the class name of your strategy and not an instance! +Now, the important point is that $strategyClassName is a Doctrine 2 +field, i.e. Doctrine will persist this value. This is only the +class name of your strategy and not an instance! -Finishing your strategy pattern, we hook into the Doctrine postLoad event and check whether a block has been loaded. If so, you will initialize it - i.e. get the strategies classname, create an instance of it and set it via setStrategyBlock(). +Finishing your strategy pattern, we hook into the Doctrine postLoad +event and check whether a block has been loaded. If so, you will +initialize it - i.e. get the strategies classname, create an +instance of it and set it via setStrategyBlock(). This might look like this: - [php] +:: + + view = $view; } - + public function getSubscribedEvents() { return array(ORM\Events::postLoad); } - + public function postLoad(ORM\Event\LifecycleEventArgs $args) { $blockItem = $args->getEntity(); - + // Both blocks and panels are instances of Block\AbstractBlock if ($blockItem instanceof Block\AbstractBlock) { $strategy = $blockItem->getStrategyClassName(); @@ -203,4 +246,7 @@ This might look like this: } } -In this example, even some variables are set - like a view object or a specific configuration object. +In this example, even some variables are set - like a view object +or a specific configuration object. + + diff --git a/cookbook/en/validation-of-entities.rst b/cookbook/en/validation-of-entities.rst new file mode 100644 index 000000000..ab15f58e0 --- /dev/null +++ b/cookbook/en/validation-of-entities.rst @@ -0,0 +1,141 @@ +Validation of Entities +====================== + +Doctrine 2 does not ship with any internal validators, the reason +being that we think all the frameworks out there already ship with +quite decent ones that can be integrated into your Domain easily. +What we offer are hooks to execute any kind of validation. + +.. note:: + + You don't need to validate your entities in the lifecycle + events. Its only one of many options. Of course you can also + perform validations in value setters or any other method of your + entities that are used in your code. + + +Entities can register lifecycle event methods with Doctrine that +are called on different occasions. For validation we would need to +hook into the events called before persisting and updating. Even +though we don't support validation out of the box, the +implementation is even simpler than in Doctrine 1 and you will get +the additional benefit of being able to re-use your validation in +any other part of your domain. + +Say we have an ``Order`` with several ``OrderLine`` instances. We +never want to allow any customer to order for a larger sum than he +is allowed to: + +:: + + customer->getOrderLimit(); + + $amount = 0; + foreach ($this->orderLines AS $line) { + $amount += $line->getAmount(); + } + + if ($amount > $orderLimit) { + throw new CustomerOrderLimitExceededException(); + } + } + } + +Now this is some pretty important piece of business logic in your +code, enforcing it at any time is important so that customers with +a unknown reputation don't owe your business too much money. + +We can enforce this constraint in any of the metadata drivers. +First Annotations: + +:: + + + + + + + + + + +YAML needs some little change yet, to allow multiple lifecycle +events for one method, this will happen before Beta 1 though. + +Now validation is performed whenever you call +``EntityManager#persist($order)`` or when you call +``EntityManager#flush()`` and an order is about to be updated. Any +Exception that happens in the lifecycle callbacks will be cached by +the EntityManager and the current transaction is rolled back. + +Of course you can do any type of primitive checks, not null, +email-validation, string size, integer and date ranges in your +validation callbacks. + +:: + + plannedShipDate instanceof DateTime)) { + throw new ValidateException(); + } + + if ($this->plannedShipDate->format('U') < time()) { + throw new ValidateException(); + } + + if ($this->customer == null) { + throw new OrderRequiresCustomerException(); + } + } + } + +What is nice about lifecycle events is, you can also re-use the +methods at other places in your domain, for example in combination +with your form library. Additionally there is no limitation in the +number of methods you register on one particular event, i.e. you +can register multiple methods for validation in "PrePersist" or +"PreUpdate" or mix and share them in any combinations between those +two events. + +There is no limit to what you can and can't validate in +"PrePersist" and "PreUpdate" as long as you don't create new entity +instances. This was already discussed in the previous blog post on +the Versionable extension, which requires another type of event +called "onFlush". + +Further readings: + + +- `Doctrine 2 Manual: Events `_ + + diff --git a/cookbook/en/validation-of-entities.txt b/cookbook/en/validation-of-entities.txt deleted file mode 100644 index 047fed22d..000000000 --- a/cookbook/en/validation-of-entities.txt +++ /dev/null @@ -1,114 +0,0 @@ -Doctrine 2 does not ship with any internal validators, the reason being that -we think all the frameworks out there already ship with quite decent ones that can be integrated -into your Domain easily. What we offer are hooks to execute any kind of validation. - -> **Note** -> You don't need to validate your entities in the lifecycle events. Its only -> one of many options. Of course you can also perform validations in value setters -> or any other method of your entities that are used in your code. - -Entities can register lifecycle event methods with Doctrine that are called on -different occasions. For validation we would need to hook into the -events called before persisting and updating. Even though we don't support -validation out of the box, the implementation is even simpler than in Doctrine 1 -and you will get the additional benefit of being able to re-use your validation -in any other part of your domain. - -Say we have an `Order` with several `OrderLine` instances. We never want to -allow any customer to order for a larger sum than he is allowed to: - - [php] - class Order - { - public function assertCustomerAllowedBuying() - { - $orderLimit = $this->customer->getOrderLimit(); - - $amount = 0; - foreach ($this->orderLines AS $line) { - $amount += $line->getAmount(); - } - - if ($amount > $orderLimit) { - throw new CustomerOrderLimitExceededException(); - } - } - } - -Now this is some pretty important piece of business logic in your code, enforcing -it at any time is important so that customers with a unknown reputation don't -owe your business too much money. - -We can enforce this constraint in any of the metadata drivers. First Annotations: - - [php] - /** - * @Entity - * @HasLifecycleCallbacks - */ - class Order - { - /** - * @PrePersist @PreUpdate - */ - public function assertCustomerAllowedBuying() {} - } - -In XML Mappings: - - [xml] - - - - - - - - - -YAML needs some little change yet, to allow multiple lifecycle events for one method, -this will happen before Beta 1 though. - -Now validation is performed whenever you call `EntityManager#persist($order)` -or when you call `EntityManager#flush()` and an order is about to be updated. -Any Exception that happens in the lifecycle callbacks will be cached by the -EntityManager and the current transaction is rolled back. - -Of course you can do any type of primitive checks, not null, email-validation, string size, -integer and date ranges in your validation callbacks. - - [php] - class Order - { - /** - * @PrePersist @PreUpdate - */ - public function validate() - { - if (!($this->plannedShipDate instanceof DateTime)) { - throw new ValidateException(); - } - - if ($this->plannedShipDate->format('U') < time()) { - throw new ValidateException(); - } - - if ($this->customer == null) { - throw new OrderRequiresCustomerException(); - } - } - } - -What is nice about lifecycle events is, you can also re-use the methods at other places -in your domain, for example in combination with your form library. -Additionally there is no limitation in the number of methods you register -on one particular event, i.e. you can register multiple methods for validation in "PrePersist" -or "PreUpdate" or mix and share them in any combinations between those two events. - -There is no limit to what you can and can't validate in "PrePersist" and "PreUpdate" as long as -you don't create new entity instances. This was already discussed in the previous -blog post on the Versionable extension, which requires another type of event called "onFlush". - -Further readings: - -* [Doctrine 2 Manual: Events](http://www.doctrine-project.org/documentation/manual/2_0/en/events#lifecycle-events) \ No newline at end of file diff --git a/generate-docs.sh b/generate-docs.sh new file mode 100755 index 000000000..14fdb721b --- /dev/null +++ b/generate-docs.sh @@ -0,0 +1,2 @@ +#!/bin/bash +sphinx-build reference/en /var/www/docs \ No newline at end of file diff --git a/manual/en.rst b/manual/en.rst new file mode 100644 index 000000000..f66e1b2fd --- /dev/null +++ b/manual/en.rst @@ -0,0 +1,79 @@ +Introduction +============ + +Architecture +============ + +Configuration +============= + +Basic Mapping +============= + +Association Mapping +=================== + +Inheritance Mapping +=================== + +Working with objects +==================== + +Working with associations +========================= + +Transactions and Concurrency +============================ + +Events +====== + +Batch processing +================ + +DQL (Doctrine Query Language) +============================= + +Query Builder +============= + +Native SQL +========== + +Change Tracking Policies +======================== + +Partial Objects +=============== + +XML Mapping +=========== + +YAML Mapping +============ + +Annotations Reference +===================== + +PHP Mapping +=========== + +Caching +======= + +Improving Performance +===================== + +Tools +===== + +Metadata Drivers +================ + +Best Practices +============== + +Limitations and Known Issues +============================ + + diff --git a/manual/en.txt b/manual/en.txt index 460439100..95d8bdbec 100644 --- a/manual/en.txt +++ b/manual/en.txt @@ -1,26 +1,26 @@ -+ Introduction -+ Architecture -+ Configuration -+ Basic Mapping -+ Association Mapping -+ Inheritance Mapping -+ Working with objects -+ Working with associations -+ Transactions and Concurrency -+ Events -+ Batch processing -+ DQL (Doctrine Query Language) -+ Query Builder -+ Native SQL -+ Change Tracking Policies -+ Partial Objects -+ XML Mapping -+ YAML Mapping -+ Annotations Reference -+ PHP Mapping -+ Caching -+ Improving Performance -+ Tools -+ Metadata Drivers -+ Best Practices -+ Limitations and Known Issues \ No newline at end of file +# Introduction +# Architecture +# Configuration +# Basic Mapping +# Association Mapping +# Inheritance Mapping +# Working with objects +# Working with associations +# Transactions and Concurrency +# Events +# Batch processing +# DQL (Doctrine Query Language) +# Query Builder +# Native SQL +# Change Tracking Policies +# Partial Objects +# XML Mapping +# YAML Mapping +# Annotations Reference +# PHP Mapping +# Caching +# Improving Performance +# Tools +# Metadata Drivers +# Best Practices +# Limitations and Known Issues \ No newline at end of file diff --git a/manual/en/annotations-reference.rst b/manual/en/annotations-reference.rst new file mode 100644 index 000000000..d7515c38a --- /dev/null +++ b/manual/en/annotations-reference.rst @@ -0,0 +1,769 @@ +In this chapter a reference of every Doctrine 2 Annotation is given +with short explanations on their context and usage. + +Index +----- + + +- `@Column <#ann_column>`_ +- `@ChangeTrackingPolicy <#ann_changetrackingpolicy>`_ +- `@DiscriminatorColumn <#ann_discriminatorcolumn>`_ +- `@DiscriminatorMap <#ann_discriminatormap>`_ +- `@Entity <#ann_entity>`_ +- `@GeneratedValue <#ann_generatedvalue>`_ +- `@HasLifecycleCallbacks <#ann_haslifecyclecallbacks>`_ +- `@Index <#ann_indexes>`_ +- `@Id <#ann_id>`_ +- `@InheritanceType <#ann_inheritancetype>`_ +- `@JoinColumn <#ann_joincolumn>`_ +- `@JoinTable <#ann_jointable>`_ +- `@ManyToOne <#ann_manytoone>`_ +- `@ManyToMany <#ann_manytomany>`_ +- `@MappedSuperclass <#ann_mappedsuperclass>`_ +- `@OneToOne <#ann_onetoone>`_ +- `@OneToMany <#ann_onetomany>`_ +- `@OrderBy <#ann_orderby>`_ +- `@PostLoad <#ann_postload>`_ +- `@PostPersist <#ann_postpersist>`_ +- `@PostRemove <#ann_postremove>`_ +- `@PostUpdate <#ann_postupdate>`_ +- `@PrePersist <#ann_prepersist>`_ +- `@PreRemove <#ann_preremove>`_ +- `@PreUpdate <#ann_preupdate>`_ +- `@SequenceGenerator <#ann_sequencegenerator>`_ +- `@Table <#ann_table>`_ +- `@UniqueConstraint <#ann_uniqueconstraint>`_ +- `@Version <#ann_version>`_ + +Reference +--------- + +### @Column + +Marks an annotated instance variable as "persistent". It has to be +inside the instance variables PHP DocBlock comment. Any value hold +inside this variable will be saved to and loaded from the database +as part of the lifecycle of the instance variables entity-class. + +Required attributes: + + +- type - Name of the Doctrine Type which is converted between PHP + and Database representation. + +Optional attributes: + + +- name - By default the property name is used for the database + column name also, however the 'name' attribute allows you to + determine the column name. +- length - Used by the "string" type to determine its maximum + length in the database. Doctrine does not validate the length of a + string values for you. +- precision - The precision for a decimal (exact numeric) column + (Applies only for decimal column) +- scale - The scale for a decimal (exact numeric) column (Applies + only for decimal column) +- unique - Boolean value to determine if the value of the column + should be unique across all rows of the underlying entities table. +- nullable - Determines if NULL values allowed for this column. +- columnDefinition - DDL SQL snippet that starts after the column + name and specifies the complete (non-portable!) column definition. + This attribute allows to make use of advanced RMDBS features. + However you should make careful use of this feature and the + consequences. Additionally you should remember that the "type" + attribute still handles the conversion between PHP and Database + values. If you use this attribute on a column that is used for + joins between tables you should also take a look at + `@JoinColumn <#ann_joincolumn>`_. + +Examples: + +:: + + `_ +can be found in the configuration section. + +Example: + +:: + + `_. This +annotation is optional and only has meaning when used in +conjunction with @Id. + +If this annotation is not specified with @Id the NONE strategy is +used as default. + +Required attributes: + + +- strategy - Set the name of the identifier generation strategy. + Valid values are AUTO, SEQUENCE, TABLE, IDENTITY and NONE. + +Example: + +:: + + `_ annotation on +the entity-class level. It allows to hint the SchemaTool to +generate a database index on the specified table columns. It only +has meaning in the SchemaTool schema generation context. + +Required attributes: + + +- name - Name of the Index +- columns - Array of columns. + +Example: + +:: + + `_ and +`@DiscriminatorColumn <#ann_discriminatorcolumn>`_ annotations. + +Examples: + +:: + + `_, `@OneToOne <#ann_onetoone>`_ fields +and in the Context of `@JoinTable <#ann_jointable>`_ nested inside +a @ManyToMany. This annotation is not required. If its not +specified the attributes *name* and *referencedColumnName* are +inferred from the table and primary key names. + +Required attributes: + + +- name - Column name that holds the foreign key identifier for + this relation. In the context of @JoinTable it specifies the column + name in the join table. +- referencedColumnName - Name of the primary key identifier that + is used for joining of this relation. + +Optional attributes: + + +- unique - Determines if this relation exclusive between the + affected entities and should be enforced so on the database + constraint level. Defaults to false. +- nullable - Determine if the related entity is required, or if + null is an allowed state for the relation. Defaults to true. +- onDelete - Cascade Action (Database-level) +- onUpdate - Cascade Action (Database-level) +- columnDefinition - DDL SQL snippet that starts after the column + name and specifies the complete (non-portable!) column definition. + This attribute allows to make use of advanced RMDBS features. Using + this attribute on @JoinColumn is necessary if you need slightly + different column definitions for joining columns, for example + regarding NULL/NOT NULL defaults. However by default a + "columnDefinition" attribute on `@Column <#ann_column>`_ also sets + the related @JoinColumn's columnDefinition. This is necessary to + make foreign keys work. + +Example: + +:: + + `_ or `@OneToOne <#ann_onetoone>`_ +relation with an entity that has multiple identifiers. + +### @JoinTable + +Using `@OneToMany <#ann_onetomany>`_ or +`@ManyToMany <#ann_manytomany>`_ on the owning side of the relation +requires to specify the @JoinTable annotation which describes the +details of the database join table. If you do not specify +@JoinTable on these relations reasonable mapping defaults apply +using the affected table and the column names. + +Required attributes: + + +- name - Database name of the join-table +- joinColumns - An array of @JoinColumn annotations describing the + join-relation between the owning entities table and the join table. +- inverseJoinColumns - An array of @JoinColumn annotations + describing the join-relation between the inverse entities table and + the join table. + +Optional attributes: + + +- schema - Database schema name of this table. + +Example: + +:: + + `_ is an +additional, optional annotation that has reasonable default +configuration values using the table and names of the two related +entities. + +Required attributes: + + +- targetEntity - FQCN of the referenced target entity. Can be the + unqualified class name if both classes are in the same namespace. + *IMPORTANT:* No leading backslash! + +Optional attributes: + + +- mappedBy - This option specifies the property name on the + targetEntity that is the owning side of this relation. Its a + required attribute for the inverse side of a relationship. +- inversedBy - The inversedBy attribute designates the field in the + entity that is the inverse side of the relationship. +- cascade - Cascade Option +- fetch - One of LAZY or EAGER + + **NOTE** For ManyToMany bidirectional relationships either side may + be the owning side (the side that defines the @JoinTable and/or + does not make use of the mappedBy attribute, thus using a default + join table). + + +Example: + +:: + + `_. + +### @OneToOne + +The @OneToOne annotation works almost exactly as the +`@ManyToOne <#ann_manytoone>`_ with one additional option that can +be specified. The configuration defaults for +`@JoinColumn <#ann_joincolumn>`_ using the target entity table and +primary key column names apply here too. + +Required attributes: + + +- targetEntity - FQCN of the referenced target entity. Can be the + unqualified class name if both classes are in the same namespace. + *IMPORTANT:* No leading backslash! + +Optional attributes: + + +- cascade - Cascade Option +- fetch - One of LAZY or EAGER +- orphanRemoval - Boolean that specifies if orphans, inverse + OneToOne entities that are not connected to any owning instance, + should be removed by Doctrine. Defaults to false. +- inversedBy - The inversedBy attribute designates the field in the + entity that is the inverse side of the relationship. + +Example: + +:: + + `_ or `@OneToMany <#ann_onetomany>`_ +annotation to specify by which criteria the collection should be +retrieved from the database by using an ORDER BY clause. + +This annotation requires a single non-attributed value with an DQL +snippet: + +Example: + +:: + + `_ annotation on +the entity-class level. It allows to hint the SchemaTool to +generate a database unique constraint on the specified table +columns. It only has meaning in the SchemaTool schema generation +context. + +Required attributes: + + +- name - Name of the Index +- columns - Array of columns. + +Example: + +:: + + `_ annotations that have the type integer or +datetime. + +Example: + +:: + + -+++ @Column +### @Column Marks an annotated instance variable as "persistent". It has to be inside the instance variables PHP DocBlock comment. Any value hold inside this variable will be saved to and loaded from the database as part of the lifecycle of the instance variables entity-class. @@ -56,7 +56,7 @@ Optional attributes: Examples: - [php] + -+++ @ChangeTrackingPolicy +### @ChangeTrackingPolicy The Change Tracking Policy annotation allows to specify how the Doctrine 2 UnitOfWork should detect changes in properties of entities during flush. By default each entity is checked according to a deferred implicit @@ -86,7 +86,7 @@ can be found in the configuration section. Example: - [php] + -+++ @DiscrimnatorColumn +### @DiscrimnatorColumn This annotation is a required annotation for the topmost/super class of an inheritance hierarchy. It specifies the details of the column which saves the name of the class, which the entity is actually instantiated as. @@ -111,14 +111,14 @@ Optional attributes: * length - By default this is 255. -+++ @DiscriminatorMap +### @DiscriminatorMap The discriminator map is a required annotation on the top-most/super class in an inheritance hierarchy. It takes an array as only argument which defines which class should be saved under which name in the database. Keys are the database value and values are the classes, either as fully- or as unqualified class names depending if the classes are in the namespace or not. - [php] + -+++ @Entity +### @Entity Required annotation to mark a PHP class as Entity. Doctrine manages the persistence of all classes marked as entity. @@ -142,7 +142,7 @@ Optional attributes: Example: - [php] + -+++ @GeneratedValue +### @GeneratedValue Specifies which strategy is used for identifier generation for an instance variable which is annotated by [@Id](#ann_id). This annotation is optional and only has meaning when used in conjunction with @Id. @@ -165,7 +165,7 @@ Required attributes: Example: - [php] + -+++ @HasLifecycleCallbacks +### @HasLifecycleCallbacks Annotation which has to be set on the entity-class PHP DocBlock to notify Doctrine that this entity has entity life-cycle callback annotations set on at least one of its methods. Using @PostLoad, @PrePersist, @PostPersist, @PreRemove, @PostRemove, @@ -182,7 +182,7 @@ callback annotations set on at least one of its methods. Using @PostLoad, @PrePe Example: - [php] + -+++ @Index +### @Index Annotation is used inside the [@Table](#ann_table) annotation on the entity-class level. It allows to hint the SchemaTool to generate a database index on the specified table columns. It only has meaning in the SchemaTool @@ -209,7 +209,7 @@ Required attributes: Example: - [php] + -+++ @Id +### @Id The annotated instance variable will be marked as entity identifier, the primary key in the database. This annotation is a marker only and has no required or optional attributes. For entities that have multiple @@ -227,7 +227,7 @@ identifier columns each column has to be marked with @Id. Example: - [php] + -+++ @InheritanceType +### @InheritanceType In an inheritance hierarchy you have to use this annotation on the topmost/super class to define which strategy should be used for inheritance. Currently Single Table and Class Table Inheritance are supported. @@ -245,7 +245,7 @@ This annotation has always been used in conjunction with the [@DiscriminatorMap] Examples: - [php] + -+++ @JoinColumn +### @JoinColumn This annotation is used in the context of relations in [@ManyToOne](#ann_manytoone), [@OneToOne](#ann_onetoone) fields and in the Context of [@JoinTable](#ann_jointable) nested inside a @ManyToMany. This annotation is not required. @@ -290,7 +290,7 @@ Optional attributes: Example: - [php] + -+++ @JoinColumns +### @JoinColumns An array of @JoinColumn annotations for a [@ManyToOne](#ann_manytoone) or [@OneToOne](#ann_onetoone) relation with an entity that has multiple identifiers. -+++ @JoinTable +### @JoinTable Using [@OneToMany](#ann_onetomany) or [@ManyToMany](#ann_manytomany) on the owning side of the relation requires to specify the @JoinTable annotation which describes the details of the database join table. If you do not specify @JoinTable on @@ -322,7 +322,7 @@ Optional attributes: Example: - [php] + -+++ @ManyToOne +### @ManyToOne Defines that the annotated instance variable holds a reference that describes a many-to-one relationship between two entities. @@ -349,14 +349,14 @@ Optional attributes: Example: - [php] + -+++ @ManyToMany +### @ManyToMany Defines an instance variable holds a many-to-many relationship between two entities. [@JoinTable](#ann_jointable) is an additional, optional annotation that has reasonable default configuration values using the table @@ -380,7 +380,7 @@ Optional attributes: Example: - [php] + -+++ @MappedSuperclass +### @MappedSuperclass An mapped superclass is an abstract or concrete class that provides persistent entity state and mapping information for its subclasses, but which is not itself an entity. This annotation is specified on the Class docblock @@ -410,7 +410,7 @@ The @MappedSuperclass annotation cannot be used in conjunction with @Entity. See section for [more details on the restrictions of mapped superclasses](/../inheritance-mapping#mapped-superclasses). -+++ @OneToOne +### @OneToOne The @OneToOne annotation works almost exactly as the [@ManyToOne](#ann_manytoone) with one additional option that can be specified. The configuration defaults for [@JoinColumn](#ann_joincolumn) using the target entity table and primary key column names @@ -430,7 +430,7 @@ owning instance, should be removed by Doctrine. Defaults to false. Example: - [php] + -+++ @OneToMany +### @OneToMany Required attributes: @@ -453,14 +453,14 @@ owning instance, should be removed by Doctrine. Defaults to false. Example: - [php] + -+++ @OrderBy +### @OrderBy Optional annotation that can be specified with a [@ManyToMany](#ann_manytomany) or [@OneToMany](#ann_onetomany) annotation to specify by which criteria the collection should be retrieved from the database by using an ORDER BY @@ -470,7 +470,7 @@ This annotation requires a single non-attributed value with an DQL snippet: Example: - [php] + -+++ @PostLoad +### @PostLoad Marks a method on the entity to be called as a @PostLoad event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -+++ @PostPersist +### @PostPersist Marks a method on the entity to be called as a @PostPersist event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -+++ @PostRemove +### @PostRemove Marks a method on the entity to be called as a @PostRemove event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -+++ @PostUpdate +### @PostUpdate Marks a method on the entity to be called as a @PostUpdate event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -+++ @PrePersist +### @PrePersist Marks a method on the entity to be called as a @PrePersist event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -+++ @PreRemove +### @PreRemove Marks a method on the entity to be called as a @PreRemove event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -+++ @PreUpdate +### @PreUpdate Marks a method on the entity to be called as a @PreUpdate event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -+++ @SequenceGenerator +### @SequenceGenerator For the use with @generatedValue(strategy="SEQUENCE") this annotation allows to specify details about the sequence, such as the increment size and initial values of the sequence. @@ -535,7 +535,7 @@ Optional attributes: Example: - [php] + -+++ @Table +### @Table Annotation describes the table an entity is persisted in. It is placed on the entity-class PHP DocBlock and is optional. If it is not specified the table name will default to the entities unqualified classname. @@ -562,7 +562,7 @@ Optional attributes: Example: - [php] + -+++ @UniqueConstraint +### @UniqueConstraint Annotation is used inside the [@Table](#ann_table) annotation on the entity-class level. It allows to hint the SchemaTool to generate a database unique constraint on the specified table columns. It only has meaning in the SchemaTool @@ -586,7 +586,7 @@ Required attributes: Example: - [php] + -+++ @Version +### @Version Marker annotation that defines a specified column as version attribute used in an optimistic locking scenario. It only works on [@Column](#ann_column) annotations that have the type integer or datetime. Example: - [php] + `_. +- An entity class must not implement ``__wakeup`` or + `do so safely `_. + Also consider implementing + `Serializable `_ + instead. +- Any two entity classes in a class hierarchy that inherit + directly or indirectly from one another must not have a mapped + property with the same name. That is, if B inherits from A then B + must not have a mapped field with the same name as an already + mapped field that is inherited from A. + +Entities support inheritance, polymorphic associations, and +polymorphic queries. Both abstract and concrete classes can be +entities. Entities may extend non-entity classes as well as entity +classes, and non-entity classes may extend entity classes. + + **TIP** The constructor of an entity is only ever invoked when + *you* construct a new instance with the *new* keyword. Doctrine + never calls entity constructors, thus you are free to use them as + you wish and even have it require arguments of any type. + + +Entity states +~~~~~~~~~~~~~ + +An entity instance can be characterized as being NEW, MANAGED, +DETACHED or REMOVED. + + +- A NEW entity instance has no persistent identity, and is not yet + associated with an EntityManager and a UnitOfWork (i.e. those just + created with the "new" operator). +- A MANAGED entity instance is an instance with a persistent + identity that is associated with an EntityManager and whose + persistence is thus managed. +- A DETACHED entity instance is an instance with a persistent + identity that is not (or no longer) associated with an + EntityManager and a UnitOfWork. +- A REMOVED entity instance is an instance with a persistent + identity, associated with an EntityManager, that will be removed + from the database upon transaction commit. + +Persistent fields +~~~~~~~~~~~~~~~~~ + +The persistent state of an entity is represented by instance +variables. An instance variable must be directly accessed only from +within the methods of the entity by the entity instance itself. +Instance variables must not be accessed by clients of the entity. +The state of the entity is available to clients only through the +entity’s methods, i.e. accessor methods (getter/setter methods) or +other business methods. + +Collection-valued persistent fields and properties must be defined +in terms of the ``Doctrine\Common\Collections\Collection`` +interface. The collection implementation type may be used by the +application to initialize fields or properties before the entity is +made persistent. Once the entity becomes managed (or detached), +subsequent access must be through the interface type. + +Serializing entities +~~~~~~~~~~~~~~~~~~~~ + +Serializing entities can be problematic and is not really +recommended, at least not as long as an entity instance still holds +references to proxy objects or is still managed by an +EntityManager. If you intend to serialize (and unserialize) entity +instances that still hold references to proxy objects you may run +into problems with private properties because of technical +limitations. Proxy objects implement ``__sleep`` and it is not +possible for ``__sleep`` to return names of private properties in +parent classes. On the other hand it is not a solution for proxy +objects to implement ``Serializable`` because Serializable does not +work well with any potential cyclic object references (at least we +did not find a way yet, if you did, please contact us). + +The EntityManager +----------------- + +The ``EntityManager`` class is a central access point to the ORM +functionality provided by Doctrine 2. The ``EntityManager`` API is +used to manage the persistence of your objects and to query for +persistent objects. + +Transactional write-behind +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An ``EntityManager`` and the underlying ``UnitOfWork`` employ a +strategy called "transactional write-behind" that delays the +execution of SQL statements in order to execute them in the most +efficient way and to execute them at the end of a transaction so +that all write locks are quickly released. You should see Doctrine +as a tool to synchronize your in-memory objects with the database +in well defined units of work. Work with your objects and modify +them as usual and when you're done call ``EntityManager#flush()`` +to make your changes persistent. + +The Unit of Work +~~~~~~~~~~~~~~~~ + +Internally an ``EntityManager`` uses a ``UnitOfWork``, which is a +typical implementation of the +`Unit of Work pattern `_, +to keep track of all the things that need to be done the next time +``flush`` is invoked. You usually do not directly interact with a +``UnitOfWork`` but with the ``EntityManager`` instead. + + diff --git a/manual/en/architecture.txt b/manual/en/architecture.txt index e9ef689d5..7305c8418 100644 --- a/manual/en/architecture.txt +++ b/manual/en/architecture.txt @@ -1,7 +1,7 @@ This chapter gives an overview of the overall architecture, terminology and constraints of Doctrine 2. It is recommended to read this chapter carefully. -++ Entities +## Entities An entity is a lightweight, persistent domain object. An entity can be any regular PHP class observing the following restrictions: @@ -23,7 +23,7 @@ classes as well as entity classes, and non-entity classes may extend entity clas > with the *new* keyword. Doctrine never calls entity constructors, thus you are free to use > them as you wish and even have it require arguments of any type. -+++ Entity states +### Entity states An entity instance can be characterized as being NEW, MANAGED, DETACHED or REMOVED. @@ -32,7 +32,7 @@ An entity instance can be characterized as being NEW, MANAGED, DETACHED or REMOV * A DETACHED entity instance is an instance with a persistent identity that is not (or no longer) associated with an EntityManager and a UnitOfWork. * A REMOVED entity instance is an instance with a persistent identity, associated with an EntityManager, that will be removed from the database upon transaction commit. -+++ Persistent fields +### Persistent fields The persistent state of an entity is represented by instance variables. An instance variable must be directly accessed only from within the methods of the @@ -47,7 +47,7 @@ implementation type may be used by the application to initialize fields or properties before the entity is made persistent. Once the entity becomes managed (or detached), subsequent access must be through the interface type. -+++ Serializing entities +### Serializing entities Serializing entities can be problematic and is not really recommended, at least not as long as an entity instance still holds references to proxy objects or is still managed by an EntityManager. @@ -58,13 +58,13 @@ private properties in parent classes. On the other hand it is not a solution for to implement `Serializable` because Serializable does not work well with any potential cyclic object references (at least we did not find a way yet, if you did, please contact us). -++ The EntityManager +## The EntityManager The `EntityManager` class is a central access point to the ORM functionality provided by Doctrine 2. The `EntityManager` API is used to manage the persistence of your objects and to query for persistent objects. -+++ Transactional write-behind +### Transactional write-behind An `EntityManager` and the underlying `UnitOfWork` employ a strategy called "transactional write-behind" that delays the execution of SQL statements in @@ -74,7 +74,7 @@ Doctrine as a tool to synchronize your in-memory objects with the database in well defined units of work. Work with your objects and modify them as usual and when you're done call `EntityManager#flush()` to make your changes persistent. -+++ The Unit of Work +### The Unit of Work Internally an `EntityManager` uses a `UnitOfWork`, which is a typical implementation of the [Unit of Work pattern](http://martinfowler.com/eaaCatalog/unitOfWork.html), to keep track of all the things that need to be done diff --git a/manual/en/association-mapping.rst b/manual/en/association-mapping.rst new file mode 100644 index 000000000..de7b72790 --- /dev/null +++ b/manual/en/association-mapping.rst @@ -0,0 +1,969 @@ +This chapter explains how associations between entities are mapped +with Doctrine. We start out with an explanation of the concept of +owning and inverse sides which is important to understand when +working with bidirectional associations. Please read these +explanations carefully. + +Owning Side and Inverse Side +---------------------------- + +When mapping bidirectional associations it is important to +understand the concept of the owning and inverse sides. The +following general rules apply: + + +- Relationships may be bidirectional or unidirectional. +- A bidirectional relationship has both an owning side and an + inverse side. +- A unidirectional relationship only has an owning side. +- The owning side of a relationship determines the updates to the + relationship in the database. + +The following rules apply to *bidirectional* associations: + + +- The inverse side of a bidirectional relationship must refer to + its owning side by use of the mappedBy attribute of the OneToOne, + OneToMany, or ManyToMany mapping declaration. The mappedBy + attribute designates the field in the entity that is the owner of + the relationship. +- The owning side of a bidirectional relationship must refer to + its inverse side by use of the inversedBy attribute of the + OneToOne, ManyToOne, or ManyToMany mapping declaration. The + inversedBy attribute designates the field in the entity that is the + inverse side of the relationship. +- The many side of OneToMany/ManyToOne bidirectional relationships + *must* be the owning side, hence the mappedBy element can not be + specified on the ManyToOne side. +- For OneToOne bidirectional relationships, the owning side + corresponds to the side that contains the corresponding foreign key + (@JoinColumn(s)). +- For ManyToMany bidirectional relationships either side may be + the owning side (the side that defines the @JoinTable and/or does + not make use of the mappedBy attribute, thus using a default join + table). + +Especially important is the following: + +**The owning side of a relationship determines the updates to the relationship in the database**. + +To fully understand this, remember how bidirectional associations +are maintained in the object world. There are 2 references on each +side of the association and these 2 references both represent the +same association but can change independently of one another. Of +course, in a correct application the semantics of the bidirectional +association are properly maintained by the application developer +(that's his responsibility). Doctrine needs to know which of these +two in-memory references is the one that should be persisted and +which not. This is what the owning/inverse concept is mainly used +for. + +**Changes made only to the inverse side of an association are ignored. Make sure to update both sides of a bidirectional association (or at least the owning side, from Doctrine's point of view)** + +The owning side of a bidirectional association is the side Doctrine +"looks at" when determining the state of the association, and +consequently whether there is anything to do to update the +association in the database. + + **NOTE** "Owning side" and "inverse side" are technical concepts of + the ORM technology, not concepts of your domain model. What you + consider as the owning side in your domain model can be different + from what the owning side is for Doctrine. These are unrelated. + + +Collections +----------- + +In all the examples of many-valued associations in this manual we +will make use of a ``Collection`` interface and a corresponding +default implementation ``ArrayCollection`` that are defined in the +``Doctrine\Common\Collections`` namespace. Why do we need that? +Doesn't that couple my domain model to Doctrine? Unfortunately, PHP +arrays, while being great for many things, do not make up for good +collections of business objects, especially not in the context of +an ORM. The reason is that plain PHP arrays can not be +transparently extended / instrumented in PHP code, which is +necessary for a lot of advanced ORM features. The classes / +interfaces that come closest to an OO collection are ArrayAccess +and ArrayObject but until instances of these types can be used in +all places where a plain array can be used (something that may +happen in PHP6) their usability is fairly limited. You "can" +type-hint on ``ArrayAccess`` instead of ``Collection``, since the +Collection interface extends ``ArrayAccess``, but this will +severely limit you in the way you can work with the collection, +because the ``ArrayAccess`` API is (intentionally) very primitive +and more importantly because you can not pass this collection to +all the useful PHP array functions, which makes it very hard to +work with. + + **CAUTION** The Collection interface and ArrayCollection class, + like everything else in the Doctrine namespace, are neither part of + the ORM, nor the DBAL, it is a plain PHP class that has no outside + dependencies apart from dependencies on PHP itself (and the SPL). + Therefore using this class in your domain classes and elsewhere + does not introduce a coupling to the persistence layer. The + Collection class, like everything else in the Common namespace, is + not part of the persistence layer. You could even copy that class + over to your project if you want to remove Doctrine from your + project and all your domain classes will work the same as before. + + +Mapping Defaults +---------------- + +Before we introduce all the association mappings in detail, you +should note that the @JoinColumn and @JoinTable definitions are +usually optional and have sensible default values. The defaults for +a join column in a one-to-one/many-to-one association is as +follows: + +:: + + name: "_id" + referencedColumnName: "id" + +As an example, consider this mapping: + +:: + + groups; + } + } + +With this code alone the ``$groups`` field only contains an +instance of ``Doctrine\Common\Collections\Collection`` if the user +is retrieved from Doctrine, however not after you instantiated a +fresh instance of the User. When your user entity is still new +``$groups`` will obviously be null. + +This is why we recommend to initialize all collection fields to an +empty ``ArrayCollection`` in your entities constructor: + +:: + + groups = new ArrayCollection(); + } + + public function getGroups() + { + return $this->groups; + } + } + +Now the following code will be working even if the Entity hasn't +been associated with an EntityManager yet: + +:: + + find('Group', $groupId); + $user = new User(); + $user->getGroups()->add($group); + +Runtime vs Development Mapping Validation +----------------------------------------- + +For performance reasons Doctrine 2 has to skip some of the +necessary validation of association mappings. You have to execute +this validation in your development workflow to verify the +associations are correctly defined. + +You can either use the Doctrine Command Line Tool: + +:: + + doctrine orm:validate-schema + +Or you can trigger the validation manually: + +:: + + use Doctrine\ORM\Tools\SchemaValidator; + + $validator = new SchemaValidator($entityManager); + $errors = $validator->validateMapping(); + + if (count($errors) > 0) { + // Lots of errors! + echo implode("\n\n", $errors); + } + +If the mapping is invalid the errors array contains a positive +number of elements with error messages. + + **NOTE** + + One common error is to use a backlash in front of the + fully-qualified class-name. Whenever a FQCN is represented inside a + string (such as in your mapping definitions) you have to drop the + prefix backslash. PHP does this with ``get_class()`` or Reflection + methods for backwards compatibility reasons. + + +One-To-One, Unidirectional +-------------------------- + +A unidirectional one-to-one association is very common. Here is an +example of a ``Product`` that has one ``Shipping`` object +associated to it. The ``Shipping`` side does not reference back to +the ``Product`` so it is unidirectional. + +:: + + phonenumbers = new \Doctrine\Common\Collections\ArrayCollection(); + } + + // ... + } + + /** @Entity */ + class Phonenumber + { + // ... + } + + **NOTE** One-To-Many uni-directional relations with join-table only + work using the @ManyToMany annotation and a unique-constraint. + + +Generates the following MySQL Schema: + +:: + + [sql] + CREATE TABLE User ( + id INT AUTO_INCREMENT NOT NULL, + PRIMARY KEY(id) + ) ENGINE = InnoDB; + + CREATE TABLE users_phonenumbers ( + user_id INT NOT NULL, + phonenumber_id INT NOT NULL, + UNIQUE INDEX users_phonenumbers_phonenumber_id_uniq (phonenumber_id), + PRIMARY KEY(user_id, phonenumber_id) + ) ENGINE = InnoDB; + + CREATE TABLE Phonenumber ( + id INT AUTO_INCREMENT NOT NULL, + PRIMARY KEY(id) + ) ENGINE = InnoDB; + + ALTER TABLE users_phonenumbers ADD FOREIGN KEY (user_id) REFERENCES User(id); + ALTER TABLE users_phonenumbers ADD FOREIGN KEY (phonenumber_id) REFERENCES Phonenumber(id); + +Many-To-One, Unidirectional +--------------------------- + +You can easily implement a many-to-one unidirectional association +with the following: + +:: + + features = new \Doctrine\Common\Collections\ArrayCollection(); + } + } + + /** @Entity */ + class Feature + { + // ... + /** + * @ManyToOne(targetEntity="Product", inversedBy="features") + * @JoinColumn(name="product_id", referencedColumnName="id") + */ + private $product; + // ... + } + +Note that the @JoinColumn is not really necessary in this example, +as the defaults would be the same. + +Generated MySQL Schema: + +:: + + [sql] + CREATE TABLE Product ( + id INT AUTO_INCREMENT NOT NULL, + PRIMARY KEY(id) + ) ENGINE = InnoDB; + CREATE TABLE Feature ( + id INT AUTO_INCREMENT NOT NULL, + product_id INT DEFAULT NULL, + PRIMARY KEY(id) + ) ENGINE = InnoDB; + ALTER TABLE Feature ADD FOREIGN KEY (product_id) REFERENCES Product(id); + +One-To-Many, Self-referencing +----------------------------- + +You can also setup a one-to-many association that is +self-referencing. In this example we setup a hierarchy of +``Category`` objects by creating a self referencing relationship. +This effectively models a hierarchy of categories and from the +database perspective is known as an adjacency list approach. + +:: + + children = new \Doctrine\Common\Collections\ArrayCollection(); + } + } + +Note that the @JoinColumn is not really necessary in this example, +as the defaults would be the same. + +Generated MySQL Schema: + +:: + + [sql] + CREATE TABLE Category ( + id INT AUTO_INCREMENT NOT NULL, + parent_id INT DEFAULT NULL, + PRIMARY KEY(id) + ) ENGINE = InnoDB; + ALTER TABLE Category ADD FOREIGN KEY (parent_id) REFERENCES Category(id); + +Many-To-Many, Unidirectional +---------------------------- + +Real many-to-many associations are less common. The following +example shows a unidirectional association between User and Group +entities: + +:: + + groups = new \Doctrine\Common\Collections\ArrayCollection(); + } + } + + /** @Entity */ + class Group + { + // ... + } + + **NOTE** Why are many-to-many associations less common? Because + frequently you want to associate additional attributes with an + association, in which case you introduce an association class. + Consequently, the direct many-to-many association disappears and is + replaced by one-to-many/many-to-one associations between the 3 + participating classes. + + +Generated MySQL Schema: + +:: + + [sql] + CREATE TABLE User ( + id INT AUTO_INCREMENT NOT NULL, + PRIMARY KEY(id) + ) ENGINE = InnoDB; + CREATE TABLE users_groups ( + user_id INT NOT NULL, + group_id INT NOT NULL, + PRIMARY KEY(user_id, group_id) + ) ENGINE = InnoDB; + CREATE TABLE Group ( + id INT AUTO_INCREMENT NOT NULL, + PRIMARY KEY(id) + ) ENGINE = InnoDB; + ALTER TABLE users_groups ADD FOREIGN KEY (user_id) REFERENCES User(id); + ALTER TABLE users_groups ADD FOREIGN KEY (group_id) REFERENCES Group(id); + +Many-To-Many, Bidirectional +--------------------------- + +Here is a similar many-to-many relationship as above except this +one is bidirectional. + +:: + + groups = new \Doctrine\Common\Collections\ArrayCollection(); + } + + // ... + } + + /** @Entity */ + class Group + { + // ... + /** + * @ManyToMany(targetEntity="User", mappedBy="groups") + */ + private $users; + + public function __construct() { + $this->users = new \Doctrine\Common\Collections\ArrayCollection(); + } + + // ... + } + +The MySQL schema is exactly the same as for the Many-To-Many +uni-directional case above. + +Picking Owning and Inverse Side +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +For Many-To-Many associations you can chose which entity is the +owning and which the inverse side. There is a very simple semantic +rule to decide which side is more suitable to be the owning side +from a developers perspective. You only have to ask yourself, which +entity is responsible for the connection management and pick that +as the owning side. + +Take an example of two entities ``Article`` and ``Tag``. Whenever +you want to connect an Article to a Tag and vice-versa, it is +mostly the Article that is responsible for this relation. Whenever +you add a new article, you want to connect it with existing or new +tags. Your create Article form will probably support this notion +and allow to specify the tags directly. This is why you should pick +the Article as owning side, as it makes the code more +understandable: + +:: + + addArticle($this); // synchronously updating inverse side + $this->tags[] = $tag; + } + } + + class Tag + { + private $articles; + + public function addArticle(Article $article) + { + $this->articles[] = $article; + } + } + +This allows to group the tag adding on the ``Article`` side of the +association: + +:: + + addTag($tagA); + $article->addTag($tagB); + +Many-To-Many, Self-referencing +------------------------------ + +You can even have a self-referencing many-to-many association. A +common scenario is where a ``User`` has friends and the target +entity of that relationship is a ``User`` so it is self +referencing. In this example it is bidirectional so ``User`` has a +field named ``$friendsWithMe`` and ``$myFriends``. + +:: + + friendsWithMe = new \Doctrine\Common\Collections\ArrayCollection(); + $this->myFriends = new \Doctrine\Common\Collections\ArrayCollection(); + } + + // ... + } + +Generated MySQL Schema: + +:: + + [sql] + CREATE TABLE User ( + id INT AUTO_INCREMENT NOT NULL, + PRIMARY KEY(id) + ) ENGINE = InnoDB; + CREATE TABLE friends ( + user_id INT NOT NULL, + friend_user_id INT NOT NULL, + PRIMARY KEY(user_id, friend_user_id) + ) ENGINE = InnoDB; + ALTER TABLE friends ADD FOREIGN KEY (user_id) REFERENCES User(id); + ALTER TABLE friends ADD FOREIGN KEY (friend_user_id) REFERENCES User(id); + +Ordering To-Many Collections +---------------------------- + +In many use-cases you will want to sort collections when they are +retrieved from the database. In userland you do this as long as you +haven't initially saved an entity with its associations into the +database. To retrieve a sorted collection from the database you can +use the ``@OrderBy`` annotation with an collection that specifies +an DQL snippet that is appended to all queries with this +collection. + +Additional to any ``@OneToMany`` or ``@ManyToMany`` annotation you +can specify the ``@OrderBy`` in the following way: + +:: + + 10 + +However the following: + +:: + + [sql] + SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 + +...would internally be rewritten to: + +:: + + [sql] + SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ORDER BY g.name ASC + +You can't reverse the order with an explicit DQL ORDER BY: + +:: + + [sql] + SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ORDER BY g.name DESC + +...is internally rewritten to: + +:: + + [sql] + SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ORDER BY g.name DESC, g.name ASC + + diff --git a/manual/en/association-mapping.txt b/manual/en/association-mapping.txt index 7e35e4566..fb22869f2 100644 --- a/manual/en/association-mapping.txt +++ b/manual/en/association-mapping.txt @@ -1,6 +1,6 @@ This chapter explains how associations between entities are mapped with Doctrine. We start out with an explanation of the concept of owning and inverse sides which is important to understand when working with bidirectional associations. Please read these explanations carefully. -++ Owning Side and Inverse Side +## Owning Side and Inverse Side When mapping bidirectional associations it is important to understand the concept of the owning and inverse sides. The following general rules apply: @@ -41,7 +41,7 @@ in the database. > of your domain model. What you consider as the owning side in your domain model can be different > from what the owning side is for Doctrine. These are unrelated. -++ Collections +## Collections In all the examples of many-valued associations in this manual we will make use of a `Collection` interface and a corresponding default implementation `ArrayCollection` that are defined in the `Doctrine\Common\Collections` namespace. Why do we need that? Doesn't that couple my domain model to Doctrine? Unfortunately, PHP arrays, while being great for many things, do not make up for good collections of business objects, especially not in the context of an ORM. The reason is that plain PHP arrays can not be transparently extended / instrumented in PHP code, which is necessary for a lot of advanced ORM features. The classes / interfaces that come closest to an OO collection are ArrayAccess and ArrayObject but until instances of these types can be used in all places where a plain array can be used (something that may happen in PHP6) their usability is fairly limited. You "can" type-hint on `ArrayAccess` instead of `Collection`, since the Collection interface extends `ArrayAccess`, but this will severely limit you in the way you can work with the collection, because the `ArrayAccess` API is (intentionally) very primitive and more importantly because you can not pass this collection to all the useful PHP array functions, which makes it very hard to work with. @@ -55,7 +55,7 @@ In all the examples of many-valued associations in this manual we will make use > over to your project if you want to remove Doctrine from your project and all your > domain classes will work the same as before. -++ Mapping Defaults +## Mapping Defaults Before we introduce all the association mappings in detail, you should note that the @JoinColumn and @JoinTable definitions are usually optional and have sensible default values. @@ -66,13 +66,13 @@ The defaults for a join column in a one-to-one/many-to-one association is as fol As an example, consider this mapping: - [php] + find('Group', $groupId); $user = new User(); $user->getGroups()->add($group); -++ Runtime vs Development Mapping Validation +## Runtime vs Development Mapping Validation For performance reasons Doctrine 2 has to skip some of the necessary validation of association mappings. You have to execute this validation in your development workflow to verify the associations are correctly @@ -191,11 +191,11 @@ If the mapping is invalid the errors array contains a positive number of element > inside a string (such as in your mapping definitions) you have to drop the prefix backslash. PHP does this with > `get_class()` or Reflection methods for backwards compatibility reasons. -++ One-To-One, Unidirectional +## One-To-One, Unidirectional A unidirectional one-to-one association is very common. Here is an example of a `Product` that has one `Shipping` object associated to it. The `Shipping` side does not reference back to the `Product` so it is unidirectional. - [php] + addTag($tagA); $article->addTag($tagB); -++ Many-To-Many, Self-referencing +## Many-To-Many, Self-referencing You can even have a self-referencing many-to-many association. A common scenario is where a `User` has friends and the target entity of that relationship is a `User` so it is self referencing. In this example it is bidirectional so `User` has a field named `$friendsWithMe` and `$myFriends`. - [php] + getConnection(); + $conn->getDatabasePlatform()->registerDoctrineTypeMapping('db_mytype', 'mytype'); + +Now using Schema-Tool, whenever it detects a column having the +``db_mytype`` it will convert it into a ``mytype`` Doctrine Type +instance for Schema representation. Keep in mind that you can +easily produce clashes this way, each database type can only map to +exactly one Doctrine mapping type. + +Identifiers / Primary Keys +-------------------------- + +Every entity class needs an identifier/primary key. You designate +the field that serves as the identifier with the ``@Id`` marker +annotation. Here is an example: + +:: + + recommended!) then the XML driver might have a slight edge in performance due to the > powerful native XML support in PHP. -++ Introduction to Docblock Annotations +## Introduction to Docblock Annotations You've probably used docblock annotations in some form already, most likely to provide documentation metadata for a tool like `PHPDocumentor` (@author, @link, ...). Docblock annotations are a tool to embed metadata inside the documentation section which can then be processed by some tool. Doctrine 2 generalizes the concept of docblock annotations so that they can be used for any kind of metadata and so that it is easy to define new docblock annotations. In order to allow more involved annotation values and to reduce the chances of clashes with other docblock annotations, the Doctrine 2 docblock annotations feature an alternative syntax that is heavily inspired by the Annotation syntax introduced in Java 5. @@ -30,11 +30,11 @@ The implementation of these enhanced docblock annotations is located in the `Doc > mentioned earlier Doctrine 2 provides XML and YAML alternatives and you could easily > implement your own favourite mechanism for defining ORM metadata. -++ Persistent classes +## Persistent classes In order to mark a class for object-relational persistence it needs to be designated as an entity. This can be done through the `@Entity` marker annotation. - [php] + Mapping types are *case-sensitive*. For example, using a DateTime column will NOT match the datetime type > that ships with Doctrine 2! -++ Property Mapping +## Property Mapping After a class has been marked as an entity it can specify mappings for its instance fields. Here we will only look at simple fields that hold scalar values like strings, numbers, etc. Associations to other objects are covered in the chapter "Association Mapping". @@ -91,7 +91,7 @@ To mark a property for relational persistence the `@Column` docblock annotation Example: - [php] + getConnection(); $conn->getDatabasePlatform()->registerDoctrineTypeMapping('db_mytype', 'mytype'); @@ -207,11 +207,11 @@ Now using Schema-Tool, whenever it detects a column having the `db_mytype` it wi Doctrine Type instance for Schema representation. Keep in mind that you can easily produce clashes this way, each database type can only map to exactly one Doctrine mapping type. -++ Identifiers / Primary Keys +## Identifiers / Primary Keys Every entity class needs an identifier/primary key. You designate the field that serves as the identifier with the `@Id` marker annotation. Here is an example: - [php] + strategy of the underlying platform is SEQUENCE, such as for Oracle and PostgreSQL. -+++ Composite Keys +### Composite Keys Doctrine 2 allows to use composite primary keys. There are however some restrictions opposed to using a single identifier. The use of the `@GeneratedValue` annotation is only supported for simple (not composite) primary keys, which means @@ -300,11 +300,11 @@ on the entity. To designate a composite primary key / identifier, simply put the @Id marker annotation on all fields that make up the primary key. -++ Quoting Reserved Words +## Quoting Reserved Words It may sometimes be necessary to quote a column or table name because it conflicts with a reserved word of the particular RDBMS in use. This is often referred to as "Identifier Quoting". To let Doctrine know that you would like a table or column name to be quoted in all SQL statements, enclose the table or column name in backticks. Here is an example: - [php] + setStatus('user'); + $user->setUsername('user' . $i); + $user->setName('Mr.Smith-' . $i); + $em->persist($user); + if (($i % $batchSize) == 0) { + $em->flush(); + $em->clear(); // Detaches all objects from Doctrine! + } + } + +Bulk Updates +------------ + +There are 2 possibilities for bulk updates with Doctrine. + +DQL UPDATE +~~~~~~~~~~ + +The by far most efficient way for bulk updates is to use a DQL +UPDATE query. Example: + +:: + + createQuery('update MyProject\Model\Manager m set m.salary = m.salary * 0.9'); + $numUpdated = $q->execute(); + +Iterating results +~~~~~~~~~~~~~~~~~ + +An alternative solution for bulk updates is to use the +``Query#iterate()`` facility to iterate over the query results step +by step instead of loading the whole result into memory at once. +The following example shows how to do this, combining the iteration +with the batching strategy that was already used for bulk inserts: + +:: + + createQuery('select u from MyProject\Model\User u'); + $iterableResult = $q->iterate(); + foreach($iterableResult AS $row) { + $user = $row[0]; + $user->increaseCredit(); + $user->calculateNewBonuses(); + if (($i % $batchSize) == 0) { + $em->flush(); // Executes all updates. + $em->clear(); // Detaches all objects from Doctrine! + } + ++$i; + } + + **NOTE** Iterating results is not possible with queries that + fetch-join a collection-valued association. The nature of such SQL + result sets is not suitable for incremental hydration. + + +Bulk Deletes +------------ + +There are two possibilities for bulk deletes with Doctrine. You can +either issue a single DQL DELETE query or you can iterate over +results removing them one at a time. + +DQL DELETE +~~~~~~~~~~ + +The by far most efficient way for bulk deletes is to use a DQL +DELETE query. + +Example: + +:: + + createQuery('delete from MyProject\Model\Manager m where m.salary > 100000'); + $numDeleted = $q->execute(); + +Iterating results +~~~~~~~~~~~~~~~~~ + +An alternative solution for bulk deletes is to use the +``Query#iterate()`` facility to iterate over the query results step +by step instead of loading the whole result into memory at once. +The following example shows how to do this: + +:: + + createQuery('select u from MyProject\Model\User u'); + $iterableResult = $q->iterate(); + while (($row = $iterableResult->next()) !== false) { + $em->remove($row[0]); + if (($i % $batchSize) == 0) { + $em->flush(); // Executes all deletions. + $em->clear(); // Detaches all objects from Doctrine! + } + ++$i; + } + + **NOTE** Iterating results is not possible with queries that + fetch-join a collection-valued association. The nature of such SQL + result sets is not suitable for incremental hydration. + + +Iterating Large Results for Data-Processing +------------------------------------------- + +You can use the ``iterate()`` method just to iterate over a large +result and no UPDATE or DELETE intention. The ``IterableResult`` +instance returned from ``$query->iterate()`` implements the +Iterator interface so you can process a large result without memory +problems using the following approach: + +:: + + _em->createQuery('select u from MyProject\Model\User u'); + $iterableResult = $q->iterate(); + foreach ($iterableResult AS $row) { + // do stuff with the data in the row, $row[0] is always the object + + // detach from Doctrine, so that it can be Garbage-Collected immediately + $this->_em->detach($row[0]); + } + + **NOTE** Iterating results is not possible with queries that + fetch-join a collection-valued association. The nature of such SQL + result sets is not suitable for incremental hydration. + + + diff --git a/manual/en/batch-processing.txt b/manual/en/batch-processing.txt index b9c3619d1..fdc44bd45 100644 --- a/manual/en/batch-processing.txt +++ b/manual/en/batch-processing.txt @@ -6,11 +6,11 @@ This chapter shows you how to accomplish bulk inserts, updates and deletes with > the options outlined below are not sufficient for your purposes we recommend you > use the tools for your particular RDBMS for these bulk operations. -++ Bulk Inserts +## Bulk Inserts Bulk inserts in Doctrine are best performed in batches, taking advantage of the transactional write-behind behavior of an `EntityManager`. The following code shows an example for inserting 10000 objects with a batch size of 20. You may need to experiment with the batch size to find the size that works best for you. Larger batch sizes mean more prepared statement reuse internally but also mean more work during `flush`. - [php] + createQuery('update MyProject\Model\Manager m set m.salary = m.salary * 0.9'); $numUpdated = $q->execute(); -+++ Iterating results +### Iterating results An alternative solution for bulk updates is to use the `Query#iterate()` facility to iterate over the query results step by step instead of loading the whole result into memory at once. The following example shows how to do this, combining the iteration with the batching strategy that was already used for bulk inserts: - [php] + createQuery('select u from MyProject\Model\User u'); @@ -61,26 +61,26 @@ An alternative solution for bulk updates is to use the `Query#iterate()` facilit > association. The nature of such SQL result sets is not suitable for incremental > hydration. -++ Bulk Deletes +## Bulk Deletes There are two possibilities for bulk deletes with Doctrine. You can either issue a single DQL DELETE query or you can iterate over results removing them one at a time. -+++ DQL DELETE +### DQL DELETE The by far most efficient way for bulk deletes is to use a DQL DELETE query. Example: - [php] + createQuery('delete from MyProject\Model\Manager m where m.salary > 100000'); $numDeleted = $q->execute(); -+++ Iterating results +### Iterating results An alternative solution for bulk deletes is to use the `Query#iterate()` facility to iterate over the query results step by step instead of loading the whole result into memory at once. The following example shows how to do this: - [php] + createQuery('select u from MyProject\Model\User u'); @@ -99,14 +99,14 @@ An alternative solution for bulk deletes is to use the `Query#iterate()` facilit > association. The nature of such SQL result sets is not suitable for incremental > hydration. -++ Iterating Large Results for Data-Processing +## Iterating Large Results for Data-Processing You can use the `iterate()` method just to iterate over a large result and no UPDATE or DELETE intention. The `IterableResult` instance returned from `$query->iterate()` implements the Iterator interface so you can process a large result without memory problems using the following approach: - [php] + _em->createQuery('select u from MyProject\Model\User u'); $iterableResult = $q->iterate(); foreach ($iterableResult AS $row) { diff --git a/manual/en/best-practices.rst b/manual/en/best-practices.rst new file mode 100644 index 000000000..48a8771c7 --- /dev/null +++ b/manual/en/best-practices.rst @@ -0,0 +1,124 @@ + **NOTE** The best practices mentioned here that affect database + design generally refer to best practices when working with Doctrine + and do not necessarily reflect best practices for database design + in general. + + +Don't use public properties on entities +--------------------------------------- + +It is very important that you don't map public properties on +entities, but only protected or private ones. The reason for this +is simple, whenever you access a public property of a proxy object +that hasn't been initialized yet the return value will be null. +Doctrine cannot hook into this process and magically make the +entity lazy load. + +This can create situations where it is very hard to debug the +current failure. We therefore urge you to map only private and +protected properties on entities and use getter methods or magic +\_\_get() to access them. + +Constrain relationships as much as possible +------------------------------------------- + +It is important to constrain relationships as much as possible. +This means: + + +- Impose a traversal direction (avoid bidirectional associations + if possible) +- Eliminate nonessential associations + +This has several benefits: + + +- Reduced coupling in your domain model +- Simpler code in your domain model (no need to maintain + bidirectionality properly) +- Less work for Doctrine + +Avoid composite keys +-------------------- + +Even though Doctrine fully supports composite keys it is best not +to use them if possible. Composite keys require additional work by +Doctrine and thus have a higher probability of errors. + +Use events judiciously +---------------------- + +The event system of Doctrine is great and fast. Even though making +heavy use of events, especially lifecycle events, can have a +negative impact on the performance of your application. Thus you +should use events judiciously. + +Use cascades judiciously +------------------------ + +Automatic cascades of the persist/remove/merge/etc. operations are +very handy but should be used wisely. Do NOT simply add all +cascades to all associations. Think about which cascades actually +do make sense for you for a particular association, given the +scenarios it is most likely used in. + +Don't use special characters +---------------------------- + +Avoid using any non-ASCII characters in class, field, table or +column names. Doctrine itself is not unicode-safe in many places +and will not be until PHP itself is fully unicode-aware (PHP6). + +Don't use identifier quoting +---------------------------- + +Identifier quoting is a workaround for using reserved words that +often causes problems in edge cases. Do not use identifier quoting +and avoid using reserved words as table or column names. + +Initialize collections in the constructor +----------------------------------------- + +It is recommended best practice to initialize any business +collections in entities in the constructor. Example: + +:: + + addresses = new ArrayCollection; + $this->articles = new ArrayCollection; + } + } + +Don't map foreign keys to fields in an entity +--------------------------------------------- + +Foreign keys have no meaning whatsoever in an object model. Foreign +keys are how a relational database establishes relationships. Your +object model establishes relationships through object references. +Thus mapping foreign keys to object fields heavily leaks details of +the relational model into the object model, something you really +should not do. + +Use explicit transaction demarcation +------------------------------------ + +While Doctrine will automatically wrap all DML operations in a +transaction on flush(), it is considered best practice to +explicitly set the transaction boundaries yourself. Otherwise every +single query is wrapped in a small transaction (Yes, SELECT +queries, too) since you can not talk to your database outside of a +transaction. While such short transactions for read-only (SELECT) +queries generally don't have any noticeable performance impact, it +is still preferable to use fewer, well-defined transactions that +are established through explicit transaction boundaries. + + diff --git a/manual/en/best-practices.txt b/manual/en/best-practices.txt index 116761b5f..1d4cee690 100644 --- a/manual/en/best-practices.txt +++ b/manual/en/best-practices.txt @@ -4,7 +4,7 @@ > practices when working with Doctrine and do not necessarily reflect best practices for > database design in general. -++ Don't use public properties on entities +## Don't use public properties on entities It is very important that you don't map public properties on entities, but only protected or private ones. The reason for this is simple, whenever you access a public property of a proxy object that hasn't been initialized @@ -13,7 +13,7 @@ yet the return value will be null. Doctrine cannot hook into this process and ma This can create situations where it is very hard to debug the current failure. We therefore urge you to map only private and protected properties on entities and use getter methods or magic __get() to access them. -++ Constrain relationships as much as possible +## Constrain relationships as much as possible It is important to constrain relationships as much as possible. This means: @@ -26,31 +26,31 @@ This has several benefits: * Simpler code in your domain model (no need to maintain bidirectionality properly) * Less work for Doctrine -++ Avoid composite keys +## Avoid composite keys Even though Doctrine fully supports composite keys it is best not to use them if possible. Composite keys require additional work by Doctrine and thus have a higher probability of errors. -++ Use events judiciously +## Use events judiciously The event system of Doctrine is great and fast. Even though making heavy use of events, especially lifecycle events, can have a negative impact on the performance of your application. Thus you should use events judiciously. -++ Use cascades judiciously +## Use cascades judiciously Automatic cascades of the persist/remove/merge/etc. operations are very handy but should be used wisely. Do NOT simply add all cascades to all associations. Think about which cascades actually do make sense for you for a particular association, given the scenarios it is most likely used in. -++ Don't use special characters +## Don't use special characters Avoid using any non-ASCII characters in class, field, table or column names. Doctrine itself is not unicode-safe in many places and will not be until PHP itself is fully unicode-aware (PHP6). -++ Don't use identifier quoting +## Don't use identifier quoting Identifier quoting is a workaround for using reserved words that often causes problems in edge cases. Do not use identifier quoting and avoid using reserved words as table or column names. -++ Initialize collections in the constructor +## Initialize collections in the constructor It is recommended best practice to initialize any business collections in entities in the constructor. Example: - [php] + `_ on the PHP website. It will give +you a little background information about what it is and how you +can use it as well as how to install it. + +Below is a simple example of how you could use the APC cache driver +by itself. + +:: + + save('cache_id', 'my_data'); + +Memcache +~~~~~~~~ + +In order to use the Memcache cache driver you must have it compiled +and enabled in your php.ini. You can read about Memcache +`here `_ on the PHP website. It will +give you a little background information about what it is and how +you can use it as well as how to install it. + +Below is a simple example of how you could use the Memcache cache +driver by itself. + +:: + + connect('memcache_host', 11211); + + $cacheDriver = new \Doctrine\Common\Cache\MemcacheCache(); + $cacheDriver->setMemcache() + $cacheDriver->save('cache_id', 'my_data'); + +Xcache +~~~~~~ + +In order to use the Xcache cache driver you must have it compiled +and enabled in your php.ini. You can read about Xcache +`here `_. It will give you a little +background information about what it is and how you can use it as +well as how to install it. + +Below is a simple example of how you could use the Xcache cache +driver by itself. + +:: + + save('cache_id', 'my_data'); + +Using Cache Drivers +------------------- + +In this section we'll describe how you can fully utilize the API of +the cache drivers to save cache, check if some cache exists, fetch +the cached data and delete the cached data. We'll use the +``ArrayCache`` implementation as our example here. + +:: + + save('cache_id', 'my_data'); + +The ``save()`` method accepts three arguments which are described +below. + + +- ``$id`` - The cache id +- ``$data`` - The cache entry/data. +- ``$lifeTime`` - The lifetime. If != false, sets a specific + lifetime for this cache entry (null => infinite lifeTime). + +You can save any type of data whether it be a string, array, +object, etc. + +:: + + 'value1', + 'key2' => 'value2' + ); + $cacheDriver->save('my_array', $array); + +Checking +~~~~~~~~ + +Checking whether some cache exists is very simple, just use the +``contains()`` method. It accepts a single argument which is the ID +of the cache entry. + +:: + + contains('cache_id')) { + echo 'cache exists'; + } else { + echo 'cache does not exist'; + } + +Fetching +~~~~~~~~ + +Now if you want to retrieve some cache entry you can use the +``fetch()`` method. It also accepts a single argument just like +``contains()`` which is the ID of the cache entry. + +:: + + fetch('my_array'); + +Deleting +~~~~~~~~ + +As you might guess, deleting is just as easy as saving, checking +and fetching. We have a few ways to delete cache entries. You can +delete by an individual ID, regular expression, prefix, suffix or +you can delete all entries. + +By Cache ID +^^^^^^^^^^^ + +:: + + delete('my_array'); + +You can also pass wild cards to the ``delete()`` method and it will +return an array of IDs that were matched and deleted. + +:: + + delete('users_*'); + +By Regular Expression +^^^^^^^^^^^^^^^^^^^^^ + +If you need a little more control than wild cards you can use a PHP +regular expression to delete cache entries. + +:: + + deleteByRegex('/users_.*/'); + +By Prefix +^^^^^^^^^ + +Because regular expressions are kind of slow, if simply deleting by +a prefix or suffix is sufficient, it is recommended that you do +that instead of using a regular expression because it will be much +faster if you have many cache entries. + +:: + + deleteByPrefix('users_'); + +By Suffix +^^^^^^^^^ + +Just like we did above with the prefix you can do the same with a +suffix. + +:: + + deleteBySuffix('_my_account'); + +All +^^^ + +If you simply want to delete all cache entries you can do so with +the ``deleteAll()`` method. + +:: + + deleteAll(); + +Counting +~~~~~~~~ + +If you want to count how many entries are stored in the cache +driver instance you can use the ``count()`` method. + +:: + + count(); + + **NOTE** In order to use ``deleteByRegex()``, ``deleteByPrefix()``, + ``deleteBySuffix()``, ``deleteAll()``, ``count()`` or ``getIds()`` + you must enable an option for the cache driver to manage your cache + IDs internally. This is necessary because APC, Memcache, etc. don't + have any advanced functionality for fetching and deleting. We add + some functionality on top of the cache drivers to maintain an index + of all the IDs stored in the cache driver so that we can allow more + granular deleting operations. + + :: + + setManageCacheIds(true); + + +Namespaces +~~~~~~~~~~ + +If you heavily use caching in your application and utilize it in +multiple parts of your application, or use it in different +applications on the same server you may have issues with cache +naming collisions. This can be worked around by using namespaces. +You can set the namespace a cache driver should use by using the +``setNamespace()`` method. + +:: + + setNamespace('my_namespace_'); + +Integrating with the ORM +------------------------ + +The Doctrine ORM package is tightly integrated with the cache +drivers to allow you to improve performance of various aspects of +Doctrine by just simply making some additional configurations and +method calls. + +Query Cache +~~~~~~~~~~~ + +It is highly recommended that in a production environment you cache +the transformation of a DQL query to its SQL counterpart. It +doesn't make sense to do this parsing multiple times as it doesn't +change unless you alter the DQL query. + +This can be done by configuring the query cache implementation to +use on your ORM configuration. + +:: + + setQueryCacheImpl(new \Doctrine\Common\Cache\ApcCache()); + +Result Cache +~~~~~~~~~~~~ + +The result cache can be used to cache the results of your queries +so that we don't have to query the database or hydrate the data +again after the first time. You just need to configure the result +cache implementation. + +:: + + setResultCacheImpl(new \Doctrine\Common\Cache\ApcCache()); + +Now when you're executing DQL queries you can configure them to use +the result cache. + +:: + + createQuery('select u from \Entities\User u'); + $query->useResultCache(true); + +You can also configure an individual query to use a different +result cache driver. + +:: + + setResultCacheDriver(new \Doctrine\Common\Cache\ApcCache()); + + **NOTE** Setting the result cache driver on the query will + automatically enable the result cache for the query. If you want to + disable it pass false to ``useResultCache()``. + + :: + + useResultCache(false); + + +If you want to set the time the cache has to live you can use the +``setResultCacheLifetime()`` method. + +:: + + setResultCacheLifetime(3600); + +The ID used to store the result set cache is a hash which is +automatically generated for you if you don't set a custom ID +yourself with the ``setResultCacheId()`` method. + +:: + + setResultCacheId('my_custom_id'); + +You can also set the lifetime and cache ID by passing the values as +the second and third argument to ``useResultCache()``. + +:: + + useResultCache(true, 3600, 'my_custom_id'); + +Metadata Cache +~~~~~~~~~~~~~~ + +Your class metadata can be parsed from a few different sources like +YAML, XML, Annotations, etc. Instead of parsing this information on +each request we should cache it using one of the cache drivers. + +Just like the query and result cache we need to configure it +first. + +:: + + setMetadataCacheImpl(new \Doctrine\Common\Cache\ApcCache()); + +Now the metadata information will only be parsed once and stored in +the cache driver. + +Clearing the Cache +------------------ + +We've already shown you previously how you can use the API of the +cache drivers to manually delete cache entries. For your +convenience we offer a command line task for you to help you with +clearing the query, result and metadata cache. + +From the Doctrine command line you can run the following command. + +:: + + $ ./doctrine clear-cache + +Running this task with no arguments will clear all the cache for +all the configured drivers. If you want to be more specific about +what you clear you can use the following options. + +To clear the query cache use the ``--query`` option. + +:: + + $ ./doctrine clear-cache --query + +To clear the metadata cache use the ``--metadata`` option. + +:: + + $ ./doctrine clear-cache --metadata + +To clear the result cache use the ``--result`` option. + +:: + + $ ./doctrine clear-cache --result + +When you use the ``--result`` option you can use some other options +to be more specific about what queries result sets you want to +clear. + +Just like the API of the cache drivers you can clear based on an +ID, regular expression, prefix or suffix. + +:: + + $ ./doctrine clear-cache --result --id=cache_id + +Or if you want to clear based on a regular expressions. + +:: + + $ ./doctrine clear-cache --result --regex=users_.* + +Or with a prefix. + +:: + + $ ./doctrine clear-cache --result --prefix=users_ + +And finally with a suffix. + +:: + + $ ./doctrine clear-cache --result --suffix=_my_account + + **NOTE** Using the ``--id``, ``--regex``, etc. options with the + ``--query`` and ``--metadata`` are not allowed as it is not + necessary to be specific about what you clear. You only ever need + to completely clear the cache to remove stale entries. + + +Cache Slams +----------- + +Something to be careful of when utilizing the cache drivers is +cache slams. If you have a heavily trafficked website with some +code that checks for the existence of a cache record and if it does +not exist it generates the information and saves it to the cache. +Now if 100 requests were issued all at the same time and each one +sees the cache does not exist and they all try and insert the same +cache entry it could lock up APC, Xcache, etc. and cause problems. +Ways exist to work around this, like pre-populating your cache and +not letting your users requests populate the cache. + +You can read more about cache slams +`here `_. + + diff --git a/manual/en/caching.txt b/manual/en/caching.txt index f3e5d202f..7a2909ac1 100644 --- a/manual/en/caching.txt +++ b/manual/en/caching.txt @@ -4,7 +4,7 @@ an `ArrayCache` driver which stores the data in a PHP array. Obviously, the cach does not live between requests but this is useful for testing in a development environment. -++ Cache Drivers +## Cache Drivers The cache drivers follow a simple interface that is defined in `Doctrine\Common\Cache\Cache`. All the cache drivers extend a base class `Doctrine\Common\Cache\AbstractCache` @@ -30,7 +30,7 @@ that are implemented by the drivers. The code is organized this way so that the protected methods in the drivers do the raw interaction with the cache implementation and the `AbstractCache` can build custom functionality on top of these methods. -+++ APC +### APC In order to use the APC cache driver you must have it compiled and enabled in your php.ini. You can read about APC [here](http://us2.php.net/apc) on the PHP @@ -39,11 +39,11 @@ how you can use it as well as how to install it. Below is a simple example of how you could use the APC cache driver by itself. - [php] + save('cache_id', 'my_data'); -+++ Memcache +### Memcache In order to use the Memcache cache driver you must have it compiled and enabled in your php.ini. You can read about Memcache [here](http://us2.php.net/memcache) on @@ -52,7 +52,7 @@ and how you can use it as well as how to install it. Below is a simple example of how you could use the Memcache cache driver by itself. - [php] + connect('memcache_host', 11211); @@ -60,7 +60,7 @@ Below is a simple example of how you could use the Memcache cache driver by itse $cacheDriver->setMemcache() $cacheDriver->save('cache_id', 'my_data'); -+++ Xcache +### Xcache In order to use the Xcache cache driver you must have it compiled and enabled in your php.ini. You can read about Xcache [here](http://xcache.lighttpd.net/). It @@ -69,25 +69,25 @@ use it as well as how to install it. Below is a simple example of how you could use the Xcache cache driver by itself. - [php] + save('cache_id', 'my_data'); -++ Using Cache Drivers +## Using Cache Drivers In this section we'll describe how you can fully utilize the API of the cache drivers to save cache, check if some cache exists, fetch the cached data and delete the cached data. We'll use the `ArrayCache` implementation as our example here. - [php] + save('cache_id', 'my_data'); The `save()` method accepts three arguments which are described below. @@ -98,88 +98,88 @@ The `save()` method accepts three arguments which are described below. You can save any type of data whether it be a string, array, object, etc. - [php] + 'value1', 'key2' => 'value2' ); $cacheDriver->save('my_array', $array); -+++ Checking +### Checking Checking whether some cache exists is very simple, just use the `contains()` method. It accepts a single argument which is the ID of the cache entry. - [php] + contains('cache_id')) { echo 'cache exists'; } else { echo 'cache does not exist'; } -+++ Fetching +### Fetching Now if you want to retrieve some cache entry you can use the `fetch()` method. It also accepts a single argument just like `contains()` which is the ID of the cache entry. - [php] + fetch('my_array'); -+++ Deleting +### Deleting As you might guess, deleting is just as easy as saving, checking and fetching. We have a few ways to delete cache entries. You can delete by an individual ID, regular expression, prefix, suffix or you can delete all entries. -++++ By Cache ID +#### By Cache ID - [php] + delete('my_array'); You can also pass wild cards to the `delete()` method and it will return an array of IDs that were matched and deleted. - [php] + delete('users_*'); -++++ By Regular Expression +#### By Regular Expression If you need a little more control than wild cards you can use a PHP regular expression to delete cache entries. - [php] + deleteByRegex('/users_.*/'); -++++ By Prefix +#### By Prefix Because regular expressions are kind of slow, if simply deleting by a prefix or suffix is sufficient, it is recommended that you do that instead of using a regular expression because it will be much faster if you have many cache entries. - [php] + deleteByPrefix('users_'); -++++ By Suffix +#### By Suffix Just like we did above with the prefix you can do the same with a suffix. - [php] + deleteBySuffix('_my_account'); -++++ All +#### All If you simply want to delete all cache entries you can do so with the `deleteAll()` method. - [php] + deleteAll(); -+++ Counting +### Counting If you want to count how many entries are stored in the cache driver instance you can use the `count()` method. - [php] + count(); > **NOTE** @@ -191,10 +191,10 @@ you can use the `count()` method. > all the IDs stored in the cache driver so that we can allow more granular deleting > operations. > -> [php] +> $cacheDriver->setManageCacheIds(true); -+++ Namespaces +### Namespaces If you heavily use caching in your application and utilize it in multiple parts of your application, or use it in different applications on the same server you @@ -202,16 +202,16 @@ may have issues with cache naming collisions. This can be worked around by using namespaces. You can set the namespace a cache driver should use by using the `setNamespace()` method. - [php] + setNamespace('my_namespace_'); -++ Integrating with the ORM +## Integrating with the ORM The Doctrine ORM package is tightly integrated with the cache drivers to allow you to improve performance of various aspects of Doctrine by just simply making some additional configurations and method calls. -+++ Query Cache +### Query Cache It is highly recommended that in a production environment you cache the transformation of a DQL query to its SQL counterpart. It doesn't make sense to @@ -221,28 +221,28 @@ query. This can be done by configuring the query cache implementation to use on your ORM configuration. - [php] + setQueryCacheImpl(new \Doctrine\Common\Cache\ApcCache()); -+++ Result Cache +### Result Cache The result cache can be used to cache the results of your queries so that we don't have to query the database or hydrate the data again after the first time. You just need to configure the result cache implementation. - [php] + setResultCacheImpl(new \Doctrine\Common\Cache\ApcCache()); Now when you're executing DQL queries you can configure them to use the result cache. - [php] + createQuery('select u from \Entities\User u'); $query->useResultCache(true); You can also configure an individual query to use a different result cache driver. - [php] + setResultCacheDriver(new \Doctrine\Common\Cache\ApcCache()); > **NOTE** @@ -250,28 +250,28 @@ You can also configure an individual query to use a different result cache drive > result cache for the query. If you want to disable it pass false to > `useResultCache()`. > -> [php] +> $query->useResultCache(false); If you want to set the time the cache has to live you can use the `setResultCacheLifetime()` method. - [php] + setResultCacheLifetime(3600); The ID used to store the result set cache is a hash which is automatically generated for you if you don't set a custom ID yourself with the `setResultCacheId()` method. - [php] + setResultCacheId('my_custom_id'); You can also set the lifetime and cache ID by passing the values as the second and third argument to `useResultCache()`. - [php] + useResultCache(true, 3600, 'my_custom_id'); -+++ Metadata Cache +### Metadata Cache Your class metadata can be parsed from a few different sources like YAML, XML, Annotations, etc. Instead of parsing this information on each request we should @@ -279,13 +279,13 @@ cache it using one of the cache drivers. Just like the query and result cache we need to configure it first. - [php] + setMetadataCacheImpl(new \Doctrine\Common\Cache\ApcCache()); Now the metadata information will only be parsed once and stored in the cache driver. -++ Clearing the Cache +## Clearing the Cache We've already shown you previously how you can use the API of the cache drivers to manually delete cache entries. For your convenience we offer a command line task @@ -336,7 +336,7 @@ And finally with a suffix. > are not allowed as it is not necessary to be specific about what you clear. > You only ever need to completely clear the cache to remove stale entries. -++ Cache Slams +## Cache Slams Something to be careful of when utilizing the cache drivers is cache slams. If you have a heavily trafficked website with some code that checks for the existence diff --git a/manual/en/change-tracking-policies.rst b/manual/en/change-tracking-policies.rst new file mode 100644 index 000000000..97b3508fb --- /dev/null +++ b/manual/en/change-tracking-policies.rst @@ -0,0 +1,151 @@ +Change Tracking Policies +------------------------ + +Change tracking is the process of determining what has changed in +managed entities since the last time they were synchronized with +the database. + +Doctrine provides 3 different change tracking policies, each having +its particular advantages and disadvantages. The change tracking +policy can be defined on a per-class basis (or more precisely, +per-hierarchy). + +Deferred Implicit +~~~~~~~~~~~~~~~~~ + +The deferred implicit policy is the default change tracking policy +and the most convenient one. With this policy, Doctrine detects the +changes by a property-by-property comparison at commit time and +also detects changes to entities or new entities that are +referenced by other managed entities ("persistence by +reachability"). Although the most convenient policy, it can have +negative effects on performance if you are dealing with large units +of work (see "Understanding the Unit of Work"). Since Doctrine +can't know what has changed, it needs to check all managed entities +for changes every time you invoke EntityManager#flush(), making +this operation rather costly. + +Deferred Explicit +~~~~~~~~~~~~~~~~~ + +The deferred explicit policy is similar to the deferred implicit +policy in that it detects changes through a property-by-property +comparison at commit time. The difference is that only entities are +considered that have been explicitly marked for change detection +through a call to EntityManager#persist(entity) or through a save +cascade. All other entities are skipped. This policy therefore +gives improved performance for larger units of work while +sacrificing the behavior of "automatic dirty checking". + +Therefore, flush() operations are potentially cheaper with this +policy. The negative aspect this has is that if you have a rather +large application and you pass your objects through several layers +for processing purposes and business tasks you may need to track +yourself which entities have changed on the way so you can pass +them to EntityManager#persist(). + +This policy can be configured as follows: + +:: + + _listeners[] = $listener; + } + } + +Then, in each property setter of this class or derived classes, you +need to notify all the ``PropertyChangedListener`` instances. As an +example we add a convenience method on ``MyEntity`` that shows this +behaviour: + +:: + + _listeners) { + foreach ($this->_listeners as $listener) { + $listener->propertyChanged($this, $propName, $oldValue, $newValue); + } + } + } + + public function setData($data) + { + if ($data != $this->data) { + $this->_onPropertyChanged('data', $this->data, $data); + $this->data = $data; + } + } + } + +You have to invoke ``_onPropertyChanged`` inside every method that +changes the persistent state of ``MyEntity``. + +The check whether the new value is different from the old one is +not mandatory but recommended. That way you also have full control +over when you consider a property changed. + +The negative point of this policy is obvious: You need implement an +interface and write some plumbing code. But also note that we tried +hard to keep this notification functionality abstract. Strictly +speaking, it has nothing to do with the persistence layer and the +Doctrine ORM or DBAL. You may find that property notification +events come in handy in many other scenarios as well. As mentioned +earlier, the ``Doctrine\Common`` namespace is not that evil and +consists solely of very small classes and interfaces that have +almost no external dependencies (none to the DBAL and none to the +ORM) and that you can easily take with you should you want to swap +out the persistence layer. This change tracking policy does not +introduce a dependency on the Doctrine DBAL/ORM or the persistence +layer. + +The positive point and main advantage of this policy is its +effectiveness. It has the best performance characteristics of the 3 +policies with larger units of work and a flush() operation is very +cheap when nothing has changed. + + diff --git a/manual/en/change-tracking-policies.txt b/manual/en/change-tracking-policies.txt index 4f3746f9a..11fec2e4d 100644 --- a/manual/en/change-tracking-policies.txt +++ b/manual/en/change-tracking-policies.txt @@ -1,4 +1,4 @@ -++ Change Tracking Policies +## Change Tracking Policies Change tracking is the process of determining what has changed in managed entities since the last time they were synchronized with the database. @@ -7,7 +7,7 @@ Doctrine provides 3 different change tracking policies, each having its particular advantages and disadvantages. The change tracking policy can be defined on a per-class basis (or more precisely, per-hierarchy). -+++ Deferred Implicit +### Deferred Implicit The deferred implicit policy is the default change tracking policy and the most convenient one. With this policy, Doctrine detects the changes by a @@ -19,7 +19,7 @@ work (see "Understanding the Unit of Work"). Since Doctrine can't know what has changed, it needs to check all managed entities for changes every time you invoke EntityManager#flush(), making this operation rather costly. -+++ Deferred Explicit +### Deferred Explicit The deferred explicit policy is similar to the deferred implicit policy in that it detects changes through a property-by-property comparison at commit time. The @@ -37,7 +37,7 @@ on the way so you can pass them to EntityManager#persist(). This policy can be configured as follows: - [php] + register(); // register on SPL autoload stack + +Git +^^^ + +The Git bootstrap assumes that you have fetched the related +packages through ``git submodule update --init`` + +:: + + register(); + + $classLoader = new \Doctrine\Common\ClassLoader('Doctrine\DBAL', $lib . 'vendor/doctrine-dbal/lib'); + $classLoader->register(); + + $classLoader = new \Doctrine\Common\ClassLoader('Doctrine\ORM', $lib); + $classLoader->register(); + +Additional Symfony Components +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you don't use Doctrine2 in combination with Symfony2 you have to +register an additional namespace to be able to use the Doctrine-CLI +Tool or the YAML Mapping driver: + +:: + + register(); + + // Git Setup + $classloader = new \Doctrine\Common\ClassLoader('Symfony', $lib . 'vendor/'); + $classloader->register(); + +For best class loading performance it is recommended that you keep +your include\_path short, ideally it should only contain the path +to the PEAR libraries, and any other class libraries should be +registered with their full base path. + +Obtaining an EntityManager +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Once you have prepared the class loading, you acquire an +*EntityManager* instance. The EntityManager class is the primary +access point to ORM functionality provided by Doctrine. + +A simple configuration of the EntityManager requires a +``Doctrine\ORM\Configuration`` instance as well as some database +connection parameters: + +:: + + setMetadataCacheImpl($cache); + $driverImpl = $config->newDefaultAnnotationDriver('/path/to/lib/MyProject/Entities'); + $config->setMetadataDriverImpl($driverImpl); + $config->setQueryCacheImpl($cache); + $config->setProxyDir('/path/to/myproject/lib/MyProject/Proxies'); + $config->setProxyNamespace('MyProject\Proxies'); + + if ($applicationMode == "development") { + $config->setAutoGenerateProxyClasses(true); + } else { + $config->setAutoGenerateProxyClasses(false); + } + + $connectionOptions = array( + 'driver' => 'pdo_sqlite', + 'path' => 'database.sqlite' + ); + + $em = EntityManager::create($connectionOptions, $config); + + **CAUTION** Do not use Doctrine without a metadata and query cache! + Doctrine is highly optimized for working with caches. The main + parts in Doctrine that are optimized for caching are the metadata + mapping information with the metadata cache and the DQL to SQL + conversions with the query cache. These 2 caches require only an + absolute minimum of memory yet they heavily improve the runtime + performance of Doctrine. The recommended cache driver to use with + Doctrine is `APC `_. APC provides you with + an opcode-cache (which is highly recommended anyway) and a very + fast in-memory cache storage that you can use for the metadata and + query caches as seen in the previous code snippet. + + +Configuration Options +--------------------- + +The following sections describe all the configuration options +available on a ``Doctrine\ORM\Configuration`` instance. + +Proxy Directory (***REQUIRED***) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + setProxyDir($dir); + $config->getProxyDir(); + +Gets or sets the directory where Doctrine generates any proxy +classes. For a detailed explanation on proxy classes and how they +are used in Doctrine, refer to the "Proxy Objects" section further +down. + +Proxy Namespace (***REQUIRED***) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + setProxyNamespace($namespace); + $config->getProxyNamespace(); + +Gets or sets the namespace to use for generated proxy classes. For +a detailed explanation on proxy classes and how they are used in +Doctrine, refer to the "Proxy Objects" section further down. + +Metadata Driver (***REQUIRED***) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + setMetadataDriverImpl($driver); + $config->getMetadataDriverImpl(); + +Gets or sets the metadata driver implementation that is used by +Doctrine to acquire the object-relational metadata for your +classes. + +There are currently 4 available implementations: + + +- ``Doctrine\ORM\Mapping\Driver\AnnotationDriver`` +- ``Doctrine\ORM\Mapping\Driver\XmlDriver`` +- ``Doctrine\ORM\Mapping\Driver\YamlDriver`` +- ``Doctrine\ORM\Mapping\Driver\DriverChain`` + +Throughout the most part of this manual the AnnotationDriver is +used in the examples. For information on the usage of the XmlDriver +or YamlDriver please refer to the dedicated chapters +``XML Mapping`` and ``YAML Mapping``. + +The annotation driver can be configured with a factory method on +the ``Doctrine\ORM\Configuration``: + +:: + + newDefaultAnnotationDriver('/path/to/lib/MyProject/Entities'); + $config->setMetadataDriverImpl($driverImpl); + +The path information to the entities is required for the annotation +driver, because otherwise mass-operations on all entities through +the console could not work correctly. All of metadata drivers +accept either a single directory as a string or an array of +directories. With this feature a single driver can support multiple +directories of Entities. + +Metadata Cache (***RECOMMENDED***) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + setMetadataCacheImpl($cache); + $config->getMetadataCacheImpl(); + +Gets or sets the cache implementation to use for caching metadata +information, that is, all the information you supply via +annotations, xml or yaml, so that they do not need to be parsed and +loaded from scratch on every single request which is a waste of +resources. The cache implementation must implement the +``Doctrine\Common\Cache\Cache`` interface. + +Usage of a metadata cache is highly recommended. + +The recommended implementations for production are: + + +- ``Doctrine\Common\Cache\ApcCache`` +- ``Doctrine\Common\Cache\MemcacheCache`` +- ``Doctrine\Common\Cache\XcacheCache`` + +For development you should use the +``Doctrine\Common\Cache\ArrayCache`` which only caches data on a +per-request basis. + +Query Cache (***RECOMMENDED***) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + setQueryCacheImpl($cache); + $config->getQueryCacheImpl(); + +Gets or sets the cache implementation to use for caching DQL +queries, that is, the result of a DQL parsing process that includes +the final SQL as well as meta information about how to process the +SQL result set of a query. Note that the query cache does not +affect query results. You do not get stale data. This is a pure +optimization cache without any negative side-effects (except some +minimal memory usage in your cache). + +Usage of a query cache is highly recommended. + +The recommended implementations for production are: + + +- ``Doctrine\Common\Cache\ApcCache`` +- ``Doctrine\Common\Cache\MemcacheCache`` +- ``Doctrine\Common\Cache\XcacheCache`` + +For development you should use the +``Doctrine\Common\Cache\ArrayCache`` which only caches data on a +per-request basis. + +SQL Logger (***Optional***) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + setSQLLogger($logger); + $config->getSQLLogger(); + +Gets or sets the logger to use for logging all SQL statements +executed by Doctrine. The logger class must implement the +``Doctrine\DBAL\Logging\SqlLogger`` interface. A simple default +implementation that logs to the standard output using ``echo`` and +``var_dump`` can be found at +``Doctrine\DBAL\Logging\EchoSqlLogger``. + +Auto-generating Proxy Classes (***OPTIONAL***) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + setAutoGenerateProxyClasses($bool); + $config->getAutoGenerateProxyClasses(); + +Gets or sets whether proxy classes should be generated +automatically at runtime by Doctrine. If set to ``FALSE``, proxy +classes must be generated manually through the doctrine command +line task ``generate-proxies``. The strongly recommended value for +a production environment is ``FALSE``. + +Development vs Production Configuration +--------------------------------------- + +You should code your Doctrine2 bootstrapping with two different +runtime models in mind. There are some serious benefits of using +APC or Memcache in production. In development however this will +frequently give you fatal errors, when you change your entities and +the cache still keeps the outdated metadata. That is why we +recommend the ``ArrayCache`` for development. + +Furthermore you should have the Auto-generating Proxy Classes +option to true in development and to false in production. If this +option is set to ``TRUE`` it can seriously hurt your script +performance if several proxy classes are re-generated during script +execution. Filesystem calls of that magnitude can even slower than +all the database queries Doctrine issues. Additionally writing a +proxy sets an exclusive file lock which can cause serious +performance bottlenecks in systems with regular concurrent +requests. + +Connection Options +------------------ + +The ``$connectionOptions`` passed as the first argument to +``EntityManager::create()`` has to be either an array or an +instance of ``Doctrine\DBAL\Connection``. If an array is passed it +is directly passed along to the DBAL Factory +``Doctrine\DBAL\DriverManager::getConnection()``. The DBAL +configuration is explained in the +`DBAL section <./../../../../../dbal/2.0/docs/reference/configuration/en>`_. + +Proxy Objects +------------- + +A proxy object is an object that is put in place or used instead of +the "real" object. A proxy object can add behavior to the object +being proxied without that object being aware of it. In Doctrine 2, +proxy objects are used to realize several features but mainly for +transparent lazy-loading. + +Proxy objects with their lazy-loading facilities help to keep the +subset of objects that are already in memory connected to the rest +of the objects. This is an essential property as without it there +would always be fragile partial objects at the outer edges of your +object graph. + +Doctrine 2 implements a variant of the proxy pattern where it +generates classes that extend your entity classes and adds +lazy-loading capabilities to them. Doctrine can then give you an +instance of such a proxy class whenever you request an object of +the class being proxied. This happens in two situations: + +**Reference Proxies** + +The method ``EntityManager#getReference($entityName, $identifier)`` +lets you obtain a reference to an entity for which the identifier +is known, without loading that entity from the database. This is +useful, for example, as a performance enhancement, when you want to +establish an association to an entity for which you have the +identifier. You could simply do this: + +:: + + getReference('MyProject\Model\Item', $itemId); + $cart->addItem($item); + +Here, we added an Item to a Cart without loading the Item from the +database. If you invoke any method on the Item instance, it would +fully initialize its state transparently from the database. Here +$item is actually an instance of the proxy class that was generated +for the Item class but your code does not need to care. In fact it +**should not care**. Proxy objects should be transparent to your +code. + +**Association proxies** + +The second most important situation where Doctrine uses proxy +objects is when querying for objects. Whenever you query for an +object that has a single-valued association to another object that +is configured LAZY, without joining that association in the same +query, Doctrine puts proxy objects in place where normally the +associated object would be. Just like other proxies it will +transparently initialize itself on first access. + + **NOTE** Joining an association in a DQL or native query + essentially means eager loading of that association in that query. + This will override the 'fetch' option specified in the mapping for + that association, but only for that query. + + +Generating Proxy classes +~~~~~~~~~~~~~~~~~~~~~~~~ + +Proxy classes can either be generated manually through the Doctrine +Console or automatically by Doctrine. The configuration option that +controls this behavior is: + +:: + + setAutoGenerateProxyClasses($bool); + $config->getAutoGenerateProxyClasses(); + +The default value is ``TRUE`` for convenient development. However, +this setting is not optimal for performance and therefore not +recommended for a production environment. To eliminate the overhead +of proxy class generation during runtime, set this configuration +option to ``FALSE``. When you do this in a development environment, +note that you may get class/file not found errors if certain proxy +classes are not available or failing lazy-loads if new methods were +added to the entity class that are not yet in the proxy class. In +such a case, simply use the Doctrine Console to (re)generate the +proxy classes like so: + +:: + + $ ./doctrine orm:generate-proxies + +Multiple Metadata Sources +------------------------- + +When using different components using Doctrine 2 you may end up +with them using two different metadata drivers, for example XML and +YAML. You can use the DriverChain Metadata implementations to +aggregate these drivers based on namespaces: + +:: + + addDriver($xmlDriver, 'Doctrine\Tests\Models\Company'); + $chain->addDriver($yamlDriver, 'Doctrine\Tests\ORM\Mapping'); + +Based on the namespace of the entity the loading of entities is +delegated to the appropriate driver. The chain semantics come from +the fact that the driver loops through all namespaces and matches +the entity class name against the namespace using a +``strpos() === 0`` call. This means you need to order the drivers +correctly if sub-namespaces use different metadata driver +implementations. + + diff --git a/manual/en/configuration.txt b/manual/en/configuration.txt index 73f9ec783..717032b0a 100644 --- a/manual/en/configuration.txt +++ b/manual/en/configuration.txt @@ -1,4 +1,4 @@ -++ Bootstrapping +## Bootstrapping Bootstrapping Doctrine is a relatively simple procedure that roughly exists of just 2 steps: @@ -6,7 +6,7 @@ just 2 steps: * Making sure Doctrine class files can be loaded on demand. * Obtaining an EntityManager instance. -+++ Class loading +### Class loading Lets start with the class loading setup. We need to set up some class loaders (often called "autoloader") so that Doctrine class files are loaded on demand. @@ -30,20 +30,20 @@ of Doctrine Installations: > This assumes you've created some kind of script to test the following code in. > Something like a `test.php` file. -++++ PEAR or Tarball Download +#### PEAR or Tarball Download - [php] + register(); // register on SPL autoload stack -++++ Git +#### Git The Git bootstrap assumes that you have fetched the related packages through `git submodule update --init` - [php] + register(); -++++ Additional Symfony Components +#### Additional Symfony Components If you don't use Doctrine2 in combination with Symfony2 you have to register an additional namespace to be able to use the Doctrine-CLI Tool or the YAML Mapping driver: - [php] + register(); @@ -74,7 +74,7 @@ the Doctrine-CLI Tool or the YAML Mapping driver: For best class loading performance it is recommended that you keep your include_path short, ideally it should only contain the path to the PEAR libraries, and any other class libraries should be registered with their full base path. -+++ Obtaining an EntityManager +### Obtaining an EntityManager Once you have prepared the class loading, you acquire an *EntityManager* instance. The EntityManager class is the primary access point to ORM functionality provided by Doctrine. @@ -82,7 +82,7 @@ The EntityManager class is the primary access point to ORM functionality provide A simple configuration of the EntityManager requires a `Doctrine\ORM\Configuration` instance as well as some database connection parameters: - [php] + a very fast in-memory cache storage that you can use for the metadata and query > caches as seen in the previous code snippet. -++ Configuration Options +## Configuration Options The following sections describe all the configuration options available on a `Doctrine\ORM\Configuration` instance. -+++ Proxy Directory (***REQUIRED***) +### Proxy Directory (***REQUIRED***) - [php] + setProxyDir($dir); $config->getProxyDir(); Gets or sets the directory where Doctrine generates any proxy classes. For a detailed explanation on proxy classes and how they are used in Doctrine, refer to the "Proxy Objects" section further down. -+++ Proxy Namespace (***REQUIRED***) +### Proxy Namespace (***REQUIRED***) - [php] + setProxyNamespace($namespace); $config->getProxyNamespace(); Gets or sets the namespace to use for generated proxy classes. For a detailed explanation on proxy classes and how they are used in Doctrine, refer to the "Proxy Objects" section further down. -+++ Metadata Driver (***REQUIRED***) +### Metadata Driver (***REQUIRED***) - [php] + setMetadataDriverImpl($driver); $config->getMetadataDriverImpl(); @@ -165,7 +165,7 @@ Throughout the most part of this manual the AnnotationDriver is used in the exam The annotation driver can be configured with a factory method on the `Doctrine\ORM\Configuration`: - [php] + newDefaultAnnotationDriver('/path/to/lib/MyProject/Entities'); $config->setMetadataDriverImpl($driverImpl); @@ -174,9 +174,9 @@ mass-operations on all entities through the console could not work correctly. Al drivers accept either a single directory as a string or an array of directories. With this feature a single driver can support multiple directories of Entities. -+++ Metadata Cache (***RECOMMENDED***) +### Metadata Cache (***RECOMMENDED***) - [php] + setMetadataCacheImpl($cache); $config->getMetadataCacheImpl(); @@ -193,9 +193,9 @@ The recommended implementations for production are: For development you should use the `Doctrine\Common\Cache\ArrayCache` which only caches data on a per-request basis. -+++ Query Cache (***RECOMMENDED***) +### Query Cache (***RECOMMENDED***) - [php] + setQueryCacheImpl($cache); $config->getQueryCacheImpl(); @@ -211,23 +211,23 @@ The recommended implementations for production are: For development you should use the `Doctrine\Common\Cache\ArrayCache` which only caches data on a per-request basis. -+++ SQL Logger (***Optional***) +### SQL Logger (***Optional***) - [php] + setSQLLogger($logger); $config->getSQLLogger(); Gets or sets the logger to use for logging all SQL statements executed by Doctrine. The logger class must implement the `Doctrine\DBAL\Logging\SqlLogger` interface. A simple default implementation that logs to the standard output using `echo` and `var_dump` can be found at `Doctrine\DBAL\Logging\EchoSqlLogger`. -+++ Auto-generating Proxy Classes (***OPTIONAL***) +### Auto-generating Proxy Classes (***OPTIONAL***) - [php] + setAutoGenerateProxyClasses($bool); $config->getAutoGenerateProxyClasses(); Gets or sets whether proxy classes should be generated automatically at runtime by Doctrine. If set to `FALSE`, proxy classes must be generated manually through the doctrine command line task `generate-proxies`. The strongly recommended value for a production environment is `FALSE`. -++ Development vs Production Configuration +## Development vs Production Configuration You should code your Doctrine2 bootstrapping with two different runtime models in mind. There are some serious benefits of using APC or Memcache in production. In development however this will frequently give you fatal @@ -240,14 +240,14 @@ classes are re-generated during script execution. Filesystem calls of that magni the database queries Doctrine issues. Additionally writing a proxy sets an exclusive file lock which can cause serious performance bottlenecks in systems with regular concurrent requests. -++ Connection Options +## Connection Options The `$connectionOptions` passed as the first argument to `EntityManager::create()` has to be either an array or an instance of `Doctrine\DBAL\Connection`. If an array is passed it is directly passed along to the DBAL Factory `Doctrine\DBAL\DriverManager::getConnection()`. The DBAL configuration is explained in the [DBAL section](./../../../../../dbal/2.0/docs/reference/configuration/en). -++ Proxy Objects +## Proxy Objects A proxy object is an object that is put in place or used instead of the "real" object. A proxy object can add behavior to the object being proxied without that object being aware of it. In Doctrine 2, proxy objects are used to realize several features but mainly for transparent lazy-loading. @@ -259,7 +259,7 @@ Doctrine 2 implements a variant of the proxy pattern where it generates classes The method `EntityManager#getReference($entityName, $identifier)` lets you obtain a reference to an entity for which the identifier is known, without loading that entity from the database. This is useful, for example, as a performance enhancement, when you want to establish an association to an entity for which you have the identifier. You could simply do this: - [php] + getReference('MyProject\Model\Item', $itemId); @@ -277,11 +277,11 @@ Just like other proxies it will transparently initialize itself on first access. > association in that query. This will override the 'fetch' option specified in > the mapping for that association, but only for that query. -+++ Generating Proxy classes +### Generating Proxy classes Proxy classes can either be generated manually through the Doctrine Console or automatically by Doctrine. The configuration option that controls this behavior is: - [php] + setAutoGenerateProxyClasses($bool); $config->getAutoGenerateProxyClasses(); @@ -290,13 +290,13 @@ To eliminate the overhead of proxy class generation during runtime, set this con $ ./doctrine orm:generate-proxies -++ Multiple Metadata Sources +## Multiple Metadata Sources When using different components using Doctrine 2 you may end up with them using two different metadata drivers, for example XML and YAML. You can use the DriverChain Metadata implementations to aggregate these drivers based on namespaces: - [php] + addDriver($xmlDriver, 'Doctrine\Tests\Models\Company'); $chain->addDriver($yamlDriver, 'Doctrine\Tests\ORM\Mapping'); diff --git a/manual/en/dql-doctrine-query-language.rst b/manual/en/dql-doctrine-query-language.rst new file mode 100644 index 000000000..2ec388c59 --- /dev/null +++ b/manual/en/dql-doctrine-query-language.rst @@ -0,0 +1,1488 @@ +DQL Explained +------------- + +DQL stands for **D**octrine **Q**uery **L**anguage and is an Object +Query Language derivate that is very similar to the **H**ibernate +**Q**uery **L**anguage (HQL) or the **J**ava **P**ersistence +**Q**uery **L**anguage (JPQL). + +In essence, DQL provides powerful querying capabilities over your +object model. Imagine all your objects lying around in some storage +(like an object database). When writing DQL queries, think about +querying that storage to pick a certain subset of your objects. + + **CAUTION** A common mistake for beginners is to mistake DQL for + being just some form of SQL and therefore trying to use table names + and column names or join arbitrary tables together in a query. You + need to think about DQL as a query language for your object model, + not for your relational schema. + + +DQL is case in-sensitive, except for namespace, class and field +names, which are case sensitive. + +Types of DQL queries +-------------------- + +DQL as a query language has SELECT, UPDATE and DELETE constructs +that map to their corresponding SQL statement types. INSERT +statements are not allowed in DQL, because entities and their +relations have to be introduced into the persistence context +through ``EntityManager#persist()`` to ensure consistency of your +object model. + +DQL SELECT statements are a very powerful way of retrieving parts +of your domain model that are not accessible via associations. +Additionally they allow to retrieve entities and their associations +in one single sql select statement which can make a huge difference +in performance in contrast to using several queries. + +DQL UPDATE and DELETE statements offer a way to execute bulk +changes on the entities of your domain model. This is often +necessary when you cannot load all the affected entities of a bulk +update into memory. + +SELECT queries +-------------- + +DQL SELECT clause +~~~~~~~~~~~~~~~~~ + +The select clause of a DQL query specifies what appears in the +query result. The composition of all the expressions in the select +clause also influences the nature of the query result. + +Here is an example that selects all users with an age > 20: + +:: + + createQuery('SELECT u FROM MyProject\Model\User u WHERE u.age > 20'); + $users = $query->getResult(); + +Lets examine the query: + + +- ``u`` is a so called identification variable or alias that + refers to the ``MyProject\Model\User`` class. By placing this alias + in the SELECT clause we specify that we want all instances of the + User class that are matched by this query appear in the query + result. +- The FROM keyword is always followed by a fully-qualified class + name which in turn is followed by an identification variable or + alias for that class name. This class designates a root of our + query from which we can navigate further via joins (explained + later) and path expressions. +- The expression ``u.age`` in the WHERE clause is a path + expression. Path expressions in DQL are easily identified by the + use of the '.' operator that is used for constructing paths. The + path expression ``u.age`` refers to the ``age`` field on the User + class. + +The result of this query would be a list of User objects where all +users are older than 20. + +The SELECT clause allows to specify both class identification +variables that signal the hydration of a complete entity class or +just fields of the entity using the syntax ``u.name``. Combinations +of both are also allowed and it is possible to wrap both fields and +identification values into aggregation and DQL functions. Numerical +fields can be part of computations using mathematical operations. +See the sub-section on +`DQL Functions, Aggregates and Operations <#dqlfn>`_ on more +information. + +Joins +~~~~~ + +A SELECT query can contain joins. There are 2 types of JOINs: +"Regular" Joins and "Fetch" Joins. + +**Regular Joins**: Used to limit the results and/or compute +aggregate values. + +**Fetch Joins**: In addition to the uses of regular joins: Used to +fetch related entities and include them in the hydrated result of a +query. + +There is no special DQL keyword that distinguishes a regular join +from a fetch join. A join (be it an inner or outer join) becomes a +"fetch join" as soon as fields of the joined entity appear in the +SELECT part of the DQL query outside of an aggregate function. +Otherwise its a "regular join". + +Example: + +Regular join of the address: + +:: + + createQuery("SELECT u FROM User u JOIN u.address a WHERE a.city = 'Berlin'"); + $users = $query->getResult(); + +Fetch join of the address: + +:: + + createQuery("SELECT u, a FROM User u JOIN u.address a WHERE a.city = 'Berlin'"); + $users = $query->getResult(); + +When Doctrine hydrates a query with fetch-join it returns the class +in the FROM clause on the root level of the result array. In the +previous example an array of User instances is returned and the +address of each user is fetched and hydrated into the +``User#address`` variable. If you access the address Doctrine does +not need to lazy load the association with another query. + + **NOTE** Doctrine allows you to walk all the associations between + all the objects in your domain model. Objects that were not already + loaded from the database are replaced with lazy load proxy + instances. Non-loaded Collections are also replaced by lazy-load + instances that fetch all the contained objects upon first access. + However relying on the lazy-load mechanism leads to many small + queries executed against the database, which can significantly + affect the performance of your application. **Fetch Joins** are the + solution to hydrate most or all of the entities that you need in a + single SELECT query. + + +Named and Positional Parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +DQL supports both named and positional parameters, however in +contrast to many SQL dialects positional parameters are specified +with numbers, for example "?1", "?2" and so on. Named parameters +are specified with ":name1", ":name2" and so on. + +DQL SELECT Examples +~~~~~~~~~~~~~~~~~~~ + +This section contains a large set of DQL queries and some +explanations of what is happening. The actual result also depends +on the hydration mode. + +Hydrate all User entities: + +:: + + createQuery('SELECT u FROM MyProject\Model\User u'); + $users = $query->getResult(); // array of User objects + +Retrieve the IDs of all CmsUsers: + +:: + + createQuery('SELECT u.id FROM CmsUser u'); + $ids = $query->getResult(); // array of CmsUser ids + +Retrieve the IDs of all users that have written an article: + +:: + + createQuery('SELECT DISTINCT u.id FROM CmsArticle a JOIN a.user u'); + $ids = $query->getResult(); // array of CmsUser ids + +Retrieve all articles and sort them by the name of the articles +users instance: + +:: + + createQuery('SELECT a FROM CmsArticle a JOIN a.user u ORDER BY u.name ASC'); + $articles = $query->getResult(); // array of CmsArticle objects + +Retrieve the Username and Name of a CmsUser: + +:: + + createQuery('SELECT u.username, u.name FROM CmsUser u'); + $users = $query->getResults(); // array of CmsUser username and id values + echo $users[0]['username']; + +Retrieve a ForumUser and his single associated entity: + +:: + + createQuery('SELECT u, a FROM ForumUser u JOIN u.avatar a'); + $users = $query->getResult(); // array of ForumUser objects with the avatar association loaded + echo get_class($users[0]->getAvatar()); + +Retrieve a CmsUser and fetch join all the phonenumbers he has: + +:: + + createQuery('SELECT u, p FROM CmsUser u JOIN u.phonenumbers p'); + $users = $query->getResult(); // array of CmsUser objects with the phonenumbers association loaded + $phonenumbers = $users[0]->getPhonenumbers(); + +Hydrate a result in Ascending: + +:: + + createQuery('SELECT u FROM ForumUser u ORDER BY u.id ASC'); + $users = $query->getResult(); // array of ForumUser objects + +Or in Descending Order: + +:: + + createQuery('SELECT u FROM ForumUser u ORDER BY u.id DESC'); + $users = $query->getResult(); // array of ForumUser objects + +Using Aggregate Functions: + +:: + + createQuery('SELECT COUNT(u.id) FROM Entities\User u'); + $count = $query->getSingleScalarResult(); + +With WHERE Clause and Positional Parameter: + +:: + + createQuery('SELECT u FROM ForumUser u WHERE u.id = ?1'); + $users = $query->getResult(); // array of ForumUser objects + +With WHERE Clause and Named Parameter: + +:: + + createQuery('SELECT u FROM ForumUser u WHERE u.username = :name'); + $users = $query->getResult(); // array of ForumUser objects + +With Nested Conditions in WHERE Clause: + +:: + + createQuery('SELECT u from ForumUser u WHERE (u.username = :name OR u.username = :name2) AND u.id = :id'); + $users = $query->getResult(); // array of ForumUser objects + +With COUNT DISTINCT: + +:: + + createQuery('SELECT COUNT(DISTINCT u.name) FROM CmsUser'); + $users = $query->getResult(); // array of ForumUser objects + +With Arithmetic Expression in WHERE clause: + +:: + + createQuery('SELECT u FROM CmsUser u WHERE ((u.id + 5000) * u.id + 3) < 10000000'); + $users = $query->getResult(); // array of ForumUser objects + +Using a LEFT JOIN to hydrate all user-ids and optionally associated +article-ids: + +:: + + createQuery('SELECT u.id, a.id as article_id FROM CmsUser u LEFT JOIN u.articles a'); + $results = $query->getResult(); // array of user ids and every article_id for each user + +Restricting a JOIN clause by additional conditions: + +:: + + createQuery("SELECT u FROM CmsUser u LEFT JOIN u.articles a WITH a.topic LIKE '%foo%'"); + $users = $query->getResult(); + +Using several Fetch JOINs: + +:: + + createQuery('SELECT u, a, p, c FROM CmsUser u JOIN u.articles a JOIN u.phonenumbers p JOIN a.comments c'); + $users = $query->getResult(); + +BETWEEN in WHERE clause: + +:: + + createQuery('SELECT u.name FROM CmsUser u WHERE u.id BETWEEN ?1 AND ?2'); + $usernames = $query->getResult(); + +DQL Functions in WHERE clause: + +:: + + createQuery("SELECT u.name FROM CmsUser u WHERE TRIM(u.name) = 'someone'"); + $usernames = $query->getResult(); + +IN() Expression: + +:: + + createQuery('SELECT u.name FROM CmsUser u WHERE u.id IN(46)'); + $usernames = $query->getResult(); + + $query = $em->createQuery('SELECT u FROM CmsUser u WHERE u.id IN (1, 2)'); + $users = $query->getResult(); + + $query = $em->createQuery('SELECT u FROM CmsUser u WHERE u.id NOT IN (1)'); + $users = $query->getResult(); + +CONCAT() DQL Function: + +:: + + createQuery("SELECT u.id FROM CmsUser u WHERE CONCAT(u.name, 's') = ?1"); + $ids = $query->getResult(); + + $query = $em->createQuery('SELECT CONCAT(u.id, u.name) FROM CmsUser u WHERE u.id = ?1'); + $idUsernames = $query->getResult(); + +EXISTS in WHERE clause with correlated Subquery + +:: + + createQuery('SELECT u.id FROM CmsUser u WHERE EXISTS (SELECT p.phonenumber FROM CmsPhonenumber p WHERE p.user = u.id)'); + $ids = $query->getResult(); + +Get all users who are members of $group. + +:: + + createQuery('SELECT u.id FROM CmsUser u WHERE :groupId MEMBER OF u.groups'); + $query->setParameter(':groupId', $group); + $ids = $query->getResult(); + +Get all users that have more than 1 phonenumber + +:: + + createQuery('SELECT u FROM CmsUser u WHERE SIZE(u.phonenumbers) > 1'); + $users = $query->getResult(); + +Get all users that have no phonenumber + +:: + + createQuery('SELECT u FROM CmsUser u WHERE u.phonenumbers IS EMPTY'); + $users = $query->getResult(); + +Get all instances of a specific type, for use with inheritance +hierarchies: + +:: + + createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u INSTANCE OF Doctrine\Tests\Models\Company\CompanyEmployee'); + $query = $em->createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u INSTANCE OF ?1'); + $query = $em->createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u NOT INSTANCE OF ?1'); + +Partial Object Syntax +^^^^^^^^^^^^^^^^^^^^^ + +By default when you run a DQL query in Doctrine and select only a +subset of the fields for a given entity, you do not receive objects +back. Instead, you receive only arrays as a flat rectangular result +set, similar to how you would if you were just using SQL directly +and joining some data. + +If you want to select partial objects you can use the ``partial`` +DQL keyword: + +:: + + createQuery('SELECT partial u.{id, username} FROM CmsUser u'); + $users = $query->getResult(); // array of partially loaded CmsUser objects + +You use the partial syntax when joining as well: + +:: + + createQuery('SELECT partial u.{id, username}, partial a.{id, name} FROM CmsUser u JOIN u.articles a'); + $users = $query->getResult(); // array of partially loaded CmsUser objects + +Using INDEX BY +~~~~~~~~~~~~~~ + +The INDEX BY construct is nothing that directly translates into SQL +but that affects object and array hydration. After each FROM and +JOIN clause you specify by which field this class should be indexed +in the result. By default a result is incremented by numerical keys +starting with 0. However with INDEX BY you can specify any other +column to be the key of your result, it really only makes sense +with primary or unique fields though: + +:: + + [sql] + SELECT u.id, u.status, upper(u.name) nameUpper FROM User u INDEX BY u.id + JOIN u.phonenumbers p INDEX BY p.phonenumber + +Returns an array of the following kind, indexed by both user-id +then phonenumber-id: + +:: + + array + 0 => + array + 1 => + object(stdClass)[299] + public '__CLASS__' => string 'Doctrine\Tests\Models\CMS\CmsUser' (length=33) + public 'id' => int 1 + .. + 'nameUpper' => string 'ROMANB' (length=6) + 1 => + array + 2 => + object(stdClass)[298] + public '__CLASS__' => string 'Doctrine\Tests\Models\CMS\CmsUser' (length=33) + public 'id' => int 2 + ... + 'nameUpper' => string 'JWAGE' (length=5) + +UPDATE queries +-------------- + +DQL not only allows to select your Entities using field names, you +can also execute bulk updates on a set of entities using an +DQL-UPDATE query. The Syntax of an UPDATE query works as expected, +as the following example shows: + +:: + + UPDATE MyProject\Model\User u SET u.password = 'new' WHERE u.id IN (1, 2, 3) + +References to related entities are only possible in the WHERE +clause and using sub-selects. + + **CAUTION** DQL UPDATE statements are ported directly into a + Database UPDATE statement and therefore bypass any locking scheme + and do not increment the version column. Entities that are already + loaded into the persistence context will *NOT* be synced with the + updated database state. It is recommended to call + ``EntityManager#clear()`` and retrieve new instances of any + affected entity. + + +DELETE queries +-------------- + +DELETE queries can also be specified using DQL and their syntax is +as simple as the UPDATE syntax: + +:: + + DELETE MyProject\Model\User u WHERE u.id = 4 + +The same restrictions apply for the reference of related entities. + + **CAUTION** DQL DELETE statements are ported directly into a + Database DELETE statement and therefore bypass any checks for the + version column if they are not explicitly added to the WHERE clause + of the query. Additionally Deletes of specifies entities are *NOT* + cascaded to related entities even if specified in the metadata. + + +Functions, Operators, Aggregates +-------------------------------- + +DQL Functions +~~~~~~~~~~~~~ + +The following functions are supported in SELECT, WHERE and HAVING +clauses: + + +- ABS(arithmetic\_expression) +- CONCAT(str1, str2) +- CURRENT\_DATE() - Return the current date +- CURRENT\_TIME() - Returns the current time +- CURRENT\_TIMESTAMP() - Returns a timestamp of the current date + and time. +- LENGTH(str) - Returns the length of the given string +- LOCATE(needle, haystack [, offset]) - Locate the first + occurrence of the substring in the string. +- LOWER(str) - returns the string lowercased. +- MOD(a, b) - Return a MOD b. +- SIZE(collection) - Return the number of elements in the + specified collection +- SQRT(q) - Return the square-root of q. +- SUBSTRING(str, start [, length]) - Return substring of given + string. +- TRIM([LEADING \| TRAILING \| BOTH] ['trchar' FROM] str) - Trim + the string by the given trim char, defaults to whitespaces. +- UPPER(str) - Return the upper-case of the given string. + +Arithmetic operators +~~~~~~~~~~~~~~~~~~~~ + +You can do math in DQL using numeric values, for example: + +:: + + SELECT person.salary * 1.5 FROM CompanyPerson person WHERE person.salary < 100000 + +Aggregate Functions +~~~~~~~~~~~~~~~~~~~ + +The following aggregate functions are allowed in SELECT and GROUP +BY clauses: AVG, COUNT, MIN, MAX, SUM + +Other Expressions +~~~~~~~~~~~~~~~~~ + +DQL offers a wide-range of additional expressions that are known +from SQL, here is a list of all the supported constructs: + + +- ``ALL/ANY/SOME`` - Used in a WHERE clause followed by a + sub-select this works like the equivalent constructs in SQL. +- ``BETWEEN a AND b`` and ``NOT BETWEEN a AND b`` can be used to + match ranges of arithmetic values. +- ``IN (x1, x2, ...)`` and ``NOT IN (x1, x2, ..)`` can be used to + match a set of given values. +- ``LIKE ..`` and ``NOT LIKE ..`` match parts of a string or text + using % as a wildcard. +- ``IS NULL`` and ``IS NOT NULL`` to check for null values +- ``EXISTS`` and ``NOT EXISTS`` in combination with a sub-select + +Adding your own functions to the DQL language +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +By default DQL comes with functions that are part of a large basis +of underlying databases. However you will most likely choose a +database platform at the beginning of your project and most likely +never change it. For this cases you can easily extend the DQL +parser with own specialized platform functions. + +You can register custom DQL functions in your ORM Configuration: + +:: + + addCustomStringFunction($name, $class); + $config->addCustomNumericFunction($name, $class); + $config->addCustomDatetimeFunction($name, $class); + + $em = EntityManager::create($dbParams, $config); + +The functions have to return either a string, numeric or datetime +value depending on the registered function type. As an example we +will add a MySQL specific FLOOR() functionality. All the given +classes have to implement the base class : + +:: + + walkSimpleArithmeticExpression( + $this->simpleArithmeticExpression + ) . ')'; + } + + public function parse(\Doctrine\ORM\Query\Parser $parser) + { + $lexer = $parser->getLexer(); + + $parser->match(Lexer::T_ABS); + $parser->match(Lexer::T_OPEN_PARENTHESIS); + + $this->simpleArithmeticExpression = $parser->SimpleArithmeticExpression(); + + $parser->match(Lexer::T_CLOSE_PARENTHESIS); + } + } + +We will register the function by calling and can then use it: + +:: + + `_ +is an inheritance mapping strategy where all classes of a hierarchy +are mapped to a single database table. In order to distinguish +which row represents which type in the hierarchy a so-called +discriminator column is used. + +First we need to setup an example set of entities to use. In this +scenario it is a generic Person and Employee example: + +:: + + setName('test'); + $employee->setDepartment('testing'); + $em->persist($employee); + $em->flush(); + +Now lets run a simple query to retrieve the ``Employee`` we just +created: + +:: + + [sql] + SELECT e FROM Entities\Employee e WHERE e.name = 'test' + +If we check the generated SQL you will notice it has some special +conditions added to ensure that we will only get back ``Employee`` +entities: + +:: + + [sql] + SELECT p0_.id AS id0, p0_.name AS name1, p0_.department AS department2, p0_.discr AS discr3 FROM Person p0_ WHERE (p0_.name = ?) AND p0_.discr IN ('employee') + +Class Table Inheritance +~~~~~~~~~~~~~~~~~~~~~~~ + +`Class Table Inheritance `_ +is an inheritance mapping strategy where each class in a hierarchy +is mapped to several tables: its own table and the tables of all +parent classes. The table of a child class is linked to the table +of a parent class through a foreign key constraint. Doctrine 2 +implements this strategy through the use of a discriminator column +in the topmost table of the hierarchy because this is the easiest +way to achieve polymorphic queries with Class Table Inheritance. + +The example for class table inheritance is the same as single +table, you just need to change the inheritance type from +``SINGLE_TABLE`` to ``JOINED``: + +:: + + createQuery('select u from MyProject\Model\User u'); + + // example2: using setDql + $q = $em->createQuery(); + $q->setDql('select u from MyProject\Model\User u'); + +Query Result Formats +~~~~~~~~~~~~~~~~~~~~ + +The format in which the result of a DQL SELECT query is returned +can be influenced by a so-called ``hydration mode``. A hydration +mode specifies a particular way in which an SQL result set is +transformed. Each hydration mode has its own dedicated method on +the Query class. Here they are: + + +- ``Query#getResult()``: Retrieves a collection of objects. The + result is either a plain collection of objects (pure) or an array + where the objects are nested in the result rows (mixed). +- ``Query#getSingleResult()``: Retrieves a single object. If the + result contains more than one object, an exception is thrown. The + pure/mixed distinction does not apply. +- ``Query#getArrayResult()``: Retrieves an array graph (a nested + array) that is largely interchangeable with the object graph + generated by ``Query#getResultList()`` for read-only purposes. + + **NOTE** An array graph can differ from the corresponding object + graph in certain scenarios due to the difference of the identity + semantics between arrays and objects. + + + +- ``Query#getScalarResult()``: Retrieves a flat/rectangular result + set of scalar values that can contain duplicate data. The + pure/mixed distinction does not apply. +- ``Query#getSingleScalarResult()``: Retrieves a single scalar + value from the result returned by the dbms. If the result contains + more than a single scalar value, an exception is thrown. The + pure/mixed distinction does not apply. + +Instead of using these methods, you can alternatively use the +general-purpose method +``Query#execute(array $params = array(), $hydrationMode = Query::HYDRATE_OBJECT)``. +Using this method you can directly supply the hydration mode as the +second parameter via one of the Query constants. In fact, the +methods mentioned earlier are just convenient shortcuts for the +execute method. For example, the method ``Query#getResultList()`` +internally invokes execute, passing in ``Query::HYDRATE_OBJECT`` as +the hydration mode. + +The use of the methods mentioned earlier is generally preferred as +it leads to more concise code. + +Pure and Mixed Results +~~~~~~~~~~~~~~~~~~~~~~ + +The nature of a result returned by a DQL SELECT query retrieved +through ``Query#getResult()`` or ``Query#getArrayResult()`` can be +of 2 forms: **pure** and **mixed**. In the previous simple +examples, you already saw a "pure" query result, with only objects. +By default, the result type is **pure** but +**as soon as scalar values, such as aggregate values or other scalar values that do not belong to an entity, appear in the SELECT part of the DQL query, the result becomes mixed**. +A mixed result has a different structure than a pure result in +order to accommodate for the scalar values. + +A pure result usually looks like this: + +:: + + array + [0] => Object + [1] => Object + [2] => Object + ... + +A mixed result on the other hand has the following general +structure: + +:: + + array + array + [0] => Object + [1] => "some scalar string" + ['count'] => 42 + // ... more scalar values, either indexed numerically or with a name + array + [0] => Object + [1] => "some scalar string" + ['count'] => 42 + // ... more scalar values, either indexed numerically or with a name + +To better understand mixed results, consider the following DQL +query: + +:: + + [sql] + SELECT u, UPPER(u.name) nameUpper FROM MyProject\Model\User u + +This query makes use of the ``UPPER`` DQL function that returns a +scalar value and because there is now a scalar value in the SELECT +clause, we get a mixed result. + +Here is how the result could look like: + +:: + + array + array + [0] => User (Object) + ['nameUpper'] => "Roman" + array + [0] => User (Object) + ['nameUpper'] => "Jonathan" + ... + +And here is how you would access it in PHP code: + +:: + + getName(); + echo "Name UPPER: " . $row['nameUpper']; + } + +You may have observed that in a mixed result, the object always +ends up on index 0 of a result row. + +Hydration Modes +~~~~~~~~~~~~~~~ + +Each of the Hydration Modes makes assumptions about how the result +is returned to user land. You should know about all the details to +make best use of the different result formats: + +The constants for the different hydration modes are: + + +- Query::HYDRATE\_OBJECT +- Query::HYDRATE\_ARRAY +- Query::HYDRATE\_SCALAR +- Query::HYDRATE\_SINGLE\_SCALAR + +Object Hydration +^^^^^^^^^^^^^^^^ + +Object hydration hydrates the result set into the object graph: + +:: + + createQuery('SELECT u FROM CmsUser u'); + $users = $query->getResult(Query::HYDRATE_OBJECT); + +Array Hydration +^^^^^^^^^^^^^^^ + +You can run the same query with array hydration and the result set +is hydrated into an array that represents the object graph: + +:: + + createQuery('SELECT u FROM CmsUser u'); + $users = $query->getResult(Query::HYDRATE_ARRAY); + +You can use the ``getArrayResult()`` shortcut as well: + +:: + + getArrayResult(); + +Scalar Hydration +^^^^^^^^^^^^^^^^ + +If you want to return a flat rectangular result set instead of an +object graph you can use scalar hydration: + +:: + + createQuery('SELECT u FROM CmsUser u'); + $users = $query->getResult(Query::HYDRATE_SCALAR); + echo $users[0]['u_id']; + +The following assumptions are made about selected fields using +Scalar Hydration: + + +1. Fields from classes are prefixed by the DQL alias in the result. + A query of the kind 'SELECT u.name ..' returns a key 'u\_name' in + the result rows. + +Single Scalar Hydration +^^^^^^^^^^^^^^^^^^^^^^^ + +If you a query which returns just a single scalar value you can use +single scalar hydration: + +:: + + createQuery('SELECT COUNT(a.id) FROM CmsUser u LEFT JOIN u.articles a WHERE u.username = ?1 GROUP BY u.id'); + $query->setParameter(1, 'jwage'); + $numArticles = $query->getResult(Query::HYDRATE_SINGLE_SCALAR); + +You can use the ``getSingleScalarResult()`` shortcut as well: + +:: + + getSingleScalarResult(); + +Custom Hydration Modes +^^^^^^^^^^^^^^^^^^^^^^ + +You can easily add your own custom hydration modes by first +creating a class which extends ``AbstractHydrator``: + +:: + + _stmt->fetchAll(PDO::FETCH_ASSOC); + } + } + +Next you just need to add the class to the ORM configuration: + +:: + + getConfiguration()->addCustomHydrationMode('CustomHydrator', 'MyProject\Hydrators\CustomHydrator'); + +Now the hydrator is ready to be used in your queries: + +:: + + createQuery('SELECT u FROM CmsUser u'); + $results = $query->getResult('CustomHydrator'); + +Iterating Large Result Sets +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There are situations when a query you want to execute returns a +very large result-set that needs to be processed. All the +previously described hydration modes completely load a result-set +into memory which might not be feasible with large result sets. See +the `Batch Processing `_ section on details how +to iterate large result sets. + +Functions +~~~~~~~~~ + +The following methods exist on the ``AbstractQuery`` which both +``Query`` and ``NativeQuery`` extend from. + +Parameters +^^^^^^^^^^ + +Prepared Statements that use numerical or named wildcards require +additional parameters to be executable against the database. To +pass parameters to the query the following methods can be used: + + +- ``AbstractQuery::setParameter($param, $value)`` - Set the + numerical or named wildcard to the given value. +- ``AbstractQuery::setParameters(array $params)`` - Set an array + of parameter key-value pairs. +- ``AbstractQuery::getParameter($param)`` +- ``AbstractQuery::getParameters()`` + +Cache related API +^^^^^^^^^^^^^^^^^ + +You can cache query results based either on all variables that +define the result (SQL, Hydration Mode, Parameters and Hints) or on +user-defined cache keys. However by default query results are not +cached at all. You have to enable the result cache on a per query +basis. The following example shows a complete workflow using the +Result Cache API: + +:: + + createQuery('SELECT u FROM MyProject\Model\User u WHERE u.id = ?1'); + $query->setParameter(1, 12); + + $query->setResultCacheDriver(new ApcCache()); + + $query->useResultCache(true) + ->setResultCacheLifeTime($seconds = 3600); + + $result = $query->getResult(); // cache miss + + $query->expireResultCache(true); + $result = $query->getResult(); // forced expire, cache miss + + $query->setResultCacheId('my_query_result'); + $result = $query->getResult(); // saved in given result cache id. + + // or call useResultCache() with all parameters: + $query->useResultCache(true, $seconds = 3600, 'my_query_result'); + $result = $query->getResult(); // cache hit! + + **TIP!** You can set the Result Cache Driver globally on the + ``Doctrine\ORM\Configuration`` instance so that it is passed to + every ``Query`` and ``NativeQuery`` instance. + + +Query Hints +^^^^^^^^^^^ + +You can pass hints to the query parser and hydrators by using the +``AbstractQuery::setHint($name, $value)`` method. Currently there +exist mostly internal query hints that are not be consumed in +userland. However the following few hints are to be used in +userland: + + +- Query::HINT\_FORCE\_PARTIAL\_LOAD - Allows to hydrate objects + although not all their columns are fetched. This query hint can be + used to handle memory consumption problems with large result-sets + that contain char or binary data. Doctrine has no way of implicitly + reloading this data. Partially loaded objects have to be passed to + ``EntityManager::refresh()`` if they are to be reloaded fully from + the database. +- Query::HINT\_REFRESH - This query is used internally by + ``EntityManager::refresh()`` and can be used in userland as well. + If you specify this hint and a query returns the data for an entity + that is already managed by the UnitOfWork, the fields of the + existing entity will be refreshed. In normal operation a result-set + that loads data of an already existing entity is discarded in favor + of the already existing entity. +- Query::HINT\_CUSTOM\_TREE\_WALKERS - An array of additional + ``Doctrine\ORM\Query\TreeWalker`` instances that are attached to + the DQL query parsing process. + +Query Cache (DQL Query Only) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Parsing a DQL query and converting it into an SQL query against the +underlying database platform obviously has some overhead in +contrast to directly executing Native SQL queries. That is why +there is a dedicated Query Cache for caching the DQL parser +results. In combination with the use of wildcards you can reduce +the number of parsed queries in production to zero. + +The Query Cache Driver is passed from the +``Doctrine\ORM\Configuration`` instance to each +``Doctrine\ORM\Query`` instance by default and is also enabled by +default. This also means you don't regularly need to fiddle with +the parameters of the Query Cache, however if you do there are +several methods to interact with it: + + +- ``Query::setQueryCacheDriver($driver)`` - Allows to set a Cache + instance +- ``Query::setQueryCacheLifeTime($seconds = 3600)`` - Set lifetime + of the query caching. +- ``Query::expireQueryCache($bool)`` - Enforce the expiring of the + query cache if set to true. +- ``Query::getExpireQueryCache()`` +- ``Query::getQueryCacheDriver()`` +- ``Query::getQueryCacheLifeTime()`` + +First and Max Result Items (DQL Query Only) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can limit the number of results returned from a DQL query as +well as specify the starting offset, Doctrine then uses a strategy +of manipulating the select query to return only the requested +number of results: + + +- ``Query::setMaxResults($maxResults)`` +- ``Query::setFirstResult($offset)`` + + **NOTE** If your query contains a fetch-joined collection + specifying the result limit methods are not working as you would + expect. Set Max Results restricts the number of database result + rows, however in the case of fetch-joined collections one root + entity might appear in many rows, effectively hydrating less than + the specified number of results. + + +EBNF +---- + +The following context-free grammar, written in an EBNF variant, +describes the Doctrine Query Language. You can consult this grammar +whenever you are unsure about what is possible with DQL or what the +correct syntax for a particular query should be. + +Document syntax: +~~~~~~~~~~~~~~~~ + + +- non-terminals begin with an upper case character +- terminals begin with a lower case character +- parentheses (...) are used for grouping +- square brackets [...] are used for defining an optional part, + e.g. zero or one time +- curly brackets {...} are used for repetition, e.g. zero or more + times +- double quotation marks "..." define a terminal string a vertical + bar \| represents an alternative + +Terminals +~~~~~~~~~ + + +- identifier (name, email, ...) +- string ('foo', 'bar''s house', '%ninja%', ...) +- char ('/', '\\', ' ', ...) +- integer (-1, 0, 1, 34, ...) +- float (-0.23, 0.007, 1.245342E+8, ...) +- boolean (false, true) + +Query Language +~~~~~~~~~~~~~~ + +:: + + QueryLanguage ::= SelectStatement | UpdateStatement | DeleteStatement + +Statements +~~~~~~~~~~ + +:: + + SelectStatement ::= SelectClause FromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause] + UpdateStatement ::= UpdateClause [WhereClause] + DeleteStatement ::= DeleteClause [WhereClause] + +Identifiers +~~~~~~~~~~~ + +:: + + /* Alias Identification usage (the "u" of "u.name") */ + IdentificationVariable ::= identifier + + /* Alias Identification declaration (the "u" of "FROM User u") */ + AliasIdentificationVariable :: = identifier + + /* identifier that must be a class name (the "User" of "FROM User u") */ + AbstractSchemaName ::= identifier + + /* identifier that must be a field (the "name" of "u.name") */ + /* This is responsible to know if the field exists in Object, no matter if it's a relation or a simple field */ + FieldIdentificationVariable ::= identifier + + /* identifier that must be a collection-valued association field (to-many) (the "Phonenumbers" of "u.Phonenumbers") */ + CollectionValuedAssociationField ::= FieldIdentificationVariable + + /* identifier that must be a single-valued association field (to-one) (the "Group" of "u.Group") */ + SingleValuedAssociationField ::= FieldIdentificationVariable + + /* identifier that must be an embedded class state field (for the future) */ + EmbeddedClassStateField ::= FieldIdentificationVariable + + /* identifier that must be a simple state field (name, email, ...) (the "name" of "u.name") */ + /* The difference between this and FieldIdentificationVariable is only semantical, because it points to a single field (not mapping to a relation) */ + SimpleStateField ::= FieldIdentificationVariable + + /* Alias ResultVariable declaration (the "total" of "COUNT(*) AS total") */ + AliasResultVariable = identifier + + /* ResultVariable identifier usage of mapped field aliases (the "total" of "COUNT(*) AS total") */ + ResultVariable = identifier + +Path Expressions +~~~~~~~~~~~~~~~~ + +:: + + /* "u.Group" or "u.Phonenumbers" declarations */ + JoinAssociationPathExpression ::= IdentificationVariable "." (CollectionValuedAssociationField | SingleValuedAssociationField) + + /* "u.Group" or "u.Phonenumbers" usages */ + AssociationPathExpression ::= CollectionValuedPathExpression | SingleValuedAssociationPathExpression + + /* "u.name" or "u.Group" */ + SingleValuedPathExpression ::= StateFieldPathExpression | SingleValuedAssociationPathExpression + + /* "u.name" or "u.Group.name" */ + StateFieldPathExpression ::= IdentificationVariable "." StateField | SingleValuedAssociationPathExpression "." StateField + + /* "u.Group" */ + SingleValuedAssociationPathExpression ::= IdentificationVariable "." {SingleValuedAssociationField "."}* SingleValuedAssociationField + + /* "u.Group.Permissions" */ + CollectionValuedPathExpression ::= IdentificationVariable "." {SingleValuedAssociationField "."}* CollectionValuedAssociationField + + /* "name" */ + StateField ::= {EmbeddedClassStateField "."}* SimpleStateField + + /* "u.name" or "u.address.zip" (address = EmbeddedClassStateField) */ + SimpleStateFieldPathExpression ::= IdentificationVariable "." StateField + +Clauses +~~~~~~~ + +:: + + SelectClause ::= "SELECT" ["DISTINCT"] SelectExpression {"," SelectExpression}* + SimpleSelectClause ::= "SELECT" ["DISTINCT"] SimpleSelectExpression + UpdateClause ::= "UPDATE" AbstractSchemaName ["AS"] AliasIdentificationVariable "SET" UpdateItem {"," UpdateItem}* + DeleteClause ::= "DELETE" ["FROM"] AbstractSchemaName ["AS"] AliasIdentificationVariable + FromClause ::= "FROM" IdentificationVariableDeclaration {"," IdentificationVariableDeclaration}* + SubselectFromClause ::= "FROM" SubselectIdentificationVariableDeclaration {"," SubselectIdentificationVariableDeclaration}* + WhereClause ::= "WHERE" ConditionalExpression + HavingClause ::= "HAVING" ConditionalExpression + GroupByClause ::= "GROUP" "BY" GroupByItem {"," GroupByItem}* + OrderByClause ::= "ORDER" "BY" OrderByItem {"," OrderByItem}* + Subselect ::= SimpleSelectClause SubselectFromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause] + +Items +~~~~~ + +:: + + UpdateItem ::= IdentificationVariable "." (StateField | SingleValuedAssociationField) "=" NewValue + OrderByItem ::= (ResultVariable | StateFieldPathExpression) ["ASC" | "DESC"] + GroupByItem ::= IdentificationVariable | SingleValuedPathExpression + NewValue ::= ScalarExpression | SimpleEntityExpression | "NULL" + +From, Join and Index by +~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + IdentificationVariableDeclaration ::= RangeVariableDeclaration [IndexBy] {JoinVariableDeclaration}* + SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration | (AssociationPathExpression ["AS"] AliasIdentificationVariable) + JoinVariableDeclaration ::= Join [IndexBy] + RangeVariableDeclaration ::= AbstractSchemaName ["AS"] AliasIdentificationVariable + Join ::= ["LEFT" ["OUTER"] | "INNER"] "JOIN" JoinAssociationPathExpression + ["AS"] AliasIdentificationVariable ["WITH" ConditionalExpression] + IndexBy ::= "INDEX" "BY" SimpleStateFieldPathExpression + +Select Expressions +~~~~~~~~~~~~~~~~~~ + +:: + + SelectExpression ::= IdentificationVariable | PartialObjectExpression | (AggregateExpression | "(" Subselect ")" | FunctionDeclaration | ScalarExpression) [["AS"] AliasResultVariable] + SimpleSelectExpression ::= ScalarExpression | IdentificationVariable | + (AggregateExpression [["AS"] AliasResultVariable]) + PartialObjectExpression ::= "PARTIAL" IdentificationVariable "." PartialFieldSet + PartialFieldSet ::= "{" SimpleStateField {"," SimpleStateField}* "}" + +Conditional Expressions +~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + ConditionalExpression ::= ConditionalTerm {"OR" ConditionalTerm}* + ConditionalTerm ::= ConditionalFactor {"AND" ConditionalFactor}* + ConditionalFactor ::= ["NOT"] ConditionalPrimary + ConditionalPrimary ::= SimpleConditionalExpression | "(" ConditionalExpression ")" + SimpleConditionalExpression ::= ComparisonExpression | BetweenExpression | LikeExpression | + InExpression | NullComparisonExpression | ExistsExpression | + EmptyCollectionComparisonExpression | CollectionMemberExpression + +Collection Expressions +~~~~~~~~~~~~~~~~~~~~~~ + +:: + + EmptyCollectionComparisonExpression ::= CollectionValuedPathExpression "IS" ["NOT"] "EMPTY" + CollectionMemberExpression ::= EntityExpression ["NOT"] "MEMBER" ["OF"] CollectionValuedPathExpression + +Literal Values +~~~~~~~~~~~~~~ + +:: + + Literal ::= string | char | integer | float | boolean + InParameter ::= Literal | InputParameter + +Input Parameter +~~~~~~~~~~~~~~~ + +:: + + InputParameter ::= PositionalParameter | NamedParameter + PositionalParameter ::= "?" integer + NamedParameter ::= ":" string + +Arithmetic Expressions +~~~~~~~~~~~~~~~~~~~~~~ + +:: + + ArithmeticExpression ::= SimpleArithmeticExpression | "(" Subselect ")" + SimpleArithmeticExpression ::= ArithmeticTerm {("+" | "-") ArithmeticTerm}* + ArithmeticTerm ::= ArithmeticFactor {("*" | "/") ArithmeticFactor}* + ArithmeticFactor ::= [("+" | "-")] ArithmeticPrimary + ArithmeticPrimary ::= SingleValuedPathExpression | Literal | "(" SimpleArithmeticExpression ")" + | FunctionsReturningNumerics | AggregateExpression | FunctionsReturningStrings + | FunctionsReturningDatetime | IdentificationVariable | InputParameter + +Scalar and Type Expressions +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + ScalarExpression ::= SimpleArithmeticExpression | StringPrimary | DateTimePrimary | StateFieldPathExpression + BooleanPrimary | CaseExpression | EntityTypeExpression + CaseExpression ::= GeneralCaseExpression | SimpleCaseExpression | + CoalesceExpression | NullifExpression + GeneralCaseExpression ::= "CASE" WhenClause {WhenClause}* "ELSE" ScalarExpression + "END" + WhenClause ::= "WHEN" ConditionalExpression "THEN" ScalarExpression + SimpleCaseExpression ::= "CASE" CaseOperand SimpleWhenClause {SimpleWhenClause}* + "ELSE" ScalarExpression "END" + CaseOperand ::= StateFieldPathExpression | TypeDiscriminator + SimpleWhenClause ::= "WHEN" ScalarExpression "THEN" ScalarExpression + CoalesceExpression ::= "COALESCE" "(" ScalarExpression {"," ScalarExpression}* ")" + NullifExpression ::= "NULLIF" "(" ScalarExpression "," ScalarExpression ")" + StringExpression ::= StringPrimary | "(" Subselect ")" + StringPrimary ::= StateFieldPathExpression | string | InputParameter | FunctionsReturningStrings | AggregateExpression + BooleanExpression ::= BooleanPrimary | "(" Subselect ")" + BooleanPrimary ::= StateFieldPathExpression | boolean | InputParameter + EntityExpression ::= SingleValuedAssociationPathExpression | SimpleEntityExpression + SimpleEntityExpression ::= IdentificationVariable | InputParameter + DatetimeExpression ::= DatetimePrimary | "(" Subselect ")" + DatetimePrimary ::= StateFieldPathExpression | InputParameter | FunctionsReturningDatetime | AggregateExpression + +Aggregate Expressions +~~~~~~~~~~~~~~~~~~~~~ + +:: + + AggregateExpression ::= ("AVG" | "MAX" | "MIN" | "SUM") "(" ["DISTINCT"] StateFieldPathExpression ")" | + "COUNT" "(" ["DISTINCT"] (IdentificationVariable | SingleValuedPathExpression) ")" + +Other Expressions +~~~~~~~~~~~~~~~~~ + +QUANTIFIED/BETWEEN/COMPARISON/LIKE/NULL/EXISTS + +:: + + QuantifiedExpression ::= ("ALL" | "ANY" | "SOME") "(" Subselect ")" + BetweenExpression ::= ArithmeticExpression ["NOT"] "BETWEEN" ArithmeticExpression "AND" ArithmeticExpression + ComparisonExpression ::= ArithmeticExpression ComparisonOperator ( QuantifiedExpression | ArithmeticExpression ) + InExpression ::= StateFieldPathExpression ["NOT"] "IN" "(" (InParameter {"," InParameter}* | Subselect) ")" + LikeExpression ::= StringExpression ["NOT"] "LIKE" string ["ESCAPE" char] + NullComparisonExpression ::= (SingleValuedPathExpression | InputParameter) "IS" ["NOT"] "NULL" + ExistsExpression ::= ["NOT"] "EXISTS" "(" Subselect ")" + ComparisonOperator ::= "=" | "<" | "<=" | "<>" | ">" | ">=" | "!=" + +Functions +~~~~~~~~~ + +:: + + FunctionDeclaration ::= FunctionsReturningStrings | FunctionsReturningNumerics | FunctionsReturningDateTime + + FunctionsReturningNumerics ::= + "LENGTH" "(" StringPrimary ")" | + "LOCATE" "(" StringPrimary "," StringPrimary ["," SimpleArithmeticExpression]")" | + "ABS" "(" SimpleArithmeticExpression ")" | "SQRT" "(" SimpleArithmeticExpression ")" | + "MOD" "(" SimpleArithmeticExpression "," SimpleArithmeticExpression ")" | + "SIZE" "(" CollectionValuedPathExpression ")" + + FunctionsReturningDateTime ::= "CURRENT_DATE" | "CURRENT_TIME" | "CURRENT_TIMESTAMP" + + FunctionsReturningStrings ::= + "CONCAT" "(" StringPrimary "," StringPrimary ")" | + "SUBSTRING" "(" StringPrimary "," SimpleArithmeticExpression "," SimpleArithmeticExpression ")" | + "TRIM" "(" [["LEADING" | "TRAILING" | "BOTH"] [char] "FROM"] StringPrimary ")" | + "LOWER" "(" StringPrimary ")" | + "UPPER" "(" StringPrimary ")" + + diff --git a/manual/en/dql-doctrine-query-language.txt b/manual/en/dql-doctrine-query-language.txt index c8dcefbc9..1a3f6ab6c 100644 --- a/manual/en/dql-doctrine-query-language.txt +++ b/manual/en/dql-doctrine-query-language.txt @@ -1,4 +1,4 @@ -++ DQL Explained +## DQL Explained DQL stands for **D**octrine **Q**uery **L**anguage and is an Object Query Language derivate that is very similar to the **H**ibernate **Q**uery **L**anguage (HQL) or the **J**ava **P**ersistence **Q**uery **L**anguage (JPQL). @@ -12,7 +12,7 @@ In essence, DQL provides powerful querying capabilities over your object model. DQL is case in-sensitive, except for namespace, class and field names, which are case sensitive. -++ Types of DQL queries +## Types of DQL queries DQL as a query language has SELECT, UPDATE and DELETE constructs that map to their corresponding SQL statement types. INSERT statements are not allowed in DQL, because entities and their relations @@ -28,15 +28,15 @@ DQL UPDATE and DELETE statements offer a way to execute bulk changes on the enti domain model. This is often necessary when you cannot load all the affected entities of a bulk update into memory. -++ SELECT queries +## SELECT queries -+++ DQL SELECT clause +### DQL SELECT clause The select clause of a DQL query specifies what appears in the query result. The composition of all the expressions in the select clause also influences the nature of the query result. Here is an example that selects all users with an age > 20: - [php] + createQuery('SELECT u FROM MyProject\Model\User u WHERE u.age > 20'); $users = $query->getResult(); @@ -55,7 +55,7 @@ identification values into aggregation and DQL functions. Numerical fields can be part of computations using mathematical operations. See the sub-section on [DQL Functions, Aggregates and Operations](#dqlfn) on more information. -+++ Joins +### Joins A SELECT query can contain joins. There are 2 types of JOINs: "Regular" Joins and "Fetch" Joins. @@ -69,13 +69,13 @@ Example: Regular join of the address: - [php] + createQuery("SELECT u FROM User u JOIN u.address a WHERE a.city = 'Berlin'"); $users = $query->getResult(); Fetch join of the address: - [php] + createQuery("SELECT u, a FROM User u JOIN u.address a WHERE a.city = 'Berlin'"); $users = $query->getResult(); @@ -93,143 +93,143 @@ the address Doctrine does not need to lazy load the association with another que > **Fetch Joins** are the solution to hydrate most or all of the entities that you > need in a single SELECT query. -+++ Named and Positional Parameters +### Named and Positional Parameters DQL supports both named and positional parameters, however in contrast to many SQL dialects positional parameters are specified with numbers, for example "?1", "?2" and so on. Named parameters are specified with ":name1", ":name2" and so on. -+++ DQL SELECT Examples +### DQL SELECT Examples This section contains a large set of DQL queries and some explanations of what is happening. The actual result also depends on the hydration mode. Hydrate all User entities: - [php] + createQuery('SELECT u FROM MyProject\Model\User u'); $users = $query->getResult(); // array of User objects Retrieve the IDs of all CmsUsers: - [php] + createQuery('SELECT u.id FROM CmsUser u'); $ids = $query->getResult(); // array of CmsUser ids Retrieve the IDs of all users that have written an article: - [php] + createQuery('SELECT DISTINCT u.id FROM CmsArticle a JOIN a.user u'); $ids = $query->getResult(); // array of CmsUser ids Retrieve all articles and sort them by the name of the articles users instance: - [php] + createQuery('SELECT a FROM CmsArticle a JOIN a.user u ORDER BY u.name ASC'); $articles = $query->getResult(); // array of CmsArticle objects Retrieve the Username and Name of a CmsUser: - [php] + createQuery('SELECT u.username, u.name FROM CmsUser u'); $users = $query->getResults(); // array of CmsUser username and id values echo $users[0]['username']; Retrieve a ForumUser and his single associated entity: - [php] + createQuery('SELECT u, a FROM ForumUser u JOIN u.avatar a'); $users = $query->getResult(); // array of ForumUser objects with the avatar association loaded echo get_class($users[0]->getAvatar()); Retrieve a CmsUser and fetch join all the phonenumbers he has: - [php] + createQuery('SELECT u, p FROM CmsUser u JOIN u.phonenumbers p'); $users = $query->getResult(); // array of CmsUser objects with the phonenumbers association loaded $phonenumbers = $users[0]->getPhonenumbers(); Hydrate a result in Ascending: - [php] + createQuery('SELECT u FROM ForumUser u ORDER BY u.id ASC'); $users = $query->getResult(); // array of ForumUser objects Or in Descending Order: - [php] + createQuery('SELECT u FROM ForumUser u ORDER BY u.id DESC'); $users = $query->getResult(); // array of ForumUser objects Using Aggregate Functions: - [php] + createQuery('SELECT COUNT(u.id) FROM Entities\User u'); $count = $query->getSingleScalarResult(); With WHERE Clause and Positional Parameter: - [php] + createQuery('SELECT u FROM ForumUser u WHERE u.id = ?1'); $users = $query->getResult(); // array of ForumUser objects With WHERE Clause and Named Parameter: - [php] + createQuery('SELECT u FROM ForumUser u WHERE u.username = :name'); $users = $query->getResult(); // array of ForumUser objects With Nested Conditions in WHERE Clause: - [php] + createQuery('SELECT u from ForumUser u WHERE (u.username = :name OR u.username = :name2) AND u.id = :id'); $users = $query->getResult(); // array of ForumUser objects With COUNT DISTINCT: - [php] + createQuery('SELECT COUNT(DISTINCT u.name) FROM CmsUser'); $users = $query->getResult(); // array of ForumUser objects With Arithmetic Expression in WHERE clause: - [php] + createQuery('SELECT u FROM CmsUser u WHERE ((u.id + 5000) * u.id + 3) < 10000000'); $users = $query->getResult(); // array of ForumUser objects Using a LEFT JOIN to hydrate all user-ids and optionally associated article-ids: - [php] + createQuery('SELECT u.id, a.id as article_id FROM CmsUser u LEFT JOIN u.articles a'); $results = $query->getResult(); // array of user ids and every article_id for each user Restricting a JOIN clause by additional conditions: - [php] + createQuery("SELECT u FROM CmsUser u LEFT JOIN u.articles a WITH a.topic LIKE '%foo%'"); $users = $query->getResult(); Using several Fetch JOINs: - [php] + createQuery('SELECT u, a, p, c FROM CmsUser u JOIN u.articles a JOIN u.phonenumbers p JOIN a.comments c'); $users = $query->getResult(); BETWEEN in WHERE clause: - [php] + createQuery('SELECT u.name FROM CmsUser u WHERE u.id BETWEEN ?1 AND ?2'); $usernames = $query->getResult(); DQL Functions in WHERE clause: - [php] + createQuery("SELECT u.name FROM CmsUser u WHERE TRIM(u.name) = 'someone'"); $usernames = $query->getResult(); IN() Expression: - [php] + createQuery('SELECT u.name FROM CmsUser u WHERE u.id IN(46)'); $usernames = $query->getResult(); @@ -241,7 +241,7 @@ IN() Expression: CONCAT() DQL Function: - [php] + createQuery("SELECT u.id FROM CmsUser u WHERE CONCAT(u.name, 's') = ?1"); $ids = $query->getResult(); @@ -250,37 +250,37 @@ CONCAT() DQL Function: EXISTS in WHERE clause with correlated Subquery - [php] + createQuery('SELECT u.id FROM CmsUser u WHERE EXISTS (SELECT p.phonenumber FROM CmsPhonenumber p WHERE p.user = u.id)'); $ids = $query->getResult(); Get all users who are members of $group. - [php] + createQuery('SELECT u.id FROM CmsUser u WHERE :groupId MEMBER OF u.groups'); $query->setParameter(':groupId', $group); $ids = $query->getResult(); Get all users that have more than 1 phonenumber - [php] + createQuery('SELECT u FROM CmsUser u WHERE SIZE(u.phonenumbers) > 1'); $users = $query->getResult(); Get all users that have no phonenumber - [php] + createQuery('SELECT u FROM CmsUser u WHERE u.phonenumbers IS EMPTY'); $users = $query->getResult(); Get all instances of a specific type, for use with inheritance hierarchies: - [php] + createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u INSTANCE OF Doctrine\Tests\Models\Company\CompanyEmployee'); $query = $em->createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u INSTANCE OF ?1'); $query = $em->createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u NOT INSTANCE OF ?1'); -++++ Partial Object Syntax +#### Partial Object Syntax By default when you run a DQL query in Doctrine and select only a subset of the fields for a given entity, you do not receive objects back. Instead, you receive @@ -289,17 +289,17 @@ were just using SQL directly and joining some data. If you want to select partial objects you can use the `partial` DQL keyword: - [php] + createQuery('SELECT partial u.{id, username} FROM CmsUser u'); $users = $query->getResult(); // array of partially loaded CmsUser objects You use the partial syntax when joining as well: - [php] + createQuery('SELECT partial u.{id, username}, partial a.{id, name} FROM CmsUser u JOIN u.articles a'); $users = $query->getResult(); // array of partially loaded CmsUser objects -+++ Using INDEX BY +### Using INDEX BY The INDEX BY construct is nothing that directly translates into SQL but that affects object and array hydration. After each FROM and JOIN clause you specify by which field @@ -332,7 +332,7 @@ Returns an array of the following kind, indexed by both user-id then phonenumber ... 'nameUpper' => string 'JWAGE' (length=5) -++ UPDATE queries +## UPDATE queries DQL not only allows to select your Entities using field names, you can also execute bulk updates on a set of entities using an DQL-UPDATE query. The Syntax of an UPDATE query works as expected, as the following @@ -348,7 +348,7 @@ References to related entities are only possible in the WHERE clause and using s > loaded into the persistence context will *NOT* be synced with the updated database state. It > is recommended to call `EntityManager#clear()` and retrieve new instances of any affected entity. -++ DELETE queries +## DELETE queries DELETE queries can also be specified using DQL and their syntax is as simple as the UPDATE syntax: @@ -362,10 +362,10 @@ The same restrictions apply for the reference of related entities. > clause of the query. Additionally Deletes of specifies entities are *NOT* cascaded > to related entities even if specified in the metadata. -++ Functions, Operators, Aggregates +## Functions, Operators, Aggregates -+++ DQL Functions +### DQL Functions The following functions are supported in SELECT, WHERE and HAVING clauses: @@ -384,17 +384,17 @@ The following functions are supported in SELECT, WHERE and HAVING clauses: * TRIM([LEADING | TRAILING | BOTH] ['trchar' FROM] str) - Trim the string by the given trim char, defaults to whitespaces. * UPPER(str) - Return the upper-case of the given string. -+++ Arithmetic operators +### Arithmetic operators You can do math in DQL using numeric values, for example: SELECT person.salary * 1.5 FROM CompanyPerson person WHERE person.salary < 100000 -+++ Aggregate Functions +### Aggregate Functions The following aggregate functions are allowed in SELECT and GROUP BY clauses: AVG, COUNT, MIN, MAX, SUM -+++ Other Expressions +### Other Expressions DQL offers a wide-range of additional expressions that are known from SQL, here is a list of all the supported constructs: @@ -406,7 +406,7 @@ all the supported constructs: * `IS NULL` and `IS NOT NULL` to check for null values * `EXISTS` and `NOT EXISTS` in combination with a sub-select -+++ Adding your own functions to the DQL language +### Adding your own functions to the DQL language By default DQL comes with functions that are part of a large basis of underlying databases. However you will most likely choose a database platform at the beginning of your project and most likely never change it. For this cases you can @@ -414,7 +414,7 @@ easily extend the DQL parser with own specialized platform functions. You can register custom DQL functions in your ORM Configuration: - [php] + addCustomStringFunction($name, $class); $config->addCustomNumericFunction($name, $class); @@ -426,7 +426,7 @@ The functions have to return either a string, numeric or datetime value dependin we will add a MySQL specific FLOOR() functionality. All the given classes have to implement the base class \Doctrine\ORM\Query\AST\Functions\FunctionNode: - [php] + setName('test'); $employee->setDepartment('testing'); @@ -538,7 +538,7 @@ ensure that we will only get back `Employee` entities: [sql] SELECT p0_.id AS id0, p0_.name AS name1, p0_.department AS department2, p0_.discr AS discr3 FROM Person p0_ WHERE (p0_.name = ?) AND p0_.discr IN ('employee') -+++ Class Table Inheritance +### Class Table Inheritance [Class Table Inheritance](http://martinfowler.com/eaaCatalog/classTableInheritance.html) is an inheritance mapping strategy where each class in a hierarchy is mapped to several tables: its own table and the tables of all parent classes. The table of a child class is linked to the table of a parent class through a foreign key constraint. Doctrine 2 implements this strategy through the use of a discriminator column in the topmost table of the hierarchy because this is the easiest way to achieve polymorphic queries with Class Table Inheritance. @@ -546,7 +546,7 @@ Doctrine 2 implements this strategy through the use of a discriminator column in The example for class table inheritance is the same as single table, you just need to change the inheritance type from `SINGLE_TABLE` to `JOINED`: - [php] + createQuery(); $q->setDql('select u from MyProject\Model\User u'); -+++ Query Result Formats +### Query Result Formats The format in which the result of a DQL SELECT query is returned can be influenced by a so-called `hydration mode`. A hydration mode specifies a particular way in which an SQL result set is transformed. Each hydration mode has its own dedicated method on the Query class. Here they are: @@ -610,7 +610,7 @@ Instead of using these methods, you can alternatively use the general-purpose me The use of the methods mentioned earlier is generally preferred as it leads to more concise code. -+++ Pure and Mixed Results +### Pure and Mixed Results The nature of a result returned by a DQL SELECT query retrieved through `Query#getResult()` or `Query#getArrayResult()` can be of 2 forms: **pure** and **mixed**. In the previous simple examples, you already saw a "pure" query result, with only objects. By default, the result type is **pure** but **as soon as scalar values, such as aggregate values or other scalar values that do not belong to an entity, appear in the SELECT part of the DQL query, the result becomes mixed**. A mixed result has a different structure than a pure result in order to accommodate for the scalar values. @@ -656,7 +656,7 @@ Here is how the result could look like: And here is how you would access it in PHP code: - [php] + getName(); echo "Name UPPER: " . $row['nameUpper']; @@ -664,7 +664,7 @@ And here is how you would access it in PHP code: You may have observed that in a mixed result, the object always ends up on index 0 of a result row. -+++ Hydration Modes +### Hydration Modes Each of the Hydration Modes makes assumptions about how the result is returned to user land. You should know about all the details to make best use of the different result formats: @@ -676,34 +676,34 @@ The constants for the different hydration modes are: * Query::HYDRATE_SCALAR * Query::HYDRATE_SINGLE_SCALAR -++++ Object Hydration +#### Object Hydration Object hydration hydrates the result set into the object graph: - [php] + createQuery('SELECT u FROM CmsUser u'); $users = $query->getResult(Query::HYDRATE_OBJECT); -++++ Array Hydration +#### Array Hydration You can run the same query with array hydration and the result set is hydrated into an array that represents the object graph: - [php] + createQuery('SELECT u FROM CmsUser u'); $users = $query->getResult(Query::HYDRATE_ARRAY); You can use the `getArrayResult()` shortcut as well: - [php] + getArrayResult(); -++++ Scalar Hydration +#### Scalar Hydration If you want to return a flat rectangular result set instead of an object graph you can use scalar hydration: - [php] + createQuery('SELECT u FROM CmsUser u'); $users = $query->getResult(Query::HYDRATE_SCALAR); echo $users[0]['u_id']; @@ -712,26 +712,26 @@ The following assumptions are made about selected fields using Scalar Hydration: 1. Fields from classes are prefixed by the DQL alias in the result. A query of the kind 'SELECT u.name ..' returns a key 'u_name' in the result rows. -++++ Single Scalar Hydration +#### Single Scalar Hydration If you a query which returns just a single scalar value you can use single scalar hydration: - [php] + createQuery('SELECT COUNT(a.id) FROM CmsUser u LEFT JOIN u.articles a WHERE u.username = ?1 GROUP BY u.id'); $query->setParameter(1, 'jwage'); $numArticles = $query->getResult(Query::HYDRATE_SINGLE_SCALAR); You can use the `getSingleScalarResult()` shortcut as well: - [php] + getSingleScalarResult(); -++++ Custom Hydration Modes +#### Custom Hydration Modes You can easily add your own custom hydration modes by first creating a class which extends `AbstractHydrator`: - [php] + getConfiguration()->addCustomHydrationMode('CustomHydrator', 'MyProject\Hydrators\CustomHydrator'); Now the hydrator is ready to be used in your queries: - [php] + createQuery('SELECT u FROM CmsUser u'); $results = $query->getResult('CustomHydrator'); -+++ Iterating Large Result Sets +### Iterating Large Result Sets There are situations when a query you want to execute returns a very large result-set that needs to be processed. All the previously described hydration modes completely load a result-set into memory which might not be feasible with large result sets. See the [Batch Processing](batch-processing) section on details how to iterate large result sets. -+++ Functions +### Functions The following methods exist on the `AbstractQuery` which both `Query` and `NativeQuery` extend from. -++++ Parameters +#### Parameters Prepared Statements that use numerical or named wildcards require additional parameters to be executable against the database. To pass parameters to the query the following methods can be used: @@ -776,14 +776,14 @@ against the database. To pass parameters to the query the following methods can * `AbstractQuery::getParameter($param)` * `AbstractQuery::getParameters()` -++++ Cache related API +#### Cache related API You can cache query results based either on all variables that define the result (SQL, Hydration Mode, Parameters and Hints) or on user-defined cache keys. However by default query results are not cached at all. You have to enable the result cache on a per query basis. The following example shows a complete workflow using the Result Cache API: - [php] + createQuery('SELECT u FROM MyProject\Model\User u WHERE u.id = ?1'); $query->setParameter(1, 12); @@ -808,7 +808,7 @@ API: > You can set the Result Cache Driver globally on the `Doctrine\ORM\Configuration` instance > so that it is passed to every `Query` and `NativeQuery` instance. -++++ Query Hints +#### Query Hints You can pass hints to the query parser and hydrators by using the `AbstractQuery::setHint($name, $value)` method. Currently there exist mostly internal query hints that are not be consumed in userland. However the following few hints @@ -825,7 +825,7 @@ entity is discarded in favor of the already existing entity. * Query::HINT_CUSTOM_TREE_WALKERS - An array of additional `Doctrine\ORM\Query\TreeWalker` instances that are attached to the DQL query parsing process. -++++ Query Cache (DQL Query Only) +#### Query Cache (DQL Query Only) Parsing a DQL query and converting it into an SQL query against the underlying database platform obviously has some overhead in contrast to directly executing Native SQL queries. That is why there is a dedicated Query Cache for caching the @@ -843,7 +843,7 @@ of the Query Cache, however if you do there are several methods to interact with * `Query::getQueryCacheDriver()` * `Query::getQueryCacheLifeTime()` -++++ First and Max Result Items (DQL Query Only) +#### First and Max Result Items (DQL Query Only) You can limit the number of results returned from a DQL query as well as specify the starting offset, Doctrine then uses a strategy of manipulating the select query to return only the requested number of results: @@ -857,11 +857,11 @@ then uses a strategy of manipulating the select query to return only the request > case of fetch-joined collections one root entity might appear in many rows, effectively hydrating > less than the specified number of results. -++ EBNF +## EBNF The following context-free grammar, written in an EBNF variant, describes the Doctrine Query Language. You can consult this grammar whenever you are unsure about what is possible with DQL or what the correct syntax for a particular query should be. -+++ Document syntax: +### Document syntax: * non-terminals begin with an upper case character * terminals begin with a lower case character @@ -870,7 +870,7 @@ The following context-free grammar, written in an EBNF variant, describes the Do * curly brackets {...} are used for repetition, e.g. zero or more times * double quotation marks "..." define a terminal string a vertical bar | represents an alternative -+++ Terminals +### Terminals * identifier (name, email, ...) * string ('foo', 'bar''s house', '%ninja%', ...) @@ -879,17 +879,17 @@ The following context-free grammar, written in an EBNF variant, describes the Do * float (-0.23, 0.007, 1.245342E+8, ...) * boolean (false, true) -+++ Query Language +### Query Language QueryLanguage ::= SelectStatement | UpdateStatement | DeleteStatement -+++ Statements +### Statements SelectStatement ::= SelectClause FromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause] UpdateStatement ::= UpdateClause [WhereClause] DeleteStatement ::= DeleteClause [WhereClause] -+++ Identifiers +### Identifiers /* Alias Identification usage (the "u" of "u.name") */ IdentificationVariable ::= identifier @@ -923,7 +923,7 @@ The following context-free grammar, written in an EBNF variant, describes the Do /* ResultVariable identifier usage of mapped field aliases (the "total" of "COUNT(*) AS total") */ ResultVariable = identifier -+++ Path Expressions +### Path Expressions /* "u.Group" or "u.Phonenumbers" declarations */ JoinAssociationPathExpression ::= IdentificationVariable "." (CollectionValuedAssociationField | SingleValuedAssociationField) @@ -950,7 +950,7 @@ The following context-free grammar, written in an EBNF variant, describes the Do SimpleStateFieldPathExpression ::= IdentificationVariable "." StateField -+++ Clauses +### Clauses SelectClause ::= "SELECT" ["DISTINCT"] SelectExpression {"," SelectExpression}* SimpleSelectClause ::= "SELECT" ["DISTINCT"] SimpleSelectExpression @@ -965,7 +965,7 @@ The following context-free grammar, written in an EBNF variant, describes the Do Subselect ::= SimpleSelectClause SubselectFromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause] -+++ Items +### Items UpdateItem ::= IdentificationVariable "." (StateField | SingleValuedAssociationField) "=" NewValue OrderByItem ::= (ResultVariable | StateFieldPathExpression) ["ASC" | "DESC"] @@ -973,7 +973,7 @@ The following context-free grammar, written in an EBNF variant, describes the Do NewValue ::= ScalarExpression | SimpleEntityExpression | "NULL" -+++ From, Join and Index by +### From, Join and Index by IdentificationVariableDeclaration ::= RangeVariableDeclaration [IndexBy] {JoinVariableDeclaration}* SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration | (AssociationPathExpression ["AS"] AliasIdentificationVariable) @@ -984,7 +984,7 @@ The following context-free grammar, written in an EBNF variant, describes the Do IndexBy ::= "INDEX" "BY" SimpleStateFieldPathExpression -+++ Select Expressions +### Select Expressions SelectExpression ::= IdentificationVariable | PartialObjectExpression | (AggregateExpression | "(" Subselect ")" | FunctionDeclaration | ScalarExpression) [["AS"] AliasResultVariable] SimpleSelectExpression ::= ScalarExpression | IdentificationVariable | @@ -993,7 +993,7 @@ The following context-free grammar, written in an EBNF variant, describes the Do PartialFieldSet ::= "{" SimpleStateField {"," SimpleStateField}* "}" -+++ Conditional Expressions +### Conditional Expressions ConditionalExpression ::= ConditionalTerm {"OR" ConditionalTerm}* ConditionalTerm ::= ConditionalFactor {"AND" ConditionalFactor}* @@ -1004,24 +1004,24 @@ The following context-free grammar, written in an EBNF variant, describes the Do EmptyCollectionComparisonExpression | CollectionMemberExpression -+++ Collection Expressions +### Collection Expressions EmptyCollectionComparisonExpression ::= CollectionValuedPathExpression "IS" ["NOT"] "EMPTY" CollectionMemberExpression ::= EntityExpression ["NOT"] "MEMBER" ["OF"] CollectionValuedPathExpression -+++ Literal Values +### Literal Values Literal ::= string | char | integer | float | boolean InParameter ::= Literal | InputParameter -+++ Input Parameter +### Input Parameter InputParameter ::= PositionalParameter | NamedParameter PositionalParameter ::= "?" integer NamedParameter ::= ":" string -+++ Arithmetic Expressions +### Arithmetic Expressions ArithmeticExpression ::= SimpleArithmeticExpression | "(" Subselect ")" SimpleArithmeticExpression ::= ArithmeticTerm {("+" | "-") ArithmeticTerm}* @@ -1032,7 +1032,7 @@ The following context-free grammar, written in an EBNF variant, describes the Do | FunctionsReturningDatetime | IdentificationVariable | InputParameter -+++ Scalar and Type Expressions +### Scalar and Type Expressions ScalarExpression ::= SimpleArithmeticExpression | StringPrimary | DateTimePrimary | StateFieldPathExpression BooleanPrimary | CaseExpression | EntityTypeExpression @@ -1057,12 +1057,12 @@ The following context-free grammar, written in an EBNF variant, describes the Do DatetimePrimary ::= StateFieldPathExpression | InputParameter | FunctionsReturningDatetime | AggregateExpression -+++ Aggregate Expressions +### Aggregate Expressions AggregateExpression ::= ("AVG" | "MAX" | "MIN" | "SUM") "(" ["DISTINCT"] StateFieldPathExpression ")" | "COUNT" "(" ["DISTINCT"] (IdentificationVariable | SingleValuedPathExpression) ")" -+++ Other Expressions +### Other Expressions QUANTIFIED/BETWEEN/COMPARISON/LIKE/NULL/EXISTS @@ -1075,7 +1075,7 @@ QUANTIFIED/BETWEEN/COMPARISON/LIKE/NULL/EXISTS ExistsExpression ::= ["NOT"] "EXISTS" "(" Subselect ")" ComparisonOperator ::= "=" | "<" | "<=" | "<>" | ">" | ">=" | "!=" -+++ Functions +### Functions FunctionDeclaration ::= FunctionsReturningStrings | FunctionsReturningNumerics | FunctionsReturningDateTime diff --git a/manual/en/events.rst b/manual/en/events.rst new file mode 100644 index 000000000..e899e3121 --- /dev/null +++ b/manual/en/events.rst @@ -0,0 +1,603 @@ +Doctrine 2 features a lightweight event system that is part of the +Common package. + +The Event System +---------------- + +The event system is controlled by the ``EventManager``. It is the +central point of Doctrine's event listener system. Listeners are +registered on the manager and events are dispatched through the +manager. + +:: + + addEventListener(array(self::preFoo, self::postFoo), $this); + } + + public function preFoo(EventArgs $e) + { + $this->preFooInvoked = true; + } + + public function postFoo(EventArgs $e) + { + $this->postFooInvoked = true; + } + } + + // Create a new instance + $test = new EventTest($evm); + +Events can be dispatched by using the ``dispatchEvent()`` method. + +:: + + dispatchEvent(EventTest::preFoo); + $evm->dispatchEvent(EventTest::postFoo); + +You can easily remove a listener with the ``removeEventListener()`` +method. + +:: + + removeEventListener(array(self::preFoo, self::postFoo), $this); + +The Doctrine 2 event system also has a simple concept of event +subscribers. We can define a simple ``TestEventSubscriber`` class +which implements the ``\Doctrine\Common\EventSubscriber`` interface +and implements a ``getSubscribedEvents()`` method which returns an +array of events it should be subscribed to. + +:: + + preFooInvoked = true; + } + + public function getSubscribedEvents() + { + return array(TestEvent::preFoo); + } + } + + $eventSubscriber = new TestEventSubscriber(); + $evm->addEventSubscriber($eventSubscriber); + +Now when you dispatch an event any event subscribers will be +notified for that event. + +:: + + dispatchEvent(TestEvent::preFoo); + +Now you can test the ``$eventSubscriber`` instance to see if the +``preFoo()`` method was invoked. + +:: + + preFooInvoked) { + echo 'pre foo invoked!'; + } + +Naming convention +~~~~~~~~~~~~~~~~~ + +Events being used with the Doctrine 2 EventManager are best named +with camelcase and the value of the corresponding constant should +be the name of the constant itself, even with spelling. This has +several reasons: + + +- It is easy to read. +- Simplicity. +- Each method within an EventSubscriber is named after the + corresponding constant. If constant name and constant value differ, + you MUST use the new value and thus, your code might be subject to + codechanges when the value changes. This contradicts the intention + of a constant. + +An example for a correct notation can be found in the example +``EventTest`` above. + +Lifecycle Events +---------------- + +The EntityManager and UnitOfWork trigger a bunch of events during +the life-time of their registered entities. + + +- preRemove - The preRemove event occurs for a given entity before + the respective EntityManager remove operation for that entity is + executed. +- postRemove - The postRemove event occurs for an entity after the + entity has been deleted. It will be invoked after the database + delete operations. +- prePersist - The prePersist event occurs for a given entity + before the respective EntityManager persist operation for that + entity is executed. +- postPersist - The postPersist event occurs for an entity after + the entity has been made persistent. It will be invoked after the + database insert operations. Generated primary key values are + available in the postPersist event. +- preUpdate - The preUpdate event occurs before the database + update operations to entity data. +- postUpdate - The postUpdate event occurs after the database + update operations to entity data. +- postLoad - The postLoad event occurs for an entity after the + entity has been loaded into the current EntityManager from the + database or after the refresh operation has been applied to it. +- loadClassMetadata - The loadClassMetadata event occurs after the + mapping metadata for a class has been loaded from a mapping source + (annotations/xml/yaml). +- onFlush - The onFlush event occurs after the change-sets of all + managed entities are computed. This event is not a lifecycle + callback. + + **CAUTION** Note that the postLoad event occurs for an entity + before any associations have been initialized. Therefore it is not + safe to access associations in a postLoad callback or event + handler. + + +You can access the Event constants from the ``Events`` class in the +ORM package. + +:: + + createdAt = date('Y-m-d H:m:s'); + } + + /** @PrePersist */ + public function doOtherStuffOnPrePersist() + { + $this->value = 'changed from prePersist callback!'; + } + + /** @PostPersist */ + public function doStuffOnPostPersist() + { + $this->value = 'changed from postPersist callback!'; + } + + /** @PostLoad */ + public function doStuffOnPostLoad() + { + $this->value = 'changed from postLoad callback!'; + } + + /** @PreUpdate */ + public function doStuffOnPreUpdate() + { + $this->value = 'changed from preUpdate callback!'; + } + } + +Note that when using annotations you have to apply the +@HasLifecycleCallbacks marker annotation on the entity class. + +If you want to register lifecycle callbacks from YAML or XML you +can do it with the following. + +:: + + [yml] + User: + type: entity + fields: + # ... + name: + type: string(50) + lifecycleCallbacks: + doStuffOnPrePersist: prePersist + doStuffOnPostPersist: postPersist + +XML would look something like this: + +:: + + [xml] + + + + + + + + + + + + + + + +You just need to make sure a public ``doStuffOnPrePersist()`` and +``doStuffOnPostPersist()`` method is defined on your ``User`` +model. + +:: + + addEventListener(array(Events::preUpdate), MyEventListener()); + $eventManager->addEventSubscriber(new MyEventSubscriber()); + + $entityManager = EntityManager::create($dbOpts, $config, $eventManager); + +You can also retrieve the event manager instance after the +EntityManager was created: + +:: + + getEventManager()->addEventListener(array(Events::preUpdate), MyEventListener()); + $entityManager->getEventManager()->addEventSubscriber(new MyEventSubscriber()); + +Implementing Event Listeners +---------------------------- + +This section explains what is and what is not allowed during +specific lifecycle events of the UnitOfWork. Although you get +passed the EntityManager in all of these events, you have to follow +this restrictions very carefully since operations in the wrong +event may produce lots of different errors, such as inconsistent +data and lost updates/persists/removes. + +For the described events that are also lifecycle callback events +the restrictions apply as well, with the additional restriction +that you do not have access to the EntityManager or UnitOfWork APIs +inside these events. + +prePersist +~~~~~~~~~~ + +There are two ways for the ``prePersist`` event to be triggered. +One is obviously when you call ``EntityManager#persist()``. The +event is also called for all cascaded associations. + +There is another way for ``prePersist`` to be called, inside the +``flush()`` method when changes to associations are computed and +this association is marked as cascade persist. Any new entity found +during this operation is also persisted and ``prePersist`` called +on it. This is called "persistence by reachability". + +In both cases you get passed a ``LifecycleEventArgs`` instance +which has access to the entity and the entity manager. + +The following restrictions apply to ``prePersist``: + + +- If you are using a PrePersist Identity Generator such as + sequences the ID value will *NOT* be available within any + PrePersist events. +- Doctrine will not recognize changes made to relations in a pre + persist event called by "reachability" through a cascade persist + unless you use the internal ``UnitOfWork`` API. We do not recommend + such operations in the persistence by reachability context, so do + this at your own risk and possibly supported by unit-tests. + +preRemove +~~~~~~~~~ + +The ``preRemove`` event is called on every entity when its passed +to the ``EntityManager#remove()`` method. It is cascaded for all +associations that are marked as cascade delete. + +There are no restrictions to what methods can be called inside the +``preRemove`` event, except when the remove method itself was +called during a flush operation. + +onFlush +~~~~~~~ + +OnFlush is a very powerful event. It is called inside +``EntityManager#flush()`` after the changes to all the managed +entities and their associations have been computed. This means, the +``onFlush`` event has access to the sets of: + + +- Entities scheduled for insert +- Entities scheduled for update +- Entities scheduled for removal +- Collections scheduled for update +- Collections scheduled for removal + +To make use of the onFlush event you have to be familiar with the +internal UnitOfWork API, which grants you access to the previously +mentioned sets. See this example: + +:: + + getEntityManager(); + $uow = $em->getUnitOfWork(); + + foreach ($uow->getScheduledEntityInsertions() AS $entity) { + + } + + foreach ($uow->getScheduledEntityUpdates() AS $entity) { + + } + + foreach ($uow->getScheduledEntityDeletions() AS $entity) { + + } + + foreach ($uow->getScheduledCollectionDeletions() AS $col) { + + } + + foreach ($uow->getScheduledCollectionUpdates() AS $col) { + + } + } + } + +The following restrictions apply to the onFlush event: + + +- Calling ``EntityManager#persist()`` does not suffice to trigger + a persist on an entity. You have to execute an additional call to + ``$unitOfWork->computeChangeSet($classMetadata, $entity)``. +- Changing primitive fields or associations requires you to + explicitly trigger a re-computation of the changeset of the + affected entity. This can be done by either calling + ``$unitOfWork->computeChangeSet($classMetadata, $entity)`` or + ``$unitOfWork->recomputeSingleEntityChangeSet($classMetadata, $entity)``. + The second method has lower overhead, but only re-computes + primitive fields, never associations. + +preUpdate +~~~~~~~~~ + +PreUpdate is the most restrictive to use event, since it is called +right before an update statement is called for an entity inside the +``EntityManager#flush()`` method. + +Changes to associations of the updated entity are never allowed in +this event, since Doctrine cannot guarantee to correctly handle +referential integrity at this point of the flush operation. This +event has a powerful feature however, it is executed with a +``PreUpdateEventArgs`` instance, which contains a reference to the +computed change-set of this entity. + +This means you have access to all the fields that have changed for +this entity with their old and new value. The following methods are +available on the ``PreUpdateEventArgs``: + + +- ``getEntity()`` to get access to the actual entity. +- ``getEntityChangeSet()`` to get a copy of the changeset array. + Changes to this returned array do not affect updating. +- ``hasChangedField($fieldName)`` to check if the given field name + of the current entity changed. +- ``getOldValue($fieldName)`` and ``getNewValue($fieldName)`` to + access the values of a field. +- ``setNewValue($fieldName, $value)`` to change the value of a + field to be updated. + +A simple example for this event looks like: + +:: + + getEntity() instanceof User) { + if ($eventArgs->hasChangedField('name') && $eventArgs->getNewValue('name') == 'Alice') { + $eventArgs->setNewValue('name', 'Bob'); + } + } + } + } + +You could also use this listener to implement validation of all the +fields that have changed. This is more efficient than using a +lifecycle callback when there are expensive validations to call: + +:: + + getEntity() instanceof Account) { + if ($eventArgs->hasChangedField('creditCard')) { + $this->validateCreditCard($eventArgs->getNewValue('creditCard')); + } + } + } + + private function validateCreditCard($no) + { + // throw an exception to interrupt flush event. Transaction will be rolled back. + } + } + +Restrictions for this event: + + +- Changes to associations of the passed entities are not + recognized by the flush operation anymore. +- Changes to fields of the passed entities are not recognized by + the flush operation anymore, use the computed change-set passed to + the event to modify primitive field values. +- Any calls to ``EntityManager#persist()`` or + ``EntityManager#remove()``, even in combination with the UnitOfWork + API are strongly discouraged and don't work as expected outside the + flush operation. + +postUpdate, postRemove, postPersist +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The three post events are called inside ``EntityManager#flush()``. +Changes in here are not relevant to the persistence in the +database, but you can use this events to + +postLoad +~~~~~~~~ + +This event is called after an entity is constructed by the +EntityManager. + +Load ClassMetadata Event +------------------------ + +When the mapping information for an entity is read, it is populated +in to a ``ClassMetadataInfo`` instance. You can hook in to this +process and manipulate the instance. + +:: + + getMetadataFactory(); + $evm = $em->getEventManager(); + $evm->addEventListener(Events::loadClassMetadata, $test); + + class EventTest + { + public function loadClassMetadata(\Doctrine\ORM\Event\LoadClassMetadataEventArgs $eventArgs) + { + $classMetadata = $eventArgs->getClassMetadata(); + $fieldMapping = array( + 'fieldName' => 'about', + 'type' => 'string', + 'length' => 255 + ); + $classMetadata->mapField($fieldMapping); + } + } + + diff --git a/manual/en/events.txt b/manual/en/events.txt index 3218814d3..a83340f39 100644 --- a/manual/en/events.txt +++ b/manual/en/events.txt @@ -1,18 +1,18 @@ Doctrine 2 features a lightweight event system that is part of the Common package. -++ The Event System +## The Event System The event system is controlled by the `EventManager`. It is the central point of Doctrine's event listener system. Listeners are registered on the manager and events are dispatched through the manager. - [php] + dispatchEvent(EventTest::preFoo); $evm->dispatchEvent(EventTest::postFoo); You can easily remove a listener with the `removeEventListener()` method. - [php] + removeEventListener(array(self::preFoo, self::postFoo), $this); The Doctrine 2 event system also has a simple concept of event subscribers. We @@ -58,7 +58,7 @@ can define a simple `TestEventSubscriber` class which implements the `\Doctrine\Common\EventSubscriber` interface and implements a `getSubscribedEvents()` method which returns an array of events it should be subscribed to. - [php] + dispatchEvent(TestEvent::preFoo); Now you can test the `$eventSubscriber` instance to see if the `preFoo()` method was invoked. - [php] + preFooInvoked) { echo 'pre foo invoked!'; } -+++ Naming convention +### Naming convention Events being used with the Doctrine 2 EventManager are best named with camelcase and the value of the corresponding constant should be the name of the constant itself, even with spelling. This has several reasons: @@ -99,7 +99,7 @@ Events being used with the Doctrine 2 EventManager are best named with camelcase An example for a correct notation can be found in the example `EventTest` above. -++ Lifecycle Events +## Lifecycle Events The EntityManager and UnitOfWork trigger a bunch of events during the life-time of their registered entities. @@ -120,7 +120,7 @@ The EntityManager and UnitOfWork trigger a bunch of events during the life-time You can access the Event constants from the `Events` class in the ORM package. - [php] + operations that can be executed. Please read the *Implementing Event Listeners* section very carefully to understand > which operations are allowed in which lifecycle event. -++ Lifecycle Callbacks +## Lifecycle Callbacks A lifecycle event is a regular event with the additional feature of providing a mechanism to register direct callbacks inside the corresponding entity classes that are executed when the lifecycle event occurs. - [php] + addEventListener(array(Events::preUpdate), MyEventListener()); $eventManager->addEventSubscriber(new MyEventSubscriber()); @@ -264,11 +264,11 @@ To register an event listener you have to hook it into the EventManager that is You can also retrieve the event manager instance after the EntityManager was created: - [php] + getEventManager()->addEventListener(array(Events::preUpdate), MyEventListener()); $entityManager->getEventManager()->addEventSubscriber(new MyEventSubscriber()); -++ Implementing Event Listeners +## Implementing Event Listeners This section explains what is and what is not allowed during specific lifecycle events of the UnitOfWork. Although you get passed the EntityManager in all of these events, you have to follow this restrictions very @@ -279,7 +279,7 @@ For the described events that are also lifecycle callback events the restriction apply as well, with the additional restriction that you do not have access to the EntityManager or UnitOfWork APIs inside these events. -+++ prePersist +### prePersist There are two ways for the `prePersist` event to be triggered. One is obviously when you call `EntityManager#persist()`. The event is also called for all @@ -302,7 +302,7 @@ The following restrictions apply to `prePersist`: `UnitOfWork` API. We do not recommend such operations in the persistence by reachability context, so do this at your own risk and possibly supported by unit-tests. -+++ preRemove +### preRemove The `preRemove` event is called on every entity when its passed to the `EntityManager#remove()` method. It is cascaded for all @@ -312,7 +312,7 @@ There are no restrictions to what methods can be called inside the `preRemove` event, except when the remove method itself was called during a flush operation. -+++ onFlush +### onFlush OnFlush is a very powerful event. It is called inside `EntityManager#flush()` after the changes to all the managed entities and their associations have @@ -327,7 +327,7 @@ been computed. This means, the `onFlush` event has access to the sets of: To make use of the onFlush event you have to be familiar with the internal UnitOfWork API, which grants you access to the previously mentioned sets. See this example: - [php] + recomputeSingleEntityChangeSet($classMetadata, $entity)`. The second method has lower overhead, but only re-computes primitive fields, never associations. -+++ preUpdate +### preUpdate PreUpdate is the most restrictive to use event, since it is called right before an update statement is called for an entity inside the `EntityManager#flush()` @@ -389,7 +389,7 @@ with their old and new value. The following methods are available on the `PreUpd A simple example for this event looks like: - [php] + getMetadataFactory(); $evm = $em->getEventManager(); diff --git a/manual/en/improving-performance.rst b/manual/en/improving-performance.rst new file mode 100644 index 000000000..2d9ffb57f --- /dev/null +++ b/manual/en/improving-performance.rst @@ -0,0 +1,38 @@ +Bytecode Cache +-------------- + +It is highly recommended to make use of a bytecode cache like APC. +A bytecode cache removes the need for parsing PHP code on every +request and can greatly improve performance. + + **NOTE** "If you care about performance and don't use a bytecode + cache then you don't really care about performance. Please get one + and start using it." (Stas Malyshev, Core Contributor to PHP and + Zend Employee). + + +Metadata and Query caches +------------------------- + +As already mentioned earlier in the chapter about configuring +Doctrine, it is strongly discouraged to use Doctrine without a +Metadata and Query cache (preferably with APC or Memcache as the +cache driver). Operating Doctrine without these caches means +Doctrine will need to load your mapping information on every single +request and has to parse each DQL query on every single request. +This is a waste of resources. + +Alternative Query Result Formats +-------------------------------- + +Make effective use of the available alternative query result +formats like nested array graphs or pure scalar results, especially +in scenarios where data is loaded for read-only purposes. + +Apply Best Practices +-------------------- + +A lot of the points mentioned in the Best Practices chapter will +also positively affect the performance of Doctrine. + + diff --git a/manual/en/improving-performance.txt b/manual/en/improving-performance.txt index f0f05710e..01509bb81 100644 --- a/manual/en/improving-performance.txt +++ b/manual/en/improving-performance.txt @@ -1,5 +1,5 @@ -++ Bytecode Cache +## Bytecode Cache It is highly recommended to make use of a bytecode cache like APC. A bytecode cache removes the need for parsing PHP code on every request and can greatly improve performance. @@ -9,15 +9,15 @@ It is highly recommended to make use of a bytecode cache like APC. A bytecode ca > to PHP and Zend Employee). -++ Metadata and Query caches +## Metadata and Query caches As already mentioned earlier in the chapter about configuring Doctrine, it is strongly discouraged to use Doctrine without a Metadata and Query cache (preferably with APC or Memcache as the cache driver). Operating Doctrine without these caches means Doctrine will need to load your mapping information on every single request and has to parse each DQL query on every single request. This is a waste of resources. -++ Alternative Query Result Formats +## Alternative Query Result Formats Make effective use of the available alternative query result formats like nested array graphs or pure scalar results, especially in scenarios where data is loaded for read-only purposes. -++ Apply Best Practices +## Apply Best Practices A lot of the points mentioned in the Best Practices chapter will also positively affect the performance of Doctrine. diff --git a/manual/en/inheritance-mapping.rst b/manual/en/inheritance-mapping.rst new file mode 100644 index 000000000..f950577c5 --- /dev/null +++ b/manual/en/inheritance-mapping.rst @@ -0,0 +1,255 @@ +Mapped Superclasses +------------------- + +An mapped superclass is an abstract or concrete class that provides +persistent entity state and mapping information for its subclasses, +but which is not itself an entity. Typically, the purpose of such a +mapped superclass is to define state and mapping information that +is common to multiple entity classes. + +Mapped superclasses, just as regular, non-mapped classes, can +appear in the middle of an otherwise mapped inheritance hierarchy +(through Single Table Inheritance or Class Table Inheritance). + + **NOTE** + + A mapped superclass cannot be an entity, it is not query-able and + persistent relationships defined by a mapped superclass must be + unidirectional. For further support of inheritance, the single or + joined table inheritance features have to be used. + + +Example: + +:: + + `_ +is an inheritance mapping strategy where all classes of a hierarchy +are mapped to a single database table. In order to distinguish +which row represents which type in the hierarchy a so-called +discriminator column is used. + +Example: + +:: + + `_ +is an inheritance mapping strategy where each class in a hierarchy +is mapped to several tables: its own table and the tables of all +parent classes. The table of a child class is linked to the table +of a parent class through a foreign key constraint. Doctrine 2 +implements this strategy through the use of a discriminator column +in the topmost table of the hierarchy because this is the easiest +way to achieve polymorphic queries with Class Table Inheritance. + +Example: + +:: + + makes use of the foreign key property `ON DELETE CASCADE` in all database implementations. A failure to implement this > yourself will lead to dead rows in the database. -+++ Design-time considerations +### Design-time considerations Introducing a new type to the hierarchy, at any level, simply involves interjecting a new table into the schema. Subtypes of that type will automatically join with that new type at runtime. Similarly, modifying any entity type in the hierarchy by adding, modifying or removing fields affects only the immediate table mapped to that type. This mapping strategy provides the greatest flexibility at design time, since changes to any type are always limited to that type's dedicated table. -+++ Performance impact +### Performance impact This strategy inherently requires multiple JOIN operations to perform just about any query which can have a negative impact on performance, especially with large tables and/or large hierarchies. When partial objects are allowed, either globally or on the specific query, then querying for any type will not cause the tables of subtypes to be OUTER JOINed which can increase performance but the resulting partial objects will not fully load themselves on access of any subtype fields, so accessing fields of subtypes after such a query is not safe. There is a general performance consideration with Class Table Inheritance: If you use a CTI entity as a many-to-one or one-to-one entity you should never use one of the classes at the upper levels of the inheritance hierachy as "targetEntity", only those that have no subclasses. Otherwise Doctrine *CANNOT* create proxy instances of this entity and will *ALWAYS* load the entity eagerly. -+++ SQL Schema considerations +### SQL Schema considerations For each entity in the Class-Table Inheritance hierarchy all the mapped fields have to be columns on the table of this entity. Additionally each child table has to have an id column that matches the id column diff --git a/manual/en/introduction.rst b/manual/en/introduction.rst new file mode 100644 index 000000000..f4e540574 --- /dev/null +++ b/manual/en/introduction.rst @@ -0,0 +1,401 @@ +Welcome +------- + +Doctrine 2 is an object-relational mapper (ORM) for PHP 5.3.0+ that +provides transparent persistence for PHP objects. It sits on top of +a powerful database abstraction layer (DBAL). Object-Relational +Mappers primary task is the transparent translation between (PHP) +objects and relational database rows. + +One of Doctrines key features is the option to write database +queries in a proprietary object oriented SQL dialect called +Doctrine Query Language (DQL), inspired by Hibernates HQL. Besides +DQLs slight differences to SQL it abstracts the mapping between +database rows and objects considerably, allowing developers to +write powerful queries in a simple and flexible fashion. + +Disclaimer +---------- + +This is the Doctrine 2 reference documentation. Introductory guides +and tutorials that you can follow along from start to finish, like +the "Guide to Doctrine" book known from the Doctrine 1.x series, +will be available at a later date. + +Using an Object-Relational Mapper +--------------------------------- + +As the term ORM already hints at, Doctrine 2 aims to simplify the +translation between database rows and the PHP object model. The +primary use case for Doctrine are therefore applications that +utilize the Object-Oriented Programming Paradigm. For applications +that not primarily work with objects Doctrine 2 is not suited very +well. + +Requirements +------------ + +Doctrine 2 requires a minimum of PHP 5.3.0. For greatly improved +performance it is also recommended that you use APC with PHP. + +Doctrine 2 Packages +------------------- + +Doctrine 2 is divided into three main packages. + + +- Common +- DBAL (includes Common) +- ORM (includes DBAL+Common) + +This manual mainly covers the ORM package, sometimes touching parts +of the underlying DBAL and Common packages. The Doctrine code base +is split in to these packages for a few reasons and they are to... + + +- ...make things more maintainable and decoupled +- ...allow you to use the code in Doctrine Common without the ORM + or DBAL +- ...allow you to use the DBAL without the ORM + +The Common Package +~~~~~~~~~~~~~~~~~~ + +The Common package contains highly reusable components that have no +dependencies beyond the package itself (and PHP, of course). The +root namespace of the Common package is ``Doctrine\Common``. + +The DBAL Package +~~~~~~~~~~~~~~~~ + +The DBAL package contains an enhanced database abstraction layer on +top of PDO but is not strongly bound to PDO. The purpose of this +layer is to provide a single API that bridges most of the +differences between the different RDBMS vendors. The root namespace +of the DBAL package is ``Doctrine\DBAL``. + +The ORM Package +~~~~~~~~~~~~~~~ + +The ORM package contains the object-relational mapping toolkit that +provides transparent relational persistence for plain PHP objects. +The root namespace of the ORM package is ``Doctrine\ORM``. + +Installing +---------- + +Doctrine can be installed many different ways. We will describe all +the different ways and you can choose which one suits you best. + +PEAR +~~~~ + +You can easily install any of the three Doctrine packages from the +PEAR command line installation utility. + +To install just the ``Common`` package you can run the following +command: + +:: + + $ sudo pear install pear.doctrine-project.org/DoctrineCommon- + +If you want to use the Doctrine Database Abstraction Layer you can +install it with the following command. + +:: + + $ sudo pear install pear.doctrine-project.org/DoctrineDBAL- + +Or, if you want to get the works and go for the ORM you can install +it with the following command. + +:: + + $ sudo pear install pear.doctrine-project.org/DoctrineORM- + + **NOTE** The ```` tag above represents the version you + want to install. For example the current version at the time of + writing this is ``2.0.0BETA3`` for the ORM, so you could install it + like the following: + + :: + + $ sudo pear install pear.doctrine-project.org/DoctrineORM-2.0.0BETA3 + + +When you have a package installed via PEAR you can require and load +the ``ClassLoader`` with the following code. + +:: + + `_. + +See the configuration section on how to configure and bootstrap a +downloaded version of Doctrine. + +GitHub +~~~~~~ + +Alternatively you can clone the latest version of Doctrine 2 via +GitHub.com: + +:: + + $ git clone git://github.com/doctrine/doctrine2.git doctrine + +This downloads all the sources of the ORM package. You need to +initialize the Github submodules for the Common and DBAL package +dependencies: + +:: + + $ git submodule init + $ git submodule update + +This updates your Git checkout to use the Doctrine and Doctrine +package versions that are recommended for the cloned Master version +of Doctrine 2. + +See the configuration chapter on how to configure a Github +installation of Doctrine with regards to autoloading. + + **NOTE** + + You should not combine the Doctrine-Common, Doctrine-DBAL and + Doctrine-ORM master commits with each other in combination. The ORM + may not work with the current Common or DBAL master versions. + Instead the ORM ships with the Git Submodules that are required. + + +Subversion +~~~~~~~~~~ + + **NOTE** + + Using the SVN Mirror is not recommended. It only allows access to + the latest master commit and does not automatically fetch the + submodules. + + +If you prefer subversion you can also checkout the code from +GitHub.com through the subversion protocol: + +:: + + $ svn co http://svn.github.com/doctrine/doctrine2.git doctrine2 + +However this only allows you to check out the current master of +Doctrine 2, without the Common and DBAL dependencies. You have to +grab them yourself, but might run into version incompatibilities +between the different master branches of Common, DBAL and ORM. + +Sandbox Quickstart +------------------ + + **NOTE** The sandbox is only available via the Doctrine2 Github + Repository or soon as a separate download on the downloads page. + You will find it in the $root/tools/sandbox folder. + + +The sandbox is a pre-configured environment for evaluating and +playing with Doctrine 2. + +Overview +~~~~~~~~ + +After navigating to the sandbox directory, you should see the +following structure: + +:: + + sandbox/ + Entities/ + Address.php + User.php + xml/ + Entities.Address.dcm.xml + Entities.User.dcm.xml + yaml/ + Entities.Address.dcm.yml + Entities.User.dcm.yml + cli-config.php + doctrine + doctrine.php + index.php + +Here is a short overview of the purpose of these folders and +files: + + +- The ``Entities`` folder is where any model classes are created. + Two example entities are already there. +- The ``xml`` folder is where any XML mapping files are created + (if you want to use XML mapping). Two example mapping documents for + the 2 example entities are already there. +- The ``yaml`` folder is where any YAML mapping files are created + (if you want to use YAML mapping). Two example mapping documents + for the 2 example entities are already there. +- The ``cli-config.php`` contains bootstrap code for a + configuration that is used by the Console tool ``doctrine`` + whenever you execute a task. +- ``doctrine``/``doctrine.php`` is a command-line tool. +- ``index.php`` is a basic classical bootstrap file of a php + application that uses Doctrine 2. + +Mini-tutorial +~~~~~~~~~~~~~ + + +1) From within the tools/sandbox folder, run the following command + and you should see the same output. + + $ php doctrine orm:schema-tool:create Creating database schema... + Database schema created successfully! + +2) Take another look into the tools/sandbox folder. A SQLite + database should have been created with the name + ``database.sqlite``. + +3) Open ``index.php`` and at the bottom edit it so it looks like + the following: + + +.. raw:: html + + + + setName('Garfield'); :math:`$em->persist($`user); $em->flush(); + + echo "User saved!"; + + +Open index.php in your browser or execute it on the command line. +You should see the output "User saved!". + + +4) Inspect the SQLite database. Again from within the tools/sandbox + folder, execute the following command: + + $ php doctrine dbal:run-sql "select \* from users" + + +You should get the following output: + +:: + + array(1) { + [0]=> + array(2) { + ["id"]=> + string(1) "1" + ["name"]=> + string(8) "Garfield" + } + } + +You just saved your first entity with a generated ID in an SQLite +database. + + +5) Replace the contents of index.php with the following: + + +.. raw:: html + + + + createQuery('select u from Entities u where u.name = ?1'); + $q->setParameter(1, 'Garfield'); $garfield = + $q->getSingleResult(); + + echo "Hello " . $garfield->getName() . "!"; + + +You just created your first DQL query to retrieve the user with the +name 'Garfield' from an SQLite database (Yes, there is an easier +way to do it, but we wanted to introduce you to DQL at this point. +Can you **find** the easier way?). + + **TIP** When you create new model classes or alter existing ones + you can recreate the database schema with the command + ``doctrine orm:schema-tool --drop`` followed by + ``doctrine orm:schema-tool --create``. + + + +6) Explore Doctrine 2! + +See the following links if you want to start with more complex +tutorials rather than reading the manual: + + +- Doctrine2 Cookbook: + `Getting Started XML Edition `_ + + diff --git a/manual/en/introduction.txt b/manual/en/introduction.txt index 913525c68..4515ead00 100644 --- a/manual/en/introduction.txt +++ b/manual/en/introduction.txt @@ -1,4 +1,4 @@ -++ Welcome +## Welcome Doctrine 2 is an object-relational mapper (ORM) for PHP 5.3.0+ that provides transparent persistence for PHP objects. It sits on top of a powerful database @@ -12,25 +12,25 @@ differences to SQL it abstracts the mapping between database rows and objects considerably, allowing developers to write powerful queries in a simple and flexible fashion. -++ Disclaimer +## Disclaimer This is the Doctrine 2 reference documentation. Introductory guides and tutorials that you can follow along from start to finish, like the "Guide to Doctrine" book known from the Doctrine 1.x series, will be available at a later date. -++ Using an Object-Relational Mapper +## Using an Object-Relational Mapper As the term ORM already hints at, Doctrine 2 aims to simplify the translation between database rows and the PHP object model. The primary use case for Doctrine are therefore applications that utilize the Object-Oriented Programming Paradigm. For applications that not primarily work with objects Doctrine 2 is not suited very well. -++ Requirements +## Requirements Doctrine 2 requires a minimum of PHP 5.3.0. For greatly improved performance it is also recommended that you use APC with PHP. -++ Doctrine 2 Packages +## Doctrine 2 Packages Doctrine 2 is divided into three main packages. @@ -46,31 +46,31 @@ packages for a few reasons and they are to... * ...allow you to use the code in Doctrine Common without the ORM or DBAL * ...allow you to use the DBAL without the ORM -+++ The Common Package +### The Common Package The Common package contains highly reusable components that have no dependencies beyond the package itself (and PHP, of course). The root namespace of the Common package is `Doctrine\Common`. -+++ The DBAL Package +### The DBAL Package The DBAL package contains an enhanced database abstraction layer on top of PDO but is not strongly bound to PDO. The purpose of this layer is to provide a single API that bridges most of the differences between the different RDBMS vendors. The root namespace of the DBAL package is `Doctrine\DBAL`. -+++ The ORM Package +### The ORM Package The ORM package contains the object-relational mapping toolkit that provides transparent relational persistence for plain PHP objects. The root namespace of the ORM package is `Doctrine\ORM`. -++ Installing +## Installing Doctrine can be installed many different ways. We will describe all the different ways and you can choose which one suits you best. -+++ PEAR +### PEAR You can easily install any of the three Doctrine packages from the PEAR command line installation utility. @@ -99,7 +99,7 @@ following command. When you have a package installed via PEAR you can require and load the `ClassLoader` with the following code. - [php] + with each other in combination. The ORM may not work with the current Common or DBAL master versions. > Instead the ORM ships with the Git Submodules that are required. -+++ Subversion +### Subversion > **NOTE** > @@ -195,7 +195,7 @@ the Common and DBAL dependencies. You have to grab them yourself, but might run into version incompatibilities between the different master branches of Common, DBAL and ORM. -++ Sandbox Quickstart +## Sandbox Quickstart > **NOTE** > The sandbox is only available via the Doctrine2 Github Repository or soon as a separate download on the downloads @@ -204,7 +204,7 @@ and ORM. The sandbox is a pre-configured environment for evaluating and playing with Doctrine 2. -+++ Overview +### Overview After navigating to the sandbox directory, you should see the following structure: @@ -232,7 +232,7 @@ Here is a short overview of the purpose of these folders and files: * `doctrine`/`doctrine.php` is a command-line tool. * `index.php` is a basic classical bootstrap file of a php application that uses Doctrine 2. -+++ Mini-tutorial +### Mini-tutorial 1) From within the tools/sandbox folder, run the following command and you should see the same output. @@ -246,7 +246,7 @@ have been created with the name `database.sqlite`. 3) Open `index.php` and at the bottom edit it so it looks like the following: - [php] + `_. + +Mapping Arrays to a Join Table +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Related to the previous limitation with "Foreign Keys as +Identifier" you might be interested in mapping the same table +structure as given above to an array. However this is not yet +possible either. See the following example: + +:: + + [sql] + CREATE TABLE product ( + id INTEGER, + name VARCHAR, + PRIMARY KEY(id) + ); + + CREATE TABLE product_attributes ( + product_id INTEGER, + attribute_name VARCHAR, + attribute_value VARCHAR, + PRIMARY KEY (product_id, attribute_name) + ); + +This schema should be mapped to a Product Entity as follows: + +:: + + class Product + { + private $id; + private $name; + private $attributes = array(); + } + +Where the ``attribute_name`` column contains the key and +``attribute_value`` contains the value of each array element in +``$attributes``. + +The feature request for persistence of primitive value arrays +`is described in the DDC-298 ticket `_. + +Value Objects +~~~~~~~~~~~~~ + +There is currently no native support value objects in Doctrine +other than for ``DateTime`` instances or if you serialize the +objects using ``serialize()/deserialize()`` which the DBAL Type +"object" supports. + +The feature request for full value-object support +`is described in the DDC-93 ticket `_. + +Applying Filter Rules to any Query +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There are scenarios in many applications where you want to apply +additional filter rules to each query implicitly. Examples +include: + + +- In I18N Applications restrict results to a entities annotated + with a specific locale +- For a large collection always only return objects in a specific + date range/where condition applied. +- Soft-Delete + +There is currently no way to achieve this consistently across both +DQL and Repository/Persister generated queries, but as this is a +pretty important feature we plan to add support for it in the +future. + +Custom Persisters +~~~~~~~~~~~~~~~~~ + +A Persister in Doctrine is an object that is responsible for the +hydration and write operations of an entity against the database. +Currently there is no way to overwrite the persister implementation +for a given entity, however there are several use-cases that can +benefit from custom persister implementations: + + +- `Add Upsert Support `_ +- `Evaluate possible ways in which stored-procedures can be used `_ +- The previous Filter Rules Feature Request + +Persist Keys of Collections +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +PHP Arrays are ordered hash-maps and so should be the +``Doctrine\Common\Collections\Collection`` interface. We plan to +evaluate a feature that optionally persists and hydrates the keys +of a Collection instance. + +`Ticket DDC-213 `_ + +Mapping many tables to one entity +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +It is not possible to map several equally looking tables onto one +entity. For example if you have a production and an archive table +of a certain business concept then you cannot have both tables map +to the same entity. + +Behaviors +~~~~~~~~~ + +Doctrine 2 *will never* include a behavior system like Doctrine 1 +in the core library. We don't think behaviors add more value than +they cost pain and debugging hell. Please see the many different +blog posts we have written on this topics: + + +- `Doctrine2 "Behaviors" in a Nutshell `_ +- `A re-usable Versionable behavior for Doctrine2 `_ +- `Write your own ORM on top of Doctrine2 `_ + +Doctrine 2 has enough hooks and extension points so that *you* can +add whatever you want on top of it. None of this will ever become +core functionality of Doctrine2 however, you will have to rely on +third party extensions for magical behaviors. + +Nested Set +~~~~~~~~~~ + +NestedSet was offered as a behavior in Doctrine 1 and will not be +included in the core of Doctrine 2. However there are already two +extensions out there that offer support for Nested Set with +Doctrine 2: + + +- `Doctrine2 Hierachical-Structural Behavior `_ +- `Doctrine2 NestedSet `_ + +Known Issues +------------ + +The Known Issues section describes critical/blocker bugs and other +issues that are either complicated to fix, not fixable due to +backwards compatibility issues or where no simple fix exists (yet). +We don't plan to add every bug in the tracker there, just those +issues that can potentially cause nightmares or pain of any sort. + +Identifier Quoting and Legacy Databases +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +For compatibility reasons between all the supported vendors and +edge case problems Doctrine 2 does *NOT* do automatic identifier +quoting. This can lead to problems when trying to get +legacy-databases to work with Doctrine 2. + + +- You can quote column-names as described in the + `Basic-Mapping `_ section. +- You cannot quote join column names. +- You cannot use non [a-zA-Z0-9\_]+ characters, they will break + several SQL statements. + +Having problems with these kind of column names? Many databases +support all CRUD operations on views that semantically map to +certain tables. You can create views for all your problematic +tables and column names to avoid the legacy quoting nightmare. + + diff --git a/manual/en/limitations-and-known-issues.txt b/manual/en/limitations-and-known-issues.txt index 9439ae1b2..d65a8516d 100644 --- a/manual/en/limitations-and-known-issues.txt +++ b/manual/en/limitations-and-known-issues.txt @@ -4,12 +4,12 @@ Much like every other piece of software Doctrine2 is not perfect and far from fe This section should give you an overview of current limitations of Doctrine 2 as well as critical known issues that you should know about. -++ Current Limitations +## Current Limitations There is a set of limitations that exist currently which might be solved in the future. Any of this limitations now stated has at least one ticket in the Tracker and is discussed for future releases. -+++ Foreign Keys as Identifiers +### Foreign Keys as Identifiers There are many use-cases where you would want to use an Entity-Attribute-Value approach to modelling and define a table-schema like the following: @@ -45,7 +45,7 @@ Although we state that we support composite primary keys that does not currently columns. To see the fundamental difference between the two different `product_attributes` tables you should see how they translate into a Doctrine Mapping (Using Annotations): - [php] + getConfiguration()->setMetadataCacheImpl(new ApcCache()); + + +If you want to use one of the included core metadata drivers you +just need to configure it. All the drivers are in the +``Doctrine\ORM\Mapping\Driver`` namespace: + +:: + + getConfiguration()->setMetadataDriverImpl($driver); + +Implementing Metadata Drivers +----------------------------- + +In addition to the included metadata drivers you can very easily +implement your own. All you need to do is define a class which +implements the ``Driver`` interface: + +:: + + _loadMappingFile($file); + + // populate ClassMetadataInfo instance from $data + } + + /** + * {@inheritdoc} + */ + protected function _loadMappingFile($file) + { + // parse contents of $file and return php data structure + } + } + + **NOTE** When using the ``AbstractFileDriver`` it requires that you + only have one entity defined per file and the file named after the + class described inside where namespace separators are replaced by + periods. So if you have an entity named ``Entities\User`` and you + wanted to write a mapping file for your driver above you would need + to name the file ``Entities.User.dcm.ext`` for it to be + recognized. + + +Now you can use your ``MyMetadataDriver`` implementation by setting +it with the ``setMetadataDriverImpl()`` method: + +:: + + getConfiguration()->setMetadataDriverImpl($driver); + +ClassMetadata +------------- + +The last piece you need to know and understand about metadata in +Doctrine 2 is the API of the ``ClassMetadata`` classes. You need to +be familiar with them in order to implement your own drivers but +more importantly to retrieve mapping information for a certain +entity when needed. + +You have all the methods you need to manually specify the mapping +information instead of using some mapping file to populate it from. +The base ``ClassMetadataInfo`` class is responsible for only data +storage and is not meant for runtime use. It does not require that +the class actually exists yet so it is useful for describing some +entity before it exists and using that information to generate for +example the entities themselves. The class ``ClassMetadata`` +extends ``ClassMetadataInfo`` and adds some functionality required +for runtime usage and requires that the PHP class is present and +can be autoloaded. + +You can read more about the API of the ``ClassMetadata`` classes in +the PHP Mapping chapter. + +Getting ClassMetadata Instances +------------------------------- + +If you want to get the ``ClassMetadata`` instance for an entity in +your project to programatically use some mapping information to +generate some HTML or something similar you can retrieve it through +the ``ClassMetadataFactory``: + +:: + + getMetadataFactory(); + $class = $cmf->getMetadataFor('MyEntityName'); + +Now you can learn about the entity and use the data stored in the +``ClassMetadata`` instance to get all mapped fields for example and +iterate over them: + +:: + + fieldMappings as $fieldMapping) { + echo $fieldMapping['fieldName'] . "\n"; + } + + diff --git a/manual/en/metadata-drivers.txt b/manual/en/metadata-drivers.txt index 9ba308cf5..0d0fe9514 100644 --- a/manual/en/metadata-drivers.txt +++ b/manual/en/metadata-drivers.txt @@ -2,7 +2,7 @@ The heart of an object relational mapper is the mapping information that glues everything together. It instructs the EntityManager how it should behave when dealing with the different entities. -++ Core Metadata Drivers +## Core Metadata Drivers Doctrine provides a few different ways for you to specify your metadata: @@ -23,23 +23,23 @@ information for an entity. > the metadata cache implementation using the `setMetadataCacheImpl()` method on > the `Doctrine\ORM\Configuration` class: > -> [php] +> $em->getConfiguration()->setMetadataCacheImpl(new ApcCache()); If you want to use one of the included core metadata drivers you just need to configure it. All the drivers are in the `Doctrine\ORM\Mapping\Driver` namespace: - [php] + getConfiguration()->setMetadataDriverImpl($driver); -++ Implementing Metadata Drivers +## Implementing Metadata Drivers In addition to the included metadata drivers you can very easily implement your own. All you need to do is define a class which implements the `Driver` interface: - [php] + getConfiguration()->setMetadataDriverImpl($driver); -++ ClassMetadata +## ClassMetadata The last piece you need to know and understand about metadata in Doctrine 2 is the API of the `ClassMetadata` classes. You need to be familiar with them in order @@ -136,20 +136,20 @@ class is present and can be autoloaded. You can read more about the API of the `ClassMetadata` classes in the PHP Mapping chapter. -++ Getting ClassMetadata Instances +## Getting ClassMetadata Instances If you want to get the `ClassMetadata` instance for an entity in your project to programatically use some mapping information to generate some HTML or something similar you can retrieve it through the `ClassMetadataFactory`: - [php] + getMetadataFactory(); $class = $cmf->getMetadataFor('MyEntityName'); Now you can learn about the entity and use the data stored in the `ClassMetadata` instance to get all mapped fields for example and iterate over them: - [php] + fieldMappings as $fieldMapping) { echo $fieldMapping['fieldName'] . "\n"; } \ No newline at end of file diff --git a/manual/en/native-sql.rst b/manual/en/native-sql.rst new file mode 100644 index 000000000..059168713 --- /dev/null +++ b/manual/en/native-sql.rst @@ -0,0 +1,353 @@ +A ``NativeQuery`` lets you execute native SQL, mapping the results +according to your specifications. Such a specification that +describes how an SQL result set is mapped to a Doctrine result is +represented by a ``ResultSetMapping``. It describes how each column +of the database result should be mapped by Doctrine in terms of the +object graph. This allows you to map arbitrary SQL code to objects, +such as highly vendor-optimized SQL or stored-procedures. + +The NativeQuery class +--------------------- + +To create a ``NativeQuery`` you use the method +``EntityManager#createNativeQuery($sql, $resultSetMapping)``. As +you can see in the signature of this method, it expects 2 +ingredients: The SQL you want to execute and the +``ResultSetMapping`` that describes how the results will be +mapped. + +Once you obtained an instance of a ``NativeQuery``, you can bind +parameters to it and finally execute it. + +The ResultSetMapping +-------------------- + +Understanding the ``ResultSetMapping`` is the key to using a +``NativeQuery``. A Doctrine result can contain the following +components: + + +- Entity results. These represent root result elements. +- Joined entity results. These represent joined entities in + associations of root entity results. +- Field results. These represent a column in the result set that + maps to a field of an entity. A field result always belongs to an + entity result or joined entity result. +- Scalar results. These represent scalar values in the result set + that will appear in each result row. Adding scalar results to a + ResultSetMapping can also cause the overall result to become + **mixed** (see DQL - Doctrine Query Language) if the same + ResultSetMapping also contains entity results. +- Meta results. These represent columns that contain + meta-information, such as foreign keys and discriminator columns. + When querying for objects (``getResult()``), all meta columns of + root entities or joined entities must be present in the SQL query + and mapped accordingly using ``ResultSetMapping#addMetaResult``. + + **TIP** It might not surprise you that Doctrine uses + ``ResultSetMapping``s internally when you create DQL queries. As + the query gets parsed and transformed to SQL, Doctrine fills a + ``ResultSetMapping`` that describes how the results should be + processed by the hydration routines. + + +We will now look at each of the result types that can appear in a +ResultSetMapping in detail. + +Entity results +~~~~~~~~~~~~~~ + +An entity result describes an entity type that appears as a root +element in the transformed result. You add an entity result through +``ResultSetMapping#addEntityResult()``. Let's take a look at the +method signature in detail: + +:: + + addEntityResult('User', 'u'); + $rsm->addFieldResult('u', 'id', 'id'); + $rsm->addFieldResult('u', 'name', 'name'); + + $query = $this->_em->createNativeQuery('SELECT id, name FROM users WHERE name = ?', $rsm); + $query->setParameter(1, 'romanb'); + + $users = $query->getResult(); + +The result would look like this: + +:: + + array( + [0] => User (Object) + ) + +Note that this would be a partial object if the entity has more +fields than just id and name. In the example above the column and +field names are identical but that is not necessary, of course. +Also note that the query string passed to createNativeQuery is +**real native SQL**. Doctrine does not touch this SQL in any way. + +In the previous basic example, a User had no relations and the +table the class is mapped to owns no foreign keys. The next example +assumes User has a unidirectional or bidirectional one-to-one +association to a CmsAddress, where the User is the owning side and +thus owns the foreign key. + +:: + + addEntityResult('User', 'u'); + $rsm->addFieldResult('u', 'id', 'id'); + $rsm->addFieldResult('u', 'name', 'name'); + $rsm->addMetaResult('u', 'address_id', 'address_id'); + + $query = $this->_em->createNativeQuery('SELECT id, name, address_id FROM users WHERE name = ?', $rsm); + $query->setParameter(1, 'romanb'); + + $users = $query->getResult(); + +Foreign keys are used by Doctrine for lazy-loading purposes when +querying for objects. In the previous example, each user object in +the result will have a proxy (a "ghost") in place of the address +that contains the address\_id. When the ghost proxy is accessed, it +loads itself based on this key. + +Consequently, associations that are *fetch-joined* do not require +the foreign keys to be present in the SQL result set, only +associations that are lazy. + +:: + + addEntityResult('User', 'u'); + $rsm->addFieldResult('u', 'id', 'id'); + $rsm->addFieldResult('u', 'name', 'name'); + $rsm->addJoinedEntityResult('Address' , 'a', 'u', 'address'); + $rsm->addFieldResult('a', 'address_id', 'id'); + $rsm->addFieldResult('a', 'street', 'street'); + $rsm->addFieldResult('a', 'city', 'city'); + + $sql = 'SELECT u.id, u.name, a.id AS address_id, a.street, a.city FROM users u ' . + 'INNER JOIN address a ON u.address_id = a.id WHERE u.name = ?'; + $query = $this->_em->createNativeQuery($sql, $rsm); + $query->setParameter(1, 'romanb'); + + $users = $query->getResult(); + +In this case the nested entity ``Address`` is registered with the +``ResultSetMapping#addJoinedEntityResult`` method, which notifies +Doctrine that this entity is not hydrated at the root level, but as +a joined entity somewhere inside the object graph. In this case we +specify the alias 'u' as third parameter and ``address`` as fourth +parameter, which means the ``Address`` is hydrated into the +``User::$address`` property. + +If a fetched entity is part of a mapped hierarchy that requires a +discriminator column, this column must be present in the result set +as a meta column so that Doctrine can create the appropriate +concrete type. This is shown in the following example where we +assume that there are one or more subclasses that extend User and +either Class Table Inheritance or Single Table Inheritance is used +to map the hierarchy (both use a discriminator column). + +:: + + addEntityResult('User', 'u'); + $rsm->addFieldResult('u', 'id', 'id'); + $rsm->addFieldResult('u', 'name', 'name'); + $rsm->addMetaResult('u', 'discr', 'discr'); // discriminator column + $rsm->setDiscriminatorColumn('u', 'discr'); + + $query = $this->_em->createNativeQuery('SELECT id, name, discr FROM users WHERE name = ?', $rsm); + $query->setParameter(1, 'romanb'); + + $users = $query->getResult(); + +Note that in the case of Class Table Inheritance, an example as +above would result in partial objects if any objects in the result +are actually a subtype of User. When using DQL, Doctrine +automatically includes the necessary joins for this mapping +strategy but with native SQL it is your responsibility. + + diff --git a/manual/en/native-sql.txt b/manual/en/native-sql.txt index 39de3ec68..867bc523c 100644 --- a/manual/en/native-sql.txt +++ b/manual/en/native-sql.txt @@ -4,13 +4,13 @@ represented by a `ResultSetMapping`. It describes how each column of the databas be mapped by Doctrine in terms of the object graph. This allows you to map arbitrary SQL code to objects, such as highly vendor-optimized SQL or stored-procedures. -++ The NativeQuery class +## The NativeQuery class To create a `NativeQuery` you use the method `EntityManager#createNativeQuery($sql, $resultSetMapping)`. As you can see in the signature of this method, it expects 2 ingredients: The SQL you want to execute and the `ResultSetMapping` that describes how the results will be mapped. Once you obtained an instance of a `NativeQuery`, you can bind parameters to it and finally execute it. -++ The ResultSetMapping +## The ResultSetMapping Understanding the `ResultSetMapping` is the key to using a `NativeQuery`. A Doctrine result can contain the following components: @@ -31,12 +31,12 @@ A Doctrine result can contain the following components: We will now look at each of the result types that can appear in a ResultSetMapping in detail. -+++ Entity results +### Entity results An entity result describes an entity type that appears as a root element in the transformed result. You add an entity result through `ResultSetMapping#addEntityResult()`. Let's take a look at the method signature in detail: - [php] + createQuery("select partial u.{id,name} from MyApp\Domain\User u"); + +When should I force partial objects? +------------------------------------ + +Mainly for optimization purposes, but be careful of premature +optimization as partial objects lead to potentially more fragile +code. + + diff --git a/manual/en/partial-objects.txt b/manual/en/partial-objects.txt index 68e23dce9..83e89b233 100644 --- a/manual/en/partial-objects.txt +++ b/manual/en/partial-objects.txt @@ -8,7 +8,7 @@ The following section will describe why partial objects are problematic and what > `Query#getArrayResult()`, `Query#getScalarResult()`, `Query#getSingleScalarResult()`, > etc. -++ What is the problem? +## What is the problem? In short, partial objects are problematic because they are usually objects with broken invariants. As such, code that uses these partial objects tends to be @@ -40,10 +40,10 @@ only selects partial object data and wants to retrieve the result as objects partial objects are dangerous. If you want to force a query to return you partial objects, possibly as a performance tweak, you can use the `partial` keyword as follows: - [php] + createQuery("select partial u.{id,name} from MyApp\Domain\User u"); -++ When should I force partial objects? +## When should I force partial objects? Mainly for optimization purposes, but be careful of premature optimization as partial objects lead to potentially more fragile code. \ No newline at end of file diff --git a/manual/en/php-mapping.rst b/manual/en/php-mapping.rst new file mode 100644 index 000000000..4a0326524 --- /dev/null +++ b/manual/en/php-mapping.rst @@ -0,0 +1,248 @@ +Doctrine 2 also allows you to provide the ORM metadata in the form +of plain PHP code using the ``ClassMetadata`` API. You can write +the code in PHP files or inside of a static function named +``loadMetadata($class)`` on the entity class itself. + +PHP Files +--------- + +If you wish to write your mapping information inside PHP files that +are named after the entity and included to populate the metadata +for an entity you can do so by using the ``PHPDriver``: + +:: + + getConfiguration()->setMetadataDriverImpl($driver); + +Now imagine we had an entity named ``Entities\User`` and we wanted +to write a mapping file for it using the above configured +``PHPDriver`` instance: + +:: + + mapField(array( + 'id' => true, + 'fieldName' => 'id', + 'type' => 'integer' + )); + + $metadata->mapField(array( + 'fieldName' => 'username', + 'type' => 'string' + )); + +Now we can easily retrieve the populated ``ClassMetadata`` instance +where the ``PHPDriver`` includes the file and the +``ClassMetadataFactory`` caches it for later retrieval: + +:: + + getMetadataFor('Entities\User'); + +Static Function +--------------- + +In addition to the PHP files you can also specify your mapping +information inside of a static function defined on the entity class +itself. This is useful for cases where you want to keep your entity +and mapping information together but don't want to use annotations. +For this you just need to use the ``StaticPHPDriver``: + +:: + + getConfiguration()->setMetadataDriverImpl($driver); + +Now you just need to define a static function named +``loadMetadata($metadata)`` on your entity: + +:: + + mapField(array( + 'id' => true, + 'fieldName' => 'id', + 'type' => 'integer' + )); + + $metadata->mapField(array( + 'fieldName' => 'username', + 'type' => 'string' + )); + } + } + +ClassMetadataInfo API +--------------------- + +The ``ClassMetadataInfo`` class is the base data object for storing +the mapping metadata for a single entity. It contains all the +getters and setters you need populate and retrieve information for +an entity. + +General Setters +~~~~~~~~~~~~~~~ + + +- ``setTableName($tableName)`` +- ``setPrimaryTable(array $primaryTableDefinition)`` +- ``setCustomRepositoryClass($repositoryClassName)`` +- ``setIdGeneratorType($generatorType)`` +- ``setIdGenerator($generator)`` +- ``setSequenceGeneratorDefinition(array $definition)`` +- ``setChangeTrackingPolicy($policy)`` +- ``setIdentifier(array $identifier)`` + +Inheritance Setters +~~~~~~~~~~~~~~~~~~~ + + +- ``setInheritanceType($type)`` +- ``setSubclasses(array $subclasses)`` +- ``setParentClasses(array $classNames)`` +- ``setDiscriminatorColumn($columnDef)`` +- ``setDiscriminatorMap(array $map)`` + +Field Mapping Setters +~~~~~~~~~~~~~~~~~~~~~ + + +- ``mapField(array $mapping)`` +- ``mapOneToOne(array $mapping)`` +- ``mapOneToMany(array $mapping)`` +- ``mapManyToOne(array $mapping)`` +- ``mapManyToMany(array $mapping)`` + +Lifecycle Callback Setters +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +- ``addLifecycleCallback($callback, $event)`` +- ``setLifecycleCallbacks(array $callbacks)`` + +Versioning Setters +~~~~~~~~~~~~~~~~~~ + + +- ``setVersionMapping(array &$mapping)`` +- ``setVersioned($bool)`` +- ``setVersionField()`` + +General Getters +~~~~~~~~~~~~~~~ + + +- ``getTableName()`` +- ``getTemporaryIdTableName()`` + +Identifier Getters +~~~~~~~~~~~~~~~~~~ + + +- ``getIdentifierColumnNames()`` +- ``usesIdGenerator()`` +- ``isIdentifier($fieldName)`` +- ``isIdGeneratorIdentity()`` +- ``isIdGeneratorSequence()`` +- ``isIdGeneratorTable()`` +- ``isIdentifierNatural()`` +- ``getIdentifierFieldNames()`` +- ``getSingleIdentifierFieldName()`` +- ``getSingleIdentifierColumnName()`` + +Inheritance Getters +~~~~~~~~~~~~~~~~~~~ + + +- ``isInheritanceTypeNone()`` +- ``isInheritanceTypeJoined()`` +- ``isInheritanceTypeSingleTable()`` +- ``isInheritanceTypeTablePerClass()`` +- ``isInheritedField($fieldName)`` +- ``isInheritedAssociation($fieldName)`` + +Change Tracking Getters +~~~~~~~~~~~~~~~~~~~~~~~ + + +- ``isChangeTrackingDeferredExplicit()`` +- ``isChangeTrackingDeferredImplicit()`` +- ``isChangeTrackingNotify()`` + +Field & Association Getters +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +- ``isUniqueField($fieldName)`` +- ``isNullable($fieldName)`` +- ``getColumnName($fieldName)`` +- ``getFieldMapping($fieldName)`` +- ``getAssociationMapping($fieldName)`` +- ``getAssociationMappings()`` +- ``getFieldName($columnName)`` +- ``hasField($fieldName)`` +- ``getColumnNames(array $fieldNames = null)`` +- ``getTypeOfField($fieldName)`` +- ``getTypeOfColumn($columnName)`` +- ``hasAssociation($fieldName)`` +- ``isSingleValuedAssociation($fieldName)`` +- ``isCollectionValuedAssociation($fieldName)`` + +Lifecycle Callback Getters +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +- ``hasLifecycleCallbacks($lifecycleEvent)`` +- ``getLifecycleCallbacks($event)`` + +ClassMetadata API +----------------- + +The ``ClassMetadata`` class extends ``ClassMetadataInfo`` and adds +the runtime functionality required by Doctrine. It adds a few extra +methods related to runtime reflection for working with the entities +themselves. + + +- ``getReflectionClass()`` +- ``getReflectionProperties()`` +- ``getReflectionProperty($name)`` +- ``getSingleIdReflectionProperty()`` +- ``getIdentifierValues($entity)`` +- ``setIdentifierValues($entity, $id)`` +- ``setFieldValue($entity, $field, $value)`` +- ``getFieldValue($entity, $field)`` + + diff --git a/manual/en/php-mapping.txt b/manual/en/php-mapping.txt index 19a4f66a5..05ea41ca3 100644 --- a/manual/en/php-mapping.txt +++ b/manual/en/php-mapping.txt @@ -2,20 +2,20 @@ Doctrine 2 also allows you to provide the ORM metadata in the form of plain PHP code using the `ClassMetadata` API. You can write the code in PHP files or inside of a static function named `loadMetadata($class)` on the entity class itself. -++ PHP Files +## PHP Files If you wish to write your mapping information inside PHP files that are named after the entity and included to populate the metadata for an entity you can do so by using the `PHPDriver`: - [php] + getConfiguration()->setMetadataDriverImpl($driver); Now imagine we had an entity named `Entities\User` and we wanted to write a mapping file for it using the above configured `PHPDriver` instance: - [php] + mapField(array( @@ -44,23 +44,23 @@ To write the mapping information you just need to create a file named Now we can easily retrieve the populated `ClassMetadata` instance where the `PHPDriver` includes the file and the `ClassMetadataFactory` caches it for later retrieval: - [php] + getMetadataFor('Entities\User'); -++ Static Function +## Static Function In addition to the PHP files you can also specify your mapping information inside of a static function defined on the entity class itself. This is useful for cases where you want to keep your entity and mapping information together but don't want to use annotations. For this you just need to use the `StaticPHPDriver`: - [php] + getConfiguration()->setMetadataDriverImpl($driver); Now you just need to define a static function named `loadMetadata($metadata)` on your entity: - [php] + createQueryBuilder(); + +Once you have created an instance of QueryBuilder, it provides a +set of useful informative functions that you can use. One good +example is to inspect what type of object the ``QueryBuilder`` is. + +:: + + getType(); // Prints: 0 + +There're currently 3 possible return values for ``getType()``: + + +- ``QueryBuilder::SELECT``, which returns value 0 +- ``QueryBuilder::DELETE``, returning value 1 +- ``QueryBuilder::UPDATE``, which returns value 2 + +It is possible to retrieve the associated ``EntityManager`` of the +current ``QueryBuilder``, its DQL and also a ``Query`` object when +you finish building your DQL. + +:: + + getEntityManager(); + + // example4: retrieve the DQL string of what was defined in QueryBuilder + $dql = $qb->getDql(); + + // example5: retrieve the associated Query object with the processed DQL + $q = $qb->getQuery(); + +Internally, ``QueryBuilder`` works with a DQL cache to increase +performance. Any changes that may affect the generated DQL actually +modifies the state of ``QueryBuilder`` to a stage we call +STATE\_DIRTY. One ``QueryBuilder`` can be in two different states: + + +- ``QueryBuilder::STATE_CLEAN``, which means DQL haven't been + altered since last retrieval or nothing were added since its + instantiation +- ``QueryBuilder::STATE_DIRTY``, means DQL query must (and will) + be processed on next retrieval + +Working with QueryBuilder +~~~~~~~~~~~~~~~~~~~~~~~~~ + +All helper methods in ``QueryBuilder`` actually rely on a single +one: ``add()``. This method is responsible of building every piece +of DQL. It takes 3 parameters: ``$dqlPartName``, ``$dqlPart`` and +``$append`` (default=false) + + +- ``$dqlPartName``: Where the ``$dqlPart`` should be placed. + Possible values: select, from, where, groupBy, having, orderBy +- ``$dqlPart``: What should be placed in ``$dqlPartName``. Accepts + a string or any instance of ``Doctrine\ORM\Query\Expr\*`` +- ``$append``: Optional flag (default=false) if the ``$dqlPart`` + should override all previously defined items in ``$dqlPartName`` or + not + +- + +:: + + add('select', 'u') + ->add('from', 'User u') + ->add('where', 'u.id = ?1') + ->add('orderBy', 'u.name ASC'); + +Binding parameters to your query +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Doctrine supports dynamic binding of parameters to your query, +similar to preparing queries. You can use both strings and numbers +as placeholders, although both have a slightly different syntax. +Additionally, you must make your choice: Mixing both styles is not +allowed. Binding parameters can simply be achieved as follows: + +:: + + add('select', 'u') + ->add('from', 'User u') + ->add('where', 'u.id = ?1') + ->add('orderBy', 'u.name ASC'); + ->setParameter(1, 100); // Sets ?1 to 100, and thus we will fetch a user with u.id = 100 + +You are not forced to enumerate your placeholders as the +alternative syntax is available: + +:: + + add('select', 'u') + ->add('from', 'User u') + ->add('where', 'u.id = :identifier') + ->add('orderBy', 'u.name ASC'); + ->setParameter('identifier', 100); // Sets :identifier to 100, and thus we will fetch a user with u.id = 100 + +Note that numeric placeholders start with a ? followed by a number +while the named placeholders start with a : followed by a string. + +If you've got several parameters to bind to your query, you can +also use setParameters() instead of setParameter() with the +following syntax: + +:: + + setParameters(array(1 => 'value for ?1', 2 => 'value for ?2')); + +Getting already bound parameters is easy - simply use the above +mentioned syntax with "getParameter()" or "getParameters()": + +:: + + getParameters(array(1, 2)); + // Equivalent to + $param = array($qb->getParameter(1), $qb->getParameter(2)); + +Note: If you try to get a parameter that was not bound yet, +getParameter() simply returns NULL. + +Expr\* classes +^^^^^^^^^^^^^^ + +When you call ``add()`` with string, it internally evaluates to an +instance of ``Doctrine\ORM\Query\Expr\Expr\*`` class. Here is the +same query of example 6 written using +``Doctrine\ORM\Query\Expr\Expr\*`` classes: + +:: + + add('select', new Expr\Select(array('u'))) + ->add('from', new Expr\From('User', 'u')) + ->add('where', new Expr\Comparison('u.id', '=', '?1')) + ->add('orderBy', new Expr\OrderBy('u.name', 'ASC')); + +Of course this is the hardest way to build a DQL query in Doctrine. +To simplify some of these efforts, we introduce what we call as +``Expr`` helper class. + +The Expr class +^^^^^^^^^^^^^^ + +To workaround most of the issues that ``add()`` method may cause, +Doctrine created a class that can be considered as a helper for +building queries. This class is called ``Expr``, which provides a +set of useful static methods to help building queries: + +:: + + add('select', $qb->expr()->select('u')) + ->add('from', $qb->expr()->from('User', 'u')) + ->add('where', $qb->expr()->orx( + $qb->expr()->eq('u.id', '?1'), + $qb->expr()->like('u.nickname', '?2') + )) + ->add('orderBy', $qb->expr()->orderBy('u.surname', 'ASC')); + +Although it still sounds complex, the ability to programmatically +create conditions are the main feature of ``Expr``. Here it is a +complete list of supported helper methods available: + +:: + + expr()->select('u') + public function select($select = null); // Returns Expr\Select instance + + // Example - $qb->expr()->from('User', 'u') + public function from($from, $alias); // Returns Expr\From instance + + // Example - $qb->expr()->leftJoin('u.Phonenumbers', 'p', Expr\Join::ON, 'p.user_id = u.id AND p.country_code = 55'); + // Example - $qb->expr()->leftJoin('u. Phonenumbers', 'p', 'ON', $qb->expr()->andx($qb->expr()->eq('p.user_id', 'u.id'), $qb->expr()->eq('p.country_code', '55')); + public function leftJoin($join, $alias, $conditionType = null, $condition = null); // Returns Expr\Join instance + + // Example - $qb->expr()->innerJoin('u.Group', 'g', Expr\Join::WITH, 'g.manager_level = 100'); + // Example - $qb->expr()->innerJoin('u.Group', 'g', 'WITH', $qb->expr()->eq('g.manager_level', '100')); + public function innerJoin($join, $alias, $conditionType = null, $condition = null); // Returns Expr\Join instance + + // Example - $qb->expr()->orderBy('u.surname', 'ASC')->add('u.firstname', 'ASC')->... + public function orderBy($sort = null, $order = null); // Returns Expr\OrderBy instance + + // Example - $qb->expr()->groupBy()->add('u.id')->... + public function groupBy($groupBy = null); // Returns Expr\GroupBy instance + + + /** Conditional objects **/ + + // Example - $qb->expr()->andx($cond1 [, $condN])->add(...)->... + public function andx($x = null); // Returns Expr\Andx instance + + // Example - $qb->expr()->orx($cond1 [, $condN])->add(...)->... + public function orx($x = null); // Returns Expr\Orx instance + + + /** Comparison objects **/ + + // Example - $qb->expr()->eq('u.id', '?1') => u.id = ?1 + public function eq($x, $y); // Returns Expr\Comparison instance + + // Example - $qb->expr()->neq('u.id', '?1') => u.id <> ?1 + public function neq($x, $y); // Returns Expr\Comparison instance + + // Example - $qb->expr()->lt('u.id', '?1') => u.id < ?1 + public function lt($x, $y); // Returns Expr\Comparison instance + + // Example - $qb->expr()->lte('u.id', '?1') => u.id <= ?1 + public function lte($x, $y); // Returns Expr\Comparison instance + + // Example - $qb->expr()->gt('u.id', '?1') => u.id > ?1 + public function gt($x, $y); // Returns Expr\Comparison instance + + // Example - $qb->expr()->gte('u.id', '?1') => u.id >= ?1 + public function gte($x, $y); // Returns Expr\Comparison instance + + + /** Arithmetic objects **/ + + // Example - $qb->expr()->prod('u.id', '2') => u.id * 2 + public function prod($x, $y); // Returns Expr\Math instance + + // Example - $qb->expr()->diff('u.id', '2') => u.id - 2 + public function diff($x, $y); // Returns Expr\Math instance + + // Example - $qb->expr()->sum('u.id', '2') => u.id + 2 + public function sum($x, $y); // Returns Expr\Math instance + + // Example - $qb->expr()->quot('u.id', '2') => u.id / 2 + public function quot($x, $y); // Returns Expr\Math instance + + + /** Pseudo-function objects **/ + + // Example - $qb->expr()->exists($qb2->getDql()) + public function exists($subquery); // Returns Expr\Func instance + + // Example - $qb->expr()->all($qb2->getDql()) + public function all($subquery); // Returns Expr\Func instance + + // Example - $qb->expr()->some($qb2->getDql()) + public function some($subquery); // Returns Expr\Func instance + + // Example - $qb->expr()->any($qb2->getDql()) + public function any($subquery); // Returns Expr\Func instance + + // Example - $qb->expr()->not($qb->expr()->eq('u.id', '?1')) + public function not($restriction); // Returns Expr\Func instance + + // Example - $qb->expr()->in('u.id', array(1, 2, 3)) + // Make sure that you do NOT use something similar to $qb->expr()->in('value', array('stringvalue')) as this will cause Doctrine to throw an Exception. + // Instead, use $qb->expr()->in('value', array('?1')) and bind your parameter to ?1 (see section above) + public function in($x, $y); // Returns Expr\Func instance + + // Example - $qb->expr()->notIn('u.id', '2') + public function notIn($x, $y); // Returns Expr\Func instance + + // Example - $qb->expr()->like('u.firstname', $qb->expr()->literal('Gui%')) + public function like($x, $y); // Returns Expr\Comparison instance + + // Example - $qb->expr()->between('u.id', '1', '10') + public function between($val, $x, $y); // Returns Expr\Func + + + /** Function objects **/ + + // Example - $qb->expr()->trim('u.firstname') + public function trim($x); // Returns Expr\Func + + // Example - $qb->expr()->concat('u.firstname', $qb->expr()->concat(' ', 'u.lastname')) + public function concat($x, $y); // Returns Expr\Func + + // Example - $qb->expr()->substr('u.firstname', 0, 1) + public function substr($x, $from, $len); // Returns Expr\Func + + // Example - $qb->expr()->lower('u.firstname') + public function lower($x); // Returns Expr\Func + + // Example - $qb->expr()->upper('u.firstname') + public function upper($x); // Returns Expr\Func + + // Example - $qb->expr()->length('u.firstname') + public function length($x); // Returns Expr\Func + + // Example - $qb->expr()->avg('u.age') + public function avg($x); // Returns Expr\Func + + // Example - $qb->expr()->max('u.age') + public function max($x); // Returns Expr\Func + + // Example - $qb->expr()->min('u.age') + public function min($x); // Returns Expr\Func + + // Example - $qb->expr()->abs('u.currentBalance') + public function abs($x); // Returns Expr\Func + + // Example - $qb->expr()->sqrt('u.currentBalance') + public function sqrt($x); // Returns Expr\Func + + // Example - $qb->expr()->count('u.firstname') + public function count($x); // Returns Expr\Func + + // Example - $qb->expr()->countDistinct('u.surname') + public function countDistinct($x); // Returns Expr\Func + } + +Helper methods +^^^^^^^^^^^^^^ + +Until now we have described the lowest level (thought of as the +hardcore method) of creating queries. It may be useful to work at +this level for optimization purposes, but most of the time it is +preferred to work at a higher level of abstraction. To simplify +even more the way you build a query in Doctrine, we can take +advantage of what we call Helper methods. For all base code, there +is a set of useful methods to simplify a programmer's life. To +illustrate how to work with them, here is the same example 6 +re-written using ``QueryBuilder`` helper methods: + +:: + + select('u') + ->from('User', 'u') + ->where('u.id = ?1') + ->orderBy('u.name ASC'); + +``QueryBuilder`` helper methods are considered the standard way to +build DQL queries. Although it is supported, it should be avoided +to use string based queries and greatly encouraged to use +``$qb->expr()->*`` methods. Here is a converted example 8 to +suggested standard way to build queries: + +:: + + select(array('u')) // string 'u' is converted to array internally + ->from('User', 'u') + ->where($qb->expr()->orx( + $qb->expr()->eq('u.id', '?1'), + $qb->expr()->like('u.nickname', '?2') + )) + ->orderBy('u.surname', 'ASC')); + +Here is a complete list of helper methods available in +``QueryBuilder``: + +:: + + select('u') + // Example - $qb->select(array('u', 'p')) + // Example - $qb->select($qb->expr()->select('u', 'p')) + public function select($select = null); + + // Example - $qb->delete('User', 'u') + public function delete($delete = null, $alias = null); + + // Example - $qb->update('Group', 'g') + public function update($update = null, $alias = null); + + // Example - $qb->set('u.firstName', $qb->expr()->literal('Arnold')) + // Example - $qb->set('u.numChilds', 'u.numChilds + ?1') + // Example - $qb->set('u.numChilds', $qb->expr()->sum('u.numChilds', '?1')) + public function set($key, $value); + + // Example - $qb->from('Phonenumber', 'p') + public function from($from, $alias = null); + + // Example - $qb->innerJoin('u.Group', 'g', Expr\Join::ON, $qb->expr()->and($qb->expr()->eq('u.group_id', 'g.id'), 'g.name = ?1')) + // Example - $qb->innerJoin('u.Group', 'g', 'ON', 'u.group_id = g.id AND g.name = ?1') + public function innerJoin($join, $alias = null, $conditionType = null, $condition = null); + + // Example - $qb->leftJoin('u.Phonenumbers', 'p', Expr\Join::WITH, $qb->expr()->eq('p.area_code', 55)) + // Example - $qb->leftJoin('u.Phonenumbers', 'p', 'WITH', 'p.area_code = 55') + public function leftJoin($join, $alias = null, $conditionType = null, $condition = null); + + // NOTE: ->where() overrides all previously set conditions + // + // Example - $qb->where('u.firstName = ?1', $qb->expr()->eq('u.surname', '?2')) + // Example - $qb->where($qb->expr()->andx($qb->expr()->eq('u.firstName', '?1'), $qb->expr()->eq('u.surname', '?2'))) + // Example - $qb->where('u.firstName = ?1 AND u.surname = ?2') + public function where($where); + + // Example - $qb->andWhere($qb->expr()->orx($qb->expr()->lte('u.age', 40), 'u.numChild = 0')) + public function andWhere($where); + + // Example - $qb->orWhere($qb->expr()->between('u.id', 1, 10)); + public function orWhere($where); + + // NOTE: -> groupBy() overrides all previously set grouping conditions + // + // Example - $qb->groupBy('u.id') + public function groupBy($groupBy); + + // Example - $qb->addGroupBy('g.name') + public function addGroupBy($groupBy); + + // NOTE: -> having() overrides all previously set having conditions + // + // Example - $qb->having('u.salary >= ?1') + // Example - $qb->having($qb->expr()->gte('u.salary', '?1')) + public function having($having); + + // Example - $qb->andHaving($qb->expr()->gt($qb->expr()->count('u.numChild'), 0)) + public function andHaving($having); + + // Example - $qb->orHaving($qb->expr()->lte('g.managerLevel', '100')) + public function orHaving($having); + + // NOTE: -> orderBy() overrides all previously set ordering conditions + // + // Example - $qb->orderBy('u.surname', 'DESC') + public function orderBy($sort, $order = null); + + // Example - $qb->addOrderBy('u.firstName') + public function addOrderBy($sort, $order = null); // Default $order = 'ASC' + } + + diff --git a/manual/en/query-builder.txt b/manual/en/query-builder.txt index 0ad69b3e3..5f15bed7a 100644 --- a/manual/en/query-builder.txt +++ b/manual/en/query-builder.txt @@ -1,17 +1,17 @@ -++ The QueryBuilder +## The QueryBuilder A `QueryBuilder` provides an API that is designed for conditionally constructing a DQL query in several steps. It provides a set of classes and methods that is able to programmatically build queries, and also provides a fluent API. This means that you can change between one methodology to the other as you want, and also pick one if you prefer. -+++ Constructing a new QueryBuilder object +### Constructing a new QueryBuilder object The same way you build a normal Query, you build a `QueryBuilder` object, just providing the correct method name. Here is an example how to build a `QueryBuilder` object: - [php] + add('where', 'u.id = ?1') ->add('orderBy', 'u.name ASC'); -++++ Binding parameters to your query +#### Binding parameters to your query Doctrine supports dynamic binding of parameters to your query, similar to preparing queries. You can use both strings and numbers as placeholders, although both have a slightly different syntax. Additionally, you must make your choice: Mixing both styles is not allowed. Binding parameters can simply be achieved as follows: - [php] + expr()->*` methods. Here is a converted example 8 to suggested standard way to build queries: - [php] + select('u') diff --git a/manual/en/tools.rst b/manual/en/tools.rst new file mode 100644 index 000000000..79941ea1d --- /dev/null +++ b/manual/en/tools.rst @@ -0,0 +1,376 @@ +The Doctrine Console +-------------------- + +The Doctrine Console is a Command Line Interface tool for +simplifying common tasks during the development of a project that +uses Doctrine 2. + +Installation +~~~~~~~~~~~~ + +If you installed Doctrine 2 through PEAR, the ``doctrine`` command +line tool should already be available to you. + +If you use Doctrine through SVN or a release package you need to +copy the ``doctrine`` and ``doctrine.php`` files from the +``tools/sandbox`` or ``bin`` folder, respectively, to a location of +your choice, for example a ``tools`` folder of your project. You +probably need to edit ``doctrine.php`` to adjust some paths to the +new environment, most importantly the first line that includes the +``Doctrine\Common\ClassLoader``. + +Getting Help +~~~~~~~~~~~~ + +Type ``doctrine`` on the command line and you should see an +overview of the available commands or use the --help flag to get +information on the available commands. If you want to know more +about the use of generate entities for example, you can call: + +:: + + doctrine orm:generate-entities --help + +Configuration +~~~~~~~~~~~~~ + +Whenever the ``doctrine`` command line tool is invoked, it can +access alls Commands that were registered by developer. There is no +auto-detection mechanism at work. The ``bin\doctrine.php`` file +already registers all the commands that currently ship with +Doctrine DBAL and ORM. If you want to use additional commands you +have to register them yourself. + +All the commands of the Doctrine Console require either the ``db`` +or the ``em`` helpers to be defined in order to work correctly. +Doctrine Console requires the definition of a HelperSet that is the +DI tool to be injected in the Console. In case of a project that is +dealing exclusively with DBAL, the ConnectionHelper is required: + +:: + + new \Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper($conn) + )); + $cli->setHelperSet($helperSet); + +When dealing with the ORM package, the EntityManagerHelper is +required: + +:: + + new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($em) + )); + $cli->setHelperSet($helperSet); + +The HelperSet instance has to be generated in a separate file (i.e. +``cli-config.php``) that contains typical Doctrine bootstrap code +and predefines the needed HelperSet attributes mentioned above. A +typical ``cli-config.php`` file looks as follows: + +:: + + register(); + + $classLoader = new \Doctrine\Common\ClassLoader('Proxies', __DIR__); + $classLoader->register(); + + $config = new \Doctrine\ORM\Configuration(); + $config->setMetadataCacheImpl(new \Doctrine\Common\Cache\ArrayCache); + $config->setProxyDir(__DIR__ . '/Proxies'); + $config->setProxyNamespace('Proxies'); + + $connectionOptions = array( + 'driver' => 'pdo_sqlite', + 'path' => 'database.sqlite' + ); + + $em = \Doctrine\ORM\EntityManager::create($connectionOptions, $config); + + $helperSet = new \Symfony\Components\Console\Helper\HelperSet(array( + 'db' => new \Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper($em->getConnection()), + 'em' => new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($em) + )); + +It is important to define a correct HelperSet that doctrine.php +script will ultimately use. The Doctrine Binary will automatically +find the first instance of HelperSet in the global variable +namespace and use this. + +You can also add your own commands on-top of the Doctrine supported +tools. To include a new command on Doctrine Console, you need to +do: + +:: + + addCommand(new \MyProject\Tools\Console\Commands\MyCustomCommand()); + +Additionally, include multiple commands (and overriding previously +defined ones) is possible through the command: + +:: + + addCommands(array( + new \MyProject\Tools\Console\Commands\MyCustomCommand(), + new \MyProject\Tools\Console\Commands\SomethingCommand(), + new \MyProject\Tools\Console\Commands\AnotherCommand(), + new \MyProject\Tools\Console\Commands\OneMoreCommand(), + )); + +Command Overview +~~~~~~~~~~~~~~~~ + +The following Commands are currently available: + + +- ``help`` Displays help for a command (?) +- ``list`` Lists commands +- ``dbal:import`` Import SQL file(s) directly to Database. +- ``dbal:run-sql`` Executes arbitrary SQL directly from the + command line. +- ``orm:clear-cache:metadata`` Clear all metadata cache of the + various cache drivers. +- ``orm:clear-cache:query`` Clear all query cache of the various + cache drivers. +- ``orm:clear-cache:result`` Clear result cache of the various + cache drivers. +- ``orm:convert-d1-schema`` Converts Doctrine 1.X schema into a + Doctrine 2.X schema. +- ``orm:convert-mapping`` Convert mapping information between + supported formats. +- ``orm:ensure-production-settings`` Verify that Doctrine is + properly configured for a production environment. +- ``orm:generate-entities`` Generate entity classes and method + stubs from your mapping information. +- ``orm:generate-proxies`` Generates proxy classes for entity + classes. +- ``orm:generate-repositories`` Generate repository classes from + your mapping information. +- ``orm:run-dql`` Executes arbitrary DQL directly from the command + line. +- ``orm:schema-tool:create`` Processes the schema and either + create it directly on EntityManager Storage Connection or generate + the SQL output. +- ``orm:schema-tool:drop`` Processes the schema and either drop + the database schema of EntityManager Storage Connection or generate + the SQL output. +- ``orm:schema-tool:update`` Processes the schema and either + update the database schema of EntityManager Storage Connection or + generate the SQL output. + +Database Schema Generation +-------------------------- + + **Note** + + SchemaTool can do harm to your database. It will drop or alter + tables, indexes, sequences and such. Please use this tool with + caution in development and not on a production server. It is meant + for helping you develop your Database Schema, but NOT with + migrating schema from A to B in production. A safe approach would + be generating the SQL on development server and saving it into SQL + Migration files that are executed manually on the production + server. + + SchemaTool assumes your Doctrine Project uses the given database on + its own. Update and Drop commands will mess with other tables if + they are not related to the current project that is using Doctrine. + Please be careful! + + +To generate your database schema from your Doctrine mapping files +you can use the ``SchemaTool`` class or the ``schema-tool`` Console +Command. + +When using the SchemaTool class directly, create your schema using +the ``createSchema()`` method. First create an instance of the +``SchemaTool`` and pass it an instance of the ``EntityManager`` +that you want to use to create the schema. This method receives an +array of ``ClassMetadataInfo`` instances. + +:: + + getClassMetadata('Entities\User'), + $em->getClassMetadata('Entities\Profile') + ); + $tool->createSchema($classes); + +To drop the schema you can use the ``dropSchema()`` method. + +:: + + dropSchema($classes); + +This drops all the tables that are currently used by your metadata +model. When you are changing your metadata a lot during development +you might want to drop the complete database instead of only the +tables of the current model to clean up with orphaned tables. + +:: + + dropSchema($classes, \Doctrine\ORM\Tools\SchemaTool::DROP_DATABASE); + +You can also use database introspection to update your schema +easily with the ``updateSchema()`` method. It will compare your +existing database schema to the passed array of +``ClassMetdataInfo`` instances. + +:: + + updateSchema($classes); + +If you want to use this functionality from the command line you can +use the ``schema-tool`` command. + +To create the schema use the ``create`` command: + +:: + + $ php doctrine orm:schema-tool:create + +To drop the schema use the ``drop`` command: + +:: + + $ php doctrine orm:schema-tool:drop + +If you want to drop and then recreate the schema then use both +options: + +:: + + $ php doctrine orm:schema-tool:drop + $ php doctrine orm:schema-tool:create + +As you would think, if you want to update your schema use the +``update`` command: + +:: + + $ php doctrine orm:schema-tool:update + +All of the above commands also accept a ``--dump-sql`` option that +will output the SQL for the ran operation. + +:: + + $ php doctrine orm:schema-tool:create --dump-sql + +Before using the orm:schema-tool commands, remember to configure +your cli-config.php properly. + + **NOTE** + + When using the Annotation Mapping Driver you have to either setup + your autoloader in the cli-config.php correctly to find all the + entities, or you can use the second argument of the + ``EntityManagerHelper`` to specify all the paths of your entities + (or mapping files), i.e. + ``new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($em, $mappingPaths);`` + + +Convert Mapping Information +--------------------------- + +To convert some mapping information between the various supported +formats you can use the ``ClassMetadataExporter`` to get exporter +instances for the different formats: + +:: + + getExporter('yml', '/path/to/export/yml'); + +Now you can export some ``ClassMetadata`` instances: + +:: + + getClassMetadata('Entities\User'), + $em->getClassMetadata('Entities\Profile') + ); + $exporter->setMetadata($classes); + $exporter->export(); + +This functionality is also available from the command line to +convert your loaded mapping information to another format. The +``orm:convert-mapping`` command accepts two arguments, the type to +convert to and the path to generate it: + +:: + + $ php doctrine orm:convert-mapping xml /path/to/mapping-path-converted-to-xml + +Reverse Engineering +------------------- + +You can use the ``DatabaseDriver`` to reverse engineer a database +to an array of ``ClassMetadataInfo`` instances and generate YAML, +XML, etc. from them. + +First you need to retrieve the metadata instances with the +``DatabaseDriver``: + +:: + + getConfiguration()->setMetadataDriverImpl( + new \Doctrine\ORM\Mapping\Driver\DatabaseDriver( + $em->getConnection()->getSchemaManager() + ) + ); + + $cmf = new DisconnectedClassMetadataFactory($em); + $metadata = $cmf->getAllMetadata(); + +Now you can get an exporter instance and export the loaded metadata +to yml: + +:: + + getExporter('yml', '/path/to/export/yml'); + $exporter->setMetadata($metadata); + $exporter->export(); + +You can also reverse engineer a database using the +``orm:convert-mapping`` command: + +:: + + $ php doctrine orm:convert-mapping --from-database yml /path/to/mapping-path-converted-to-yml + + **CAUTION** Reverse Engineering is not always working perfectly + depending on special cases. It will only detect Many-To-One + relations (even if they are One-To-One) and will try to create + entities from Many-To-Many tables. It also has problems with naming + of foreign keys that have multiple column names. Any Reverse + Engineered Database-Schema needs considerable manual work to become + a useful domain model. + + + diff --git a/manual/en/tools.txt b/manual/en/tools.txt index d461bafcf..221ce89ce 100644 --- a/manual/en/tools.txt +++ b/manual/en/tools.txt @@ -1,21 +1,21 @@ -++ The Doctrine Console +## The Doctrine Console The Doctrine Console is a Command Line Interface tool for simplifying common tasks during the development of a project that uses Doctrine 2. -+++ Installation +### Installation If you installed Doctrine 2 through PEAR, the `doctrine` command line tool should already be available to you. If you use Doctrine through SVN or a release package you need to copy the `doctrine` and `doctrine.php` files from the `tools/sandbox` or `bin` folder, respectively, to a location of your choice, for example a `tools` folder of your project. You probably need to edit `doctrine.php` to adjust some paths to the new environment, most importantly the first line that includes the `Doctrine\Common\ClassLoader`. -+++ Getting Help +### Getting Help Type `doctrine` on the command line and you should see an overview of the available commands or use the --help flag to get information on the available commands. If you want to know more about the use of generate entities for example, you can call: doctrine orm:generate-entities --help -+++ Configuration +### Configuration Whenever the `doctrine` command line tool is invoked, it can access alls Commands that were registered by developer. There is no auto-detection mechanism at work. The `bin\doctrine.php` file already registers all the commands that @@ -24,7 +24,7 @@ currently ship with Doctrine DBAL and ORM. If you want to use additional command All the commands of the Doctrine Console require either the `db` or the `em` helpers to be defined in order to work correctly. Doctrine Console requires the definition of a HelperSet that is the DI tool to be injected in the Console. In case of a project that is dealing exclusively with DBAL, the ConnectionHelper is required: - [php] + new \Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper($conn) )); @@ -32,7 +32,7 @@ In case of a project that is dealing exclusively with DBAL, the ConnectionHelper When dealing with the ORM package, the EntityManagerHelper is required: - [php] + new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($em) )); @@ -41,7 +41,7 @@ When dealing with the ORM package, the EntityManagerHelper is required: The HelperSet instance has to be generated in a separate file (i.e. `cli-config.php`) that contains typical Doctrine bootstrap code and predefines the needed HelperSet attributes mentioned above. A typical `cli-config.php` file looks as follows: - [php] + addCommand(new \MyProject\Tools\Console\Commands\MyCustomCommand()); Additionally, include multiple commands (and overriding previously defined ones) is possible through the command: - [php] + addCommands(array( new \MyProject\Tools\Console\Commands\MyCustomCommand(), new \MyProject\Tools\Console\Commands\SomethingCommand(), @@ -86,7 +86,7 @@ Additionally, include multiple commands (and overriding previously defined ones) new \MyProject\Tools\Console\Commands\OneMoreCommand(), )); -+++ Command Overview +### Command Overview The following Commands are currently available: @@ -108,7 +108,7 @@ The following Commands are currently available: * `orm:schema-tool:drop` Processes the schema and either drop the database schema of EntityManager Storage Connection or generate the SQL output. * `orm:schema-tool:update` Processes the schema and either update the database schema of EntityManager Storage Connection or generate the SQL output. -++ Database Schema Generation +## Database Schema Generation > **Note** > @@ -126,7 +126,7 @@ To generate your database schema from your Doctrine mapping files you can use th When using the SchemaTool class directly, create your schema using the `createSchema()` method. First create an instance of the `SchemaTool` and pass it an instance of the `EntityManager` that you want to use to create the schema. This method receives an array of `ClassMetadataInfo` instances. - [php] + getClassMetadata('Entities\User'), @@ -136,7 +136,7 @@ When using the SchemaTool class directly, create your schema using the `createSc To drop the schema you can use the `dropSchema()` method. - [php] + dropSchema($classes); This drops all the tables that are currently used by your metadata model. @@ -144,14 +144,14 @@ When you are changing your metadata a lot during development you might want to drop the complete database instead of only the tables of the current model to clean up with orphaned tables. - [php] + dropSchema($classes, \Doctrine\ORM\Tools\SchemaTool::DROP_DATABASE); You can also use database introspection to update your schema easily with the `updateSchema()` method. It will compare your existing database schema to the passed array of `ClassMetdataInfo` instances. - [php] + updateSchema($classes); If you want to use this functionality from the command line you can use the @@ -188,23 +188,23 @@ Before using the orm:schema-tool commands, remember to configure your cli-config > specify all the paths of your entities (or mapping files), i.e. > `new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($em, $mappingPaths);` -++ Convert Mapping Information +## Convert Mapping Information To convert some mapping information between the various supported formats you can use the `ClassMetadataExporter` to get exporter instances for the different formats: - [php] + getExporter('yml', '/path/to/export/yml'); Now you can export some `ClassMetadata` instances: - [php] + getClassMetadata('Entities\User'), $em->getClassMetadata('Entities\Profile') @@ -218,14 +218,14 @@ accepts two arguments, the type to convert to and the path to generate it: $ php doctrine orm:convert-mapping xml /path/to/mapping-path-converted-to-xml -++ Reverse Engineering +## Reverse Engineering You can use the `DatabaseDriver` to reverse engineer a database to an array of `ClassMetadataInfo` instances and generate YAML, XML, etc. from them. First you need to retrieve the metadata instances with the `DatabaseDriver`: - [php] + getConfiguration()->setMetadataDriverImpl( new \Doctrine\ORM\Mapping\Driver\DatabaseDriver( $em->getConnection()->getSchemaManager() @@ -237,7 +237,7 @@ First you need to retrieve the metadata instances with the `DatabaseDriver`: Now you can get an exporter instance and export the loaded metadata to yml: - [php] + getExporter('yml', '/path/to/export/yml'); $exporter->setMetadata($metadata); $exporter->export(); diff --git a/manual/en/transactions-and-concurrency.rst b/manual/en/transactions-and-concurrency.rst new file mode 100644 index 000000000..19692f1ac --- /dev/null +++ b/manual/en/transactions-and-concurrency.rst @@ -0,0 +1,351 @@ +Transaction Demarcation +----------------------- + +Transaction demarcation is the task of defining your transaction +boundaries. Proper transaction demarcation is very important +because if not done properly it can negatively affect the +performance of your application. Many databases and database +abstraction layers like PDO by default operate in auto-commit mode, +which means that every single SQL statement is wrapped in a small +transaction. Without any explicit transaction demarcation from your +side, this quickly results in poor performance because transactions +are not cheap. + +For the most part, Doctrine 2 already takes care of proper +transaction demarcation for you: All the write operations +(INSERT/UPDATE/DELETE) are queued until ``EntityManager#flush()`` +is invoked which wraps all of these changes in a single +transaction. + +However, Doctrine 2 also allows (and encourages) you to take over +and control transaction demarcation yourself. + +These are two ways to deal with transactions when using the +Doctrine ORM and are now described in more detail. + +Approach 1: Implicitly +~~~~~~~~~~~~~~~~~~~~~~ + +The first approach is to use the implicit transaction handling +provided by the Doctrine ORM EntityManager. Given the following +code snippet, without any explicit transaction demarcation: + +:: + + setName('George'); + $em->persist($user); + $em->flush(); + +Since we do not do any custom transaction demarcation in the above +code, ``EntityManager#flush()`` will begin and commit/rollback a +transaction. This behavior is made possible by the aggregation of +the DML operations by the Doctrine ORM and is sufficient if all the +data manipulation that is part of a unit of work happens through +the domain model and thus the ORM. + +Approach 2: Explicitly +~~~~~~~~~~~~~~~~~~~~~~ + +The explicit alternative is to use the ``Doctrine\DBAL\Connection`` +API directly to control the transaction boundaries. The code then +looks like this: + +:: + + getConnection()->beginTransaction(); // suspend auto-commit + try { + //... do some work + $user = new User; + $user->setName('George'); + $em->persist($user); + $em->flush(); + $em->getConnection()->commit(); + } catch (Exception $e) { + $em->getConnection()->rollback(); + $em->close(); + throw $e; + } + +Explicit transaction demarcation is required when you want to +include custom DBAL operations in a unit of work or when you want +to make use of some methods of the ``EntityManager`` API that +require an active transaction. Such methods will throw a +``TransactionRequiredException`` to inform you of that +requirement. + +A more convenient alternative for explicit transaction demarcation +is the use of provided control abstractions in the form of +``Connection#transactional($func)`` and +``EntityManager#transactional($func)``. When used, these control +abstractions ensure that you never forget to rollback the +transaction or close the ``EntityManager``, apart from the obvious +code reduction. An example that is functionally equivalent to the +previously shown code looks as follows: + +:: + + transactional(function($em) { + //... do some work + $user = new User; + $user->setName('George'); + $em->persist($user); + }); + +The difference between ``Connection#transactional($func)`` and +``EntityManager#transactional($func)`` is that the latter +abstraction flushes the ``EntityManager`` prior to transaction +commit and also closes the ``EntityManager`` properly when an +exception occurs (in addition to rolling back the transaction). + +Exception Handling +~~~~~~~~~~~~~~~~~~ + +When using implicit transaction demarcation and an exception occurs +during ``EntityManager#flush()``, the transaction is automatically +rolled back and the ``EntityManager`` closed. + +When using explicit transaction demarcation and an exception +occurs, the transaction should be rolled back immediately and the +``EntityManager`` closed by invoking ``EntityManager#close()`` and +subsequently discarded, as demonstrated in the example above. This +can be handled elegantly by the control abstractions shown earlier. +Note that when catching ``Exception`` you should generally re-throw +the exception. If you intend to recover from some exceptions, catch +them explicitly in earlier catch blocks (but do not forget to +rollback the transaction and close the ``EntityManager`` there as +well). All other best practices of exception handling apply +similarly (i.e. either log or re-throw, not both, etc.). + +As a result of this procedure, all previously managed or removed +instances of the ``EntityManager`` become detached. The state of +the detached objects will be the state at the point at which the +transaction was rolled back. The state of the objects is in no way +rolled back and thus the objects are now out of synch with the +database. The application can continue to use the detached objects, +knowing that their state is potentially no longer accurate. + +If you intend to start another unit of work after an exception has +occurred you should do that with a new ``EntityManager``. + +Locking Support +--------------- + +Doctrine 2 offers support for Pessimistic- and Optimistic-locking +strategies natively. This allows to take very fine-grained control +over what kind of locking is required for your Entities in your +application. + +Optimistic Locking +~~~~~~~~~~~~~~~~~~ + +Database transactions are fine for concurrency control during a +single request. However, a database transaction should not span +across requests, the so-called "user think time". Therefore a +long-running "business transaction" that spans multiple requests +needs to involve several database transactions. Thus, database +transactions alone can no longer control concurrency during such a +long-running business transaction. Concurrency control becomes the +partial responsibility of the application itself. + +Doctrine has integrated support for automatic optimistic locking +via a version field. In this approach any entity that should be +protected against concurrent modifications during long-running +business transactions gets a version field that is either a simple +number (mapping type: integer) or a timestamp (mapping type: +datetime). When changes to such an entity are persisted at the end +of a long-running conversation the version of the entity is +compared to the version in the database and if they don't match, an +``OptimisticLockException`` is thrown, indicating that the entity +has been modified by someone else already. + +You designate a version field in an entity as follows. In this +example we'll use an integer. + +:: + + find('User', $theEntityId, LockMode::OPTIMISTIC, $expectedVersion); + + // do the work + + $em->flush(); + } catch(OptimisticLockException $e) { + echo "Sorry, but someone else has already changed this entity. Please apply the changes again!"; + } + +Or you can use ``EntityManager#lock()`` to find out: + +:: + + find('User', $theEntityId); + + try { + // assert version + $em->lock($entity, LockMode::OPTIMISTIC, $expectedVersion); + + } catch(OptimisticLockException $e) { + echo "Sorry, but someone else has already changed this entity. Please apply the changes again!"; + } + +Important Implementation Notes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can easily get the optimistic locking workflow wrong if you +compare the wrong versions. Say you have Alice and Bob accessing a +hypothetical bank account: + + +- Alice reads the headline of the blog post being "Foo", at + optimistic lock version 1 (GET Request) +- Bob reads the headline of the blog post being "Foo", at + optimistic lock version 1 (GET Request) +- Bob updates the headline to "Bar", upgrading the optimistic lock + version to 2 (POST Request of a Form) +- Alice updates the headline to "Baz", ... (POST Request of a + Form) + +Now at the last stage of this scenario the blog post has to be read +again from the database before Alice's headline can be applied. At +this point you will want to check if the blog post is still at +version 1 (which it is not in this scenario). + +Using optimistic locking correctly, you *have* to add the version +as an additional hidden field (or into the SESSION for more +safety). Otherwise you cannot verify the version is still the one +being originally read from the database when Alice performed her +GET request for the blog post. If this happens you might see lost +updates you wanted to prevent with Optimistic Locking. + +See the example code, The form (GET Request): + +:: + + find('BlogPost', 123456); + + echo ''; + echo ''; + +And the change headline action (POST Request): + +:: + + find('BlogPost', $postId, \Doctrine\DBAL\LockMode::OPTIMISTIC, $postVersion); + +Pessimistic Locking +~~~~~~~~~~~~~~~~~~~ + +Doctrine 2 supports Pessimistic Locking at the database level. No +attempt is being made to implement pessimistic locking inside +Doctrine, rather vendor-specific and ANSI-SQL commands are used to +acquire row-level locks. Every Entity can be part of a pessimistic +lock, there is no special metadata required to use this feature. + +However for Pessimistic Locking to work you have to disable the +Auto-Commit Mode of your Database and start a transaction around +your pessimistic lock use-case using the "Approach 2: Explicit +Transaction Demarcation" described above. Doctrine 2 will throw an +Exception if you attempt to acquire an pessimistic lock and no +transaction is running. + +Doctrine 2 currently supports two pessimistic lock modes: + + +- Pessimistic Write + (``Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE``), locks the + underlying database rows for concurrent Read and Write Operations. +- Pessimistic Read (``Doctrine\DBAL\LockMode::PESSIMISTIC_READ``), + locks other concurrent requests that attempt to update or lock rows + in write mode. + +You can use pessimistic locks in three different scenarios: + + +1. Using + ``EntityManager#find($className, $id, \Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE)`` + or + ``EntityManager#find($className, $id, \Doctrine\DBAL\LockMode::PESSIMISTIC_READ)`` +2. Using + ``EntityManager#lock($entity, \Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE)`` + or + ``EntityManager#lock($entity, \Doctrine\DBAL\LockMode::PESSIMISTIC_READ)`` +3. Using + ``Query#setLockMode(\Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE)`` + or + ``Query#setLockMode(\Doctrine\DBAL\LockMode::PESSIMISTIC_READ)`` + + diff --git a/manual/en/transactions-and-concurrency.txt b/manual/en/transactions-and-concurrency.txt index 7d49539ed..550f8e52e 100644 --- a/manual/en/transactions-and-concurrency.txt +++ b/manual/en/transactions-and-concurrency.txt @@ -1,4 +1,4 @@ -++ Transaction Demarcation +## Transaction Demarcation Transaction demarcation is the task of defining your transaction boundaries. Proper transaction demarcation is very important because if not done properly it can negatively affect the performance of your application. @@ -14,12 +14,12 @@ However, Doctrine 2 also allows (and encourages) you to take over and control tr These are two ways to deal with transactions when using the Doctrine ORM and are now described in more detail. -+++ Approach 1: Implicitly +### Approach 1: Implicitly The first approach is to use the implicit transaction handling provided by the Doctrine ORM EntityManager. Given the following code snippet, without any explicit transaction demarcation: - [php] + setName('George'); @@ -32,12 +32,12 @@ by the Doctrine ORM and is sufficient if all the data manipulation that is part through the domain model and thus the ORM. -+++ Approach 2: Explicitly +### Approach 2: Explicitly The explicit alternative is to use the `Doctrine\DBAL\Connection` API directly to control the transaction boundaries. The code then looks like this: - [php] + getConnection()->beginTransaction(); // suspend auto-commit try { @@ -63,7 +63,7 @@ When used, these control abstractions ensure that you never forget to rollback t close the `EntityManager`, apart from the obvious code reduction. An example that is functionally equivalent to the previously shown code looks as follows: - [php] + transactional(function($em) { //... do some work @@ -77,7 +77,7 @@ that the latter abstraction flushes the `EntityManager` prior to transaction com the `EntityManager` properly when an exception occurs (in addition to rolling back the transaction). -+++ Exception Handling +### Exception Handling When using implicit transaction demarcation and an exception occurs during `EntityManager#flush()`, the transaction is automatically rolled back and the `EntityManager` closed. @@ -98,12 +98,12 @@ accurate. If you intend to start another unit of work after an exception has occurred you should do that with a new `EntityManager`. -++ Locking Support +## Locking Support Doctrine 2 offers support for Pessimistic- and Optimistic-locking strategies natively. This allows to take very fine-grained control over what kind of locking is required for your Entities in your application. -+++ Optimistic Locking +### Optimistic Locking Database transactions are fine for concurrency control during a single request. However, a database transaction should not span across requests, the so-called "user think time". Therefore a long-running "business transaction" @@ -120,7 +120,7 @@ entity has been modified by someone else already. You designate a version field in an entity as follows. In this example we'll use an integer. - [php] + find('BlogPost', 123456); echo ''; @@ -220,13 +220,13 @@ See the example code, The form (GET Request): And the change headline action (POST Request): - [php] + find('BlogPost', $postId, \Doctrine\DBAL\LockMode::OPTIMISTIC, $postVersion); -+++ Pessimistic Locking +### Pessimistic Locking Doctrine 2 supports Pessimistic Locking at the database level. No attempt is being made to implement pessimistic locking inside Doctrine, rather vendor-specific and ANSI-SQL commands are used to acquire row-level locks. Every Entity can diff --git a/manual/en/working-with-associations.rst b/manual/en/working-with-associations.rst new file mode 100644 index 000000000..12d2f10a6 --- /dev/null +++ b/manual/en/working-with-associations.rst @@ -0,0 +1,521 @@ +Associations between entities are represented just like in regular +object-oriented PHP, with references to other objects or +collections of objects. When it comes to persistence, it is +important to understand three main things: + + +- The concept of owning and inverse sides in bidirectional + associations as described + `here `_. +- If an entity is removed from a collection, the association is + removed, not the entity itself. A collection of entities always + only represents the association to the containing entities, not the + entity itself. +- Collection-valued persistent fields have to be instances of the + ``Doctrine\Common\Collections\Collection`` interface. + `See here `_ + for more details. + +Changes to associations in your code are not synchronized to the +database directly, but upon calling ``EntityManager#flush()``. + +To describe all the concepts of working with associations we +introduce a specific set of example entities that show all the +different flavors of association management in Doctrine. + +Association Example Entities +---------------------------- + +We will use a simple comment system with Users and Comments as +entities to show examples of association management. See the PHP +docblocks of each association in the following example for +information about its type and if its the owning or inverse side. + +:: + + commentsRead; + } + + public function setFirstComment(Comment $c) { + $this->firstComment = $c; + } + } + +The interaction code would then look like in the following snippet +(``$em`` here is an instance of the EntityManager): + +:: + + find('User', $userId); + + // unidirectional many to many + $comment = $em->find('Comment', $readCommentId); + $user->getReadComments()->add($comment); + + $em->flush(); + + // unidirectional many to one + $myFirstComment = new Comment(); + $user->setFirstComment($myFirstComment); + + $em->persist($myFirstComment); + $em->flush(); + +In the case of bi-directional associations you have to update the +fields on both sides: + +:: + + commentsAuthored; + } + + public function getFavoriteComments() { + return $this->favorites; + } + } + + class Comment + { + // ... + + public function getUserFavorites() { + return $this->userFavorites; + } + + public function setAuthor(User $author = null) { + $this->author = $author; + } + } + + // Many-to-Many + $user->getFavorites()->add($favoriteComment); + $favoriteComment->getUserFavorites()->add($user); + + $em->flush(); + + // Many-To-One / One-To-Many Bidirectional + $newComment = new Comment(); + $user->getAuthoredComments()->add($newComment); + $newComment->setAuthor($user); + + $em->persist($newComment); + $em->flush(); + +Notice how always both sides of the bidirectional association are +updated. The previous unidirectional associations were simpler to +handle. + +Removing Associations +--------------------- + +Removing an association between two entities is similarly +straight-forward. There are two strategies to do so, by key and by +element. Here are some examples: + +:: + + getComments()->removeElement($comment); + $comment->setAuthor(null); + + $user->getFavorites()->removeElement($comment); + $comment->getUserFavorites()->removeElement($user); + + // Remove by Key + $user->getComments()->removeElement($ithComment); + $comment->setAuthor(null); + +You need to call ``$em->flush()`` to make persist these changes in +the database permanently. + +Notice how both sides of the bidirectional association are always +updated. Unidirectional associations are consequently simpler to +handle. Also note that if you type-hint your methods, i.e. +``setAddress(Address $address)``, then PHP does only allows null +values if ``null`` is set as default value. Otherwise +setAddress(null) will fail for removing the association. If you +insist on type-hinting a typical way to deal with this is to +provide a special method, like ``removeAddress()``. This can also +provide better encapsulation as it hides the internal meaning of +not having an address. + +When working with collections, keep in mind that a Collection is +essentially an ordered map (just like a PHP array). That is why the +``remove`` operation accepts an index/key. ``removeElement`` is a +separate method that has O(n) complexity using ``array_search``, +where n is the size of the map. + + **NOTE** + + Since Doctrine always only looks at the owning side of a + bidirectional association for updates, it is not necessary for + write operations that an inverse collection of a bidirectional + one-to-many or many-to-many association is updated. This knowledge + can often be used to improve performance by avoiding the loading of + the inverse collection. + + +You can also clear the contents of a whole collection using the +``Collections::clear()`` method. You should be aware that using +this method can lead to a straight and optimized database delete or +update call during the flush operation that is not aware of +entities that have been re-added to the collection. + +Say you clear a collection of tags by calling +``$post->getTags()->clear();`` and then call +``$post->getTags()->add($tag)``. This will not recognize tag being +already added before and issue two database calls. + +Association Management Methods +------------------------------ + +It is generally a good idea to encapsulate proper association +management inside the entity classes. This makes it easier to use +the class correctly and can encapsulate details about how the +association is maintained. + +The following code shows updates to the previous User and Comment +example that encapsulate much of the association management code: + +:: + + commentsRead[] = $comment; + } + + public function addComment(Comment $comment) { + if (count($this->commentsAuthored) == 0) { + $this->setFirstComment($comment); + } + $this->comments[] = $comment; + $comment->setAuthor($this); + } + + private function setFirstComment(Comment $c) { + $this->firstComment = $c; + } + + public function addFavorite(Comment $comment) { + $this->favorites->add($comment); + $comment->addUserFavorite($this); + } + + public function removeFavorite(Comment $comment) { + $this->favorites->removeElement($comment); + $comment->removeUserFavorite($this); + } + } + + class Comment + { + // .. + + public function addUserFavorite(User $user) { + $this->userFavorites[] = $user; + } + + public function removeUserFavorite(User $user) { + $this->userFavorites->removeElement($user); + } + } + +You will notice that ``addUserFavorite`` and ``removeUserFavorite`` +do not call ``addFavorite`` and ``removeFavorite``, thus the +bidirectional association is strictly-speaking still incomplete. +However if you would naively add the ``addFavorite`` in +``addUserFavorite``, you end up with an infinite loop, so more work +is needed. As you can see, proper bidirectional association +management in plain OOP is a non-trivial task and encapsulating all +the details inside the classes can be challenging. + + **NOTE** + + If you want to make sure that your collections are perfectly + encapsulated you should not return them from a + ``getCollectionName()`` method directly, but call + ``$collection->toArray()``. This way a client programmer for the + entity cannot circumvent the logic you implement on your entity for + association management. For example: + + +:: + + commentsRead->toArray(); + } + } + +This will however always initialize the collection, with all the +performance penalties given the size. In some scenarios of large +collections it might even be a good idea to completely hide the +read access behind methods on the EntityRepository. + +There is no single, best way for association management. It greatly +depends on the requirements of your concrete domain model as well +as your preferences. + +Synchronizing Bidirectional Collections +--------------------------------------- + +In the case of Many-To-Many associations you as the developer are +responsible to keep the collections on the owning and inverse side +up in sync, when you apply changes to them. Doctrine can only +guarantee a consistent state for the hydration, not for your client +code. + +Using the User-Comment entities from above, a very simple example +can show the possible caveats you can encounter: + +:: + + getFavorites()->add($favoriteComment); + // not calling $favoriteComment->getUserFavorites()->add($user); + + $user->getFavorites()->contains($favoriteComment); // TRUE + $favoriteComment->getUserFavorites()->contains($user); // FALSE + +There are to approaches to handle this problem in your code: + + +1. Ignore updating the inverse side of bidirectional collections, + BUT never read from them in requests that changed their state. In + the next Request Doctrine hydrates the consistent collection state + again. +2. Always keep the bidirectional collections in sync through + association management methods. Reads of the Collections directly + after changes are consistent then. + +Transitive persistence / Cascade Operations +------------------------------------------- + +Persisting, removing, detaching and merging individual entities can +become pretty cumbersome, especially when a larger object graph +with collections is involved. Therefore Doctrine 2 provides a +mechanism for transitive persistence through cascading of these +operations. Each association to another entity or a collection of +entities can be configured to automatically cascade certain +operations. By default, no operations are cascaded. + +The following cascade options exist: + + +- persist : Cascades persist operations to the associated + entities. +- remove : Cascades remove operations to the associated entities. +- merge : Cascades merge operations to the associated entities. +- detach : Cascades detach operations to the associated entities. +- all : Cascades persist, remove, merge and detach operations to + associated entities. + +The following example is an extension to the User-Comment example +of this chapter. Suppose in our application a user is created +whenever he writes his first comment. In this case we would use the +following code: + +:: + + addComment($myFirstComment); + + $em->persist($user); + $em->persist($myFirstComment); + $em->flush(); + +Even if you *persist* a new User that contains our new Comment this +code would fail if you removed the call to +``EntityManager#persist($myFirstComment)``. Doctrine 2 does not +cascade the persist operation to all nested entities that are new +as well. + +More complicated is the deletion of all a users comments when he is +removed from the system: + +:: + + $user = $em->find('User', $deleteUserId); + + foreach ($user->getAuthoredComments() AS $comment) { + $em->remove($comment); + } + $em->remove($user); + $em->flush(); + +Without the loop over all the authored comments Doctrine would use +an UPDATE statement only to set the foreign key to NULL and only +the User would be deleted from the database during the +flush()-Operation. + +To have Doctrine handle both cases automatically we can change the +``User#commentsAuthored`` property to cascade both the "persist" +and the "remove" operation. + +:: + + find('User', $userId); // unidirectional many to many @@ -145,7 +145,7 @@ The interaction code would then look like in the following snippet (`$em` here i In the case of bi-directional associations you have to update the fields on both sides: - [php] + getComments()->removeElement($comment); $comment->setAuthor(null); @@ -232,14 +232,14 @@ Say you clear a collection of tags by calling `$post->getTags()->clear();` and t `$post->getTags()->add($tag)`. This will not recognize tag being already added before and issue two database calls. -++ Association Management Methods +## Association Management Methods It is generally a good idea to encapsulate proper association management inside the entity classes. This makes it easier to use the class correctly and can encapsulate details about how the association is maintained. The following code shows updates to the previous User and Comment example that encapsulate much of the association management code: - [php] + them from a `getCollectionName()` method directly, but call `$collection->toArray()`. This way a client programmer > for the entity cannot circumvent the logic you implement on your entity for association management. For example: - [php] + commentsRead->toArray(); @@ -310,7 +310,7 @@ methods on the EntityRepository. There is no single, best way for association management. It greatly depends on the requirements of your concrete domain model as well as your preferences. -++ Synchronizing Bidirectional Collections +## Synchronizing Bidirectional Collections In the case of Many-To-Many associations you as the developer are responsible to keep the collections on the owning and inverse side up in sync, when you apply changes to them. Doctrine can only guarantee a consistent @@ -318,7 +318,7 @@ state for the hydration, not for your client code. Using the User-Comment entities from above, a very simple example can show the possible caveats you can encounter: - [php] + getFavorites()->add($favoriteComment); // not calling $favoriteComment->getUserFavorites()->add($user); @@ -332,7 +332,7 @@ There are to approaches to handle this problem in your code: 2. Always keep the bidirectional collections in sync through association management methods. Reads of the Collections directly after changes are consistent then. -++ Transitive persistence / Cascade Operations +## Transitive persistence / Cascade Operations Persisting, removing, detaching and merging individual entities can become pretty cumbersome, especially when a larger object graph with collections is involved. @@ -353,7 +353,7 @@ The following example is an extension to the User-Comment example of this chapte Suppose in our application a user is created whenever he writes his first comment. In this case we would use the following code: - [php] + addComment($myFirstComment); @@ -383,7 +383,7 @@ during the flush()-Operation. To have Doctrine handle both cases automatically we can change the `User#commentsAuthored` property to cascade both the "persist" and the "remove" operation. - [php] + find('CMS\Article', 1234); + $article->setHeadline('Hello World dude!'); + + $article2 = $entityManager->find('CMS\Article', 1234); + echo $article2->getHeadline(); + +In this case the Article is accessed from the entity manager twice, +but modified in between. Doctrine 2 realizes this and will only +ever give you access to one instance of the Article with ID 1234, +no matter how often do you retrieve it from the EntityManager and +even no matter what kind of Query method you are using (find, +Repository Finder or DQL). This is called "Identity Map" pattern, +which means Doctrine keeps a map of each entity and ids that have +been retrieved per PHP request and keeps returning you the same +instances. + +In the previous example the echo prints "Hello World dude!" to the +screen. You can even verify that ``$article`` and ``$article2`` are +indeed pointing to the same instance by running the following +code: + +:: + + comments = new ArrayCollection(); + } + + public function getAuthor() { return $this->author; } + public function getComments() { return $this->comments; } + } + + $article = $em->find('Article', 1); + +This code only retrieves the ``User`` instance with id 1 executing +a single SELECT statement against the user table in the database. +You can still access the associated properties author and comments +and the associated objects they contain. + +This works by utilizing the lazy loading pattern. Instead of +passing you back a real Author instance and a collection of +comments Doctrine will create proxy instances for you. Only if you +access these proxies for the first time they will go through the +EntityManager and load their state from the database. + +This lazy-loading process happens behind the scenes, hidden from +your code. See the following code: + +:: + + find('Article', 1); + + // accessing a method of the user instance triggers the lazy-load + echo "Author: " . $article->getAuthor()->getName() . "\n"; + + // Lazy Loading Proxies pass instanceof tests: + if ($article->getAuthor() instanceof User) { + // a User Proxy is a generated "UserProxy" class + } + + // accessing the comments as an iterator triggers the lazy-load + // retrieving ALL the comments of this article from the database + // using a single SELECT statement + foreach ($article->getComments() AS $comment) { + echo $comment->getText() . "\n\n"; + } + + // Article::$comments passes instanceof tests for the Collection interface + // But it will NOT pass for the ArrayCollection interface + if ($article->getComments() instanceof \Doctrine\Common\Collections\Collection) { + echo "This will always be true!"; + } + +A slice of the generated proxy classes code looks like the +following piece of code. A real proxy class override ALL public +methods along the lines of the ``getName()`` method shown below: + +:: + + _load(); + return parent::getName(); + } + // .. other public methods of User + } + + **Warning** + + Traversing the object graph for parts that are lazy-loaded will + easily trigger lots of SQL queries and will perform badly if used + to heavily. Make sure to use DQL to fetch-join all the parts of the + object-graph that you need as efficiently as possible. + + +Persisting entities +------------------- + +An entity can be made persistent by passing it to the +``EntityManager#persist($entity)`` method. By applying the persist +operation on some entity, that entity becomes MANAGED, which means +that its persistence is from now on managed by an EntityManager. As +a result the persistent state of such an entity will subsequently +be properly synchronized with the database when +``EntityManager#flush()`` is invoked. + + **CAUTION** Invoking the ``persist`` method on an entity does NOT + cause an immediate SQL INSERT to be issued on the database. + Doctrine applies a strategy called "transactional write-behind", + which means that it will delay most SQL commands until + ``EntityManager#flush()`` is invoked which will then issue all + necessary SQL statements to synchronize your objects with the + database in the most efficient way and a single, short transaction, + taking care of maintaining referential integrity. + + +Example: + +:: + + setName('Mr.Right'); + $em->persist($user); + $em->flush(); + + **CAUTION** Generated entity identifiers / primary keys are + guaranteed to be available after the next successful flush + operation that involves the entity in question. You can not rely on + a generated identifier to be available directly after invoking + ``persist``. The inverse is also true. You can not rely on a + generated identifier being not available after a failed flush + operation. + + +The semantics of the persist operation, applied on an entity X, are +as follows: + + +- If X is a new entity, it becomes managed. The entity X will be + entered into the database as a result of the flush operation. +- If X is a preexisting managed entity, it is ignored by the + persist operation. However, the persist operation is cascaded to + entities referenced by X, if the relationships from X to these + other entities are mapped with cascade=PERSIST or cascade=ALL (see + "Transitive Persistence"). +- If X is a removed entity, it becomes managed. +- If X is a detached entity, an exception will be thrown on + flush. + +Removing entities +----------------- + +An entity can be removed from persistent storage by passing it to +the ``EntityManager#remove($entity)`` method. By applying the +``remove`` operation on some entity, that entity becomes REMOVED, +which means that its persistent state will be deleted once +``EntityManager#flush()`` is invoked. + + **CAUTION** Just like ``persist``, invoking ``remove`` on an entity + does NOT cause an immediate SQL DELETE to be issued on the + database. The entity will be deleted on the next invocation of + ``EntityManager#flush()`` that involves that entity. + + +Example: + +:: + + remove($user); + $em->flush(); + +The semantics of the remove operation, applied to an entity X are +as follows: + + +- If X is a new entity, it is ignored by the remove operation. + However, the remove operation is cascaded to entities referenced by + X, if the relationship from X to these other entities is mapped + with cascade=REMOVE or cascade=ALL (see "Transitive Persistence"). +- If X is a managed entity, the remove operation causes it to + become removed. The remove operation is cascaded to entities + referenced by X, if the relationships from X to these other + entities is mapped with cascade=REMOVE or cascade=ALL (see + "Transitive Persistence"). +- If X is a detached entity, an InvalidArgumentException will be + thrown. +- If X is a removed entity, it is ignored by the remove operation. +- A removed entity X will be removed from the database as a result + of the flush operation. + +After an entity has been removed its in-memory state is the same as +before the removal, except for generated identifiers. + +Removing an entity will also automatically delete any existing +records in many-to-many join tables that link this entity. The +action taken depends on the value of the ``@joinColumn`` mapping +attribute "onDelete". Either Doctrine issues a dedicated ``DELETE`` +statement for records of each join table or it depends on the +foreign key semantics of onDelete="CASCADE". + +Deleting an object with all its associated objects can be achieved +in multiple ways with very different performance impacts. + + +1. If an association is marked as ``CASCADE=REMOVE`` Doctrine 2 + will fetch this association. If its a Single association it will + pass this entity to + ´EntityManager#remove()``. If the association is a collection, Doctrine will loop over all its elements and pass them to``EntityManager#remove()\`. + In both cases the cascade remove semantics are applied recursively. + For large object graphs this removal strategy can be very costly. +2. Using a DQL ``DELETE`` statement allows you to delete multiple + entities of a type with a single command and without hydrating + these entities. This can be very efficient to delete large object + graphs from the database. +3. Using foreign key semantics ``onDelete="CASCADE"`` can force the + database to remove all associated objects internally. This strategy + is a bit tricky to get right but can be very powerful and fast. You + should be aware however that using strategy 1 (``CASCADE=REMOVE``) + completely by-passes any foreign key ``onDelete=CASCADE`` option, + because Doctrine will fetch and remove all associated entities + explicitly nevertheless. + +Detaching entities +------------------ + +An entity is detached from an EntityManager and thus no longer +managed by invoking the ``EntityManager#detach($entity)`` method on +it or by cascading the detach operation to it. Changes made to the +detached entity, if any (including removal of the entity), will not +be synchronized to the database after the entity has been +detached. + +Doctrine will not hold on to any references to a detached entity. + +Example: + +:: + + detach($entity); + +The semantics of the detach operation, applied to an entity X are +as follows: + + +- If X is a managed entity, the detach operation causes it to + become detached. The detach operation is cascaded to entities + referenced by X, if the relationships from X to these other + entities is mapped with cascade=DETACH or cascade=ALL (see + "Transitive Persistence"). Entities which previously referenced X + will continue to reference X. +- If X is a new or detached entity, it is ignored by the detach + operation. +- If X is a removed entity, the detach operation is cascaded to + entities referenced by X, if the relationships from X to these + other entities is mapped with cascade=DETACH or cascade=ALL (see + "Transitive Persistence"). Entities which previously referenced X + will continue to reference X. + +There are several situations in which an entity is detached +automatically without invoking the ``detach`` method: + + +- When ``EntityManager#clear()`` is invoked, all entities that are + currently managed by the EntityManager instance become detached. +- When serializing an entity. The entity retrieved upon subsequent + unserialization will be detached (This is the case for all entities + that are serialized and stored in some cache, i.e. when using the + Query Result Cache). + +The ``detach`` operation is usually not as frequently needed and +used as ``persist`` and ``remove``. + +Merging entities +---------------- + +Merging entities refers to the merging of (usually detached) +entities into the context of an EntityManager so that they become +managed again. To merge the state of an entity into an +EntityManager use the ``EntityManager#merge($entity)`` method. The +state of the passed entity will be merged into a managed copy of +this entity and this copy will subsequently be returned. + +Example: + +:: + + merge($detachedEntity); + // $entity now refers to the fully managed copy returned by the merge operation. + // The EntityManager $em now manages the persistence of $entity as usual. + + **CAUTION** When you want to serialize/unserialize entities you + have to make all entity properties protected, never private. The + reason for this is, if you serialize a class that was a proxy + instance before, the private variables won't be serialized and a + PHP Notice is thrown. + + +The semantics of the merge operation, applied to an entity X, are +as follows: + + +- If X is a detached entity, the state of X is copied onto a + pre-existing managed entity instance X' of the same identity. +- If X is a new entity instance, a new managed copy X' will be + created and the state of X is copied onto this managed instance. +- If X is a removed entity instance, an InvalidArgumentException + will be thrown. +- If X is a managed entity, it is ignored by the merge operation, + however, the merge operation is cascaded to entities referenced by + relationships from X if these relationships have been mapped with + the cascade element value MERGE or ALL (see "Transitive + Persistence"). +- For all entities Y referenced by relationships from X having the + cascade element value MERGE or ALL, Y is merged recursively as Y'. + For all such Y referenced by X, X' is set to reference Y'. (Note + that if X is managed then X is the same object as X'.) +- If X is an entity merged to X', with a reference to another + entity Y, where cascade=MERGE or cascade=ALL is not specified, then + navigation of the same association from X' yields a reference to a + managed object Y' with the same persistent identity as Y. + +The ``merge`` operation will throw an ``OptimisticLockException`` +if the entity being merged uses optimistic locking through a +version field and the versions of the entity being merged and the +managed copy don't match. This usually means that the entity has +been modified while being detached. + +The ``merge`` operation is usually not as frequently needed and +used as ``persist`` and ``remove``. The most common scenario for +the ``merge`` operation is to reattach entities to an EntityManager +that come from some cache (and are therefore detached) and you want +to modify and persist such an entity. + + **NOTE** If you load some detached entities from a cache and you do + not need to persist or delete them or otherwise make use of them + without the need for persistence services there is no need to use + ``merge``. I.e. you can simply pass detached objects from a cache + directly to the view. + + +Synchronization with the Database +--------------------------------- + +The state of persistent entities is synchronized with the database +on flush of an ``EntityManager`` which commits the underlying +``UnitOfWork``. The synchronization involves writing any updates to +persistent entities and their relationships to the database. +Thereby bidirectional relationships are persisted based on the +references held by the owning side of the relationship as explained +in the Association Mapping chapter. + +When ``EntityManager#flush()`` is called, Doctrine inspects all +managed, new and removed entities and will perform the following +operations. + +Synchronizing New and Managed Entities +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The flush operation applies to a managed entity with the following +semantics: + + +- The entity itself is synchronized to the database using a SQL + UPDATE statement, only if at least one persistent field has + changed. +- No SQL updates are executed if the entity did not change. + +The flush operation applies to a new entity with the following +semantics: + + +- The entity itself is synchronized to the database using a SQL + INSERT statement. + +For all (initialized) relationships of the new or managed entity +the following semantics apply to each associated entity X: + + +- If X is new and persist operations are configured to cascade on + the relationship, X will be persisted. +- If X is new and no persist operations are configured to cascade + on the relationship, an exception will be thrown as this indicates + a programming error. +- If X is removed and persist operations are configured to cascade + on the relationship, an exception will be thrown as this indicates + a programming error (X would be re-persisted by the cascade). +- If X is detached and persist operations are configured to + cascade on the relationship, an exception will be thrown (This is + semantically the same as passing X to persist()). + +Synchronizing Removed Entities +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The flush operation applies to a removed entity by deleting its +persistent state from the database. No cascade options are relevant +for removed entities on flush, the cascade remove option is already +executed during ``EntityManager#remove($entity)``. + +The size of a Unit of Work +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The size of a Unit of Work mainly refers to the number of managed +entities at a particular point in time. + +The cost of flushing +~~~~~~~~~~~~~~~~~~~~ + +How costly a flush operation is, mainly depends on two factors: + + +- The size of the EntityManager's current UnitOfWork. +- The configured change tracking policies + +You can get the size of a UnitOfWork as follows: + +:: + + getUnitOfWork()->size(); + +The size represents the number of managed entities in the Unit of +Work. This size affects the performance of flush() operations due +to change tracking (see "Change Tracking Policies") and, of course, +memory consumption, so you may want to check it from time to time +during development. + + **CAUTION** Do not invoke ``flush`` after every change to an entity + or every single invocation of persist/remove/merge/... This is an + anti-pattern and unnecessarily reduces the performance of your + application. Instead, form units of work that operate on your + objects and call ``flush`` when you are done. While serving a + single HTTP request there should be usually no need for invoking + ``flush`` more than 0-2 times. + + +Direct access to a Unit of Work +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can get direct access to the Unit of Work by calling +``EntityManager#getUnitOfWork()``. This will return the UnitOfWork +instance the EntityManager is currently using. + +:: + + getUnitOfWork(); + + **NOTE** Directly manipulating a UnitOfWork is not recommended. + When working directly with the UnitOfWork API, respect methods + marked as INTERNAL by not using them and carefully read the API + documentation. + + +Entity State +~~~~~~~~~~~~ + +As outlined in the architecture overview an entity can be in one of +four possible states: NEW, MANAGED, REMOVED, DETACHED. If you +explicitly need to find out what the current state of an entity is +in the context of a certain ``EntityManager`` you can ask the +underlying ``UnitOfWork``: + +:: + + getUnitOfWork()->getEntityState($entity)) { + case UnitOfWork::MANAGED: + ... + case UnitOfWork::REMOVED: + ... + case UnitOfWork::DETACHED: + ... + case UnitOfWork::NEW: + ... + } + +An entity is in MANAGED state if it is associated with an +``EntityManager`` and it is not REMOVED. + +An entity is in REMOVED state after it has been passed to +``EntityManager#remove()`` until the next flush operation of the +same EntityManager. A REMOVED entity is still associated with an +``EntityManager`` until the next flush operation. + +An entity is in DETACHED state if it has persistent state and +identity but is currently not associated with an +``EntityManager``. + +An entity is in NEW state if has no persistent state and identity +and is not associated with an ``EntityManager`` (for example those +just created via the "new" operator). + +Querying +-------- + +Doctrine 2 provides the following ways, in increasing level of +power and flexibility, to query for persistent objects. You should +always start with the simplest one that suits your needs. + +By Primary Key +~~~~~~~~~~~~~~ + +The most basic way to query for a persistent object is by its +identifier / primary key using the +``EntityManager#find($entityName, $id)`` method. Here is an +example: + +:: + + find('MyProject\Domain\User', $id); + +The return value is either the found entity instance or null if no +instance could be found with the given identifier. + +Essentially, ``EntityManager#find()`` is just a shortcut for the +following: + +:: + + getRepository('MyProject\Domain\User')->find($id); + +``EntityManager#getRepository($entityName)`` returns a repository +object which provides many ways to retrieve entities of the +specified type. By default, the repository instance is of type +``Doctrine\ORM\EntityRepository``. You can also use custom +repository classes as shown later. + +By Simple Conditions +~~~~~~~~~~~~~~~~~~~~ + +To query for one or more entities based on several conditions that +form a logical conjunction, use the ``findBy`` and ``findOneBy`` +methods on a repository as follows: + +:: + + getRepository('MyProject\Domain\User')->findBy(array('age' => 20)); + + // All users that are 20 years old and have a surname of 'Miller' + $users = $em->getRepository('MyProject\Domain\User')->findBy(array('age' => 20, 'surname' => 'Miller')); + + // A single user by its nickname + $user = $em->getRepository('MyProject\Domain\User')->findOneBy(array('nickname' => 'romanb')); + +An EntityRepository also provides a mechanism for more concise +calls through its use of ``__call``. Thus, the following two +examples are equivalent: + +:: + + getRepository('MyProject\Domain\User')->findOneBy(array('nickname' => 'romanb')); + + // A single user by its nickname (__call magic) + $user = $em->getRepository('MyProject\Domain\User')->findOneByNickname('romanb'); + +By Eager Loading +~~~~~~~~~~~~~~~~ + +Whenever you query for an entity that has persistent associations +and these associations are mapped as EAGER, they will automatically +be loaded together with the entity being queried and is thus +immediately available to your application. + +By Lazy Loading +~~~~~~~~~~~~~~~ + +Whenever you have a managed entity instance at hand, you can +traverse and use any associations of that entity that are +configured LAZY as if they were in-memory already. Doctrine will +automatically load the associated objects on demand through the +concept of lazy-loading. + +By DQL +~~~~~~ + +The most powerful and flexible method to query for persistent +objects is the Doctrine Query Language, an object query language. +DQL enables you to query for persistent objects in the language of +objects. DQL understands classes, fields, inheritance and +associations. DQL is syntactically very similar to the familiar SQL +but *it is not SQL*. + +A DQL query is represented by an instance of the +``Doctrine\ORM\Query`` class. You create a query using +``EntityManager#createQuery($dql)``. Here is a simple example: + +:: + + createQuery("select u from MyDomain\Model\User u where u.age >= 20 and u.age <= 30"); + $users = $q->getResult(); + +Note that this query contains no knowledge about the relational +schema, only about the object model. DQL supports positional as +well as named parameters, many functions, (fetch) joins, +aggregates, subqueries and much more. Detailed information about +DQL and its syntax as well as the Doctrine class can be found in +`the dedicated chapter `_. +For programmatically building up queries based on conditions that +are only known at runtime, Doctrine provides the special +``Doctrine\ORM\QueryBuilder`` class. More information on +constructing queries with a QueryBuilder can be found +`in the dedicated chapter `_. + +By Native Queries +~~~~~~~~~~~~~~~~~ + +As an alternative to DQL or as a fallback for special SQL +statements native queries can be used. Native queries are built by +using a hand-crafted SQL query and a ResultSetMapping that +describes how the SQL result set should be transformed by Doctrine. +More information about native queries can be found in +`the dedicated chapter `_. + +Custom Repositories +~~~~~~~~~~~~~~~~~~~ + +By default the EntityManager returns a default implementation of +``Doctrine\ORM\EntityRepository`` when you call +``EntityManager#getRepository($entityClass)``. You can overwrite +this behaviour by specifying the class name of your own Entity +Repository in the Annotation, XML or YAML metadata. In large +applications that require lots of specialized DQL queries using a +custom repository is one recommended way of grouping these queries +in a central location. + +:: + + _em->createQuery('SELECT u FROM MyDomain\Model\User u WHERE u.status = "admin"') + ->getResult(); + } + } + +You can access your repository now by calling: + +:: + + getRepository('MyDomain\Model\User')->getAllAdminUsers(); + + diff --git a/manual/en/working-with-objects.txt b/manual/en/working-with-objects.txt index 0decce091..ad0a943ec 100644 --- a/manual/en/working-with-objects.txt +++ b/manual/en/working-with-objects.txt @@ -18,7 +18,7 @@ are lost. > > Not calling `EntityManager#flush()` will lead to all changes during that request being lost. -++ Entities and the Identity Map +## Entities and the Identity Map Entities are objects with identity. Their identity has a conceptual meaning inside your domain. In a CMS application each article has a unique id. You can uniquely identify each article @@ -27,7 +27,7 @@ by that id. Take the following example, where you find an article with the headline "Hello World" with the ID 1234: - [php] + find('CMS\Article', 1234); $article->setHeadline('Hello World dude!'); @@ -45,7 +45,7 @@ In the previous example the echo prints "Hello World dude!" to the screen. You c even verify that `$article` and `$article2` are indeed pointing to the same instance by running the following code: - [php] + find('Article', 1); // accessing a method of the user instance triggers the lazy-load @@ -127,7 +127,7 @@ This lazy-loading process happens behind the scenes, hidden from your code. See A slice of the generated proxy classes code looks like the following piece of code. A real proxy class override ALL public methods along the lines of the `getName()` method shown below: - [php] + of SQL queries and will perform badly if used to heavily. Make sure to use DQL > to fetch-join all the parts of the object-graph that you need as efficiently as possible. -++ Persisting entities +## Persisting entities An entity can be made persistent by passing it to the `EntityManager#persist($entity)` method. By applying the persist operation on some entity, that entity becomes MANAGED, @@ -167,7 +167,7 @@ synchronized with the database when `EntityManager#flush()` is invoked. Example: - [php] + setName('Mr.Right'); $em->persist($user); @@ -188,7 +188,7 @@ The semantics of the persist operation, applied on an entity X, are as follows: * If X is a detached entity, an exception will be thrown on flush. -++ Removing entities +## Removing entities An entity can be removed from persistent storage by passing it to the `EntityManager#remove($entity)` method. By applying the `remove` operation on some entity, that entity becomes REMOVED, which means that its persistent state will be deleted once `EntityManager#flush()` is invoked. @@ -199,7 +199,7 @@ An entity can be removed from persistent storage by passing it to the `EntityMan Example: - [php] + remove($user); $em->flush(); @@ -238,7 +238,7 @@ ways with very different performance impacts. any foreign key `onDelete=CASCADE` option, because Doctrine will fetch and remove all associated entities explicitly nevertheless. -++ Detaching entities +## Detaching entities An entity is detached from an EntityManager and thus no longer managed by invoking the `EntityManager#detach($entity)` method on it or by cascading @@ -250,7 +250,7 @@ Doctrine will not hold on to any references to a detached entity. Example: - [php] + detach($entity); The semantics of the detach operation, applied to an entity X are as follows: @@ -267,7 +267,7 @@ There are several situations in which an entity is detached automatically withou The `detach` operation is usually not as frequently needed and used as `persist` and `remove`. -++ Merging entities +## Merging entities Merging entities refers to the merging of (usually detached) entities into the context of an EntityManager so that they become managed again. To merge the @@ -277,7 +277,7 @@ this entity and this copy will subsequently be returned. Example: - [php] + merge($detachedEntity); // $entity now refers to the fully managed copy returned by the merge operation. @@ -314,7 +314,7 @@ and you want to modify and persist such an entity. > there is no need to use `merge`. I.e. you can simply pass detached objects from a cache > directly to the view. -++ Synchronization with the Database +## Synchronization with the Database The state of persistent entities is synchronized with the database on flush of an `EntityManager` which commits the underlying `UnitOfWork`. The synchronization involves writing any updates to @@ -325,7 +325,7 @@ in the Association Mapping chapter. When `EntityManager#flush()` is called, Doctrine inspects all managed, new and removed entities and will perform the following operations. -+++ Synchronizing New and Managed Entities +### Synchronizing New and Managed Entities The flush operation applies to a managed entity with the following semantics: @@ -348,18 +348,18 @@ associated entity X: * If X is detached and persist operations are configured to cascade on the relationship, an exception will be thrown (This is semantically the same as passing X to persist()). -+++ Synchronizing Removed Entities +### Synchronizing Removed Entities The flush operation applies to a removed entity by deleting its persistent state from the database. No cascade options are relevant for removed entities on flush, the cascade remove option is already executed during `EntityManager#remove($entity)`. -+++ The size of a Unit of Work +### The size of a Unit of Work The size of a Unit of Work mainly refers to the number of managed entities at a particular point in time. -+++ The cost of flushing +### The cost of flushing How costly a flush operation is, mainly depends on two factors: @@ -368,7 +368,7 @@ How costly a flush operation is, mainly depends on two factors: You can get the size of a UnitOfWork as follows: - [php] + getUnitOfWork()->size(); The size represents the number of managed entities in the Unit of Work. This @@ -383,12 +383,12 @@ may want to check it from time to time during development. > and call `flush` when you are done. While serving a single HTTP request there should > be usually no need for invoking `flush` more than 0-2 times. -+++ Direct access to a Unit of Work +### Direct access to a Unit of Work You can get direct access to the Unit of Work by calling `EntityManager#getUnitOfWork()`. This will return the UnitOfWork instance the EntityManager is currently using. - [php] + getUnitOfWork(); > **NOTE** @@ -396,14 +396,14 @@ This will return the UnitOfWork instance the EntityManager is currently using. > UnitOfWork API, respect methods marked as INTERNAL by not using them and carefully read > the API documentation. -+++ Entity State +### Entity State As outlined in the architecture overview an entity can be in one of four possible states: NEW, MANAGED, REMOVED, DETACHED. If you explicitly need to find out what the current state of an entity is in the context of a certain `EntityManager` you can ask the underlying `UnitOfWork`: - [php] + getUnitOfWork()->getEntityState($entity)) { case UnitOfWork::MANAGED: ... @@ -428,15 +428,15 @@ An entity is in NEW state if has no persistent state and identity and is not ass `EntityManager` (for example those just created via the "new" operator). -++ Querying +## Querying Doctrine 2 provides the following ways, in increasing level of power and flexibility, to query for persistent objects. You should always start with the simplest one that suits your needs. -+++ By Primary Key +### By Primary Key The most basic way to query for a persistent object is by its identifier / primary key using the `EntityManager#find($entityName, $id)` method. Here is an example: - [php] + find('MyProject\Domain\User', $id); @@ -444,17 +444,17 @@ The return value is either the found entity instance or null if no instance coul Essentially, `EntityManager#find()` is just a shortcut for the following: - [php] + getRepository('MyProject\Domain\User')->find($id); `EntityManager#getRepository($entityName)` returns a repository object which provides many ways to retrieve entities of the specified type. By default, the repository instance is of type `Doctrine\ORM\EntityRepository`. You can also use custom repository classes as shown later. -+++ By Simple Conditions +### By Simple Conditions To query for one or more entities based on several conditions that form a logical conjunction, use the `findBy` and `findOneBy` methods on a repository as follows: - [php] + getRepository('MyProject\Domain\User')->findOneBy(array('nickname' => 'romanb')); @@ -476,24 +476,24 @@ An EntityRepository also provides a mechanism for more concise calls through its $user = $em->getRepository('MyProject\Domain\User')->findOneByNickname('romanb'); -+++ By Eager Loading +### By Eager Loading Whenever you query for an entity that has persistent associations and these associations are mapped as EAGER, they will automatically be loaded together with the entity being queried and is thus immediately available to your application. -+++ By Lazy Loading +### By Lazy Loading Whenever you have a managed entity instance at hand, you can traverse and use any associations of that entity that are configured LAZY as if they were in-memory already. Doctrine will automatically load the associated objects on demand through the concept of lazy-loading. -+++ By DQL +### By DQL The most powerful and flexible method to query for persistent objects is the Doctrine Query Language, an object query language. DQL enables you to query for persistent objects in the language of objects. DQL understands classes, fields, inheritance and associations. DQL is syntactically very similar to the familiar SQL but *it is not SQL*. A DQL query is represented by an instance of the `Doctrine\ORM\Query` class. You create a query using `EntityManager#createQuery($dql)`. Here is a simple example: - [php] + getRepository('MyDomain\Model\User')->getAllAdminUsers(); diff --git a/manual/en/xml-mapping.rst b/manual/en/xml-mapping.rst new file mode 100644 index 000000000..b384dd638 --- /dev/null +++ b/manual/en/xml-mapping.rst @@ -0,0 +1,716 @@ +The XML mapping driver enables you to provide the ORM metadata in +form of XML documents. + +The XML driver is backed by an XML Schema document that describes +the structure of a mapping document. The most recent version of the +XML Schema document is available online at +`http://www.doctrine-project.org/schemas/orm/doctrine-mapping.xsd `_. +In order to point to the latest version of the document of a +particular stable release branch, just append the release number, +i.e.: doctrine-mapping-2.0.xsd The most convenient way to work with +XML mapping files is to use an IDE/editor that can provide +code-completion based on such an XML Schema document. The following +is an outline of a XML mapping document with the proper xmlns/xsi +setup for the latest code in trunk. + +:: + + [xml] + + + ... + + + +The XML mapping document of a class is loaded on-demand the first +time it is requested and subsequently stored in the metadata cache. +In order to work, this requires certain conventions: + + +- Each entity/mapped superclass must get its own dedicated XML + mapping document. +- The name of the mapping document must consist of the fully + qualified name of the class, where namespace separators are + replaced by dots (.). For example an Entity with the fully + qualified class-name "MyProject" would require a mapping file + "MyProject.Entities.User.dcm.xml" unless the extension is changed. +- All mapping documents should get the extension ".dcm.xml" to + identify it as a Doctrine mapping file. This is more of a + convention and you are not forced to do this. You can change the + file extension easily enough. + +- + +:: + + setFileExtension('.xml'); + +It is recommended to put all XML mapping documents in a single +folder but you can spread the documents over several folders if you +want to. In order to tell the XmlDriver where to look for your +mapping documents, supply an array of paths as the first argument +of the constructor, like this: + +:: + + setMetadataDriverImpl($driver); + +Example +------- + +As a quick start, here is a small example document that makes use +of several common elements: + +:: + + [xml] + // Doctrine.Tests.ORM.Mapping.User.dcm.xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Be aware that class-names specified in the XML files should be +fully qualified. + +XML-Element Reference +--------------------- + +The XML-Element reference explains all the tags and attributes that +the Doctrine Mapping XSD Schema defines. You should read the +Basic-, Association- and Inheritance Mapping chapters to understand +what each of this definitions means in detail. + +Defining an Entity +~~~~~~~~~~~~~~~~~~ + +Each XML Mapping File contains the definition of one entity, +specified as the ```` element as a direct child of the +```` element: + +:: + + [xml] + + + + + + +Required attributes: + + +- name - The fully qualified class-name of the entity. + +Optional attributes: + + +- table - The Table-Name to be used for this entity. Otherwise the + Unqualified Class-Name is used by default. +- repository-class - The fully qualified class-name of an + alternative ``Doctrine\ORM\EntityRepository`` implementation to be + used with this entity. +- inheritance-type - The type of inheritance, defaults to none. A + more detailed description follows in the + *Defining Inheritance Mappings* section. + +Defining Fields +~~~~~~~~~~~~~~~ + +Each entity class can contain zero to infinite fields that are +managed by Doctrine. You can define them using the ```` +element as a children to the ```` element. The field +element is only used for primitive types that are not the ID of the +entity. For the ID mapping you have to use the ```` element. + +:: + + [xml] + + + + + + + + + +Required attributes: + + +- name - The name of the Property/Field on the given Entity PHP + class. + +Optional attributes: + + +- type - The ``Doctrine\DBAL\Types\Type`` name, defaults to + "string" +- column - Name of the column in the database, defaults to the + field name. +- length - The length of the given type, for use with strings + only. +- unique - Should this field contain a unique value across the + table? Defaults to false. +- nullable - Should this field allow NULL as a value? Defaults to + false. +- version - Should this field be used for optimistic locking? Only + works on fields with type integer or datetime. +- scale - Scale of a decimal type. +- precision - Precision of a decimal type. +- column-definition - Optional alternative SQL representation for + this column. This definition begin after the field-name and has to + specify the complete column definition. Using this feature will + turn this field dirty for Schema-Tool update commands at all + times. + +Defining Identity and Generator Strategies +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An entity has to have at least one ```` element. For +composite keys you can specify more than one id-element, however +surrogate keys are recommended for use with Doctrine 2. The Id +field allows to define properties of the identifier and allows a +subset of the ```` element attributes: + +:: + + [xml] + + + + +Required attributes: + + +- name - The name of the Property/Field on the given Entity PHP + class. +- type - The ``Doctrine\DBAL\Types\Type`` name, preferably + "string" or "integer". + +Optional attributes: + + +- column - Name of the column in the database, defaults to the + field name. + +Using the simplified definition above Doctrine will use no +identifier strategy for this entity. That means you have to +manually set the identifier before calling +``EntityManager#persist($entity)``. This is the so called +``ASSIGNED`` strategy. + +If you want to switch the identifier generation strategy you have +to nest a ```` element inside the id-element. This of +course only works for surrogate keys. For composite keys you always +have to use the ``ASSIGNED`` strategy. + +:: + + [xml] + + + + + + +The following values are allowed for the ```` strategy +attribute: + + +- AUTO - Automatic detection of the identifier strategy based on + the preferred solution of the database vendor. +- IDENTITY - Use of a IDENTIFY strategy such as Auto-Increment IDs + available to Doctrine AFTER the INSERT statement has been executed. +- SEQUENCE - Use of a database sequence to retrieve the + entity-ids. This is possible before the INSERT statement is + executed. + +If you are using the SEQUENCE strategy you can define an additional +element to describe the sequence: + +:: + + [xml] + + + + + + + +Required attributes for ````: + + +- sequence-name - The name of the sequence + +Optional attributes for ````: + + +- allocation-size - By how much steps should the sequence be + incremented when a value is retrieved. Defaults to 1 +- initial-value - What should the initial value of the sequence + be. + + **NOTE** + + If you want to implement a cross-vendor compatible application you + have to specify and additionally define the + element, if Doctrine chooses the sequence strategy for a + platform. + + +Defining a Mapped Superclass +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sometimes you want to define a class that multiple entities inherit +from, which itself is not an entity however. The chapter on +*Inheritance Mapping* describes a Mapped Superclass in detail. You +can define it in XML using the ```` tag. + +:: + + [xml] + + + + + + + +Required attributes: + + +- name - Class name of the mapped superclass. + +You can nest any number of ```` and unidirectional +```` or ```` associations inside a +mapped superclass. + +Defining Inheritance Mappings +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There are currently two inheritance persistence strategies that you +can choose from when defining entities that inherit from each +other. Single Table inheritance saves the fields of the complete +inheritance hierarchy in a single table, joined table inheritance +creates a table for each entity combining the fields using join +conditions. + +You can specify the inheritance type in the ```` element +and then use the ```` and +```` attributes. + +:: + + [xml] + + + + + + + + + +The allowed values for inheritance-type attribute are ``JOINED`` or +``SINGLE_TABLE``. + + **NOTE** + + All inheritance related definitions have to be defined on the root + entity of the hierarchy. + + +Defining Lifecycle Callbacks +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can define the lifecycle callback methods on your entities +using the ```` element: + +:: + + [xml] + + + + + + + +Defining One-To-One Relations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can define One-To-One Relations/Associations using the +```` element. The required and optional attributes +depend on the associations being on the inverse or owning side. + +For the inverse side the mapping is as simple as: + +:: + + [xml] + + + + +Required attributes for inverse One-To-One: + + +- field - Name of the property/field on the entity's PHP class. +- target-entity - Name of the entity associated entity class. If + this is not qualified the namespace of the current class is + prepended. *IMPORTANT:* No leading backslash! +- mapped-by - Name of the field on the owning side (here Address + entity) that contains the owning side association. + +For the owning side this mapping would look like: + +:: + + [xml] + + + + +Required attributes for owning One-to-One: + + +- field - Name of the property/field on the entity's PHP class. +- target-entity - Name of the entity associated entity class. If + this is not qualified the namespace of the current class is + prepended. *IMPORTANT:* No leading backslash! + +Optional attributes for owning One-to-One: + + +- inversed-by - If the association is bidirectional the + inversed-by attribute has to be specified with the name of the + field on the inverse entity that contains the back-reference. +- orphan-removal - If true, the inverse side entity is always + deleted when the owning side entity is. Defaults to false. +- fetch - Either LAZY or FETCH, defaults to LAZY. This attribute + makes only sense on the owning side, the inverse side *ALWAYS* has + to use the ``FETCH`` strategy. + +The definition for the owning side relies on a bunch of mapping +defaults for the join column names. Without the nested +```` element Doctrine assumes to foreign key to be +called ``user_id`` on the Address Entities table. This is because +the ``MyProject\Address`` entity is the owning side of this +association, which means it contains the foreign key. + +The completed explicitly defined mapping is: + +:: + + [xml] + + + + + + +Defining Many-To-One Associations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The many-to-one association is *ALWAYS* the owning side of any +bidirectional association. This simplifies the mapping compared to +the one-to-one case. The minimal mapping for this association looks +like: + +:: + + [xml] + + + + +Required attributes: + + +- field - Name of the property/field on the entity's PHP class. +- target-entity - Name of the entity associated entity class. If + this is not qualified the namespace of the current class is + prepended. *IMPORTANT:* No leading backslash! + +Optional attributes: + + +- inversed-by - If the association is bidirectional the + inversed-by attribute has to be specified with the name of the + field on the inverse entity that contains the back-reference. +- orphan-removal - If true the entity on the inverse side is + always deleted when the owning side entity is and it is not + connected to any other owning side entity anymore. Defaults to + false. +- fetch - Either LAZY or FETCH, defaults to LAZY. + +This definition relies on a bunch of mapping defaults with regards +to the naming of the join-column/foreign key. The explicitly +defined mapping includes a ```` tag nested inside +the many-to-one association tag: + +:: + + [xml] + + + + + + +The join-column attribute ``name`` specifies the column name of the +foreign key and the ``referenced-column-name`` attribute specifies +the name of the primary key column on the User entity. + +Defining One-To-Many Associations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The one-to-many association is *ALWAYS* the inverse side of any +association. There exists no such thing as a uni-directional +one-to-many association, which means this association only ever +exists for bi-directional associations. + +:: + + [xml] + + + + +Required attributes: + + +- field - Name of the property/field on the entity's PHP class. +- target-entity - Name of the entity associated entity class. If + this is not qualified the namespace of the current class is + prepended. *IMPORTANT:* No leading backslash! +- mapped-by - Name of the field on the owning side (here + Phonenumber entity) that contains the owning side association. + +Optional attributes: + + +- fetch - Either LAZY or FETCH, defaults to LAZY. + +Defining Many-To-Many Associations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +From all the associations the many-to-many has the most complex +definition. When you rely on the mapping defaults you can omit many +definitions and rely on their implicit values. + +:: + + [xml] + + + + +Required attributes: + + +- field - Name of the property/field on the entity's PHP class. +- target-entity - Name of the entity associated entity class. If + this is not qualified the namespace of the current class is + prepended. *IMPORTANT:* No leading backslash! + +Optional attributes: + + +- mapped-by - Name of the field on the owning side that contains + the owning side association if the defined many-to-many association + is on the inverse side. +- inversed-by - If the association is bidirectional the + inversed-by attribute has to be specified with the name of the + field on the inverse entity that contains the back-reference. +- fetch - Either LAZY or FETCH, defaults to LAZY. + +The mapping defaults would lead to a join-table with the name +"User\_Group" being created that contains two columns "user\_id" +and "group\_id". The explicit definition of this mapping would be: + +:: + + [xml] + + + + + + + + + + + + + +Here both the ```` and ```` +tags are necessary to tell Doctrine for which side the specified +join-columns apply. These are nested inside a ```` +attribute which allows to specify the table name of the +many-to-many join-table. + +Cascade Element +~~~~~~~~~~~~~~~ + +Doctrine allows cascading of several UnitOfWork operations to +related entities. You can specify the cascade operations in the +```` element inside any of the association mapping +tags. + +:: + + [xml] + + + + + + + + +Besides ```` the following operations can be +specified by their respective tags: + + +- ```` +- ```` +- ```` +- ```` + +Join Column Element +~~~~~~~~~~~~~~~~~~~ + +In any explicitly defined association mapping you will need the +```` tag. It defines how the foreign key and primary +key names are called that are used for joining two entities. + +Required attributes: + + +- name - The column name of the foreign key. +- referenced-column-name - The column name of the associated + entities primary key + +Optional attributes: + + +- unique - If the join column should contain a UNIQUE constraint. + This makes sense for Many-To-Many join-columns only to simulate a + one-to-many unidirectional using a join-table. +- nullable - should the join column be nullable, defaults to true. +- on-delete - Foreign Key Cascade action to perform when entity is + deleted, defaults to NO ACTION/RESTRICT but can be set to + "CASCADE". + +Defining Order of To-Many Associations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can require one-to-many or many-to-many associations to be +retrieved using an additional ``ORDER BY``. + +:: + + [xml] + + + + + + + + +Defining Indexes or Unique Constraints +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To define additional indexes or unique constraints on the entities +table you can use the ```` and +```` elements: + +:: + + [xml] + + + + + + + + + + + + +You have to specify the column and not the entity-class field names +in the index and unique-constraint definitions. + + diff --git a/manual/en/xml-mapping.txt b/manual/en/xml-mapping.txt index 086484406..2dd1806b7 100644 --- a/manual/en/xml-mapping.txt +++ b/manual/en/xml-mapping.txt @@ -23,18 +23,18 @@ The XML mapping document of a class is loaded on-demand the first time it is req - - [php] + setFileExtension('.xml'); It is recommended to put all XML mapping documents in a single folder but you can spread the documents over several folders if you want to. In order to tell the XmlDriver where to look for your mapping documents, supply an array of paths as the first argument of the constructor, like this: - [php] + setMetadataDriverImpl($driver); -++ Example +## Example As a quick start, here is a small example document that makes use of several common elements: @@ -105,13 +105,13 @@ As a quick start, here is a small example document that makes use of several com Be aware that class-names specified in the XML files should be fully qualified. -++ XML-Element Reference +## XML-Element Reference The XML-Element reference explains all the tags and attributes that the Doctrine Mapping XSD Schema defines. You should read the Basic-, Association- and Inheritance Mapping chapters to understand what each of this definitions means in detail. -+++ Defining an Entity +### Defining an Entity Each XML Mapping File contains the definition of one entity, specified as the `` element as a direct child of the `` element: @@ -133,7 +133,7 @@ Optional attributes: * repository-class - The fully qualified class-name of an alternative `Doctrine\ORM\EntityRepository` implementation to be used with this entity. * inheritance-type - The type of inheritance, defaults to none. A more detailed description follows in the *Defining Inheritance Mappings* section. -+++ Defining Fields +### Defining Fields Each entity class can contain zero to infinite fields that are managed by Doctrine. You can define them using the `` element as a children to the `` element. The field element is only @@ -167,7 +167,7 @@ Optional attributes: field-name and has to specify the complete column definition. Using this feature will turn this field dirty for Schema-Tool update commands at all times. -+++ Defining Identity and Generator Strategies +### Defining Identity and Generator Strategies An entity has to have at least one `` element. For composite keys you can specify more than one id-element, however surrogate keys are recommended for use with Doctrine 2. The Id field allows to define properties of @@ -232,7 +232,7 @@ Optional attributes for ``: > If you want to implement a cross-vendor compatible application you have to specify and > additionally define the element, if Doctrine chooses the sequence strategy for a platform. -+++ Defining a Mapped Superclass +### Defining a Mapped Superclass Sometimes you want to define a class that multiple entities inherit from, which itself is not an entity however. The chapter on *Inheritance Mapping* describes a Mapped Superclass in detail. You can define it in XML using @@ -253,7 +253,7 @@ Required attributes: You can nest any number of `` and unidirectional `` or `` associations inside a mapped superclass. -+++ Defining Inheritance Mappings +### Defining Inheritance Mappings There are currently two inheritance persistence strategies that you can choose from when defining entities that inherit from each other. Single Table inheritance saves the fields of the complete inheritance hierarchy in a single table, @@ -278,7 +278,7 @@ The allowed values for inheritance-type attribute are `JOINED` or `SINGLE_TABLE` > > All inheritance related definitions have to be defined on the root entity of the hierarchy. -+++ Defining Lifecycle Callbacks +### Defining Lifecycle Callbacks You can define the lifecycle callback methods on your entities using the `` element: @@ -290,7 +290,7 @@ You can define the lifecycle callback methods on your entities using the ` -+++ Defining One-To-One Relations +### Defining One-To-One Relations You can define One-To-One Relations/Associations using the `` element. The required and optional attributes depend on the associations being on the inverse or owning side. @@ -340,7 +340,7 @@ The completed explicitly defined mapping is: -+++ Defining Many-To-One Associations +### Defining Many-To-One Associations The many-to-one association is *ALWAYS* the owning side of any bidirectional association. This simplifies the mapping compared to the one-to-one case. The minimal mapping for this association looks like: @@ -375,7 +375,7 @@ The join-column attribute `name` specifies the column name of the foreign key an the `referenced-column-name` attribute specifies the name of the primary key column on the User entity. -+++ Defining One-To-Many Associations +### Defining One-To-Many Associations The one-to-many association is *ALWAYS* the inverse side of any association. There exists no such thing as a uni-directional one-to-many association, which means this association only ever exists for bi-directional associations. @@ -395,7 +395,7 @@ Optional attributes: * fetch - Either LAZY or FETCH, defaults to LAZY. -+++ Defining Many-To-Many Associations +### Defining Many-To-Many Associations From all the associations the many-to-many has the most complex definition. When you rely on the mapping defaults you can omit many definitions and rely on their implicit values. @@ -437,7 +437,7 @@ Here both the `` and `` tags are necessary t specified join-columns apply. These are nested inside a `` attribute which allows to specify the table name of the many-to-many join-table. -+++ Cascade Element +### Cascade Element Doctrine allows cascading of several UnitOfWork operations to related entities. You can specify the cascade operations in the `` element inside any of the association mapping tags. @@ -458,7 +458,7 @@ Besides `` the following operations can be specified by their res * `` * `` -+++ Join Column Element +### Join Column Element In any explicitly defined association mapping you will need the `` tag. It defines how the foreign key and primary key names are called that are used for joining two entities. @@ -474,7 +474,7 @@ Optional attributes: * nullable - should the join column be nullable, defaults to true. * on-delete - Foreign Key Cascade action to perform when entity is deleted, defaults to NO ACTION/RESTRICT but can be set to "CASCADE". -+++ Defining Order of To-Many Associations +### Defining Order of To-Many Associations You can require one-to-many or many-to-many associations to be retrieved using an additional `ORDER BY`. @@ -487,7 +487,7 @@ You can require one-to-many or many-to-many associations to be retrieved using a -+++ Defining Indexes or Unique Constraints +### Defining Indexes or Unique Constraints To define additional indexes or unique constraints on the entities table you can use the `` and `` elements: diff --git a/manual/en/yaml-mapping.rst b/manual/en/yaml-mapping.rst new file mode 100644 index 000000000..54245c5c2 --- /dev/null +++ b/manual/en/yaml-mapping.rst @@ -0,0 +1,90 @@ +The YAML mapping driver enables you to provide the ORM metadata in +form of YAML documents. + +The YAML mapping document of a class is loaded on-demand the first +time it is requested and subsequently stored in the metadata cache. +In order to work, this requires certain conventions: + + +- Each entity/mapped superclass must get its own dedicated YAML + mapping document. +- The name of the mapping document must consist of the fully + qualified name of the class, where namespace separators are + replaced by dots (.). +- All mapping documents should get the extension ".dcm.yml" to + identify it as a Doctrine mapping file. This is more of a + convention and you are not forced to do this. You can change the + file extension easily enough. + +- + +:: + + setFileExtension('.yml'); + +It is recommended to put all YAML mapping documents in a single +folder but you can spread the documents over several folders if you +want to. In order to tell the YamlDriver where to look for your +mapping documents, supply an array of paths as the first argument +of the constructor, like this: + +:: + + setMetadataDriverImpl($driver); + +Example +------- + +As a quick start, here is a small example document that makes use +of several common elements: + +:: + + [yml] + # Doctrine.Tests.ORM.Mapping.User.dcm.yml + Doctrine\Tests\ORM\Mapping\User: + type: entity + table: cms_users + id: + id: + type: integer + generator: + strategy: AUTO + fields: + name: + type: string + length: 50 + oneToOne: + address: + targetEntity: Address + joinColumn: + name: address_id + referencedColumnName: id + oneToMany: + phonenumbers: + targetEntity: Phonenumber + mappedBy: user + cascade: cascadePersist + manyToMany: + groups: + targetEntity: Group + joinTable: + name: cms_users_groups + joinColumns: + user_id: + referencedColumnName: id + inverseJoinColumns: + group_id: + referencedColumnName: id + lifecycleCallbacks: + prePersist: [ doStuffOnPrePersist, doOtherStuffOnPrePersistToo ] + postPersist: [ doStuffOnPostPersist ] + +Be aware that class-names specified in the YAML files should be +fully qualified. + + diff --git a/manual/en/yaml-mapping.txt b/manual/en/yaml-mapping.txt index a5c6b29c7..e043eb121 100644 --- a/manual/en/yaml-mapping.txt +++ b/manual/en/yaml-mapping.txt @@ -8,18 +8,18 @@ The YAML mapping document of a class is loaded on-demand the first time it is re - - [php] + setFileExtension('.yml'); It is recommended to put all YAML mapping documents in a single folder but you can spread the documents over several folders if you want to. In order to tell the YamlDriver where to look for your mapping documents, supply an array of paths as the first argument of the constructor, like this: - [php] + setMetadataDriverImpl($driver); -++ Example +## Example As a quick start, here is a small example document that makes use of several common elements: From aa25b7cc0aad7fc98516e7222b809185481ff412 Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Mon, 1 Nov 2010 21:21:01 +0100 Subject: [PATCH 02/10] Add Sphinx Configs --- cookbook/en/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/cookbook/en/conf.py b/cookbook/en/conf.py index 58e36054e..18997a35d 100644 --- a/cookbook/en/conf.py +++ b/cookbook/en/conf.py @@ -51,7 +51,7 @@ release = '2.0.0-BETA4' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -83,6 +83,8 @@ exclude_trees = ['_build'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' +highlight_language = 'php' + # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] From e7e1f62f72fc5f4fea30476784f1effaf2326753 Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Mon, 1 Nov 2010 21:21:07 +0100 Subject: [PATCH 03/10] Add Sphinx Configs --- manual/en/Makefile | 89 ++++++++++++++++++++ manual/en/conf.py | 196 ++++++++++++++++++++++++++++++++++++++++++++ manual/en/index.rst | 20 +++++ manual/en/make.bat | 113 +++++++++++++++++++++++++ 4 files changed, 418 insertions(+) create mode 100644 manual/en/Makefile create mode 100644 manual/en/conf.py create mode 100644 manual/en/index.rst create mode 100644 manual/en/make.bat diff --git a/manual/en/Makefile b/manual/en/Makefile new file mode 100644 index 000000000..a6f6fce62 --- /dev/null +++ b/manual/en/Makefile @@ -0,0 +1,89 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Doctrine2ORM.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Doctrine2ORM.qhc" + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ + "run these through (pdf)latex." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/manual/en/conf.py b/manual/en/conf.py new file mode 100644 index 000000000..b972b640f --- /dev/null +++ b/manual/en/conf.py @@ -0,0 +1,196 @@ +# -*- coding: utf-8 -*- +# +# Doctrine 2 ORM documentation build configuration file, created by +# sphinx-quickstart on Mon Nov 1 21:19:39 2010. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.append(os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Doctrine 2 ORM' +copyright = u'2010, Roman Borschel, Guilherme Blanco, Benjamin Eberlei, Jonathan Wage' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '2.0' +# The full version, including alpha/beta/rc tags. +release = '2.0.0-BETA4' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +language = 'en' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directory, that shouldn't be searched +# for source files. +exclude_trees = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +highlight_language = 'php' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_use_modindex = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Doctrine2ORMdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Doctrine2ORM.tex', u'Doctrine 2 ORM Documentation', + u'Roman Borschel, Guilherme Blanco, Benjamin Eberlei, Jonathan Wage', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True diff --git a/manual/en/index.rst b/manual/en/index.rst new file mode 100644 index 000000000..af4ddee9a --- /dev/null +++ b/manual/en/index.rst @@ -0,0 +1,20 @@ +.. Doctrine 2 ORM documentation master file, created by + sphinx-quickstart on Mon Nov 1 21:19:39 2010. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Doctrine 2 ORM's documentation! +========================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/manual/en/make.bat b/manual/en/make.bat new file mode 100644 index 000000000..53c40c912 --- /dev/null +++ b/manual/en/make.bat @@ -0,0 +1,113 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +set SPHINXBUILD=sphinx-build +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Doctrine2ORM.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Doctrine2ORM.ghc + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end From a5a0dfa96e3ac01ac0794a05f05c52d5b3190792 Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Mon, 1 Nov 2010 22:03:50 +0100 Subject: [PATCH 04/10] Converted ORM Docs into ReST --- generate-docs.sh | 2 +- manual/en/annotations-reference.rst | 93 +- manual/en/annotations-reference.txt | 611 ----------- manual/en/architecture.rst | 3 + manual/en/architecture.txt | 82 -- manual/en/association-mapping.rst | 60 +- manual/en/association-mapping.txt | 756 -------------- manual/en/basic-mapping.rst | 29 +- manual/en/basic-mapping.txt | 321 ------ manual/en/batch-processing.rst | 7 +- manual/en/batch-processing.txt | 122 --- manual/en/best-practices.rst | 11 +- manual/en/best-practices.txt | 77 -- manual/en/caching.rst | 3 + manual/en/caching.txt | 350 ------- manual/en/change-tracking-policies.rst | 2 +- manual/en/change-tracking-policies.txt | 128 --- manual/en/configuration.rst | 17 +- manual/en/configuration.txt | 307 ------ manual/en/dql-doctrine-query-language.rst | 47 +- manual/en/dql-doctrine-query-language.txt | 1096 -------------------- manual/en/events.rst | 19 +- manual/en/events.txt | 467 --------- manual/en/improving-performance.rst | 7 +- manual/en/improving-performance.txt | 25 - manual/en/index.rst | 27 + manual/en/inheritance-mapping.rst | 12 +- manual/en/inheritance-mapping.txt | 159 --- manual/en/introduction.txt | 309 ------ manual/en/limitations-and-known-issues.rst | 12 +- manual/en/limitations-and-known-issues.txt | 203 ---- manual/en/metadata-drivers.rst | 3 + manual/en/metadata-drivers.txt | 155 --- manual/en/native-sql.rst | 7 +- manual/en/native-sql.txt | 242 ----- manual/en/partial-objects.rst | 7 +- manual/en/partial-objects.txt | 49 - manual/en/php-mapping.rst | 3 + manual/en/php-mapping.txt | 199 ---- manual/en/query-builder.rst | 2 +- manual/en/query-builder.txt | 408 -------- manual/en/tools.rst | 15 +- manual/en/tools.txt | 254 ----- manual/en/transactions-and-concurrency.rst | 3 + manual/en/transactions-and-concurrency.txt | 249 ----- manual/en/working-with-associations.rst | 10 +- manual/en/working-with-associations.txt | 417 -------- manual/en/working-with-objects.rst | 27 +- manual/en/working-with-objects.txt | 549 ---------- manual/en/xml-mapping.rst | 65 +- manual/en/xml-mapping.txt | 509 --------- manual/en/yaml-mapping.rst | 6 +- manual/en/yaml-mapping.txt | 66 -- 53 files changed, 317 insertions(+), 8292 deletions(-) delete mode 100644 manual/en/annotations-reference.txt delete mode 100644 manual/en/architecture.txt delete mode 100644 manual/en/association-mapping.txt delete mode 100644 manual/en/basic-mapping.txt delete mode 100644 manual/en/batch-processing.txt delete mode 100644 manual/en/best-practices.txt delete mode 100644 manual/en/caching.txt delete mode 100644 manual/en/change-tracking-policies.txt delete mode 100644 manual/en/configuration.txt delete mode 100644 manual/en/dql-doctrine-query-language.txt delete mode 100644 manual/en/events.txt delete mode 100644 manual/en/improving-performance.txt delete mode 100644 manual/en/inheritance-mapping.txt delete mode 100644 manual/en/introduction.txt delete mode 100644 manual/en/limitations-and-known-issues.txt delete mode 100644 manual/en/metadata-drivers.txt delete mode 100644 manual/en/native-sql.txt delete mode 100644 manual/en/partial-objects.txt delete mode 100644 manual/en/php-mapping.txt delete mode 100644 manual/en/query-builder.txt delete mode 100644 manual/en/tools.txt delete mode 100644 manual/en/transactions-and-concurrency.txt delete mode 100644 manual/en/working-with-associations.txt delete mode 100644 manual/en/working-with-objects.txt delete mode 100644 manual/en/xml-mapping.txt delete mode 100644 manual/en/yaml-mapping.txt diff --git a/generate-docs.sh b/generate-docs.sh index 14fdb721b..07aaf048f 100755 --- a/generate-docs.sh +++ b/generate-docs.sh @@ -1,2 +1,2 @@ #!/bin/bash -sphinx-build reference/en /var/www/docs \ No newline at end of file +sphinx-build manual/en /var/www/docs diff --git a/manual/en/annotations-reference.rst b/manual/en/annotations-reference.rst index d7515c38a..3b5cefddd 100644 --- a/manual/en/annotations-reference.rst +++ b/manual/en/annotations-reference.rst @@ -1,3 +1,6 @@ +Annotations Reference +===================== + In this chapter a reference of every Doctrine 2 Annotation is given with short explanations on their context and usage. @@ -38,7 +41,8 @@ Index Reference --------- -### @Column +@Column +~~~~~~~ Marks an annotated instance variable as "persistent". It has to be inside the instance variables PHP DocBlock comment. Any value hold @@ -97,7 +101,8 @@ Examples: */ protected $height; -### @ChangeTrackingPolicy +@ChangeTrackingPolicy +~~~~~~~~~~~~~~~~~~~~~ The Change Tracking Policy annotation allows to specify how the Doctrine 2 UnitOfWork should detect changes in properties of @@ -125,7 +130,8 @@ Example: */ class User {} -### @DiscrimnatorColumn +@DiscrimnatorColumn +~~~~~~~~~~~~~~~~~~~~~ This annotation is a required annotation for the topmost/super class of an inheritance hierarchy. It specifies the details of the @@ -144,7 +150,8 @@ Optional attributes: - type - By default this is string. - length - By default this is 255. -### @DiscriminatorMap +@DiscriminatorMap +~~~~~~~~~~~~~~~~~~~~~ The discriminator map is a required annotation on the top-most/super class in an inheritance hierarchy. It takes an array @@ -167,7 +174,8 @@ depending if the classes are in the namespace or not. // ... } -### @Entity +@Entity +~~~~~~~ Required annotation to mark a PHP class as Entity. Doctrine manages the persistence of all classes marked as entity. @@ -193,7 +201,8 @@ Example: //... } -### @GeneratedValue +@GeneratedValue +~~~~~~~~~~~~~~~~~~~~~ Specifies which strategy is used for identifier generation for an instance variable which is annotated by `@Id <#ann_id>`_. This @@ -221,7 +230,8 @@ Example: */ protected $id = null; -### @HasLifecycleCallbacks +@HasLifecycleCallbacks +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Annotation which has to be set on the entity-class PHP DocBlock to notify Doctrine that this entity has entity life-cycle callback @@ -247,7 +257,8 @@ Example: public function sendOptinMail() {} } -### @Index +@Index +~~~~~~~ Annotation is used inside the `@Table <#ann_table>`_ annotation on the entity-class level. It allows to hint the SchemaTool to @@ -273,7 +284,8 @@ Example: { } -### @Id +@Id +~~~~~~~ The annotated instance variable will be marked as entity identifier, the primary key in the database. This annotation is a @@ -292,7 +304,8 @@ Example: */ protected $id = null; -### @InheritanceType +@InheritanceType +~~~~~~~~~~~~~~~~~~~~~ In an inheritance hierarchy you have to use this annotation on the topmost/super class to define which strategy should be used for @@ -330,7 +343,8 @@ Examples: // ... } -### @JoinColumn +@JoinColumn +~~~~~~~~~~~~~~ This annotation is used in the context of relations in `@ManyToOne <#ann_manytoone>`_, `@OneToOne <#ann_onetoone>`_ fields @@ -379,13 +393,15 @@ Example: */ private $customer; -### @JoinColumns +@JoinColumns +~~~~~~~~~~~~~~ An array of @JoinColumn annotations for a `@ManyToOne <#ann_manytoone>`_ or `@OneToOne <#ann_onetoone>`_ relation with an entity that has multiple identifiers. -### @JoinTable +@JoinTable +~~~~~~~~~~~~~~ Using `@OneToMany <#ann_onetomany>`_ or `@ManyToMany <#ann_manytomany>`_ on the owning side of the relation @@ -423,7 +439,8 @@ Example: */ public $phonenumbers; -### @ManyToOne +@ManyToOne +~~~~~~~~~~~~~~ Defines that the annotated instance variable holds a reference that describes a many-to-one relationship between two entities. @@ -453,7 +470,8 @@ Example: */ private $cart; -### @ManyToMany +@ManyToMany +~~~~~~~~~~~~~~ Defines an instance variable holds a many-to-many relationship between two entities. `@JoinTable <#ann_jointable>`_ is an @@ -508,7 +526,8 @@ Example: */ private $features; -### @MappedSuperclass +@MappedSuperclass +~~~~~~~~~~~~~~~~~~~~~ An mapped superclass is an abstract or concrete class that provides persistent entity state and mapping information for its subclasses, @@ -519,7 +538,8 @@ The @MappedSuperclass annotation cannot be used in conjunction with @Entity. See the Inheritance Mapping section for `more details on the restrictions of mapped superclasses `_. -### @OneToOne +@OneToOne +~~~~~~~~~~~~~~ The @OneToOne annotation works almost exactly as the `@ManyToOne <#ann_manytoone>`_ with one additional option that can @@ -556,7 +576,8 @@ Example: */ private $customer; -### @OneToMany +@OneToMany +~~~~~~~~~~~~~~ Required attributes: @@ -586,7 +607,8 @@ Example: */ public $phonenumbers; -### @OrderBy +@OrderBy +~~~~~~~~~~~~~~ Optional annotation that can be specified with a `@ManyToMany <#ann_manytomany>`_ or `@OneToMany <#ann_onetomany>`_ @@ -613,49 +635,57 @@ positional statement. Multiple Fields are separated by a comma (,). The referenced field names have to exist on the ``targetEntity`` class of the ``@ManyToMany`` or ``@OneToMany`` annotation. -### @PostLoad +@PostLoad +~~~~~~~~~~~~~~ Marks a method on the entity to be called as a @PostLoad event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -### @PostPersist +@PostPersist +~~~~~~~~~~~~~~ Marks a method on the entity to be called as a @PostPersist event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -### @PostRemove +@PostRemove +~~~~~~~~~~~~~~ Marks a method on the entity to be called as a @PostRemove event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -### @PostUpdate +@PostUpdate +~~~~~~~~~~~~~~ Marks a method on the entity to be called as a @PostUpdate event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -### @PrePersist +@PrePersist +~~~~~~~~~~~~~~ Marks a method on the entity to be called as a @PrePersist event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -### @PreRemove +@PreRemove +~~~~~~~~~~~~~~ Marks a method on the entity to be called as a @PreRemove event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -### @PreUpdate +@PreUpdate +~~~~~~~~~~~~~~ Marks a method on the entity to be called as a @PreUpdate event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. -### @SequenceGenerator +@SequenceGenerator +~~~~~~~~~~~~~~~~~~~~~ For the use with @generatedValue(strategy="SEQUENCE") this annotation allows to specify details about the sequence, such as @@ -688,7 +718,8 @@ Example: */ protected $id = null; -### @Table +@Table +~~~~~~~ Annotation describes the table an entity is persisted in. It is placed on the entity-class PHP DocBlock and is optional. If it is @@ -721,7 +752,8 @@ Example: */ class User { } -### @UniqueConstraint +@UniqueConstraint +~~~~~~~~~~~~~~~~~~~~~ Annotation is used inside the `@Table <#ann_table>`_ annotation on the entity-class level. It allows to hint the SchemaTool to @@ -748,7 +780,8 @@ Example: { } -### @Version +@Version +~~~~~~~~~~~~~~ Marker annotation that defines a specified column as version attribute used in an optimistic locking scenario. It only works on diff --git a/manual/en/annotations-reference.txt b/manual/en/annotations-reference.txt deleted file mode 100644 index a95362e9e..000000000 --- a/manual/en/annotations-reference.txt +++ /dev/null @@ -1,611 +0,0 @@ -In this chapter a reference of every Doctrine 2 Annotation is given with short explanations on their context and usage. - -## Index - -* [@Column](#ann_column) -* [@ChangeTrackingPolicy](#ann_changetrackingpolicy) -* [@DiscriminatorColumn](#ann_discriminatorcolumn) -* [@DiscriminatorMap](#ann_discriminatormap) -* [@Entity](#ann_entity) -* [@GeneratedValue](#ann_generatedvalue) -* [@HasLifecycleCallbacks](#ann_haslifecyclecallbacks) -* [@Index](#ann_indexes) -* [@Id](#ann_id) -* [@InheritanceType](#ann_inheritancetype) -* [@JoinColumn](#ann_joincolumn) -* [@JoinTable](#ann_jointable) -* [@ManyToOne](#ann_manytoone) -* [@ManyToMany](#ann_manytomany) -* [@MappedSuperclass](#ann_mappedsuperclass) -* [@OneToOne](#ann_onetoone) -* [@OneToMany](#ann_onetomany) -* [@OrderBy](#ann_orderby) -* [@PostLoad](#ann_postload) -* [@PostPersist](#ann_postpersist) -* [@PostRemove](#ann_postremove) -* [@PostUpdate](#ann_postupdate) -* [@PrePersist](#ann_prepersist) -* [@PreRemove](#ann_preremove) -* [@PreUpdate](#ann_preupdate) -* [@SequenceGenerator](#ann_sequencegenerator) -* [@Table](#ann_table) -* [@UniqueConstraint](#ann_uniqueconstraint) -* [@Version](#ann_version) - -## Reference - - -### @Column - -Marks an annotated instance variable as "persistent". It has to be inside the instance variables PHP DocBlock comment. -Any value hold inside this variable will be saved to and loaded from the database as part of the lifecycle of the instance variables entity-class. - -Required attributes: - -* type - Name of the Doctrine Type which is converted between PHP and Database representation. - -Optional attributes: - -* name - By default the property name is used for the database column name also, however the 'name' attribute allows you to determine the column name. -* length - Used by the "string" type to determine its maximum length in the database. Doctrine does not validate the length of a string values for you. -* precision - The precision for a decimal (exact numeric) column (Applies only for decimal column) -* scale - The scale for a decimal (exact numeric) column (Applies only for decimal column) -* unique - Boolean value to determine if the value of the column should be unique across all rows of the underlying entities table. -* nullable - Determines if NULL values allowed for this column. -* columnDefinition - DDL SQL snippet that starts after the column name and specifies the complete (non-portable!) column definition. This attribute allows to make use of advanced RMDBS features. However you should make careful use of this feature and the consequences. Additionally you should remember that the "type" attribute still handles the conversion between PHP and Database values. If you use this attribute on a column that is used for joins between tables you should also take a look at [@JoinColumn](#ann_joincolumn). - -Examples: - - -### @ChangeTrackingPolicy - -The Change Tracking Policy annotation allows to specify how the Doctrine 2 UnitOfWork should detect changes -in properties of entities during flush. By default each entity is checked according to a deferred implicit -strategy, which means upon flush UnitOfWork compares all the properties of an entity to a previously stored -snapshot. This works out of the box, however you might want to tweak the flush performance where using -another change tracking policy is an interesting option. - -The [details on all the available change tracking policies](/../configuration#change-tracking-policies) -can be found in the configuration section. - -Example: - - -### @DiscrimnatorColumn - -This annotation is a required annotation for the topmost/super class of an inheritance hierarchy. It specifies -the details of the column which saves the name of the class, which the entity is actually instantiated as. - -Required attributes: - -* name - The column name of the discriminator. This name is also used during Array hydration as key to specify the class-name. - -Optional attributes: - -* type - By default this is string. -* length - By default this is 255. - - -### @DiscriminatorMap - -The discriminator map is a required annotation on the top-most/super class in an inheritance hierarchy. It takes -an array as only argument which defines which class should be saved under which name in the database. Keys -are the database value and values are the classes, either as fully- or as unqualified class names depending -if the classes are in the namespace or not. - - -### @Entity - -Required annotation to mark a PHP class as Entity. Doctrine manages the persistence of all classes marked as entity. - -Optional attributes: - -* repositoryClass - Specifies the FQCN of a subclass of the Doctrine\ORM\EntityRepository. Use of repositories for entities is encouraged to keep specialized DQL and SQL operations separated from the Model/Domain Layer. - -Example: - - -### @GeneratedValue - -Specifies which strategy is used for identifier generation for an instance variable which is annotated by [@Id](#ann_id). -This annotation is optional and only has meaning when used in conjunction with @Id. - -If this annotation is not specified with @Id the NONE strategy is used as default. - -Required attributes: - -* strategy - Set the name of the identifier generation strategy. Valid values are AUTO, SEQUENCE, TABLE, IDENTITY and NONE. - -Example: - - -### @HasLifecycleCallbacks - -Annotation which has to be set on the entity-class PHP DocBlock to notify Doctrine that this entity has entity life-cycle -callback annotations set on at least one of its methods. Using @PostLoad, @PrePersist, @PostPersist, @PreRemove, @PostRemove, -@PreUpdate or @PostUpdate without this marker annotation will make Doctrine ignore the callbacks. - -Example: - - -### @Index - -Annotation is used inside the [@Table](#ann_table) annotation on the entity-class level. It allows to hint the -SchemaTool to generate a database index on the specified table columns. It only has meaning in the SchemaTool -schema generation context. - -Required attributes: - -* name - Name of the Index -* columns - Array of columns. - -Example: - - -### @Id - -The annotated instance variable will be marked as entity identifier, the primary key in the database. -This annotation is a marker only and has no required or optional attributes. For entities that have multiple -identifier columns each column has to be marked with @Id. - -Example: - - -### @InheritanceType - -In an inheritance hierarchy you have to use this annotation on the topmost/super class to define which -strategy should be used for inheritance. Currently Single Table and Class Table Inheritance are supported. - -This annotation has always been used in conjunction with the [@DiscriminatorMap](#ann_discriminatormap) and -[@DiscriminatorColumn](#ann_discriminatorcolumn) annotations. - -Examples: - - -### @JoinColumn - -This annotation is used in the context of relations in [@ManyToOne](#ann_manytoone), [@OneToOne](#ann_onetoone) fields -and in the Context of [@JoinTable](#ann_jointable) nested inside a @ManyToMany. This annotation is not required. -If its not specified the attributes *name* and *referencedColumnName* are inferred from the table and primary key names. - -Required attributes: - -* name - Column name that holds the foreign key identifier for this relation. In the context of @JoinTable it specifies the column name in the join table. -* referencedColumnName - Name of the primary key identifier that is used for joining of this relation. - -Optional attributes: - -* unique - Determines if this relation exclusive between the affected entities and should be enforced so on the database constraint level. Defaults to false. -* nullable - Determine if the related entity is required, or if null is an allowed state for the relation. Defaults to true. -* onDelete - Cascade Action (Database-level) -* onUpdate - Cascade Action (Database-level) -* columnDefinition - DDL SQL snippet that starts after the column name and specifies the complete (non-portable!) column definition. This attribute allows to make use of advanced RMDBS features. Using this attribute on @JoinColumn is necessary if you need slightly different column definitions for joining columns, for example regarding NULL/NOT NULL defaults. However by default a "columnDefinition" attribute on [@Column](#ann_column) also sets the related @JoinColumn's columnDefinition. This is necessary to make foreign keys work. - -Example: - - -### @JoinColumns - -An array of @JoinColumn annotations for a [@ManyToOne](#ann_manytoone) or [@OneToOne](#ann_onetoone) relation -with an entity that has multiple identifiers. - - -### @JoinTable - -Using [@OneToMany](#ann_onetomany) or [@ManyToMany](#ann_manytomany) on the owning side of the relation requires to specify -the @JoinTable annotation which describes the details of the database join table. If you do not specify @JoinTable on -these relations reasonable mapping defaults apply using the affected table and the column names. - -Required attributes: - -* name - Database name of the join-table -* joinColumns - An array of @JoinColumn annotations describing the join-relation between the owning entities table and the join table. -* inverseJoinColumns - An array of @JoinColumn annotations describing the join-relation between the inverse entities table and the join table. - -Optional attributes: - -* schema - Database schema name of this table. - -Example: - - -### @ManyToOne - -Defines that the annotated instance variable holds a reference that describes a many-to-one relationship between two entities. - -Required attributes: - -* targetEntity - FQCN of the referenced target entity. Can be the unqualified class name if both classes are in the same namespace. *IMPORTANT:* No leading backslash! - -Optional attributes: - -* cascade - Cascade Option -* fetch - One of LAZY or EAGER -* inversedBy - The inversedBy attribute designates the field in the entity that is the inverse side of the relationship. - -Example: - - -### @ManyToMany - -Defines an instance variable holds a many-to-many relationship between two entities. [@JoinTable](#ann_jointable) -is an additional, optional annotation that has reasonable default configuration values using the table -and names of the two related entities. - -Required attributes: - -* targetEntity - FQCN of the referenced target entity. Can be the unqualified class name if both classes are in the same namespace. *IMPORTANT:* No leading backslash! - -Optional attributes: - -* mappedBy - This option specifies the property name on the targetEntity that is the owning side of this relation. Its a required attribute for the inverse side of a relationship. -* inversedBy - The inversedBy attribute designates the field in the entity that is the inverse side of the relationship. -* cascade - Cascade Option -* fetch - One of LAZY or EAGER - -> **NOTE** -> For ManyToMany bidirectional relationships either side may be the owning side (the side -> that defines the @JoinTable and/or does not make use of the mappedBy attribute, thus -> using a default join table). - -Example: - - -### @MappedSuperclass - -An mapped superclass is an abstract or concrete class that provides persistent entity state and mapping information -for its subclasses, but which is not itself an entity. This annotation is specified on the Class docblock -and has no additional attributes. - -The @MappedSuperclass annotation cannot be used in conjunction with @Entity. See the Inheritance Mapping -section for [more details on the restrictions of mapped superclasses](/../inheritance-mapping#mapped-superclasses). - - -### @OneToOne - -The @OneToOne annotation works almost exactly as the [@ManyToOne](#ann_manytoone) with one additional option -that can be specified. The configuration defaults for [@JoinColumn](#ann_joincolumn) using the target entity table and primary key column names -apply here too. - -Required attributes: - -* targetEntity - FQCN of the referenced target entity. Can be the unqualified class name if both classes are in the same namespace. *IMPORTANT:* No leading backslash! - -Optional attributes: - -* cascade - Cascade Option -* fetch - One of LAZY or EAGER -* orphanRemoval - Boolean that specifies if orphans, inverse OneToOne entities that are not connected to any -owning instance, should be removed by Doctrine. Defaults to false. -* inversedBy - The inversedBy attribute designates the field in the entity that is the inverse side of the relationship. - -Example: - - -### @OneToMany - -Required attributes: - -* targetEntity - FQCN of the referenced target entity. Can be the unqualified class name if both classes are in the same namespace. *IMPORTANT:* No leading backslash! - -Optional attributes: - -* cascade - Cascade Option -* orphanRemoval - Boolean that specifies if orphans, inverse OneToOne entities that are not connected to any -owning instance, should be removed by Doctrine. Defaults to false. -* mappedBy - This option specifies the property name on the targetEntity that is the owning side of this relation. Its a required attribute for the inverse side of a relationship. - -Example: - - -### @OrderBy - -Optional annotation that can be specified with a [@ManyToMany](#ann_manytomany) or [@OneToMany](#ann_onetomany) -annotation to specify by which criteria the collection should be retrieved from the database by using an ORDER BY -clause. - -This annotation requires a single non-attributed value with an DQL snippet: - -Example: - - -### @PostLoad - -Marks a method on the entity to be called as a @PostLoad event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. - - -### @PostPersist - -Marks a method on the entity to be called as a @PostPersist event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. - - -### @PostRemove - -Marks a method on the entity to be called as a @PostRemove event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. - - -### @PostUpdate - -Marks a method on the entity to be called as a @PostUpdate event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. - - -### @PrePersist - -Marks a method on the entity to be called as a @PrePersist event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. - - -### @PreRemove - -Marks a method on the entity to be called as a @PreRemove event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. - - -### @PreUpdate - -Marks a method on the entity to be called as a @PreUpdate event. Only works with @HasLifecycleCallbacks in the entity class PHP DocBlock. - - -### @SequenceGenerator - -For the use with @generatedValue(strategy="SEQUENCE") this annotation allows to specify details about the sequence, -such as the increment size and initial values of the sequence. - -Required attributes: - -* sequenceName - Name of the sequence - -Optional attributes: - -* allocationSize - Increment the sequence by the allocation size when its fetched. A value larger than 1 allows to optimize for scenarios where you create more than one new entity per request. Defaults to 10 -* initialValue - Where does the sequence start, defaults to 1. - -Example: - - -### @Table - -Annotation describes the table an entity is persisted in. It is placed on the entity-class PHP DocBlock and is optional. -If it is not specified the table name will default to the entities unqualified classname. - -Required attributes: - -* name - Name of the table - -Optional attributes: - -* schema - Database schema name of this table. -* indexes - Array of @Index annotations -* uniqueConstraints - Array of @UniqueConstraint annotations. - -Example: - - -### @UniqueConstraint - -Annotation is used inside the [@Table](#ann_table) annotation on the entity-class level. It allows to hint the -SchemaTool to generate a database unique constraint on the specified table columns. It only has meaning in the SchemaTool -schema generation context. - -Required attributes: - -* name - Name of the Index -* columns - Array of columns. - -Example: - - -### @Version - -Marker annotation that defines a specified column as version attribute used in an optimistic locking scenario. -It only works on [@Column](#ann_column) annotations that have the type integer or datetime. - -Example: - - **TIP** -> The constructor of an entity is only ever invoked when *you* construct a new instance -> with the *new* keyword. Doctrine never calls entity constructors, thus you are free to use -> them as you wish and even have it require arguments of any type. - -### Entity states - -An entity instance can be characterized as being NEW, MANAGED, DETACHED or REMOVED. - -* A NEW entity instance has no persistent identity, and is not yet associated with an EntityManager and a UnitOfWork (i.e. those just created with the "new" operator). -* A MANAGED entity instance is an instance with a persistent identity that is associated with an EntityManager and whose persistence is thus managed. -* A DETACHED entity instance is an instance with a persistent identity that is not (or no longer) associated with an EntityManager and a UnitOfWork. -* A REMOVED entity instance is an instance with a persistent identity, associated with an EntityManager, that will be removed from the database upon transaction commit. - -### Persistent fields - -The persistent state of an entity is represented by instance variables. An -instance variable must be directly accessed only from within the methods of the -entity by the entity instance itself. Instance variables must not be accessed by -clients of the entity. The state of the entity is available to clients only through -the entity’s methods, i.e. accessor methods (getter/setter methods) or other -business methods. - -Collection-valued persistent fields and properties must be defined in terms of -the `Doctrine\Common\Collections\Collection` interface. The collection -implementation type may be used by the application to initialize fields or -properties before the entity is made persistent. Once the entity becomes -managed (or detached), subsequent access must be through the interface type. - -### Serializing entities - -Serializing entities can be problematic and is not really recommended, at least not as long as an -entity instance still holds references to proxy objects or is still managed by an EntityManager. -If you intend to serialize (and unserialize) entity instances that still hold references to proxy objects -you may run into problems with private properties because of technical limitations. -Proxy objects implement `__sleep` and it is not possible for `__sleep` to return names of -private properties in parent classes. On the other hand it is not a solution for proxy objects -to implement `Serializable` because Serializable does not work well with any potential cyclic -object references (at least we did not find a way yet, if you did, please contact us). - -## The EntityManager - -The `EntityManager` class is a central access point to the ORM functionality -provided by Doctrine 2. The `EntityManager` API is used to manage the persistence -of your objects and to query for persistent objects. - -### Transactional write-behind - -An `EntityManager` and the underlying `UnitOfWork` employ a strategy called -"transactional write-behind" that delays the execution of SQL statements in -order to execute them in the most efficient way and to execute them at the end -of a transaction so that all write locks are quickly released. You should see -Doctrine as a tool to synchronize your in-memory objects with the database in -well defined units of work. Work with your objects and modify them as usual and -when you're done call `EntityManager#flush()` to make your changes persistent. - -### The Unit of Work - -Internally an `EntityManager` uses a `UnitOfWork`, which is a typical -implementation of the [Unit of Work pattern](http://martinfowler.com/eaaCatalog/unitOfWork.html), to keep track of all the things that need to be done -the next time `flush` is invoked. You usually do not directly interact with -a `UnitOfWork` but with the `EntityManager` instead. \ No newline at end of file diff --git a/manual/en/association-mapping.rst b/manual/en/association-mapping.rst index de7b72790..6b1631905 100644 --- a/manual/en/association-mapping.rst +++ b/manual/en/association-mapping.rst @@ -1,3 +1,6 @@ +Association Mapping +=================== + This chapter explains how associations between entities are mapped with Doctrine. We start out with an explanation of the concept of owning and inverse sides which is important to understand when @@ -65,7 +68,9 @@ The owning side of a bidirectional association is the side Doctrine consequently whether there is anything to do to update the association in the database. - **NOTE** "Owning side" and "inverse side" are technical concepts of +.. note:: + + "Owning side" and "inverse side" are technical concepts of the ORM technology, not concepts of your domain model. What you consider as the owning side in your domain model can be different from what the owning side is for Doctrine. These are unrelated. @@ -96,7 +101,9 @@ and more importantly because you can not pass this collection to all the useful PHP array functions, which makes it very hard to work with. - **CAUTION** The Collection interface and ArrayCollection class, +.. warning:: + + The Collection interface and ArrayCollection class, like everything else in the Doctrine namespace, are neither part of the ORM, nor the DBAL, it is a plain PHP class that has no outside dependencies apart from dependencies on PHP itself (and the SPL). @@ -280,7 +287,7 @@ Or you can trigger the validation manually: If the mapping is invalid the errors array contains a positive number of elements with error messages. - **NOTE** +.. note:: One common error is to use a backlash in front of the fully-qualified class-name. Whenever a FQCN is represented inside a @@ -325,9 +332,8 @@ as the defaults would be the same. Generated MySQL Schema: -:: +.. code-block:: sql - [sql] CREATE TABLE Product ( id INT AUTO_INCREMENT NOT NULL, shipping_id INT DEFAULT NULL, @@ -381,9 +387,8 @@ as the defaults would be the same. Generated MySQL Schema: -:: +.. code-block:: sql - [sql] CREATE TABLE Cart ( id INT AUTO_INCREMENT NOT NULL, customer_id INT DEFAULT NULL, @@ -426,9 +431,8 @@ as the defaults would be the same. With the generated MySQL Schema: -:: +.. code-block:: sql - [sql] CREATE TABLE Student ( id INT AUTO_INCREMENT NOT NULL, mentor_id INT DEFAULT NULL, @@ -476,15 +480,16 @@ association: // ... } - **NOTE** One-To-Many uni-directional relations with join-table only +.. note:: + + One-To-Many uni-directional relations with join-table only work using the @ManyToMany annotation and a unique-constraint. Generates the following MySQL Schema: -:: +.. code-block:: sql - [sql] CREATE TABLE User ( id INT AUTO_INCREMENT NOT NULL, PRIMARY KEY(id) @@ -532,16 +537,17 @@ with the following: // ... } - **TIP** The above ``@JoinColumn`` is optional as it would default +.. note:: + + The above ``@JoinColumn`` is optional as it would default to ``address_id`` and ``id`` anyways. You can omit it and let it use the defaults. Generated MySQL Schema: -:: +.. code-block:: sql - [sql] CREATE TABLE User ( id INT AUTO_INCREMENT NOT NULL, address_id INT DEFAULT NULL, @@ -597,9 +603,8 @@ as the defaults would be the same. Generated MySQL Schema: -:: +.. code-block:: sql - [sql] CREATE TABLE Product ( id INT AUTO_INCREMENT NOT NULL, PRIMARY KEY(id) @@ -649,9 +654,8 @@ as the defaults would be the same. Generated MySQL Schema: -:: +.. code-block:: sql - [sql] CREATE TABLE Category ( id INT AUTO_INCREMENT NOT NULL, parent_id INT DEFAULT NULL, @@ -706,9 +710,8 @@ entities: Generated MySQL Schema: -:: +.. code-block:: sql - [sql] CREATE TABLE User ( id INT AUTO_INCREMENT NOT NULL, PRIMARY KEY(id) @@ -868,9 +871,8 @@ field named ``$friendsWithMe`` and ``$myFriends``. Generated MySQL Schema: -:: +.. code-block:: sql - [sql] CREATE TABLE User ( id INT AUTO_INCREMENT NOT NULL, PRIMARY KEY(id) @@ -940,30 +942,26 @@ ORDER BY, since g is not fetch joined: However the following: -:: +.. code-block:: sql - [sql] SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ...would internally be rewritten to: -:: +.. code-block:: sql - [sql] SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ORDER BY g.name ASC You can't reverse the order with an explicit DQL ORDER BY: -:: +.. code-block:: sql - [sql] SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ORDER BY g.name DESC ...is internally rewritten to: -:: +.. code-block:: sql - [sql] SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ORDER BY g.name DESC, g.name ASC diff --git a/manual/en/association-mapping.txt b/manual/en/association-mapping.txt deleted file mode 100644 index fb22869f2..000000000 --- a/manual/en/association-mapping.txt +++ /dev/null @@ -1,756 +0,0 @@ -This chapter explains how associations between entities are mapped with Doctrine. We start out with an explanation of the concept of owning and inverse sides which is important to understand when working with bidirectional associations. Please read these explanations carefully. - -## Owning Side and Inverse Side - -When mapping bidirectional associations it is important to understand the concept of the owning and inverse sides. The following general rules apply: - -* Relationships may be bidirectional or unidirectional. -* A bidirectional relationship has both an owning side and an inverse side. -* A unidirectional relationship only has an owning side. -* The owning side of a relationship determines the updates to the relationship in the database. - -The following rules apply to *bidirectional* associations: - -* The inverse side of a bidirectional relationship must refer to its owning side by use of the mappedBy attribute of the OneToOne, OneToMany, or ManyToMany mapping declaration. The mappedBy attribute designates the field in the entity that is the owner of the relationship. -* The owning side of a bidirectional relationship must refer to its inverse side by use of the inversedBy attribute of the OneToOne, ManyToOne, or ManyToMany mapping declaration. The inversedBy attribute designates the field in the entity that is the inverse side of the relationship. -* The many side of OneToMany/ManyToOne bidirectional relationships *must* be the owning side, hence the mappedBy element can not be specified on the ManyToOne side. -* For OneToOne bidirectional relationships, the owning side corresponds to the side that contains the corresponding foreign key (@JoinColumn(s)). -* For ManyToMany bidirectional relationships either side may be the owning side (the side that defines the @JoinTable and/or does not make use of the mappedBy attribute, thus using a default join table). - -Especially important is the following: - -**The owning side of a relationship determines the updates to the relationship in the database**. - -To fully understand this, remember how bidirectional associations are maintained -in the object world. There are 2 references on each side of the association -and these 2 references both represent the same association but can change -independently of one another. Of course, in a correct application the semantics -of the bidirectional association are properly maintained by the application -developer (that's his responsibility). Doctrine needs to know which of -these two in-memory references is the one that should be persisted and which -not. This is what the owning/inverse concept is mainly used for. - -**Changes made only to the inverse side of an association are ignored. Make sure to update both sides of a bidirectional association (or at least the owning side, from Doctrine's point of view)** - -The owning side of a bidirectional association is the side Doctrine "looks at" when determining -the state of the association, and consequently whether there is anything to do to update the association -in the database. - -> **NOTE** -> "Owning side" and "inverse side" are technical concepts of the ORM technology, not concepts -> of your domain model. What you consider as the owning side in your domain model can be different -> from what the owning side is for Doctrine. These are unrelated. - -## Collections - -In all the examples of many-valued associations in this manual we will make use of a `Collection` interface and a corresponding default implementation `ArrayCollection` that are defined in the `Doctrine\Common\Collections` namespace. Why do we need that? Doesn't that couple my domain model to Doctrine? Unfortunately, PHP arrays, while being great for many things, do not make up for good collections of business objects, especially not in the context of an ORM. The reason is that plain PHP arrays can not be transparently extended / instrumented in PHP code, which is necessary for a lot of advanced ORM features. The classes / interfaces that come closest to an OO collection are ArrayAccess and ArrayObject but until instances of these types can be used in all places where a plain array can be used (something that may happen in PHP6) their usability is fairly limited. You "can" type-hint on `ArrayAccess` instead of `Collection`, since the Collection interface extends `ArrayAccess`, but this will severely limit you in the way you can work with the collection, because the `ArrayAccess` API is (intentionally) very primitive and more importantly because you can not pass this collection to all the useful PHP array functions, which makes it very hard to work with. - -> **CAUTION** -> The Collection interface and ArrayCollection class, like everything else in the -> Doctrine\Common namespace, are neither part of the ORM, nor the DBAL, it is a plain PHP -> class that has no outside dependencies apart from dependencies on PHP itself (and the -> SPL). Therefore using this class in your domain classes and elsewhere does not introduce -> a coupling to the persistence layer. The Collection class, like everything else in the -> Common namespace, is not part of the persistence layer. You could even copy that class -> over to your project if you want to remove Doctrine from your project and all your -> domain classes will work the same as before. - -## Mapping Defaults - -Before we introduce all the association mappings in detail, you should note that the @JoinColumn and @JoinTable -definitions are usually optional and have sensible default values. -The defaults for a join column in a one-to-one/many-to-one association is as follows: - - name: "_id" - referencedColumnName: "id" - -As an example, consider this mapping: - - groups; - } - } - -With this code alone the `$groups` field only contains an instance of `Doctrine\Common\Collections\Collection` if the user is retrieved from -Doctrine, however not after you instantiated a fresh instance of the User. When your user entity is still new `$groups` will obviously be null. - -This is why we recommend to initialize all collection fields to an empty `ArrayCollection` in your entities constructor: - - groups = new ArrayCollection(); - } - - public function getGroups() - { - return $this->groups; - } - } - -Now the following code will be working even if the Entity hasn't been associated with an EntityManager yet: - - find('Group', $groupId); - $user = new User(); - $user->getGroups()->add($group); - -## Runtime vs Development Mapping Validation - -For performance reasons Doctrine 2 has to skip some of the necessary validation of association mappings. -You have to execute this validation in your development workflow to verify the associations are correctly -defined. - -You can either use the Doctrine Command Line Tool: - - doctrine orm:validate-schema - -Or you can trigger the validation manually: - - use Doctrine\ORM\Tools\SchemaValidator; - - $validator = new SchemaValidator($entityManager); - $errors = $validator->validateMapping(); - - if (count($errors) > 0) { - // Lots of errors! - echo implode("\n\n", $errors); - } - -If the mapping is invalid the errors array contains a positive number of elements with error messages. - -> **NOTE** -> -> One common error is to use a backlash in front of the fully-qualified class-name. Whenever a FQCN is represented -> inside a string (such as in your mapping definitions) you have to drop the prefix backslash. PHP does this with -> `get_class()` or Reflection methods for backwards compatibility reasons. - -## One-To-One, Unidirectional - -A unidirectional one-to-one association is very common. Here is an example of a `Product` that has one `Shipping` object associated to it. The `Shipping` side does not reference back to the `Product` so it is unidirectional. - - phonenumbers = new \Doctrine\Common\Collections\ArrayCollection(); - } - - // ... - } - - /** @Entity */ - class Phonenumber - { - // ... - } - -> **NOTE** -> One-To-Many uni-directional relations with join-table only work using the @ManyToMany annotation and a unique-constraint. - -Generates the following MySQL Schema: - - [sql] - CREATE TABLE User ( - id INT AUTO_INCREMENT NOT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - - CREATE TABLE users_phonenumbers ( - user_id INT NOT NULL, - phonenumber_id INT NOT NULL, - UNIQUE INDEX users_phonenumbers_phonenumber_id_uniq (phonenumber_id), - PRIMARY KEY(user_id, phonenumber_id) - ) ENGINE = InnoDB; - - CREATE TABLE Phonenumber ( - id INT AUTO_INCREMENT NOT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - - ALTER TABLE users_phonenumbers ADD FOREIGN KEY (user_id) REFERENCES User(id); - ALTER TABLE users_phonenumbers ADD FOREIGN KEY (phonenumber_id) REFERENCES Phonenumber(id); - -## Many-To-One, Unidirectional - -You can easily implement a many-to-one unidirectional association with the following: - - **TIP** -> The above `@JoinColumn` is optional as it would default to `address_id` and `id` -> anyways. You can omit it and let it use the defaults. - -Generated MySQL Schema: - - [sql] - CREATE TABLE User ( - id INT AUTO_INCREMENT NOT NULL, - address_id INT DEFAULT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - - CREATE TABLE Address ( - id INT AUTO_INCREMENT NOT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - - ALTER TABLE User ADD FOREIGN KEY (address_id) REFERENCES Address(id); - -## One-To-Many, Bidirectional - -Bidirectional one-to-many associations are very common. The following code shows an example with a Product and a Feature class: - - features = new \Doctrine\Common\Collections\ArrayCollection(); - } - } - - /** @Entity */ - class Feature - { - // ... - /** - * @ManyToOne(targetEntity="Product", inversedBy="features") - * @JoinColumn(name="product_id", referencedColumnName="id") - */ - private $product; - // ... - } - -Note that the @JoinColumn is not really necessary in this example, as the defaults would be the same. - -Generated MySQL Schema: - - [sql] - CREATE TABLE Product ( - id INT AUTO_INCREMENT NOT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - CREATE TABLE Feature ( - id INT AUTO_INCREMENT NOT NULL, - product_id INT DEFAULT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - ALTER TABLE Feature ADD FOREIGN KEY (product_id) REFERENCES Product(id); - -## One-To-Many, Self-referencing - -You can also setup a one-to-many association that is self-referencing. In this example we -setup a hierarchy of `Category` objects by creating a self referencing relationship. -This effectively models a hierarchy of categories and from the database perspective is known as an adjacency list approach. - - children = new \Doctrine\Common\Collections\ArrayCollection(); - } - } - -Note that the @JoinColumn is not really necessary in this example, as the defaults would be the same. - -Generated MySQL Schema: - - [sql] - CREATE TABLE Category ( - id INT AUTO_INCREMENT NOT NULL, - parent_id INT DEFAULT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - ALTER TABLE Category ADD FOREIGN KEY (parent_id) REFERENCES Category(id); - -## Many-To-Many, Unidirectional - -Real many-to-many associations are less common. The following example shows a unidirectional association between User and Group entities: - - groups = new \Doctrine\Common\Collections\ArrayCollection(); - } - } - - /** @Entity */ - class Group - { - // ... - } - -> **NOTE** -> Why are many-to-many associations less common? Because frequently you want to associate -> additional attributes with an association, in which case you introduce an association -> class. Consequently, the direct many-to-many association disappears and is replaced -> by one-to-many/many-to-one associations between the 3 participating classes. - -Generated MySQL Schema: - - [sql] - CREATE TABLE User ( - id INT AUTO_INCREMENT NOT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - CREATE TABLE users_groups ( - user_id INT NOT NULL, - group_id INT NOT NULL, - PRIMARY KEY(user_id, group_id) - ) ENGINE = InnoDB; - CREATE TABLE Group ( - id INT AUTO_INCREMENT NOT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - ALTER TABLE users_groups ADD FOREIGN KEY (user_id) REFERENCES User(id); - ALTER TABLE users_groups ADD FOREIGN KEY (group_id) REFERENCES Group(id); - -## Many-To-Many, Bidirectional - -Here is a similar many-to-many relationship as above except this one is bidirectional. - - groups = new \Doctrine\Common\Collections\ArrayCollection(); - } - - // ... - } - - /** @Entity */ - class Group - { - // ... - /** - * @ManyToMany(targetEntity="User", mappedBy="groups") - */ - private $users; - - public function __construct() { - $this->users = new \Doctrine\Common\Collections\ArrayCollection(); - } - - // ... - } - -The MySQL schema is exactly the same as for the Many-To-Many uni-directional case above. - -### Picking Owning and Inverse Side - -For Many-To-Many associations you can chose which entity is the owning and which the inverse side. There is -a very simple semantic rule to decide which side is more suitable to be the owning side from a developers perspective. -You only have to ask yourself, which entity is responsible for the connection management and pick that as the owning side. - -Take an example of two entities `Article` and `Tag`. Whenever you want to connect an Article to a Tag and vice-versa, it is mostly -the Article that is responsible for this relation. Whenever you add a new article, you want to connect it with existing or new tags. -Your create Article form will probably support this notion and allow to specify the tags directly. This is why you should -pick the Article as owning side, as it makes the code more understandable: - - addArticle($this); // synchronously updating inverse side - $this->tags[] = $tag; - } - } - - class Tag - { - private $articles; - - public function addArticle(Article $article) - { - $this->articles[] = $article; - } - } - -This allows to group the tag adding on the `Article` side of the association: - - addTag($tagA); - $article->addTag($tagB); - -## Many-To-Many, Self-referencing - -You can even have a self-referencing many-to-many association. A common scenario is where a `User` has friends and the target entity of that relationship is a `User` so it is self referencing. In this example it is bidirectional so `User` has a field named `$friendsWithMe` and `$myFriends`. - - friendsWithMe = new \Doctrine\Common\Collections\ArrayCollection(); - $this->myFriends = new \Doctrine\Common\Collections\ArrayCollection(); - } - - // ... - } - -Generated MySQL Schema: - - [sql] - CREATE TABLE User ( - id INT AUTO_INCREMENT NOT NULL, - PRIMARY KEY(id) - ) ENGINE = InnoDB; - CREATE TABLE friends ( - user_id INT NOT NULL, - friend_user_id INT NOT NULL, - PRIMARY KEY(user_id, friend_user_id) - ) ENGINE = InnoDB; - ALTER TABLE friends ADD FOREIGN KEY (user_id) REFERENCES User(id); - ALTER TABLE friends ADD FOREIGN KEY (friend_user_id) REFERENCES User(id); - -## Ordering To-Many Collections - -In many use-cases you will want to sort collections when they are retrieved from the database. -In userland you do this as long as you haven't initially saved an entity with its associations -into the database. To retrieve a sorted collection from the database you can use the -`@OrderBy` annotation with an collection that specifies an DQL snippet that is appended -to all queries with this collection. - -Additional to any `@OneToMany` or `@ManyToMany` annotation you can specify the `@OrderBy` -in the following way: - - 10 - -However the following: - - [sql] - SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 - -...would internally be rewritten to: - - [sql] - SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ORDER BY g.name ASC - -You can't reverse the order with an explicit DQL ORDER BY: - - [sql] - SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ORDER BY g.name DESC - -...is internally rewritten to: - - [sql] - SELECT u, g FROM User u JOIN u.groups g WHERE u.id = 10 ORDER BY g.name DESC, g.name ASC \ No newline at end of file diff --git a/manual/en/basic-mapping.rst b/manual/en/basic-mapping.rst index 7d8378f4e..506337092 100644 --- a/manual/en/basic-mapping.rst +++ b/manual/en/basic-mapping.rst @@ -1,3 +1,6 @@ +Basic Mapping +============= + This chapter explains the basic mapping of objects and properties. Mapping of associations will be covered in the next chapter "Association Mapping". @@ -17,7 +20,9 @@ This manual usually uses docblock annotations in all the examples that are spread throughout all chapters. There are dedicated chapters for XML and YAML mapping, respectively. - **NOTE** If you're wondering which mapping driver gives the best +.. note:: + + If you're wondering which mapping driver gives the best performance, the answer is: None. Once the metadata of a class has been read from the source (annotations, xml or yaml) it is stored in an instance of the ``Doctrine\ORM\Mapping\ClassMetadata`` class @@ -127,11 +132,14 @@ built-in mapping types: PHP double. *IMPORTANT*: Works only with locale settings that use decimal points as separator. - **NOTE** Doctrine Mapping Types are NOT SQL types and NOT PHP +.. note:: + + Doctrine Mapping Types are NOT SQL types and NOT PHP types! They are mapping types between 2 types. +.. warning:: - **CAUTION** Mapping types are *case-sensitive*. For example, using + Mapping types are *case-sensitive*. For example, using a DateTime column will NOT match the datetime type that ships with Doctrine 2! @@ -259,7 +267,9 @@ know about it. This can be achieved through the ``Doctrine\DBAL\Configuration#setCustomTypes(array $types)`` method. - **NOTE** ``Doctrine\ORM\Configuration`` is a subclass of +.. note:: + + ``Doctrine\ORM\Configuration`` is a subclass of ``Doctrine\DBAL\Configuration``, so the methods are available on your ORM Configuration instance as well. @@ -428,7 +438,9 @@ need to access the sequence once to generate the identifiers for INCREMENT BY value, otherwise you may get duplicate keys. - **TIP** It is possible to use strategy="AUTO" and at the same time +.. note:: + + It is possible to use strategy="AUTO" and at the same time specifying a @SequenceGenerator. In such a case, your custom sequence settings are used in the case where the preferred strategy of the underlying platform is SEQUENCE, such as for Oracle and @@ -467,11 +479,14 @@ backticks. Here is an example: Doctrine will then quote this column name in all SQL statements according to the used database platform. - **CAUTION** Identifier Quoting is not supported for join column +.. warning:: + + Identifier Quoting is not supported for join column names or discriminator column names. +.. warning:: - **CAUTION** Identifier Quoting is a feature that is mainly intended + Identifier Quoting is a feature that is mainly intended to support legacy database schemas. The use of reserved words and identifier quoting is generally discouraged. Identifier quoting should not be used to enable the use non-standard-characters such diff --git a/manual/en/basic-mapping.txt b/manual/en/basic-mapping.txt deleted file mode 100644 index 15eeb81dc..000000000 --- a/manual/en/basic-mapping.txt +++ /dev/null @@ -1,321 +0,0 @@ -This chapter explains the basic mapping of objects and properties. Mapping of associations will be covered in the next chapter "Association Mapping". - -## Mapping Drivers - -Doctrine provides several different ways for specifying object-relational mapping metadata: - -* Docblock Annotations -* XML -* YAML - -This manual usually uses docblock annotations in all the examples that are spread throughout all chapters. There are dedicated chapters for XML and YAML mapping, respectively. - -> **NOTE** -> If you're wondering which mapping driver gives the best performance, the answer is: -> None. Once the metadata of a class has been read from the source (annotations, xml or -> yaml) it is stored in an instance of the `Doctrine\ORM\Mapping\ClassMetadata` class -> and these instances are stored in the metadata cache. Therefore at the end of the day -> all drivers perform equally well. If you're not using a metadata cache (not -> recommended!) then the XML driver might have a slight edge in performance due to the -> powerful native XML support in PHP. - -## Introduction to Docblock Annotations - -You've probably used docblock annotations in some form already, most likely to provide documentation metadata for a tool like `PHPDocumentor` (@author, @link, ...). Docblock annotations are a tool to embed metadata inside the documentation section which can then be processed by some tool. Doctrine 2 generalizes the concept of docblock annotations so that they can be used for any kind of metadata and so that it is easy to define new docblock annotations. In order to allow more involved annotation values and to reduce the chances of clashes with other docblock annotations, the Doctrine 2 docblock annotations feature an alternative syntax that is heavily inspired by the Annotation syntax introduced in Java 5. - -The implementation of these enhanced docblock annotations is located in the `Doctrine\Common\Annotations` namespace and therefore part of the Common package. Doctrine 2 docblock annotations support namespaces and nested annotations among other things. The Doctrine 2 ORM defines its own set of docblock annotations for supplying object-relational mapping metadata. - -> **NOTE** -> If you're not comfortable with the concept of docblock annotations, don't worry, as -> mentioned earlier Doctrine 2 provides XML and YAML alternatives and you could easily -> implement your own favourite mechanism for defining ORM metadata. - -## Persistent classes - -In order to mark a class for object-relational persistence it needs to be designated as an entity. This can be done through the `@Entity` marker annotation. - - **NOTE** -> Doctrine Mapping Types are NOT SQL types and NOT PHP types! They are mapping types -> between 2 types. - -> **CAUTION** -> Mapping types are *case-sensitive*. For example, using a DateTime column will NOT match the datetime type -> that ships with Doctrine 2! - -## Property Mapping - -After a class has been marked as an entity it can specify mappings for its instance fields. Here we will only look at simple fields that hold scalar values like strings, numbers, etc. Associations to other objects are covered in the chapter "Association Mapping". - -To mark a property for relational persistence the `@Column` docblock annotation is used. This annotation usually requires at least 1 attribute to be set, the `type`. The `type` attribute specifies the Doctrine Mapping Type to use for the field. If the type is not specified, 'string' is used as the default mapping type since it is the most flexible. - -Example: - - **NOTE** -> `Doctrine\ORM\Configuration` is a subclass of `Doctrine\DBAL\Configuration`, so the -> methods are available on your ORM Configuration instance as well. - -Here is an example: - - getConnection(); - $conn->getDatabasePlatform()->registerDoctrineTypeMapping('db_mytype', 'mytype'); - -Now using Schema-Tool, whenever it detects a column having the `db_mytype` it will convert it into a `mytype` -Doctrine Type instance for Schema representation. Keep in mind that you can easily produce clashes this way, -each database type can only map to exactly one Doctrine mapping type. - -## Identifiers / Primary Keys - -Every entity class needs an identifier/primary key. You designate the field that serves as the identifier with the `@Id` marker annotation. Here is an example: - - **CAUTION** -> The allocationSize is detected by SchemaTool and transformed into an "INCREMENT BY " clause -> in the CREATE SEQUENCE statement. For a database schema created manually (and not SchemaTool) you have to -> make sure that the allocationSize configuration option is never larger than the actual sequences INCREMENT BY value, -> otherwise you may get duplicate keys. - -> **TIP** -> It is possible to use strategy="AUTO" and at the same time specifying a @SequenceGenerator. -> In such a case, your custom sequence settings are used in the case where the preferred -> strategy of the underlying platform is SEQUENCE, such as for Oracle and PostgreSQL. - - -### Composite Keys - -Doctrine 2 allows to use composite primary keys. There are however some restrictions opposed to using a single identifier. -The use of the `@GeneratedValue` annotation is only supported for simple (not composite) primary keys, which means -you can only use composite keys if you generate the primary key values yourself before calling `EntityManager#persist()` -on the entity. - -To designate a composite primary key / identifier, simply put the @Id marker annotation on all fields that make up the primary key. - -## Quoting Reserved Words - -It may sometimes be necessary to quote a column or table name because it conflicts with a reserved word of the particular RDBMS in use. This is often referred to as "Identifier Quoting". To let Doctrine know that you would like a table or column name to be quoted in all SQL statements, enclose the table or column name in backticks. Here is an example: - - **CAUTION** -> Identifier Quoting is not supported for join column names or discriminator column names. - -> **CAUTION** -> Identifier Quoting is a feature that is mainly intended to support legacy database -> schemas. The use of reserved words and identifier quoting is generally discouraged. -> Identifier quoting should not be used to enable the use non-standard-characters such -> as a dash in a hypothetical column `test-name`. Also Schema-Tool will likely have -> troubles when quoting is used for case-sensitivity reasons (in Oracle for example). \ No newline at end of file diff --git a/manual/en/batch-processing.rst b/manual/en/batch-processing.rst index 5e04e435b..b47906d6a 100644 --- a/manual/en/batch-processing.rst +++ b/manual/en/batch-processing.rst @@ -1,9 +1,14 @@ +Batch Processing +================ + This chapter shows you how to accomplish bulk inserts, updates and deletes with Doctrine in an efficient way. The main problem with bulk operations is usually not to run out of memory and this is especially what the strategies presented here provide help with. - **CAUTION** An ORM tool is not primarily well-suited for mass +.. warning:: + + An ORM tool is not primarily well-suited for mass inserts, updates or deletions. Every RDBMS has its own, most effective way of dealing with such operations and if the options outlined below are not sufficient for your purposes we recommend diff --git a/manual/en/batch-processing.txt b/manual/en/batch-processing.txt deleted file mode 100644 index fdc44bd45..000000000 --- a/manual/en/batch-processing.txt +++ /dev/null @@ -1,122 +0,0 @@ -This chapter shows you how to accomplish bulk inserts, updates and deletes with Doctrine in an efficient way. The main problem with bulk operations is usually not to run out of memory and this is especially what the strategies presented here provide help with. - -> **CAUTION** -> An ORM tool is not primarily well-suited for mass inserts, updates or deletions. -> Every RDBMS has its own, most effective way of dealing with such operations and if -> the options outlined below are not sufficient for your purposes we recommend you -> use the tools for your particular RDBMS for these bulk operations. - -## Bulk Inserts - -Bulk inserts in Doctrine are best performed in batches, taking advantage of the transactional write-behind behavior of an `EntityManager`. The following code shows an example for inserting 10000 objects with a batch size of 20. You may need to experiment with the batch size to find the size that works best for you. Larger batch sizes mean more prepared statement reuse internally but also mean more work during `flush`. - - setStatus('user'); - $user->setUsername('user' . $i); - $user->setName('Mr.Smith-' . $i); - $em->persist($user); - if (($i % $batchSize) == 0) { - $em->flush(); - $em->clear(); // Detaches all objects from Doctrine! - } - } - -## Bulk Updates - -There are 2 possibilities for bulk updates with Doctrine. - -### DQL UPDATE - -The by far most efficient way for bulk updates is to use a DQL UPDATE query. Example: - - createQuery('update MyProject\Model\Manager m set m.salary = m.salary * 0.9'); - $numUpdated = $q->execute(); - -### Iterating results - -An alternative solution for bulk updates is to use the `Query#iterate()` facility to iterate over the query results step by step instead of loading the whole result into memory at once. The following example shows how to do this, combining the iteration with the batching strategy that was already used for bulk inserts: - - createQuery('select u from MyProject\Model\User u'); - $iterableResult = $q->iterate(); - foreach($iterableResult AS $row) { - $user = $row[0]; - $user->increaseCredit(); - $user->calculateNewBonuses(); - if (($i % $batchSize) == 0) { - $em->flush(); // Executes all updates. - $em->clear(); // Detaches all objects from Doctrine! - } - ++$i; - } - -> **NOTE** -> Iterating results is not possible with queries that fetch-join a collection-valued -> association. The nature of such SQL result sets is not suitable for incremental -> hydration. - -## Bulk Deletes - -There are two possibilities for bulk deletes with Doctrine. You can either issue -a single DQL DELETE query or you can iterate over results removing them one at a time. - -### DQL DELETE - -The by far most efficient way for bulk deletes is to use a DQL DELETE query. - -Example: - - createQuery('delete from MyProject\Model\Manager m where m.salary > 100000'); - $numDeleted = $q->execute(); - -### Iterating results - -An alternative solution for bulk deletes is to use the `Query#iterate()` facility to iterate over the query results step by step instead of loading the whole result into memory at once. The following example shows how to do this: - - createQuery('select u from MyProject\Model\User u'); - $iterableResult = $q->iterate(); - while (($row = $iterableResult->next()) !== false) { - $em->remove($row[0]); - if (($i % $batchSize) == 0) { - $em->flush(); // Executes all deletions. - $em->clear(); // Detaches all objects from Doctrine! - } - ++$i; - } - -> **NOTE** -> Iterating results is not possible with queries that fetch-join a collection-valued -> association. The nature of such SQL result sets is not suitable for incremental -> hydration. - -## Iterating Large Results for Data-Processing - -You can use the `iterate()` method just to iterate over a large result and no UPDATE or DELETE -intention. The `IterableResult` instance returned from `$query->iterate()` implements the -Iterator interface so you can process a large result without memory problems using the -following approach: - - _em->createQuery('select u from MyProject\Model\User u'); - $iterableResult = $q->iterate(); - foreach ($iterableResult AS $row) { - // do stuff with the data in the row, $row[0] is always the object - - // detach from Doctrine, so that it can be Garbage-Collected immediately - $this->_em->detach($row[0]); - } - -> **NOTE** -> Iterating results is not possible with queries that fetch-join a collection-valued -> association. The nature of such SQL result sets is not suitable for incremental -> hydration. \ No newline at end of file diff --git a/manual/en/best-practices.rst b/manual/en/best-practices.rst index 48a8771c7..28709666f 100644 --- a/manual/en/best-practices.rst +++ b/manual/en/best-practices.rst @@ -1,7 +1,10 @@ - **NOTE** The best practices mentioned here that affect database - design generally refer to best practices when working with Doctrine - and do not necessarily reflect best practices for database design - in general. +Best Practices +============== + +The best practices mentioned here that affect database +design generally refer to best practices when working with Doctrine +and do not necessarily reflect best practices for database design +in general. Don't use public properties on entities diff --git a/manual/en/best-practices.txt b/manual/en/best-practices.txt deleted file mode 100644 index 1d4cee690..000000000 --- a/manual/en/best-practices.txt +++ /dev/null @@ -1,77 +0,0 @@ - -> **NOTE** -> The best practices mentioned here that affect database design generally refer to best -> practices when working with Doctrine and do not necessarily reflect best practices for -> database design in general. - -## Don't use public properties on entities - -It is very important that you don't map public properties on entities, but only protected or private ones. -The reason for this is simple, whenever you access a public property of a proxy object that hasn't been initialized -yet the return value will be null. Doctrine cannot hook into this process and magically make the entity lazy load. - -This can create situations where it is very hard to debug the current failure. We therefore urge you to map only -private and protected properties on entities and use getter methods or magic __get() to access them. - -## Constrain relationships as much as possible - -It is important to constrain relationships as much as possible. This means: - -* Impose a traversal direction (avoid bidirectional associations if possible) -* Eliminate nonessential associations - -This has several benefits: - -* Reduced coupling in your domain model -* Simpler code in your domain model (no need to maintain bidirectionality properly) -* Less work for Doctrine - -## Avoid composite keys - -Even though Doctrine fully supports composite keys it is best not to use them if possible. Composite keys require additional work by Doctrine and thus have a higher probability of errors. - -## Use events judiciously - -The event system of Doctrine is great and fast. Even though making heavy use of events, especially lifecycle events, can have a negative impact on the performance of your application. Thus you should use events judiciously. - -## Use cascades judiciously - -Automatic cascades of the persist/remove/merge/etc. operations are very handy but should be used wisely. Do NOT simply add all cascades to all associations. Think about which cascades actually do make sense for you for a particular association, given the scenarios it is most likely used in. - -## Don't use special characters - -Avoid using any non-ASCII characters in class, field, table or column names. Doctrine itself is not unicode-safe in many places and will not be until PHP itself is fully unicode-aware (PHP6). - -## Don't use identifier quoting - -Identifier quoting is a workaround for using reserved words that often causes problems in edge cases. Do not use identifier quoting and avoid using reserved words as table or column names. - -## Initialize collections in the constructor - -It is recommended best practice to initialize any business collections in entities in the constructor. Example: - - addresses = new ArrayCollection; - $this->articles = new ArrayCollection; - } - } - -## Don't map foreign keys to fields in an entity - -Foreign keys have no meaning whatsoever in an object model. Foreign keys are how a relational database establishes relationships. Your object model establishes relationships through object references. Thus mapping foreign keys to object fields heavily leaks details of the relational model into the object model, something you really should not do. - -## Use explicit transaction demarcation - -While Doctrine will automatically wrap all DML operations in a transaction on flush(), it is considered best practice to explicitly set the transaction boundaries yourself. -Otherwise every single query is wrapped in a small transaction (Yes, SELECT queries, too) since you can not talk to your database outside of a transaction. -While such short transactions for read-only (SELECT) queries generally don't have any noticeable performance impact, it is still preferable to use fewer, well-defined transactions -that are established through explicit transaction boundaries. - diff --git a/manual/en/caching.rst b/manual/en/caching.rst index 8c4ee7a4d..62601af86 100644 --- a/manual/en/caching.rst +++ b/manual/en/caching.rst @@ -1,3 +1,6 @@ +Caching +======= + Doctrine provides cache drivers in the ``Common`` package for some of the most popular caching implementations such as APC, Memcache and Xcache. We also provide an ``ArrayCache`` driver which stores diff --git a/manual/en/caching.txt b/manual/en/caching.txt deleted file mode 100644 index 7a2909ac1..000000000 --- a/manual/en/caching.txt +++ /dev/null @@ -1,350 +0,0 @@ -Doctrine provides cache drivers in the `Common` package for some of the most -popular caching implementations such as APC, Memcache and Xcache. We also provide -an `ArrayCache` driver which stores the data in a PHP array. Obviously, the cache -does not live between requests but this is useful for testing in a development -environment. - -## Cache Drivers - -The cache drivers follow a simple interface that is defined in `Doctrine\Common\Cache\Cache`. -All the cache drivers extend a base class `Doctrine\Common\Cache\AbstractCache` -which implements the before mentioned interface. - -The interface defines the following methods for you to publicly use. - - * fetch($id) - Fetches an entry from the cache. - * contains($id) - Test if an entry exists in the cache. - * save($id, $data, $lifeTime = false) - Puts data into the cache. - * delete($id) - Deletes a cache entry. - -Each driver extends the `AbstractCache` class which defines a few abstract -protected methods that each of the drivers must implement. - - * _doFetch($id) - * _doContains($id) - * _doSave($id, $data, $lifeTime = false) - * _doDelete($id) - -The public methods `fetch()`, `contains()`, etc. utilize the above protected methods -that are implemented by the drivers. The code is organized this way so that the -protected methods in the drivers do the raw interaction with the cache implementation -and the `AbstractCache` can build custom functionality on top of these methods. - -### APC - -In order to use the APC cache driver you must have it compiled and enabled in -your php.ini. You can read about APC [here](http://us2.php.net/apc) on the PHP -website. It will give you a little background information about what it is and -how you can use it as well as how to install it. - -Below is a simple example of how you could use the APC cache driver by itself. - - save('cache_id', 'my_data'); - -### Memcache - -In order to use the Memcache cache driver you must have it compiled and enabled in -your php.ini. You can read about Memcache [here](http://us2.php.net/memcache) on -the PHP website. It will give you a little background information about what it is -and how you can use it as well as how to install it. - -Below is a simple example of how you could use the Memcache cache driver by itself. - - connect('memcache_host', 11211); - - $cacheDriver = new \Doctrine\Common\Cache\MemcacheCache(); - $cacheDriver->setMemcache() - $cacheDriver->save('cache_id', 'my_data'); - -### Xcache - -In order to use the Xcache cache driver you must have it compiled and enabled in -your php.ini. You can read about Xcache [here](http://xcache.lighttpd.net/). It -will give you a little background information about what it is and how you can -use it as well as how to install it. - -Below is a simple example of how you could use the Xcache cache driver by itself. - - save('cache_id', 'my_data'); - -## Using Cache Drivers - -In this section we'll describe how you can fully utilize the API of the cache -drivers to save cache, check if some cache exists, fetch the cached data and -delete the cached data. We'll use the `ArrayCache` implementation as our -example here. - - save('cache_id', 'my_data'); - -The `save()` method accepts three arguments which are described below. - - * `$id` - The cache id - * `$data` - The cache entry/data. - * `$lifeTime` - The lifetime. If != false, sets a specific lifetime for this cache entry (null => infinite lifeTime). - -You can save any type of data whether it be a string, array, object, etc. - - 'value1', - 'key2' => 'value2' - ); - $cacheDriver->save('my_array', $array); - -### Checking - -Checking whether some cache exists is very simple, just use the `contains()` method. -It accepts a single argument which is the ID of the cache entry. - - contains('cache_id')) { - echo 'cache exists'; - } else { - echo 'cache does not exist'; - } - -### Fetching - -Now if you want to retrieve some cache entry you can use the `fetch()` method. It -also accepts a single argument just like `contains()` which is the ID of the cache entry. - - fetch('my_array'); - -### Deleting - -As you might guess, deleting is just as easy as saving, checking and fetching. -We have a few ways to delete cache entries. You can delete by an individual ID, -regular expression, prefix, suffix or you can delete all entries. - -#### By Cache ID - - delete('my_array'); - -You can also pass wild cards to the `delete()` method and it will return an array -of IDs that were matched and deleted. - - delete('users_*'); - -#### By Regular Expression - -If you need a little more control than wild cards you can use a PHP regular -expression to delete cache entries. - - deleteByRegex('/users_.*/'); - -#### By Prefix - -Because regular expressions are kind of slow, if simply deleting by a prefix or -suffix is sufficient, it is recommended that you do that instead of using a regular -expression because it will be much faster if you have many cache entries. - - deleteByPrefix('users_'); - -#### By Suffix - -Just like we did above with the prefix you can do the same with a suffix. - - deleteBySuffix('_my_account'); - -#### All - -If you simply want to delete all cache entries you can do so with the `deleteAll()` -method. - - deleteAll(); - -### Counting - -If you want to count how many entries are stored in the cache driver instance -you can use the `count()` method. - - count(); - -> **NOTE** -> In order to use `deleteByRegex()`, `deleteByPrefix()`, `deleteBySuffix()`, -> `deleteAll()`, `count()` or `getIds()` you must enable an option for the cache -> driver to manage your cache IDs internally. This is necessary because APC, -> Memcache, etc. don't have any advanced functionality for fetching and deleting. -> We add some functionality on top of the cache drivers to maintain an index of -> all the IDs stored in the cache driver so that we can allow more granular deleting -> operations. -> -> $cacheDriver->setManageCacheIds(true); - -### Namespaces - -If you heavily use caching in your application and utilize it in multiple parts -of your application, or use it in different applications on the same server you -may have issues with cache naming collisions. This can be worked around by using -namespaces. You can set the namespace a cache driver should use by using the -`setNamespace()` method. - - setNamespace('my_namespace_'); - -## Integrating with the ORM - -The Doctrine ORM package is tightly integrated with the cache drivers to allow -you to improve performance of various aspects of Doctrine by just simply making -some additional configurations and method calls. - -### Query Cache - -It is highly recommended that in a production environment you cache the -transformation of a DQL query to its SQL counterpart. It doesn't make sense to -do this parsing multiple times as it doesn't change unless you alter the DQL -query. - -This can be done by configuring the query cache implementation to use on your ORM -configuration. - - setQueryCacheImpl(new \Doctrine\Common\Cache\ApcCache()); - -### Result Cache - -The result cache can be used to cache the results of your queries so that we -don't have to query the database or hydrate the data again after the first time. -You just need to configure the result cache implementation. - - setResultCacheImpl(new \Doctrine\Common\Cache\ApcCache()); - -Now when you're executing DQL queries you can configure them to use the result cache. - - createQuery('select u from \Entities\User u'); - $query->useResultCache(true); - -You can also configure an individual query to use a different result cache driver. - - setResultCacheDriver(new \Doctrine\Common\Cache\ApcCache()); - -> **NOTE** -> Setting the result cache driver on the query will automatically enable the -> result cache for the query. If you want to disable it pass false to -> `useResultCache()`. -> -> $query->useResultCache(false); - -If you want to set the time the cache has to live you can use the `setResultCacheLifetime()` -method. - - setResultCacheLifetime(3600); - -The ID used to store the result set cache is a hash which is automatically generated -for you if you don't set a custom ID yourself with the `setResultCacheId()` method. - - setResultCacheId('my_custom_id'); - -You can also set the lifetime and cache ID by passing the values as the second -and third argument to `useResultCache()`. - - useResultCache(true, 3600, 'my_custom_id'); - -### Metadata Cache - -Your class metadata can be parsed from a few different sources like YAML, XML, -Annotations, etc. Instead of parsing this information on each request we should -cache it using one of the cache drivers. - -Just like the query and result cache we need to configure it first. - - setMetadataCacheImpl(new \Doctrine\Common\Cache\ApcCache()); - -Now the metadata information will only be parsed once and stored in the cache -driver. - -## Clearing the Cache - -We've already shown you previously how you can use the API of the cache drivers -to manually delete cache entries. For your convenience we offer a command line task -for you to help you with clearing the query, result and metadata cache. - -From the Doctrine command line you can run the following command. - - $ ./doctrine clear-cache - -Running this task with no arguments will clear all the cache for all the configured -drivers. If you want to be more specific about what you clear you can use the -following options. - -To clear the query cache use the `--query` option. - - $ ./doctrine clear-cache --query - -To clear the metadata cache use the `--metadata` option. - - $ ./doctrine clear-cache --metadata - -To clear the result cache use the `--result` option. - - $ ./doctrine clear-cache --result - -When you use the `--result` option you can use some other options to be more -specific about what queries result sets you want to clear. - -Just like the API of the cache drivers you can clear based on an ID, regular -expression, prefix or suffix. - - $ ./doctrine clear-cache --result --id=cache_id - -Or if you want to clear based on a regular expressions. - - $ ./doctrine clear-cache --result --regex=users_.* - -Or with a prefix. - - $ ./doctrine clear-cache --result --prefix=users_ - -And finally with a suffix. - - $ ./doctrine clear-cache --result --suffix=_my_account - -> **NOTE** -> Using the `--id`, `--regex`, etc. options with the `--query` and `--metadata` -> are not allowed as it is not necessary to be specific about what you clear. -> You only ever need to completely clear the cache to remove stale entries. - -## Cache Slams - -Something to be careful of when utilizing the cache drivers is cache slams. If -you have a heavily trafficked website with some code that checks for the existence -of a cache record and if it does not exist it generates the information and saves -it to the cache. Now if 100 requests were issued all at the same time and each one -sees the cache does not exist and they all try and insert the same cache entry -it could lock up APC, Xcache, etc. and cause problems. Ways exist to work around -this, like pre-populating your cache and not letting your users requests populate -the cache. - -You can read more about cache slams [here](http://t3.dotgnu.info/blog/php/user-cache-timebomb). \ No newline at end of file diff --git a/manual/en/change-tracking-policies.rst b/manual/en/change-tracking-policies.rst index 97b3508fb..25f32d051 100644 --- a/manual/en/change-tracking-policies.rst +++ b/manual/en/change-tracking-policies.rst @@ -1,5 +1,5 @@ Change Tracking Policies ------------------------- +======================== Change tracking is the process of determining what has changed in managed entities since the last time they were synchronized with diff --git a/manual/en/change-tracking-policies.txt b/manual/en/change-tracking-policies.txt deleted file mode 100644 index 11fec2e4d..000000000 --- a/manual/en/change-tracking-policies.txt +++ /dev/null @@ -1,128 +0,0 @@ -## Change Tracking Policies - -Change tracking is the process of determining what has changed in managed -entities since the last time they were synchronized with the database. - -Doctrine provides 3 different change tracking policies, each having its -particular advantages and disadvantages. The change tracking policy can -be defined on a per-class basis (or more precisely, per-hierarchy). - -### Deferred Implicit - -The deferred implicit policy is the default change tracking policy and the most -convenient one. With this policy, Doctrine detects the changes by a -property-by-property comparison at commit time and also detects changes -to entities or new entities that are referenced by other managed entities -("persistence by reachability"). Although the most convenient policy, it can -have negative effects on performance if you are dealing with large units of -work (see "Understanding the Unit of Work"). Since Doctrine can't know what -has changed, it needs to check all managed entities for changes every time you -invoke EntityManager#flush(), making this operation rather costly. - -### Deferred Explicit - -The deferred explicit policy is similar to the deferred implicit policy in that -it detects changes through a property-by-property comparison at commit time. The -difference is that only entities are considered that have been explicitly marked -for change detection through a call to EntityManager#persist(entity) or through -a save cascade. All other entities are skipped. This policy therefore gives -improved performance for larger units of work while sacrificing the behavior -of "automatic dirty checking". - -Therefore, flush() operations are potentially cheaper with this policy. The -negative aspect this has is that if you have a rather large application and -you pass your objects through several layers for processing purposes and -business tasks you may need to track yourself which entities have changed -on the way so you can pass them to EntityManager#persist(). - -This policy can be configured as follows: - - _listeners[] = $listener; - } - } - -Then, in each property setter of this class or derived classes, you need to -notify all the `PropertyChangedListener` instances. As an example we -add a convenience method on `MyEntity` that shows this behaviour: - - _listeners) { - foreach ($this->_listeners as $listener) { - $listener->propertyChanged($this, $propName, $oldValue, $newValue); - } - } - } - - public function setData($data) - { - if ($data != $this->data) { - $this->_onPropertyChanged('data', $this->data, $data); - $this->data = $data; - } - } - } - -You have to invoke `_onPropertyChanged` inside every method that changes the -persistent state of `MyEntity`. - -The check whether the new value is different from the old one is not mandatory -but recommended. That way you also have full control over when you consider a -property changed. - -The negative point of this policy is obvious: You need implement an interface -and write some plumbing code. But also note that we tried hard to keep this -notification functionality abstract. Strictly speaking, it has nothing to do -with the persistence layer and the Doctrine ORM or DBAL. You may find that -property notification events come in handy in many other scenarios as well. -As mentioned earlier, the `Doctrine\Common` namespace is not that evil and -consists solely of very small classes and interfaces that have almost no -external dependencies (none to the DBAL and none to the ORM) and that you -can easily take with you should you want to swap out the persistence layer. -This change tracking policy does not introduce a dependency on the Doctrine -DBAL/ORM or the persistence layer. - -The positive point and main advantage of this policy is its effectiveness. It -has the best performance characteristics of the 3 policies with larger units of -work and a flush() operation is very cheap when nothing has changed. \ No newline at end of file diff --git a/manual/en/configuration.rst b/manual/en/configuration.rst index 585108f6e..a3a3a3987 100644 --- a/manual/en/configuration.rst +++ b/manual/en/configuration.rst @@ -1,3 +1,6 @@ +Configuration +============= + Bootstrapping ------------- @@ -32,7 +35,9 @@ namespace and where there is a common root namespace. The following example shows the setup of a ``ClassLoader`` for the different types of Doctrine Installations: - **NOTE** This assumes you've created some kind of script to test +.. note:: + + This assumes you've created some kind of script to test the following code in. Something like a ``test.php`` file. @@ -370,7 +375,8 @@ lazy-loading capabilities to them. Doctrine can then give you an instance of such a proxy class whenever you request an object of the class being proxied. This happens in two situations: -**Reference Proxies** +Reference Proxies +~~~~~~~~~~~~~~~~~ The method ``EntityManager#getReference($entityName, $identifier)`` lets you obtain a reference to an entity for which the identifier @@ -395,7 +401,8 @@ for the Item class but your code does not need to care. In fact it **should not care**. Proxy objects should be transparent to your code. -**Association proxies** +Association proxies +~~~~~~~~~~~~~~~~~~~ The second most important situation where Doctrine uses proxy objects is when querying for objects. Whenever you query for an @@ -405,7 +412,9 @@ query, Doctrine puts proxy objects in place where normally the associated object would be. Just like other proxies it will transparently initialize itself on first access. - **NOTE** Joining an association in a DQL or native query +.. note:: + + Joining an association in a DQL or native query essentially means eager loading of that association in that query. This will override the 'fetch' option specified in the mapping for that association, but only for that query. diff --git a/manual/en/configuration.txt b/manual/en/configuration.txt deleted file mode 100644 index 717032b0a..000000000 --- a/manual/en/configuration.txt +++ /dev/null @@ -1,307 +0,0 @@ -## Bootstrapping - -Bootstrapping Doctrine is a relatively simple procedure that roughly exists of -just 2 steps: - -* Making sure Doctrine class files can be loaded on demand. -* Obtaining an EntityManager instance. - -### Class loading - -Lets start with the class loading setup. We need to set up some class loaders -(often called "autoloader") so that Doctrine class files are loaded on demand. -The Doctrine\Common namespace contains a very fast and minimalistic class loader -that can be used for Doctrine and any other libraries where the coding standards -ensure that a class's location in the directory tree is reflected by its name -and namespace and where there is a common root namespace. - -> **NOTE** -> You are not forced to use the Doctrine class loader to load Doctrine -> classes. Doctrine does not care how the classes are loaded, if you want to use a -> different class loader or your own to load Doctrine classes, just do that. -> Along the same lines, the class loader in the Doctrine\Common namespace is not -> meant to be only used for Doctrine classes, too. It is a generic class loader that can -> be used for any classes that follow some basic naming standards as described above. - -The following example shows the setup of a `ClassLoader` for the different types -of Doctrine Installations: - -> **NOTE** -> This assumes you've created some kind of script to test the following code in. -> Something like a `test.php` file. - -#### PEAR or Tarball Download - - register(); // register on SPL autoload stack - -#### Git - -The Git bootstrap assumes that you have fetched the related packages through `git submodule update --init` - - register(); - - $classLoader = new \Doctrine\Common\ClassLoader('Doctrine\DBAL', $lib . 'vendor/doctrine-dbal/lib'); - $classLoader->register(); - - $classLoader = new \Doctrine\Common\ClassLoader('Doctrine\ORM', $lib); - $classLoader->register(); - -#### Additional Symfony Components - -If you don't use Doctrine2 in combination with Symfony2 you have to register an additional namespace to be able to use -the Doctrine-CLI Tool or the YAML Mapping driver: - - register(); - - // Git Setup - $classloader = new \Doctrine\Common\ClassLoader('Symfony', $lib . 'vendor/'); - $classloader->register(); - -For best class loading performance it is recommended that you keep your include_path short, ideally it should only contain the path to the PEAR libraries, and any other class libraries should be registered with their full base path. - -### Obtaining an EntityManager - -Once you have prepared the class loading, you acquire an *EntityManager* instance. -The EntityManager class is the primary access point to ORM functionality provided by Doctrine. - -A simple configuration of the EntityManager requires a `Doctrine\ORM\Configuration` -instance as well as some database connection parameters: - - setMetadataCacheImpl($cache); - $driverImpl = $config->newDefaultAnnotationDriver('/path/to/lib/MyProject/Entities'); - $config->setMetadataDriverImpl($driverImpl); - $config->setQueryCacheImpl($cache); - $config->setProxyDir('/path/to/myproject/lib/MyProject/Proxies'); - $config->setProxyNamespace('MyProject\Proxies'); - - if ($applicationMode == "development") { - $config->setAutoGenerateProxyClasses(true); - } else { - $config->setAutoGenerateProxyClasses(false); - } - - $connectionOptions = array( - 'driver' => 'pdo_sqlite', - 'path' => 'database.sqlite' - ); - - $em = EntityManager::create($connectionOptions, $config); - -> **CAUTION** -> Do not use Doctrine without a metadata and query cache! Doctrine is highly -> optimized for working with caches. The main parts in Doctrine that are optimized -> for caching are the metadata mapping information with the metadata cache and the -> DQL to SQL conversions with the query cache. These 2 caches require only an absolute -> minimum of memory yet they heavily improve the runtime performance of Doctrine. -> The recommended cache driver to use with Doctrine is [APC](http://www.php.net/apc). -> APC provides you with an opcode-cache (which is highly recommended anyway) and -> a very fast in-memory cache storage that you can use for the metadata and query -> caches as seen in the previous code snippet. - -## Configuration Options - -The following sections describe all the configuration options available on a `Doctrine\ORM\Configuration` instance. - -### Proxy Directory (***REQUIRED***) - - setProxyDir($dir); - $config->getProxyDir(); - -Gets or sets the directory where Doctrine generates any proxy classes. For a detailed explanation on proxy classes and how they are used in Doctrine, refer to the "Proxy Objects" section further down. - -### Proxy Namespace (***REQUIRED***) - - setProxyNamespace($namespace); - $config->getProxyNamespace(); - -Gets or sets the namespace to use for generated proxy classes. For a detailed explanation on proxy classes and how they are used in Doctrine, refer to the "Proxy Objects" section further down. - -### Metadata Driver (***REQUIRED***) - - setMetadataDriverImpl($driver); - $config->getMetadataDriverImpl(); - -Gets or sets the metadata driver implementation that is used by Doctrine to acquire the object-relational metadata for your classes. - -There are currently 4 available implementations: - - * `Doctrine\ORM\Mapping\Driver\AnnotationDriver` - * `Doctrine\ORM\Mapping\Driver\XmlDriver` - * `Doctrine\ORM\Mapping\Driver\YamlDriver` - * `Doctrine\ORM\Mapping\Driver\DriverChain` - -Throughout the most part of this manual the AnnotationDriver is used in the examples. For information on the usage of the XmlDriver or YamlDriver please refer to the dedicated chapters `XML Mapping` and `YAML Mapping`. - -The annotation driver can be configured with a factory method on the `Doctrine\ORM\Configuration`: - - newDefaultAnnotationDriver('/path/to/lib/MyProject/Entities'); - $config->setMetadataDriverImpl($driverImpl); - -The path information to the entities is required for the annotation driver, because otherwise -mass-operations on all entities through the console could not work correctly. All of metadata -drivers accept either a single directory as a string or an array of directories. With this feature a -single driver can support multiple directories of Entities. - -### Metadata Cache (***RECOMMENDED***) - - setMetadataCacheImpl($cache); - $config->getMetadataCacheImpl(); - -Gets or sets the cache implementation to use for caching metadata information, that is, all the information you supply via annotations, xml or yaml, so that they do not need to be parsed and loaded from scratch on every single request which is a waste of resources. -The cache implementation must implement the `Doctrine\Common\Cache\Cache` interface. - -Usage of a metadata cache is highly recommended. - -The recommended implementations for production are: - - * `Doctrine\Common\Cache\ApcCache` - * `Doctrine\Common\Cache\MemcacheCache` - * `Doctrine\Common\Cache\XcacheCache` - -For development you should use the `Doctrine\Common\Cache\ArrayCache` which only caches data on a per-request basis. - -### Query Cache (***RECOMMENDED***) - - setQueryCacheImpl($cache); - $config->getQueryCacheImpl(); - -Gets or sets the cache implementation to use for caching DQL queries, that is, the result of a DQL parsing process that includes the final SQL as well as meta information about how to process the SQL result set of a query. Note that the query cache does not affect query results. You do not get stale data. This is a pure optimization cache without any negative side-effects (except some minimal memory usage in your cache). - -Usage of a query cache is highly recommended. - -The recommended implementations for production are: - - * `Doctrine\Common\Cache\ApcCache` - * `Doctrine\Common\Cache\MemcacheCache` - * `Doctrine\Common\Cache\XcacheCache` - -For development you should use the `Doctrine\Common\Cache\ArrayCache` which only caches data on a per-request basis. - -### SQL Logger (***Optional***) - - setSQLLogger($logger); - $config->getSQLLogger(); - -Gets or sets the logger to use for logging all SQL statements executed by Doctrine. The logger class must implement the `Doctrine\DBAL\Logging\SqlLogger` interface. A simple default implementation that logs to the standard output using `echo` and `var_dump` can be found at `Doctrine\DBAL\Logging\EchoSqlLogger`. - -### Auto-generating Proxy Classes (***OPTIONAL***) - - setAutoGenerateProxyClasses($bool); - $config->getAutoGenerateProxyClasses(); - -Gets or sets whether proxy classes should be generated automatically at runtime by Doctrine. If set to `FALSE`, proxy classes must be generated manually through the doctrine command line task `generate-proxies`. The strongly recommended value for a production environment is `FALSE`. - -## Development vs Production Configuration - -You should code your Doctrine2 bootstrapping with two different runtime models in mind. There are some serious -benefits of using APC or Memcache in production. In development however this will frequently give you fatal -errors, when you change your entities and the cache still keeps the outdated metadata. That is why we recommend -the `ArrayCache` for development. - -Furthermore you should have the Auto-generating Proxy Classes option to true in development and to false -in production. If this option is set to `TRUE` it can seriously hurt your script performance if several proxy -classes are re-generated during script execution. Filesystem calls of that magnitude can even slower than all -the database queries Doctrine issues. Additionally writing a proxy sets an exclusive file lock which can cause -serious performance bottlenecks in systems with regular concurrent requests. - -## Connection Options - -The `$connectionOptions` passed as the first argument to `EntityManager::create()` has to be either an array -or an instance of `Doctrine\DBAL\Connection`. If an array is passed it is directly passed along to the -DBAL Factory `Doctrine\DBAL\DriverManager::getConnection()`. The DBAL configuration is explained -in the [DBAL section](./../../../../../dbal/2.0/docs/reference/configuration/en). - -## Proxy Objects - -A proxy object is an object that is put in place or used instead of the "real" object. A proxy object can add behavior to the object being proxied without that object being aware of it. In Doctrine 2, proxy objects are used to realize several features but mainly for transparent lazy-loading. - -Proxy objects with their lazy-loading facilities help to keep the subset of objects that are already in memory connected to the rest of the objects. This is an essential property as without it there would always be fragile partial objects at the outer edges of your object graph. - -Doctrine 2 implements a variant of the proxy pattern where it generates classes that extend your entity classes and adds lazy-loading capabilities to them. Doctrine can then give you an instance of such a proxy class whenever you request an object of the class being proxied. This happens in two situations: - -**Reference Proxies** - -The method `EntityManager#getReference($entityName, $identifier)` lets you obtain a reference to an entity for which the identifier is known, without loading that entity from the database. This is useful, for example, as a performance enhancement, when you want to establish an association to an entity for which you have the identifier. You could simply do this: - - getReference('MyProject\Model\Item', $itemId); - $cart->addItem($item); - -Here, we added an Item to a Cart without loading the Item from the database. If you invoke any method on the Item instance, it would fully initialize its state transparently from the database. Here $item is actually an instance of the proxy class that was generated for the Item class but your code does not need to care. In fact it **should not care**. Proxy objects should be transparent to your code. - -**Association proxies** - -The second most important situation where Doctrine uses proxy objects is when querying for objects. Whenever you query for an object that has a single-valued association to another object that is configured LAZY, without joining that association in the same query, Doctrine puts proxy objects in place where normally the associated object would be. -Just like other proxies it will transparently initialize itself on first access. - -> **NOTE** -> Joining an association in a DQL or native query essentially means eager loading of that -> association in that query. This will override the 'fetch' option specified in -> the mapping for that association, but only for that query. - -### Generating Proxy classes - -Proxy classes can either be generated manually through the Doctrine Console or automatically by Doctrine. The configuration option that controls this behavior is: - - setAutoGenerateProxyClasses($bool); - $config->getAutoGenerateProxyClasses(); - -The default value is `TRUE` for convenient development. However, this setting is not optimal for performance and therefore not recommended for a production environment. -To eliminate the overhead of proxy class generation during runtime, set this configuration option to `FALSE`. When you do this in a development environment, note that you may get class/file not found errors if certain proxy classes are not available or failing lazy-loads if new methods were added to the entity class that are not yet in the proxy class. In such a case, simply use the Doctrine Console to (re)generate the proxy classes like so: - - $ ./doctrine orm:generate-proxies - -## Multiple Metadata Sources - -When using different components using Doctrine 2 you may end up with them using two different metadata drivers, -for example XML and YAML. You can use the DriverChain Metadata implementations to aggregate these drivers -based on namespaces: - - addDriver($xmlDriver, 'Doctrine\Tests\Models\Company'); - $chain->addDriver($yamlDriver, 'Doctrine\Tests\ORM\Mapping'); - -Based on the namespace of the entity the loading of entities is delegated to the appropriate driver. The chain -semantics come from the fact that the driver loops through all namespaces and matches the entity class name -against the namespace using a `strpos() === 0` call. This means you need to order the drivers correctly if -sub-namespaces use different metadata driver implementations. diff --git a/manual/en/dql-doctrine-query-language.rst b/manual/en/dql-doctrine-query-language.rst index 2ec388c59..e99916d2c 100644 --- a/manual/en/dql-doctrine-query-language.rst +++ b/manual/en/dql-doctrine-query-language.rst @@ -1,5 +1,5 @@ -DQL Explained -------------- +Doctrine Query Language +=========================== DQL stands for **D**octrine **Q**uery **L**anguage and is an Object Query Language derivate that is very similar to the **H**ibernate @@ -433,9 +433,8 @@ starting with 0. However with INDEX BY you can specify any other column to be the key of your result, it really only makes sense with primary or unique fields though: -:: +.. code-block:: sql - [sql] SELECT u.id, u.status, upper(u.name) nameUpper FROM User u INDEX BY u.id JOIN u.phonenumbers p INDEX BY p.phonenumber @@ -470,15 +469,17 @@ can also execute bulk updates on a set of entities using an DQL-UPDATE query. The Syntax of an UPDATE query works as expected, as the following example shows: -:: +.. code-block:: sql UPDATE MyProject\Model\User u SET u.password = 'new' WHERE u.id IN (1, 2, 3) References to related entities are only possible in the WHERE clause and using sub-selects. - **CAUTION** DQL UPDATE statements are ported directly into a - Database UPDATE statement and therefore bypass any locking scheme +.. warning:: + + DQL UPDATE statements are ported directly into a + Database UPDATE statement and therefore bypass any locking scheme, events and do not increment the version column. Entities that are already loaded into the persistence context will *NOT* be synced with the updated database state. It is recommended to call @@ -492,14 +493,16 @@ DELETE queries DELETE queries can also be specified using DQL and their syntax is as simple as the UPDATE syntax: -:: +.. code-block:: sql DELETE MyProject\Model\User u WHERE u.id = 4 The same restrictions apply for the reference of related entities. - **CAUTION** DQL DELETE statements are ported directly into a - Database DELETE statement and therefore bypass any checks for the +.. warning:: + + DQL DELETE statements are ported directly into a + Database DELETE statement and therefore bypass any events and checks for the version column if they are not explicitly added to the WHERE clause of the query. Additionally Deletes of specifies entities are *NOT* cascaded to related entities even if specified in the metadata. @@ -540,7 +543,7 @@ Arithmetic operators You can do math in DQL using numeric values, for example: -:: +.. warning:: SELECT person.salary * 1.5 FROM CompanyPerson person WHERE person.salary < 100000 @@ -694,9 +697,8 @@ scenario it is a generic Person and Employee example: First notice that the generated SQL to create the tables for these entities looks like the following: -:: +.. code-block:: sql - [sql] CREATE TABLE Person (id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, name VARCHAR(50) NOT NULL, discr VARCHAR(255) NOT NULL, department VARCHAR(50) NOT NULL) Now when persist a new ``Employee`` instance it will set the @@ -714,18 +716,16 @@ discriminator value for us automatically: Now lets run a simple query to retrieve the ``Employee`` we just created: -:: +.. code-block:: sql - [sql] SELECT e FROM Entities\Employee e WHERE e.name = 'test' If we check the generated SQL you will notice it has some special conditions added to ensure that we will only get back ``Employee`` entities: -:: +.. code-block:: sql - [sql] SELECT p0_.id AS id0, p0_.name AS name1, p0_.department AS department2, p0_.discr AS discr3 FROM Person p0_ WHERE (p0_.name = ?) AND p0_.discr IN ('employee') Class Table Inheritance @@ -761,9 +761,8 @@ table, you just need to change the inheritance type from Now take a look at the SQL which is generated to create the table, you'll notice some differences: -:: +.. code-block:: sql - [sql] CREATE TABLE Person (id INT AUTO_INCREMENT NOT NULL, name VARCHAR(50) NOT NULL, discr VARCHAR(255) NOT NULL, PRIMARY KEY(id)) ENGINE = InnoDB; CREATE TABLE Employee (id INT NOT NULL, department VARCHAR(50) NOT NULL, PRIMARY KEY(id)) ENGINE = InnoDB; ALTER TABLE Employee ADD FOREIGN KEY (id) REFERENCES Person(id) ON DELETE CASCADE @@ -777,9 +776,8 @@ Now if were to insert the same ``Employee`` as we did in the generate different SQL joining the ``Person`` information automatically for you: -:: +.. code-block:: sql - [sql] SELECT p0_.id AS id0, p0_.name AS name1, e1_.department AS department2, p0_.discr AS discr3 FROM Employee e1_ INNER JOIN Person p0_ ON e1_.id = p0_.id WHERE p0_.name = ? The Query class @@ -892,9 +890,8 @@ structure: To better understand mixed results, consider the following DQL query: -:: +.. code-block:: sql - [sql] SELECT u, UPPER(u.name) nameUpper FROM MyProject\Model\User u This query makes use of the ``UPPER`` DQL function that returns a @@ -1186,7 +1183,9 @@ number of results: - ``Query::setMaxResults($maxResults)`` - ``Query::setFirstResult($offset)`` - **NOTE** If your query contains a fetch-joined collection +.. note:: + + If your query contains a fetch-joined collection specifying the result limit methods are not working as you would expect. Set Max Results restricts the number of database result rows, however in the case of fetch-joined collections one root diff --git a/manual/en/dql-doctrine-query-language.txt b/manual/en/dql-doctrine-query-language.txt deleted file mode 100644 index 1a3f6ab6c..000000000 --- a/manual/en/dql-doctrine-query-language.txt +++ /dev/null @@ -1,1096 +0,0 @@ -## DQL Explained - -DQL stands for **D**octrine **Q**uery **L**anguage and is an Object Query Language derivate that is very similar to the **H**ibernate **Q**uery **L**anguage (HQL) or the **J**ava **P**ersistence **Q**uery **L**anguage (JPQL). - -In essence, DQL provides powerful querying capabilities over your object model. Imagine all your objects lying around in some storage (like an object database). When writing DQL queries, think about querying that storage to pick a certain subset of your objects. - -> **CAUTION** -> A common mistake for beginners is to mistake DQL for being just some form of SQL -> and therefore trying to use table names and column names or join arbitrary tables -> together in a query. You need to think about DQL as a query language for your object -> model, not for your relational schema. - -DQL is case in-sensitive, except for namespace, class and field names, which are case sensitive. - -## Types of DQL queries - -DQL as a query language has SELECT, UPDATE and DELETE constructs that map to their corresponding -SQL statement types. INSERT statements are not allowed in DQL, because entities and their relations -have to be introduced into the persistence context through `EntityManager#persist()` to ensure -consistency of your object model. - -DQL SELECT statements are a very powerful way of retrieving parts of your domain model that are -not accessible via associations. Additionally they allow to retrieve entities and their associations -in one single sql select statement which can make a huge difference in performance in contrast -to using several queries. - -DQL UPDATE and DELETE statements offer a way to execute bulk changes on the entities of your -domain model. This is often necessary when you cannot load all the affected entities of a bulk -update into memory. - -## SELECT queries - -### DQL SELECT clause - -The select clause of a DQL query specifies what appears in the query result. The composition of all the expressions in the select clause also influences the nature of the query result. - -Here is an example that selects all users with an age > 20: - - createQuery('SELECT u FROM MyProject\Model\User u WHERE u.age > 20'); - $users = $query->getResult(); - -Lets examine the query: - -* `u` is a so called identification variable or alias that refers to the `MyProject\Model\User` class. By placing this alias in the SELECT clause we specify that we want all instances of the User class that are matched by this query appear in the query result. -* The FROM keyword is always followed by a fully-qualified class name which in turn is followed by an identification variable or alias for that class name. This class designates a root of our query from which we can navigate further via joins (explained later) and path expressions. -* The expression `u.age` in the WHERE clause is a path expression. Path expressions in DQL are easily identified by the use of the '.' operator that is used for constructing paths. The path expression `u.age` refers to the `age` field on the User class. - -The result of this query would be a list of User objects where all users are older than 20. - -The SELECT clause allows to specify both class identification variables that signal the hydration -of a complete entity class or just fields of the entity using the syntax `u.name`. -Combinations of both are also allowed and it is possible to wrap both fields and -identification values into aggregation and DQL functions. Numerical fields can -be part of computations using mathematical operations. See the sub-section on [DQL Functions, Aggregates and Operations](#dqlfn) -on more information. - -### Joins - -A SELECT query can contain joins. There are 2 types of JOINs: "Regular" Joins and "Fetch" Joins. - -**Regular Joins**: Used to limit the results and/or compute aggregate values. - -**Fetch Joins**: In addition to the uses of regular joins: Used to fetch related entities and include them in the hydrated result of a query. - -There is no special DQL keyword that distinguishes a regular join from a fetch join. A join (be it an inner or outer join) becomes a "fetch join" as soon as fields of the joined entity appear in the SELECT part of the DQL query outside of an aggregate function. Otherwise its a "regular join". - -Example: - -Regular join of the address: - - createQuery("SELECT u FROM User u JOIN u.address a WHERE a.city = 'Berlin'"); - $users = $query->getResult(); - -Fetch join of the address: - - createQuery("SELECT u, a FROM User u JOIN u.address a WHERE a.city = 'Berlin'"); - $users = $query->getResult(); - -When Doctrine hydrates a query with fetch-join it returns the class in the FROM clause on the -root level of the result array. In the previous example an array of User instances is returned -and the address of each user is fetched and hydrated into the `User#address` variable. If you access -the address Doctrine does not need to lazy load the association with another query. - -> **NOTE** -> Doctrine allows you to walk all the associations between all the objects in your domain model. -> Objects that were not already loaded from the database are replaced with lazy load proxy instances. -> Non-loaded Collections are also replaced by lazy-load instances that fetch all the contained objects upon -> first access. However relying on the lazy-load mechanism leads to many small queries executed -> against the database, which can significantly affect the performance of your application. -> **Fetch Joins** are the solution to hydrate most or all of the entities that you -> need in a single SELECT query. - -### Named and Positional Parameters - -DQL supports both named and positional parameters, however in contrast to many SQL dialects -positional parameters are specified with numbers, for example "?1", "?2" and so on. -Named parameters are specified with ":name1", ":name2" and so on. - -### DQL SELECT Examples - -This section contains a large set of DQL queries and some explanations of what is happening. -The actual result also depends on the hydration mode. - -Hydrate all User entities: - - createQuery('SELECT u FROM MyProject\Model\User u'); - $users = $query->getResult(); // array of User objects - -Retrieve the IDs of all CmsUsers: - - createQuery('SELECT u.id FROM CmsUser u'); - $ids = $query->getResult(); // array of CmsUser ids - -Retrieve the IDs of all users that have written an article: - - createQuery('SELECT DISTINCT u.id FROM CmsArticle a JOIN a.user u'); - $ids = $query->getResult(); // array of CmsUser ids - -Retrieve all articles and sort them by the name of the articles users instance: - - createQuery('SELECT a FROM CmsArticle a JOIN a.user u ORDER BY u.name ASC'); - $articles = $query->getResult(); // array of CmsArticle objects - -Retrieve the Username and Name of a CmsUser: - - createQuery('SELECT u.username, u.name FROM CmsUser u'); - $users = $query->getResults(); // array of CmsUser username and id values - echo $users[0]['username']; - -Retrieve a ForumUser and his single associated entity: - - createQuery('SELECT u, a FROM ForumUser u JOIN u.avatar a'); - $users = $query->getResult(); // array of ForumUser objects with the avatar association loaded - echo get_class($users[0]->getAvatar()); - -Retrieve a CmsUser and fetch join all the phonenumbers he has: - - createQuery('SELECT u, p FROM CmsUser u JOIN u.phonenumbers p'); - $users = $query->getResult(); // array of CmsUser objects with the phonenumbers association loaded - $phonenumbers = $users[0]->getPhonenumbers(); - -Hydrate a result in Ascending: - - createQuery('SELECT u FROM ForumUser u ORDER BY u.id ASC'); - $users = $query->getResult(); // array of ForumUser objects - -Or in Descending Order: - - createQuery('SELECT u FROM ForumUser u ORDER BY u.id DESC'); - $users = $query->getResult(); // array of ForumUser objects - -Using Aggregate Functions: - - createQuery('SELECT COUNT(u.id) FROM Entities\User u'); - $count = $query->getSingleScalarResult(); - -With WHERE Clause and Positional Parameter: - - createQuery('SELECT u FROM ForumUser u WHERE u.id = ?1'); - $users = $query->getResult(); // array of ForumUser objects - -With WHERE Clause and Named Parameter: - - createQuery('SELECT u FROM ForumUser u WHERE u.username = :name'); - $users = $query->getResult(); // array of ForumUser objects - -With Nested Conditions in WHERE Clause: - - createQuery('SELECT u from ForumUser u WHERE (u.username = :name OR u.username = :name2) AND u.id = :id'); - $users = $query->getResult(); // array of ForumUser objects - -With COUNT DISTINCT: - - createQuery('SELECT COUNT(DISTINCT u.name) FROM CmsUser'); - $users = $query->getResult(); // array of ForumUser objects - -With Arithmetic Expression in WHERE clause: - - createQuery('SELECT u FROM CmsUser u WHERE ((u.id + 5000) * u.id + 3) < 10000000'); - $users = $query->getResult(); // array of ForumUser objects - -Using a LEFT JOIN to hydrate all user-ids and optionally associated article-ids: - - createQuery('SELECT u.id, a.id as article_id FROM CmsUser u LEFT JOIN u.articles a'); - $results = $query->getResult(); // array of user ids and every article_id for each user - -Restricting a JOIN clause by additional conditions: - - createQuery("SELECT u FROM CmsUser u LEFT JOIN u.articles a WITH a.topic LIKE '%foo%'"); - $users = $query->getResult(); - -Using several Fetch JOINs: - - createQuery('SELECT u, a, p, c FROM CmsUser u JOIN u.articles a JOIN u.phonenumbers p JOIN a.comments c'); - $users = $query->getResult(); - -BETWEEN in WHERE clause: - - createQuery('SELECT u.name FROM CmsUser u WHERE u.id BETWEEN ?1 AND ?2'); - $usernames = $query->getResult(); - -DQL Functions in WHERE clause: - - createQuery("SELECT u.name FROM CmsUser u WHERE TRIM(u.name) = 'someone'"); - $usernames = $query->getResult(); - -IN() Expression: - - createQuery('SELECT u.name FROM CmsUser u WHERE u.id IN(46)'); - $usernames = $query->getResult(); - - $query = $em->createQuery('SELECT u FROM CmsUser u WHERE u.id IN (1, 2)'); - $users = $query->getResult(); - - $query = $em->createQuery('SELECT u FROM CmsUser u WHERE u.id NOT IN (1)'); - $users = $query->getResult(); - -CONCAT() DQL Function: - - createQuery("SELECT u.id FROM CmsUser u WHERE CONCAT(u.name, 's') = ?1"); - $ids = $query->getResult(); - - $query = $em->createQuery('SELECT CONCAT(u.id, u.name) FROM CmsUser u WHERE u.id = ?1'); - $idUsernames = $query->getResult(); - -EXISTS in WHERE clause with correlated Subquery - - createQuery('SELECT u.id FROM CmsUser u WHERE EXISTS (SELECT p.phonenumber FROM CmsPhonenumber p WHERE p.user = u.id)'); - $ids = $query->getResult(); - -Get all users who are members of $group. - - createQuery('SELECT u.id FROM CmsUser u WHERE :groupId MEMBER OF u.groups'); - $query->setParameter(':groupId', $group); - $ids = $query->getResult(); - -Get all users that have more than 1 phonenumber - - createQuery('SELECT u FROM CmsUser u WHERE SIZE(u.phonenumbers) > 1'); - $users = $query->getResult(); - -Get all users that have no phonenumber - - createQuery('SELECT u FROM CmsUser u WHERE u.phonenumbers IS EMPTY'); - $users = $query->getResult(); - -Get all instances of a specific type, for use with inheritance hierarchies: - - createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u INSTANCE OF Doctrine\Tests\Models\Company\CompanyEmployee'); - $query = $em->createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u INSTANCE OF ?1'); - $query = $em->createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u NOT INSTANCE OF ?1'); - -#### Partial Object Syntax - -By default when you run a DQL query in Doctrine and select only a subset of the -fields for a given entity, you do not receive objects back. Instead, you receive -only arrays as a flat rectangular result set, similar to how you would if you -were just using SQL directly and joining some data. - -If you want to select partial objects you can use the `partial` DQL keyword: - - createQuery('SELECT partial u.{id, username} FROM CmsUser u'); - $users = $query->getResult(); // array of partially loaded CmsUser objects - -You use the partial syntax when joining as well: - - createQuery('SELECT partial u.{id, username}, partial a.{id, name} FROM CmsUser u JOIN u.articles a'); - $users = $query->getResult(); // array of partially loaded CmsUser objects - -### Using INDEX BY - -The INDEX BY construct is nothing that directly translates into SQL but that affects -object and array hydration. After each FROM and JOIN clause you specify by which field -this class should be indexed in the result. By default a result is incremented -by numerical keys starting with 0. However with INDEX BY you can specify any -other column to be the key of your result, it really only makes sense with primary -or unique fields though: - - [sql] - SELECT u.id, u.status, upper(u.name) nameUpper FROM User u INDEX BY u.id - JOIN u.phonenumbers p INDEX BY p.phonenumber - -Returns an array of the following kind, indexed by both user-id then phonenumber-id: - - array - 0 => - array - 1 => - object(stdClass)[299] - public '__CLASS__' => string 'Doctrine\Tests\Models\CMS\CmsUser' (length=33) - public 'id' => int 1 - .. - 'nameUpper' => string 'ROMANB' (length=6) - 1 => - array - 2 => - object(stdClass)[298] - public '__CLASS__' => string 'Doctrine\Tests\Models\CMS\CmsUser' (length=33) - public 'id' => int 2 - ... - 'nameUpper' => string 'JWAGE' (length=5) - -## UPDATE queries - -DQL not only allows to select your Entities using field names, you can also execute bulk updates on a set -of entities using an DQL-UPDATE query. The Syntax of an UPDATE query works as expected, as the following -example shows: - - UPDATE MyProject\Model\User u SET u.password = 'new' WHERE u.id IN (1, 2, 3) - -References to related entities are only possible in the WHERE clause and using sub-selects. - -> **CAUTION** -> DQL UPDATE statements are ported directly into a Database UPDATE statement and therefore bypass -> any locking scheme and do not increment the version column. Entities that are already -> loaded into the persistence context will *NOT* be synced with the updated database state. It -> is recommended to call `EntityManager#clear()` and retrieve new instances of any affected entity. - -## DELETE queries - -DELETE queries can also be specified using DQL and their syntax is as simple as the UPDATE syntax: - - DELETE MyProject\Model\User u WHERE u.id = 4 - -The same restrictions apply for the reference of related entities. - -> **CAUTION** -> DQL DELETE statements are ported directly into a Database DELETE statement and therefore -> bypass any checks for the version column if they are not explicitly added to the WHERE -> clause of the query. Additionally Deletes of specifies entities are *NOT* cascaded -> to related entities even if specified in the metadata. - -## Functions, Operators, Aggregates - - -### DQL Functions - -The following functions are supported in SELECT, WHERE and HAVING clauses: - -* ABS(arithmetic_expression) -* CONCAT(str1, str2) -* CURRENT_DATE() - Return the current date -* CURRENT_TIME() - Returns the current time -* CURRENT_TIMESTAMP() - Returns a timestamp of the current date and time. -* LENGTH(str) - Returns the length of the given string -* LOCATE(needle, haystack [, offset]) - Locate the first occurrence of the substring in the string. -* LOWER(str) - returns the string lowercased. -* MOD(a, b) - Return a MOD b. -* SIZE(collection) - Return the number of elements in the specified collection -* SQRT(q) - Return the square-root of q. -* SUBSTRING(str, start [, length]) - Return substring of given string. -* TRIM([LEADING | TRAILING | BOTH] ['trchar' FROM] str) - Trim the string by the given trim char, defaults to whitespaces. -* UPPER(str) - Return the upper-case of the given string. - -### Arithmetic operators - -You can do math in DQL using numeric values, for example: - - SELECT person.salary * 1.5 FROM CompanyPerson person WHERE person.salary < 100000 - -### Aggregate Functions - -The following aggregate functions are allowed in SELECT and GROUP BY clauses: AVG, COUNT, MIN, MAX, SUM - -### Other Expressions - -DQL offers a wide-range of additional expressions that are known from SQL, here is a list of -all the supported constructs: - -* `ALL/ANY/SOME` - Used in a WHERE clause followed by a sub-select this works like the equivalent constructs in SQL. -* `BETWEEN a AND b` and `NOT BETWEEN a AND b` can be used to match ranges of arithmetic values. -* `IN (x1, x2, ...)` and `NOT IN (x1, x2, ..)` can be used to match a set of given values. -* `LIKE ..` and `NOT LIKE ..` match parts of a string or text using % as a wildcard. -* `IS NULL` and `IS NOT NULL` to check for null values -* `EXISTS` and `NOT EXISTS` in combination with a sub-select - -### Adding your own functions to the DQL language - -By default DQL comes with functions that are part of a large basis of underlying databases. However you will most likely -choose a database platform at the beginning of your project and most likely never change it. For this cases you can -easily extend the DQL parser with own specialized platform functions. - -You can register custom DQL functions in your ORM Configuration: - - addCustomStringFunction($name, $class); - $config->addCustomNumericFunction($name, $class); - $config->addCustomDatetimeFunction($name, $class); - - $em = EntityManager::create($dbParams, $config); - -The functions have to return either a string, numeric or datetime value depending on the registered function type. As an example -we will add a MySQL specific FLOOR() functionality. All the given classes have to implement the base class -\Doctrine\ORM\Query\AST\Functions\FunctionNode: - - walkSimpleArithmeticExpression( - $this->simpleArithmeticExpression - ) . ')'; - } - - public function parse(\Doctrine\ORM\Query\Parser $parser) - { - $lexer = $parser->getLexer(); - - $parser->match(Lexer::T_ABS); - $parser->match(Lexer::T_OPEN_PARENTHESIS); - - $this->simpleArithmeticExpression = $parser->SimpleArithmeticExpression(); - - $parser->match(Lexer::T_CLOSE_PARENTHESIS); - } - } - -We will register the function by calling and can then use it: - - setName('test'); - $employee->setDepartment('testing'); - $em->persist($employee); - $em->flush(); - -Now lets run a simple query to retrieve the `Employee` we just created: - - [sql] - SELECT e FROM Entities\Employee e WHERE e.name = 'test' - -If we check the generated SQL you will notice it has some special conditions added to -ensure that we will only get back `Employee` entities: - - [sql] - SELECT p0_.id AS id0, p0_.name AS name1, p0_.department AS department2, p0_.discr AS discr3 FROM Person p0_ WHERE (p0_.name = ?) AND p0_.discr IN ('employee') - -### Class Table Inheritance - -[Class Table Inheritance](http://martinfowler.com/eaaCatalog/classTableInheritance.html) is an inheritance mapping strategy where each class in a hierarchy is mapped to several tables: its own table and the tables of all parent classes. The table of a child class is linked to the table of a parent class through a foreign key constraint. -Doctrine 2 implements this strategy through the use of a discriminator column in the topmost table of the hierarchy because this is the easiest way to achieve polymorphic queries with Class Table Inheritance. - -The example for class table inheritance is the same as single table, you just need to -change the inheritance type from `SINGLE_TABLE` to `JOINED`: - - createQuery('select u from MyProject\Model\User u'); - - // example2: using setDql - $q = $em->createQuery(); - $q->setDql('select u from MyProject\Model\User u'); - -### Query Result Formats - -The format in which the result of a DQL SELECT query is returned can be influenced by a so-called `hydration mode`. A hydration mode specifies a particular way in which an SQL result set is transformed. Each hydration mode has its own dedicated method on the Query class. Here they are: - -* `Query#getResult()`: Retrieves a collection of objects. The result is either a plain collection of objects (pure) or an array where the objects are nested in the result rows (mixed). -* `Query#getSingleResult()`: Retrieves a single object. If the result contains more than one object, an exception is thrown. The pure/mixed distinction does not apply. -* `Query#getArrayResult()`: Retrieves an array graph (a nested array) that is largely interchangeable with the object graph generated by `Query#getResultList()` for read-only purposes. - -> **NOTE** -> An array graph can differ from the corresponding object graph in -> certain scenarios due to the difference of the identity semantics between arrays and -> objects. - -* `Query#getScalarResult()`: Retrieves a flat/rectangular result set of scalar values that can contain duplicate data. The pure/mixed distinction does not apply. -* `Query#getSingleScalarResult()`: Retrieves a single scalar value from the result returned by the dbms. If the result contains more than a single scalar value, an exception is thrown. The pure/mixed distinction does not apply. - -Instead of using these methods, you can alternatively use the general-purpose method `Query#execute(array $params = array(), $hydrationMode = Query::HYDRATE_OBJECT)`. Using this method you can directly supply the hydration mode as the second parameter via one of the Query constants. In fact, the methods mentioned earlier are just convenient shortcuts for the execute method. For example, the method `Query#getResultList()` internally invokes execute, passing in `Query::HYDRATE_OBJECT` as the hydration mode. - -The use of the methods mentioned earlier is generally preferred as it leads to more concise code. - -### Pure and Mixed Results - -The nature of a result returned by a DQL SELECT query retrieved through `Query#getResult()` or `Query#getArrayResult()` can be of 2 forms: **pure** and **mixed**. In the previous simple examples, you already saw a "pure" query result, with only objects. By default, the result type is **pure** but **as soon as scalar values, such as aggregate values or other scalar values that do not belong to an entity, appear in the SELECT part of the DQL query, the result becomes mixed**. A mixed result has a different structure than a pure result in order to accommodate for the scalar values. - -A pure result usually looks like this: - - array - [0] => Object - [1] => Object - [2] => Object - ... - -A mixed result on the other hand has the following general structure: - - array - array - [0] => Object - [1] => "some scalar string" - ['count'] => 42 - // ... more scalar values, either indexed numerically or with a name - array - [0] => Object - [1] => "some scalar string" - ['count'] => 42 - // ... more scalar values, either indexed numerically or with a name - -To better understand mixed results, consider the following DQL query: - - [sql] - SELECT u, UPPER(u.name) nameUpper FROM MyProject\Model\User u - -This query makes use of the `UPPER` DQL function that returns a scalar value and because there is now a scalar value in the SELECT clause, we get a mixed result. - -Here is how the result could look like: - - array - array - [0] => User (Object) - ['nameUpper'] => "Roman" - array - [0] => User (Object) - ['nameUpper'] => "Jonathan" - ... - -And here is how you would access it in PHP code: - - getName(); - echo "Name UPPER: " . $row['nameUpper']; - } - -You may have observed that in a mixed result, the object always ends up on index 0 of a result row. - -### Hydration Modes - -Each of the Hydration Modes makes assumptions about how the result is returned to user land. You should -know about all the details to make best use of the different result formats: - -The constants for the different hydration modes are: - -* Query::HYDRATE_OBJECT -* Query::HYDRATE_ARRAY -* Query::HYDRATE_SCALAR -* Query::HYDRATE_SINGLE_SCALAR - -#### Object Hydration - -Object hydration hydrates the result set into the object graph: - - createQuery('SELECT u FROM CmsUser u'); - $users = $query->getResult(Query::HYDRATE_OBJECT); - -#### Array Hydration - -You can run the same query with array hydration and the result set is hydrated into -an array that represents the object graph: - - createQuery('SELECT u FROM CmsUser u'); - $users = $query->getResult(Query::HYDRATE_ARRAY); - -You can use the `getArrayResult()` shortcut as well: - - getArrayResult(); - -#### Scalar Hydration - -If you want to return a flat rectangular result set instead of an object graph -you can use scalar hydration: - - createQuery('SELECT u FROM CmsUser u'); - $users = $query->getResult(Query::HYDRATE_SCALAR); - echo $users[0]['u_id']; - -The following assumptions are made about selected fields using Scalar Hydration: - -1. Fields from classes are prefixed by the DQL alias in the result. A query of the kind 'SELECT u.name ..' returns a key 'u_name' in the result rows. - -#### Single Scalar Hydration - -If you a query which returns just a single scalar value you can use single scalar -hydration: - - createQuery('SELECT COUNT(a.id) FROM CmsUser u LEFT JOIN u.articles a WHERE u.username = ?1 GROUP BY u.id'); - $query->setParameter(1, 'jwage'); - $numArticles = $query->getResult(Query::HYDRATE_SINGLE_SCALAR); - -You can use the `getSingleScalarResult()` shortcut as well: - - getSingleScalarResult(); - -#### Custom Hydration Modes - -You can easily add your own custom hydration modes by first creating a class which extends `AbstractHydrator`: - - _stmt->fetchAll(PDO::FETCH_ASSOC); - } - } - -Next you just need to add the class to the ORM configuration: - - getConfiguration()->addCustomHydrationMode('CustomHydrator', 'MyProject\Hydrators\CustomHydrator'); - -Now the hydrator is ready to be used in your queries: - - createQuery('SELECT u FROM CmsUser u'); - $results = $query->getResult('CustomHydrator'); - -### Iterating Large Result Sets - -There are situations when a query you want to execute returns a very large result-set that needs -to be processed. All the previously described hydration modes completely load a result-set into -memory which might not be feasible with large result sets. See the [Batch Processing](batch-processing) -section on details how to iterate large result sets. - -### Functions - -The following methods exist on the `AbstractQuery` which both `Query` and `NativeQuery` extend from. - -#### Parameters - -Prepared Statements that use numerical or named wildcards require additional parameters to be executable -against the database. To pass parameters to the query the following methods can be used: - -* `AbstractQuery::setParameter($param, $value)` - Set the numerical or named wildcard to the given value. -* `AbstractQuery::setParameters(array $params)` - Set an array of parameter key-value pairs. -* `AbstractQuery::getParameter($param)` -* `AbstractQuery::getParameters()` - -#### Cache related API - -You can cache query results based either on all variables that define the result (SQL, Hydration Mode, Parameters and Hints) -or on user-defined cache keys. However by default query results are not cached at all. You have to enable -the result cache on a per query basis. The following example shows a complete workflow using the Result Cache -API: - - createQuery('SELECT u FROM MyProject\Model\User u WHERE u.id = ?1'); - $query->setParameter(1, 12); - - $query->setResultCacheDriver(new ApcCache()); - - $query->useResultCache(true) - ->setResultCacheLifeTime($seconds = 3600); - - $result = $query->getResult(); // cache miss - - $query->expireResultCache(true); - $result = $query->getResult(); // forced expire, cache miss - - $query->setResultCacheId('my_query_result'); - $result = $query->getResult(); // saved in given result cache id. - - // or call useResultCache() with all parameters: - $query->useResultCache(true, $seconds = 3600, 'my_query_result'); - $result = $query->getResult(); // cache hit! - -> **TIP!** -> You can set the Result Cache Driver globally on the `Doctrine\ORM\Configuration` instance -> so that it is passed to every `Query` and `NativeQuery` instance. - -#### Query Hints - -You can pass hints to the query parser and hydrators by using the `AbstractQuery::setHint($name, $value)` method. -Currently there exist mostly internal query hints that are not be consumed in userland. However the following few hints -are to be used in userland: - -* Query::HINT_FORCE_PARTIAL_LOAD - Allows to hydrate objects although not all their columns are fetched. This query -hint can be used to handle memory consumption problems with large result-sets that contain char or binary data. -Doctrine has no way of implicitly reloading this data. Partially loaded objects have to be passed to -`EntityManager::refresh()` if they are to be reloaded fully from the database. -* Query::HINT_REFRESH - This query is used internally by `EntityManager::refresh()` and can be used in userland as well. -If you specify this hint and a query returns the data for an entity that is already managed by the UnitOfWork, the -fields of the existing entity will be refreshed. In normal operation a result-set that loads data of an already existing -entity is discarded in favor of the already existing entity. -* Query::HINT_CUSTOM_TREE_WALKERS - An array of additional `Doctrine\ORM\Query\TreeWalker` instances that are attached -to the DQL query parsing process. - -#### Query Cache (DQL Query Only) - -Parsing a DQL query and converting it into an SQL query against the underlying database platform obviously has some overhead -in contrast to directly executing Native SQL queries. That is why there is a dedicated Query Cache for caching the -DQL parser results. In combination with the use of wildcards you can reduce the number of parsed queries in production -to zero. - -The Query Cache Driver is passed from the `Doctrine\ORM\Configuration` instance to each `Doctrine\ORM\Query` instance -by default and is also enabled by default. This also means you don't regularly need to fiddle with the parameters -of the Query Cache, however if you do there are several methods to interact with it: - -* `Query::setQueryCacheDriver($driver)` - Allows to set a Cache instance -* `Query::setQueryCacheLifeTime($seconds = 3600)` - Set lifetime of the query caching. -* `Query::expireQueryCache($bool)` - Enforce the expiring of the query cache if set to true. -* `Query::getExpireQueryCache()` -* `Query::getQueryCacheDriver()` -* `Query::getQueryCacheLifeTime()` - -#### First and Max Result Items (DQL Query Only) - -You can limit the number of results returned from a DQL query as well as specify the starting offset, Doctrine -then uses a strategy of manipulating the select query to return only the requested number of results: - -* `Query::setMaxResults($maxResults)` -* `Query::setFirstResult($offset)` - -> **NOTE** -> If your query contains a fetch-joined collection specifying the result limit methods are not working -> as you would expect. Set Max Results restricts the number of database result rows, however in the -> case of fetch-joined collections one root entity might appear in many rows, effectively hydrating -> less than the specified number of results. - -## EBNF - -The following context-free grammar, written in an EBNF variant, describes the Doctrine Query Language. You can consult this grammar whenever you are unsure about what is possible with DQL or what the correct syntax for a particular query should be. - -### Document syntax: - -* non-terminals begin with an upper case character -* terminals begin with a lower case character -* parentheses (...) are used for grouping -* square brackets [...] are used for defining an optional part, e.g. zero or one time -* curly brackets {...} are used for repetition, e.g. zero or more times -* double quotation marks "..." define a terminal string a vertical bar | represents an alternative - -### Terminals - -* identifier (name, email, ...) -* string ('foo', 'bar''s house', '%ninja%', ...) -* char ('/', '\\', ' ', ...) -* integer (-1, 0, 1, 34, ...) -* float (-0.23, 0.007, 1.245342E+8, ...) -* boolean (false, true) - -### Query Language - - QueryLanguage ::= SelectStatement | UpdateStatement | DeleteStatement - -### Statements - - SelectStatement ::= SelectClause FromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause] - UpdateStatement ::= UpdateClause [WhereClause] - DeleteStatement ::= DeleteClause [WhereClause] - -### Identifiers - - /* Alias Identification usage (the "u" of "u.name") */ - IdentificationVariable ::= identifier - - /* Alias Identification declaration (the "u" of "FROM User u") */ - AliasIdentificationVariable :: = identifier - - /* identifier that must be a class name (the "User" of "FROM User u") */ - AbstractSchemaName ::= identifier - - /* identifier that must be a field (the "name" of "u.name") */ - /* This is responsible to know if the field exists in Object, no matter if it's a relation or a simple field */ - FieldIdentificationVariable ::= identifier - - /* identifier that must be a collection-valued association field (to-many) (the "Phonenumbers" of "u.Phonenumbers") */ - CollectionValuedAssociationField ::= FieldIdentificationVariable - - /* identifier that must be a single-valued association field (to-one) (the "Group" of "u.Group") */ - SingleValuedAssociationField ::= FieldIdentificationVariable - - /* identifier that must be an embedded class state field (for the future) */ - EmbeddedClassStateField ::= FieldIdentificationVariable - - /* identifier that must be a simple state field (name, email, ...) (the "name" of "u.name") */ - /* The difference between this and FieldIdentificationVariable is only semantical, because it points to a single field (not mapping to a relation) */ - SimpleStateField ::= FieldIdentificationVariable - - /* Alias ResultVariable declaration (the "total" of "COUNT(*) AS total") */ - AliasResultVariable = identifier - - /* ResultVariable identifier usage of mapped field aliases (the "total" of "COUNT(*) AS total") */ - ResultVariable = identifier - -### Path Expressions - - /* "u.Group" or "u.Phonenumbers" declarations */ - JoinAssociationPathExpression ::= IdentificationVariable "." (CollectionValuedAssociationField | SingleValuedAssociationField) - - /* "u.Group" or "u.Phonenumbers" usages */ - AssociationPathExpression ::= CollectionValuedPathExpression | SingleValuedAssociationPathExpression - - /* "u.name" or "u.Group" */ - SingleValuedPathExpression ::= StateFieldPathExpression | SingleValuedAssociationPathExpression - - /* "u.name" or "u.Group.name" */ - StateFieldPathExpression ::= IdentificationVariable "." StateField | SingleValuedAssociationPathExpression "." StateField - - /* "u.Group" */ - SingleValuedAssociationPathExpression ::= IdentificationVariable "." {SingleValuedAssociationField "."}* SingleValuedAssociationField - - /* "u.Group.Permissions" */ - CollectionValuedPathExpression ::= IdentificationVariable "." {SingleValuedAssociationField "."}* CollectionValuedAssociationField - - /* "name" */ - StateField ::= {EmbeddedClassStateField "."}* SimpleStateField - - /* "u.name" or "u.address.zip" (address = EmbeddedClassStateField) */ - SimpleStateFieldPathExpression ::= IdentificationVariable "." StateField - - -### Clauses - - SelectClause ::= "SELECT" ["DISTINCT"] SelectExpression {"," SelectExpression}* - SimpleSelectClause ::= "SELECT" ["DISTINCT"] SimpleSelectExpression - UpdateClause ::= "UPDATE" AbstractSchemaName ["AS"] AliasIdentificationVariable "SET" UpdateItem {"," UpdateItem}* - DeleteClause ::= "DELETE" ["FROM"] AbstractSchemaName ["AS"] AliasIdentificationVariable - FromClause ::= "FROM" IdentificationVariableDeclaration {"," IdentificationVariableDeclaration}* - SubselectFromClause ::= "FROM" SubselectIdentificationVariableDeclaration {"," SubselectIdentificationVariableDeclaration}* - WhereClause ::= "WHERE" ConditionalExpression - HavingClause ::= "HAVING" ConditionalExpression - GroupByClause ::= "GROUP" "BY" GroupByItem {"," GroupByItem}* - OrderByClause ::= "ORDER" "BY" OrderByItem {"," OrderByItem}* - Subselect ::= SimpleSelectClause SubselectFromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause] - - -### Items - - UpdateItem ::= IdentificationVariable "." (StateField | SingleValuedAssociationField) "=" NewValue - OrderByItem ::= (ResultVariable | StateFieldPathExpression) ["ASC" | "DESC"] - GroupByItem ::= IdentificationVariable | SingleValuedPathExpression - NewValue ::= ScalarExpression | SimpleEntityExpression | "NULL" - - -### From, Join and Index by - - IdentificationVariableDeclaration ::= RangeVariableDeclaration [IndexBy] {JoinVariableDeclaration}* - SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration | (AssociationPathExpression ["AS"] AliasIdentificationVariable) - JoinVariableDeclaration ::= Join [IndexBy] - RangeVariableDeclaration ::= AbstractSchemaName ["AS"] AliasIdentificationVariable - Join ::= ["LEFT" ["OUTER"] | "INNER"] "JOIN" JoinAssociationPathExpression - ["AS"] AliasIdentificationVariable ["WITH" ConditionalExpression] - IndexBy ::= "INDEX" "BY" SimpleStateFieldPathExpression - - -### Select Expressions - - SelectExpression ::= IdentificationVariable | PartialObjectExpression | (AggregateExpression | "(" Subselect ")" | FunctionDeclaration | ScalarExpression) [["AS"] AliasResultVariable] - SimpleSelectExpression ::= ScalarExpression | IdentificationVariable | - (AggregateExpression [["AS"] AliasResultVariable]) - PartialObjectExpression ::= "PARTIAL" IdentificationVariable "." PartialFieldSet - PartialFieldSet ::= "{" SimpleStateField {"," SimpleStateField}* "}" - - -### Conditional Expressions - - ConditionalExpression ::= ConditionalTerm {"OR" ConditionalTerm}* - ConditionalTerm ::= ConditionalFactor {"AND" ConditionalFactor}* - ConditionalFactor ::= ["NOT"] ConditionalPrimary - ConditionalPrimary ::= SimpleConditionalExpression | "(" ConditionalExpression ")" - SimpleConditionalExpression ::= ComparisonExpression | BetweenExpression | LikeExpression | - InExpression | NullComparisonExpression | ExistsExpression | - EmptyCollectionComparisonExpression | CollectionMemberExpression - - -### Collection Expressions - - EmptyCollectionComparisonExpression ::= CollectionValuedPathExpression "IS" ["NOT"] "EMPTY" - CollectionMemberExpression ::= EntityExpression ["NOT"] "MEMBER" ["OF"] CollectionValuedPathExpression - -### Literal Values - - Literal ::= string | char | integer | float | boolean - InParameter ::= Literal | InputParameter - -### Input Parameter - - InputParameter ::= PositionalParameter | NamedParameter - PositionalParameter ::= "?" integer - NamedParameter ::= ":" string - - -### Arithmetic Expressions - - ArithmeticExpression ::= SimpleArithmeticExpression | "(" Subselect ")" - SimpleArithmeticExpression ::= ArithmeticTerm {("+" | "-") ArithmeticTerm}* - ArithmeticTerm ::= ArithmeticFactor {("*" | "/") ArithmeticFactor}* - ArithmeticFactor ::= [("+" | "-")] ArithmeticPrimary - ArithmeticPrimary ::= SingleValuedPathExpression | Literal | "(" SimpleArithmeticExpression ")" - | FunctionsReturningNumerics | AggregateExpression | FunctionsReturningStrings - | FunctionsReturningDatetime | IdentificationVariable | InputParameter - - -### Scalar and Type Expressions - - ScalarExpression ::= SimpleArithmeticExpression | StringPrimary | DateTimePrimary | StateFieldPathExpression - BooleanPrimary | CaseExpression | EntityTypeExpression - CaseExpression ::= GeneralCaseExpression | SimpleCaseExpression | - CoalesceExpression | NullifExpression - GeneralCaseExpression ::= "CASE" WhenClause {WhenClause}* "ELSE" ScalarExpression - "END" - WhenClause ::= "WHEN" ConditionalExpression "THEN" ScalarExpression - SimpleCaseExpression ::= "CASE" CaseOperand SimpleWhenClause {SimpleWhenClause}* - "ELSE" ScalarExpression "END" - CaseOperand ::= StateFieldPathExpression | TypeDiscriminator - SimpleWhenClause ::= "WHEN" ScalarExpression "THEN" ScalarExpression - CoalesceExpression ::= "COALESCE" "(" ScalarExpression {"," ScalarExpression}* ")" - NullifExpression ::= "NULLIF" "(" ScalarExpression "," ScalarExpression ")" - StringExpression ::= StringPrimary | "(" Subselect ")" - StringPrimary ::= StateFieldPathExpression | string | InputParameter | FunctionsReturningStrings | AggregateExpression - BooleanExpression ::= BooleanPrimary | "(" Subselect ")" - BooleanPrimary ::= StateFieldPathExpression | boolean | InputParameter - EntityExpression ::= SingleValuedAssociationPathExpression | SimpleEntityExpression - SimpleEntityExpression ::= IdentificationVariable | InputParameter - DatetimeExpression ::= DatetimePrimary | "(" Subselect ")" - DatetimePrimary ::= StateFieldPathExpression | InputParameter | FunctionsReturningDatetime | AggregateExpression - - -### Aggregate Expressions - - AggregateExpression ::= ("AVG" | "MAX" | "MIN" | "SUM") "(" ["DISTINCT"] StateFieldPathExpression ")" | - "COUNT" "(" ["DISTINCT"] (IdentificationVariable | SingleValuedPathExpression) ")" - -### Other Expressions - -QUANTIFIED/BETWEEN/COMPARISON/LIKE/NULL/EXISTS - - QuantifiedExpression ::= ("ALL" | "ANY" | "SOME") "(" Subselect ")" - BetweenExpression ::= ArithmeticExpression ["NOT"] "BETWEEN" ArithmeticExpression "AND" ArithmeticExpression - ComparisonExpression ::= ArithmeticExpression ComparisonOperator ( QuantifiedExpression | ArithmeticExpression ) - InExpression ::= StateFieldPathExpression ["NOT"] "IN" "(" (InParameter {"," InParameter}* | Subselect) ")" - LikeExpression ::= StringExpression ["NOT"] "LIKE" string ["ESCAPE" char] - NullComparisonExpression ::= (SingleValuedPathExpression | InputParameter) "IS" ["NOT"] "NULL" - ExistsExpression ::= ["NOT"] "EXISTS" "(" Subselect ")" - ComparisonOperator ::= "=" | "<" | "<=" | "<>" | ">" | ">=" | "!=" - -### Functions - - FunctionDeclaration ::= FunctionsReturningStrings | FunctionsReturningNumerics | FunctionsReturningDateTime - - FunctionsReturningNumerics ::= - "LENGTH" "(" StringPrimary ")" | - "LOCATE" "(" StringPrimary "," StringPrimary ["," SimpleArithmeticExpression]")" | - "ABS" "(" SimpleArithmeticExpression ")" | "SQRT" "(" SimpleArithmeticExpression ")" | - "MOD" "(" SimpleArithmeticExpression "," SimpleArithmeticExpression ")" | - "SIZE" "(" CollectionValuedPathExpression ")" - - FunctionsReturningDateTime ::= "CURRENT_DATE" | "CURRENT_TIME" | "CURRENT_TIMESTAMP" - - FunctionsReturningStrings ::= - "CONCAT" "(" StringPrimary "," StringPrimary ")" | - "SUBSTRING" "(" StringPrimary "," SimpleArithmeticExpression "," SimpleArithmeticExpression ")" | - "TRIM" "(" [["LEADING" | "TRAILING" | "BOTH"] [char] "FROM"] StringPrimary ")" | - "LOWER" "(" StringPrimary ")" | - "UPPER" "(" StringPrimary ")" \ No newline at end of file diff --git a/manual/en/events.rst b/manual/en/events.rst index e899e3121..ebdeee81b 100644 --- a/manual/en/events.rst +++ b/manual/en/events.rst @@ -1,3 +1,6 @@ +Events +====== + Doctrine 2 features a lightweight event system that is part of the Common package. @@ -139,10 +142,10 @@ the life-time of their registered entities. - preRemove - The preRemove event occurs for a given entity before the respective EntityManager remove operation for that entity is - executed. + executed. It is not called for a DQL DELETE statement. - postRemove - The postRemove event occurs for an entity after the entity has been deleted. It will be invoked after the database - delete operations. + delete operations. It is not called for a DQL DELETE statement. - prePersist - The prePersist event occurs for a given entity before the respective EntityManager persist operation for that entity is executed. @@ -151,9 +154,9 @@ the life-time of their registered entities. database insert operations. Generated primary key values are available in the postPersist event. - preUpdate - The preUpdate event occurs before the database - update operations to entity data. + update operations to entity data. It is not called for a DQL UPDATE statement. - postUpdate - The postUpdate event occurs after the database - update operations to entity data. + update operations to entity data. It is not called for a DQL UPDATE statement. - postLoad - The postLoad event occurs for an entity after the entity has been loaded into the current EntityManager from the database or after the refresh operation has been applied to it. @@ -164,7 +167,9 @@ the life-time of their registered entities. managed entities are computed. This event is not a lifecycle callback. - **CAUTION** Note that the postLoad event occurs for an entity +.. warning:: + + Note that the postLoad event occurs for an entity before any associations have been initialized. Therefore it is not safe to access associations in a postLoad callback or event handler. @@ -191,7 +196,9 @@ listeners: methods that receives some kind of ``EventArgs`` instance which give access to the entity, EntityManager or other relevant data. - **NOTE** All Lifecycle events that happen during the ``flush()`` of +.. note:: + + All Lifecycle events that happen during the ``flush()`` of an EntityManager have very specific constraints on the allowed operations that can be executed. Please read the *Implementing Event Listeners* section very carefully to understand diff --git a/manual/en/events.txt b/manual/en/events.txt deleted file mode 100644 index a83340f39..000000000 --- a/manual/en/events.txt +++ /dev/null @@ -1,467 +0,0 @@ -Doctrine 2 features a lightweight event system that is part of the Common package. - -## The Event System - -The event system is controlled by the `EventManager`. It is the central point -of Doctrine's event listener system. Listeners are registered on the manager -and events are dispatched through the manager. - - addEventListener(array(self::preFoo, self::postFoo), $this); - } - - public function preFoo(EventArgs $e) - { - $this->preFooInvoked = true; - } - - public function postFoo(EventArgs $e) - { - $this->postFooInvoked = true; - } - } - - // Create a new instance - $test = new EventTest($evm); - -Events can be dispatched by using the `dispatchEvent()` method. - - dispatchEvent(EventTest::preFoo); - $evm->dispatchEvent(EventTest::postFoo); - -You can easily remove a listener with the `removeEventListener()` method. - - removeEventListener(array(self::preFoo, self::postFoo), $this); - -The Doctrine 2 event system also has a simple concept of event subscribers. We -can define a simple `TestEventSubscriber` class which implements the -`\Doctrine\Common\EventSubscriber` interface and implements a `getSubscribedEvents()` -method which returns an array of events it should be subscribed to. - - preFooInvoked = true; - } - - public function getSubscribedEvents() - { - return array(TestEvent::preFoo); - } - } - - $eventSubscriber = new TestEventSubscriber(); - $evm->addEventSubscriber($eventSubscriber); - -Now when you dispatch an event any event subscribers will be notified for that event. - - dispatchEvent(TestEvent::preFoo); - -Now you can test the `$eventSubscriber` instance to see if the `preFoo()` method was invoked. - - preFooInvoked) { - echo 'pre foo invoked!'; - } - -### Naming convention - -Events being used with the Doctrine 2 EventManager are best named with camelcase and the value of the corresponding constant should be the name of the constant itself, even with spelling. This has several reasons: - -* It is easy to read. -* Simplicity. -* Each method within an EventSubscriber is named after the corresponding constant. If constant name and constant value differ, you MUST use the new value and thus, your code might be subject to codechanges when the value changes. This contradicts the intention of a constant. - -An example for a correct notation can be found in the example `EventTest` above. - -## Lifecycle Events - -The EntityManager and UnitOfWork trigger a bunch of events during the life-time of their registered entities. - -* preRemove - The preRemove event occurs for a given entity before the respective EntityManager remove operation for that entity is executed. -* postRemove - The postRemove event occurs for an entity after the entity has been deleted. It will be invoked after the database delete operations. -* prePersist - The prePersist event occurs for a given entity before the respective EntityManager persist operation for that entity is executed. -* postPersist - The postPersist event occurs for an entity after the entity has been made persistent. It will be invoked after the database insert operations. Generated primary key values are available in the postPersist event. -* preUpdate - The preUpdate event occurs before the database update operations to entity data. -* postUpdate - The postUpdate event occurs after the database update operations to entity data. -* postLoad - The postLoad event occurs for an entity after the entity has been loaded into the current EntityManager from the database or after the refresh operation has been applied to it. -* loadClassMetadata - The loadClassMetadata event occurs after the mapping metadata for a class has been loaded from a mapping source (annotations/xml/yaml). -* onFlush - The onFlush event occurs after the change-sets of all managed entities are computed. This event is not a lifecycle callback. - -> **CAUTION** -> Note that the postLoad event occurs for an entity before any associations have been -> initialized. Therefore it is not safe to access associations in a postLoad callback -> or event handler. - -You can access the Event constants from the `Events` class in the ORM package. - - **NOTE** -> All Lifecycle events that happen during the `flush()` of an EntityManager have very specific constraints on the allowed -> operations that can be executed. Please read the *Implementing Event Listeners* section very carefully to understand -> which operations are allowed in which lifecycle event. - -## Lifecycle Callbacks - -A lifecycle event is a regular event with the additional feature of providing -a mechanism to register direct callbacks inside the corresponding entity classes -that are executed when the lifecycle event occurs. - - createdAt = date('Y-m-d H:m:s'); - } - - /** @PrePersist */ - public function doOtherStuffOnPrePersist() - { - $this->value = 'changed from prePersist callback!'; - } - - /** @PostPersist */ - public function doStuffOnPostPersist() - { - $this->value = 'changed from postPersist callback!'; - } - - /** @PostLoad */ - public function doStuffOnPostLoad() - { - $this->value = 'changed from postLoad callback!'; - } - - /** @PreUpdate */ - public function doStuffOnPreUpdate() - { - $this->value = 'changed from preUpdate callback!'; - } - } - -Note that when using annotations you have to apply the @HasLifecycleCallbacks marker annotation on the entity class. - -If you want to register lifecycle callbacks from YAML or XML you can do it with -the following. - - [yml] - User: - type: entity - fields: - # ... - name: - type: string(50) - lifecycleCallbacks: - doStuffOnPrePersist: prePersist - doStuffOnPostPersist: postPersist - -XML would look something like this: - - [xml] - - - - - - - - - - - - - - - -You just need to make sure a public `doStuffOnPrePersist()` and `doStuffOnPostPersist()` method is defined on your `User` model. - - addEventListener(array(Events::preUpdate), MyEventListener()); - $eventManager->addEventSubscriber(new MyEventSubscriber()); - - $entityManager = EntityManager::create($dbOpts, $config, $eventManager); - -You can also retrieve the event manager instance after the EntityManager was created: - - getEventManager()->addEventListener(array(Events::preUpdate), MyEventListener()); - $entityManager->getEventManager()->addEventSubscriber(new MyEventSubscriber()); - -## Implementing Event Listeners - -This section explains what is and what is not allowed during specific lifecycle events of the UnitOfWork. -Although you get passed the EntityManager in all of these events, you have to follow this restrictions very -carefully since operations in the wrong event may produce lots of different errors, such as inconsistent data and -lost updates/persists/removes. - -For the described events that are also lifecycle callback events the restrictions -apply as well, with the additional restriction that you do not have access to the EntityManager -or UnitOfWork APIs inside these events. - -### prePersist - -There are two ways for the `prePersist` event to be triggered. One is obviously -when you call `EntityManager#persist()`. The event is also called for all -cascaded associations. - -There is another way for `prePersist` to be called, inside the `flush()` -method when changes to associations are computed and this association -is marked as cascade persist. Any new entity found during this operation -is also persisted and `prePersist` called on it. This is called "persistence by reachability". - -In both cases you get passed a `LifecycleEventArgs` -instance which has access to the entity and the entity manager. - -The following restrictions apply to `prePersist`: - -* If you are using a PrePersist Identity Generator such as sequences the ID value - will *NOT* be available within any PrePersist events. -* Doctrine will not recognize changes made to relations in a pre persist event - called by "reachability" through a cascade persist unless you use the internal - `UnitOfWork` API. We do not recommend such operations in the persistence by - reachability context, so do this at your own risk and possibly supported by unit-tests. - -### preRemove - -The `preRemove` event is called on every entity when its passed to -the `EntityManager#remove()` method. It is cascaded for all -associations that are marked as cascade delete. - -There are no restrictions to what methods can be called inside -the `preRemove` event, except when the remove method itself was -called during a flush operation. - -### onFlush - -OnFlush is a very powerful event. It is called inside `EntityManager#flush()` -after the changes to all the managed entities and their associations have -been computed. This means, the `onFlush` event has access to the sets of: - -* Entities scheduled for insert -* Entities scheduled for update -* Entities scheduled for removal -* Collections scheduled for update -* Collections scheduled for removal - -To make use of the onFlush event you have to be familiar with the internal UnitOfWork API, -which grants you access to the previously mentioned sets. See this example: - - getEntityManager(); - $uow = $em->getUnitOfWork(); - - foreach ($uow->getScheduledEntityInsertions() AS $entity) { - - } - - foreach ($uow->getScheduledEntityUpdates() AS $entity) { - - } - - foreach ($uow->getScheduledEntityDeletions() AS $entity) { - - } - - foreach ($uow->getScheduledCollectionDeletions() AS $col) { - - } - - foreach ($uow->getScheduledCollectionUpdates() AS $col) { - - } - } - } - -The following restrictions apply to the onFlush event: - -* Calling `EntityManager#persist()` does not suffice to trigger a persist on an entity. - You have to execute an additional call to `$unitOfWork->computeChangeSet($classMetadata, $entity)`. -* Changing primitive fields or associations requires you to explicitly trigger - a re-computation of the changeset of the affected entity. This can be done - by either calling `$unitOfWork->computeChangeSet($classMetadata, $entity)` - or `$unitOfWork->recomputeSingleEntityChangeSet($classMetadata, $entity)`. The second - method has lower overhead, but only re-computes primitive fields, never associations. - -### preUpdate - -PreUpdate is the most restrictive to use event, since it is called right before -an update statement is called for an entity inside the `EntityManager#flush()` -method. - -Changes to associations of the updated entity are never allowed in this event, since Doctrine cannot guarantee to -correctly handle referential integrity at this point of the flush operation. This -event has a powerful feature however, it is executed with a `PreUpdateEventArgs` -instance, which contains a reference to the computed change-set of this entity. - -This means you have access to all the fields that have changed for this entity -with their old and new value. The following methods are available on the `PreUpdateEventArgs`: - -* `getEntity()` to get access to the actual entity. -* `getEntityChangeSet()` to get a copy of the changeset array. Changes to this returned array do not affect updating. -* `hasChangedField($fieldName)` to check if the given field name of the current entity changed. -* `getOldValue($fieldName)` and `getNewValue($fieldName)` to access the values of a field. -* `setNewValue($fieldName, $value)` to change the value of a field to be updated. - -A simple example for this event looks like: - - getEntity() instanceof User) { - if ($eventArgs->hasChangedField('name') && $eventArgs->getNewValue('name') == 'Alice') { - $eventArgs->setNewValue('name', 'Bob'); - } - } - } - } - -You could also use this listener to implement validation of all the fields that have changed. -This is more efficient than using a lifecycle callback when there are expensive validations -to call: - - getEntity() instanceof Account) { - if ($eventArgs->hasChangedField('creditCard')) { - $this->validateCreditCard($eventArgs->getNewValue('creditCard')); - } - } - } - - private function validateCreditCard($no) - { - // throw an exception to interrupt flush event. Transaction will be rolled back. - } - } - -Restrictions for this event: - -* Changes to associations of the passed entities are not recognized by the flush operation anymore. -* Changes to fields of the passed entities are not recognized by the flush operation anymore, use the computed change-set passed to the event to modify primitive field values. -* Any calls to `EntityManager#persist()` or `EntityManager#remove()`, even in combination with the UnitOfWork API are strongly discouraged and don't work as expected outside the flush operation. - -### postUpdate, postRemove, postPersist - -The three post events are called inside `EntityManager#flush()`. Changes in here -are not relevant to the persistence in the database, but you can use this events -to - -### postLoad - -This event is called after an entity is constructed by the EntityManager. - -## Load ClassMetadata Event - -When the mapping information for an entity is read, it is populated in to a -`ClassMetadataInfo` instance. You can hook in to this process and manipulate -the instance. - - getMetadataFactory(); - $evm = $em->getEventManager(); - $evm->addEventListener(Events::loadClassMetadata, $test); - - class EventTest - { - public function loadClassMetadata(\Doctrine\ORM\Event\LoadClassMetadataEventArgs $eventArgs) - { - $classMetadata = $eventArgs->getClassMetadata(); - $fieldMapping = array( - 'fieldName' => 'about', - 'type' => 'string', - 'length' => 255 - ); - $classMetadata->mapField($fieldMapping); - } - } diff --git a/manual/en/improving-performance.rst b/manual/en/improving-performance.rst index 2d9ffb57f..eee5b4b9b 100644 --- a/manual/en/improving-performance.rst +++ b/manual/en/improving-performance.rst @@ -1,3 +1,6 @@ +Improving Performance +===================== + Bytecode Cache -------------- @@ -5,7 +8,9 @@ It is highly recommended to make use of a bytecode cache like APC. A bytecode cache removes the need for parsing PHP code on every request and can greatly improve performance. - **NOTE** "If you care about performance and don't use a bytecode +.. note:: + + "If you care about performance and don't use a bytecode cache then you don't really care about performance. Please get one and start using it." (Stas Malyshev, Core Contributor to PHP and Zend Employee). diff --git a/manual/en/improving-performance.txt b/manual/en/improving-performance.txt deleted file mode 100644 index 01509bb81..000000000 --- a/manual/en/improving-performance.txt +++ /dev/null @@ -1,25 +0,0 @@ - -## Bytecode Cache - -It is highly recommended to make use of a bytecode cache like APC. A bytecode cache removes the need for parsing PHP code on every request and can greatly improve performance. - -> **NOTE** -> "If you care about performance and don't use a bytecode cache then you don't really care -> about performance. Please get one and start using it." (Stas Malyshev, Core Contributor -> to PHP and Zend Employee). - - -## Metadata and Query caches - -As already mentioned earlier in the chapter about configuring Doctrine, it is strongly discouraged to use Doctrine without a Metadata and Query cache (preferably with APC or Memcache as the cache driver). Operating Doctrine without these caches means Doctrine will need to load your mapping information on every single request and has to parse each DQL query on every single request. This is a waste of resources. - -## Alternative Query Result Formats - -Make effective use of the available alternative query result formats like nested array graphs or pure scalar results, especially in scenarios where data is loaded for read-only purposes. - -## Apply Best Practices - -A lot of the points mentioned in the Best Practices chapter will also positively affect the performance of Doctrine. - - - diff --git a/manual/en/index.rst b/manual/en/index.rst index af4ddee9a..91eb8f6b6 100644 --- a/manual/en/index.rst +++ b/manual/en/index.rst @@ -11,6 +11,33 @@ Contents: .. toctree:: :maxdepth: 2 + introduction + architecture + configuration + basic-mapping + association-mapping + inheritance-mapping + working-with-objects + working-with-associations + transactions-and-concurrency + events + batch-processing + dql-doctrine-query-language + query-builder + native-sql + change-tracking-policies + partial-objects + xml-mapping + yaml-mapping + annotations-reference + php-mapping + caching + improving-performance + tools + metadata-drivers + best-practices + limitations-and-Known-issues + Indices and tables ================== diff --git a/manual/en/inheritance-mapping.rst b/manual/en/inheritance-mapping.rst index f950577c5..3b226aad4 100644 --- a/manual/en/inheritance-mapping.rst +++ b/manual/en/inheritance-mapping.rst @@ -1,3 +1,6 @@ +Inheritance Mapping +=================== + Mapped Superclasses ------------------- @@ -11,7 +14,7 @@ Mapped superclasses, just as regular, non-mapped classes, can appear in the middle of an otherwise mapped inheritance hierarchy (through Single Table Inheritance or Class Table Inheritance). - **NOTE** +.. note:: A mapped superclass cannot be an entity, it is not query-able and persistent relationships defined by a mapped superclass must be @@ -54,9 +57,8 @@ Example: The DDL for the corresponding database schema would look something like this (this is for SQLite): -:: +.. code-block:: sql - [sql] CREATE TABLE EntitySubClass (mapped1 INTEGER NOT NULL, mapped2 TEXT NOT NULL, id INTEGER NOT NULL, name TEXT NOT NULL, related1_id INTEGER DEFAULT NULL, PRIMARY KEY(id)) As you can see from this DDL snippet, there is only a single table @@ -202,7 +204,9 @@ Things to note: namespace as the entity class on which the discriminator map is applied. - **NOTE** When you do not use the SchemaTool to generate the +.. note:: + + When you do not use the SchemaTool to generate the required SQL you should know that deleting a class table inheritance makes use of the foreign key property ``ON DELETE CASCADE`` in all database implementations. A failure to diff --git a/manual/en/inheritance-mapping.txt b/manual/en/inheritance-mapping.txt deleted file mode 100644 index b1ed480c4..000000000 --- a/manual/en/inheritance-mapping.txt +++ /dev/null @@ -1,159 +0,0 @@ -## Mapped Superclasses - -An mapped superclass is an abstract or concrete class that provides persistent entity state and mapping information -for its subclasses, but which is not itself an entity. Typically, the purpose of such a mapped superclass is to define -state and mapping information that is common to multiple entity classes. - -Mapped superclasses, just as regular, non-mapped classes, can appear in the middle of an otherwise -mapped inheritance hierarchy (through Single Table Inheritance or Class Table Inheritance). - -> **NOTE** -> -> A mapped superclass cannot be an entity, it is not query-able and persistent relationships defined by a mapped -> superclass must be unidirectional. For further support of inheritance, the single or joined table inheritance -> features have to be used. - -Example: - - **NOTE** -> When you do not use the SchemaTool to generate the required SQL you should know that deleting a class table inheritance -> makes use of the foreign key property `ON DELETE CASCADE` in all database implementations. A failure to implement this -> yourself will lead to dead rows in the database. - -### Design-time considerations - -Introducing a new type to the hierarchy, at any level, simply involves interjecting a new table into the schema. Subtypes of that type will automatically join with that new type at runtime. Similarly, modifying any entity type in the hierarchy by adding, modifying or removing fields affects only the immediate table mapped to that type. This mapping strategy provides the greatest flexibility at design time, since changes to any type are always limited to that type's dedicated table. - -### Performance impact - -This strategy inherently requires multiple JOIN operations to perform just about any query which can have a negative impact on performance, especially with large tables and/or large hierarchies. When partial objects are allowed, either globally or on the specific query, then querying for any type will not cause the tables of subtypes to be OUTER JOINed which can increase performance but the resulting partial objects will not fully load themselves on access of any subtype fields, so accessing fields of subtypes after such a query is not safe. - -There is a general performance consideration with Class Table Inheritance: If you use a CTI entity as a many-to-one or one-to-one entity you should never use one of the classes at the upper levels of the inheritance hierachy as "targetEntity", only those that have no subclasses. Otherwise Doctrine *CANNOT* create proxy instances of this entity and will *ALWAYS* load the entity eagerly. - -### SQL Schema considerations - -For each entity in the Class-Table Inheritance hierarchy all the mapped fields have to be columns on the -table of this entity. Additionally each child table has to have an id column that matches the id column -definition on the root table (except for any sequence or auto-increment details). Furthermore each child table has -to have a foreign key pointing from the id column to the root table id column and cascading on delete. diff --git a/manual/en/introduction.txt b/manual/en/introduction.txt deleted file mode 100644 index 4515ead00..000000000 --- a/manual/en/introduction.txt +++ /dev/null @@ -1,309 +0,0 @@ -## Welcome - -Doctrine 2 is an object-relational mapper (ORM) for PHP 5.3.0+ that provides -transparent persistence for PHP objects. It sits on top of a powerful database -abstraction layer (DBAL). Object-Relational Mappers primary task is the transparent -translation between (PHP) objects and relational database rows. - -One of Doctrines key features is the option to write database queries in a -proprietary object oriented SQL dialect called Doctrine -Query Language (DQL), inspired by Hibernates HQL. Besides DQLs slight -differences to SQL it abstracts the mapping between database rows and -objects considerably, allowing developers to write powerful queries -in a simple and flexible fashion. - -## Disclaimer - -This is the Doctrine 2 reference documentation. Introductory guides and tutorials -that you can follow along from start to finish, like the "Guide to Doctrine" book -known from the Doctrine 1.x series, will be available at a later date. - -## Using an Object-Relational Mapper - -As the term ORM already hints at, Doctrine 2 aims to simplify the translation -between database rows and the PHP object model. The primary use case for Doctrine -are therefore applications that utilize the Object-Oriented Programming Paradigm. -For applications that not primarily work with objects Doctrine 2 is not suited very well. - -## Requirements - -Doctrine 2 requires a minimum of PHP 5.3.0. For greatly improved performance it -is also recommended that you use APC with PHP. - -## Doctrine 2 Packages - -Doctrine 2 is divided into three main packages. - -* Common -* DBAL (includes Common) -* ORM (includes DBAL+Common) - -This manual mainly covers the ORM package, sometimes touching parts of the -underlying DBAL and Common packages. The Doctrine code base is split in to these -packages for a few reasons and they are to... - -* ...make things more maintainable and decoupled -* ...allow you to use the code in Doctrine Common without the ORM or DBAL -* ...allow you to use the DBAL without the ORM - -### The Common Package - -The Common package contains highly reusable components that have no dependencies -beyond the package itself (and PHP, of course). The root namespace of the -Common package is `Doctrine\Common`. - -### The DBAL Package - -The DBAL package contains an enhanced database abstraction layer on top of -PDO but is not strongly bound to PDO. The purpose of this layer is to provide a -single API that bridges most of the differences between the different RDBMS vendors. -The root namespace of the DBAL package is `Doctrine\DBAL`. - -### The ORM Package - -The ORM package contains the object-relational mapping toolkit that provides -transparent relational persistence for plain PHP objects. The root namespace of -the ORM package is `Doctrine\ORM`. - -## Installing - -Doctrine can be installed many different ways. We will describe all the different -ways and you can choose which one suits you best. - -### PEAR - -You can easily install any of the three Doctrine packages from the PEAR command -line installation utility. - -To install just the `Common` package you can run the following command: - - $ sudo pear install pear.doctrine-project.org/DoctrineCommon- - -If you want to use the Doctrine Database Abstraction Layer you can install it -with the following command. - - $ sudo pear install pear.doctrine-project.org/DoctrineDBAL- - -Or, if you want to get the works and go for the ORM you can install it with the -following command. - - $ sudo pear install pear.doctrine-project.org/DoctrineORM- - -> **NOTE** -> The `` tag above represents the version you want to install. For example the -> current version at the time of writing this is `2.0.0BETA3` for the ORM, so you could -> install it like the following: -> -> $ sudo pear install pear.doctrine-project.org/DoctrineORM-2.0.0BETA3 - -When you have a package installed via PEAR you can require and load the -`ClassLoader` with the following code. - - **NOTE** -> -> You should not combine the Doctrine-Common, Doctrine-DBAL and Doctrine-ORM master commits -> with each other in combination. The ORM may not work with the current Common or DBAL master versions. -> Instead the ORM ships with the Git Submodules that are required. - -### Subversion - -> **NOTE** -> -> Using the SVN Mirror is not recommended. It only allows access to the latest master commit -> and does not automatically fetch the submodules. - -If you prefer subversion you can also checkout the code from GitHub.com through -the subversion protocol: - - $ svn co http://svn.github.com/doctrine/doctrine2.git doctrine2 - -However this only allows you to check out the current master of Doctrine 2, without -the Common and DBAL dependencies. You have to grab them yourself, but might run -into version incompatibilities between the different master branches of Common, DBAL -and ORM. - -## Sandbox Quickstart - -> **NOTE** -> The sandbox is only available via the Doctrine2 Github Repository or soon as a separate download on the downloads -> page. You will find it in the $root/tools/sandbox folder. - -The sandbox is a pre-configured environment for evaluating and playing -with Doctrine 2. - -### Overview - -After navigating to the sandbox directory, you should see the following structure: - - sandbox/ - Entities/ - Address.php - User.php - xml/ - Entities.Address.dcm.xml - Entities.User.dcm.xml - yaml/ - Entities.Address.dcm.yml - Entities.User.dcm.yml - cli-config.php - doctrine - doctrine.php - index.php - -Here is a short overview of the purpose of these folders and files: - - * The `Entities` folder is where any model classes are created. Two example entities are already there. - * The `xml` folder is where any XML mapping files are created (if you want to use XML mapping). Two example mapping documents for the 2 example entities are already there. - * The `yaml` folder is where any YAML mapping files are created (if you want to use YAML mapping). Two example mapping documents for the 2 example entities are already there. - * The `cli-config.php` contains bootstrap code for a configuration that is used by the Console tool `doctrine` whenever you execute a task. - * `doctrine`/`doctrine.php` is a command-line tool. - * `index.php` is a basic classical bootstrap file of a php application that uses Doctrine 2. - -### Mini-tutorial - -1) From within the tools/sandbox folder, run the following command and you should -see the same output. - - $ php doctrine orm:schema-tool:create - Creating database schema... - Database schema created successfully! - -2) Take another look into the tools/sandbox folder. A SQLite database should -have been created with the name `database.sqlite`. - -3) Open `index.php` and at the bottom edit it so it looks like the following: - - setName('Garfield'); - $em->persist($user); - $em->flush(); - - echo "User saved!"; - -Open index.php in your browser or execute it on the command line. You should see -the output "User saved!". - -4) Inspect the SQLite database. Again from within the tools/sandbox folder, -execute the following command: - - $ php doctrine dbal:run-sql "select * from users" - -You should get the following output: - - array(1) { - [0]=> - array(2) { - ["id"]=> - string(1) "1" - ["name"]=> - string(8) "Garfield" - } - } - -You just saved your first entity with a generated ID in an SQLite database. - -5) Replace the contents of index.php with the following: - - createQuery('select u from Entities\User u where u.name = ?1'); - $q->setParameter(1, 'Garfield'); - $garfield = $q->getSingleResult(); - - echo "Hello " . $garfield->getName() . "!"; - -You just created your first DQL query to retrieve the user with the name -'Garfield' from an SQLite database (Yes, there is an easier way to do it, -but we wanted to introduce you to DQL at this point. Can you **find** the easier way?). - -> **TIP** -> When you create new model classes or alter existing ones you can recreate the database -> schema with the command `doctrine orm:schema-tool --drop` followed by -> `doctrine orm:schema-tool --create`. - -6) Explore Doctrine 2! - -See the following links if you want to start with more complex tutorials rather than reading the manual: - -* Doctrine2 Cookbook: [Getting Started XML Edition](http://www.doctrine-project.org/projects/orm/2.0/docs/cookbook/getting-started-xml-edition/en) diff --git a/manual/en/limitations-and-known-issues.rst b/manual/en/limitations-and-known-issues.rst index 78072272c..8631c2d7d 100644 --- a/manual/en/limitations-and-known-issues.rst +++ b/manual/en/limitations-and-known-issues.rst @@ -1,3 +1,6 @@ +Limitations and Known Issues +============================ + We try to make using Doctrine2 a very pleasant experience. Therefore we think it is very important to be honest about the current limitations to our users. Much like every other piece of @@ -21,9 +24,8 @@ There are many use-cases where you would want to use an Entity-Attribute-Value approach to modelling and define a table-schema like the following: -:: +.. code-block:: sql - [sql] CREATE TABLE product ( id INTEGER, name VARCHAR, @@ -41,9 +43,8 @@ This is currently *NOT* possible with Doctrine2. You have to define a surrogate key on the ``product_attributes`` table and use a unique-constraint for the ``product_id`` and ``attribute_name``. -:: +.. code-block:: sql - [sql] CREATE TABLE product_attributes ( attribute_id, INTEGER, product_id INTEGER, @@ -109,9 +110,8 @@ Identifier" you might be interested in mapping the same table structure as given above to an array. However this is not yet possible either. See the following example: -:: +.. code-block:: sql - [sql] CREATE TABLE product ( id INTEGER, name VARCHAR, diff --git a/manual/en/limitations-and-known-issues.txt b/manual/en/limitations-and-known-issues.txt deleted file mode 100644 index d65a8516d..000000000 --- a/manual/en/limitations-and-known-issues.txt +++ /dev/null @@ -1,203 +0,0 @@ -We try to make using Doctrine2 a very pleasant experience. Therefore we think it is very important -to be honest about the current limitations to our users. -Much like every other piece of software Doctrine2 is not perfect and far from feature complete. -This section should give you an overview of current limitations of Doctrine 2 as well as critical known issues that -you should know about. - -## Current Limitations - -There is a set of limitations that exist currently which might be solved in the future. Any of this -limitations now stated has at least one ticket in the Tracker and is discussed for future releases. - -### Foreign Keys as Identifiers - -There are many use-cases where you would want to use an Entity-Attribute-Value approach to modelling and -define a table-schema like the following: - - [sql] - CREATE TABLE product ( - id INTEGER, - name VARCHAR, - PRIMARY KEY(id) - ); - - CREATE TABLE product_attributes ( - product_id INTEGER, - attribute_name VARCHAR, - attribute_value VARCHAR, - PRIMARY KEY (product_id, attribute_name) - ); - -This is currently *NOT* possible with Doctrine2. You have to define a surrogate key on the `product_attributes` -table and use a unique-constraint for the `product_id` and `attribute_name`. - - [sql] - CREATE TABLE product_attributes ( - attribute_id, INTEGER, - product_id INTEGER, - attribute_name VARCHAR, - attribute_value VARCHAR, - PRIMARY KEY (attribute_id), - UNIQUE (product_id, attribute_name) - ); - -Although we state that we support composite primary keys that does not currently include foreign keys as primary key -columns. To see the fundamental difference between the two different `product_attributes` tables you should see -how they translate into a Doctrine Mapping (Using Annotations): - - **TIP** -> The populated `ClassMetadata` instances are also cached so in a production -> environment the parsing and populating only ever happens once. You can configure -> the metadata cache implementation using the `setMetadataCacheImpl()` method on -> the `Doctrine\ORM\Configuration` class: -> -> $em->getConfiguration()->setMetadataCacheImpl(new ApcCache()); - -If you want to use one of the included core metadata drivers you just need to -configure it. All the drivers are in the `Doctrine\ORM\Mapping\Driver` namespace: - - getConfiguration()->setMetadataDriverImpl($driver); - -## Implementing Metadata Drivers - -In addition to the included metadata drivers you can very easily implement -your own. All you need to do is define a class which implements the `Driver` -interface: - - _loadMappingFile($file); - - // populate ClassMetadataInfo instance from $data - } - - /** - * {@inheritdoc} - */ - protected function _loadMappingFile($file) - { - // parse contents of $file and return php data structure - } - } - -> **NOTE** -> When using the `AbstractFileDriver` it requires that you only have one entity -> defined per file and the file named after the class described inside where -> namespace separators are replaced by periods. So if you have an entity named -> `Entities\User` and you wanted to write a mapping file for your driver above -> you would need to name the file `Entities.User.dcm.ext` for it to be recognized. - -Now you can use your `MyMetadataDriver` implementation by setting it with the -`setMetadataDriverImpl()` method: - - getConfiguration()->setMetadataDriverImpl($driver); - -## ClassMetadata - -The last piece you need to know and understand about metadata in Doctrine 2 is -the API of the `ClassMetadata` classes. You need to be familiar with them in order -to implement your own drivers but more importantly to retrieve mapping information -for a certain entity when needed. - -You have all the methods you need to manually specify the mapping information -instead of using some mapping file to populate it from. The base `ClassMetadataInfo` -class is responsible for only data storage and is not meant for runtime use. It -does not require that the class actually exists yet so it is useful for describing some -entity before it exists and using that information to generate for example the -entities themselves. The class `ClassMetadata` extends `ClassMetadataInfo` and -adds some functionality required for runtime usage and requires that the PHP -class is present and can be autoloaded. - -You can read more about the API of the `ClassMetadata` classes in the PHP Mapping -chapter. - -## Getting ClassMetadata Instances - -If you want to get the `ClassMetadata` instance for an entity in your project -to programatically use some mapping information to generate some HTML or something -similar you can retrieve it through the `ClassMetadataFactory`: - - getMetadataFactory(); - $class = $cmf->getMetadataFor('MyEntityName'); - -Now you can learn about the entity and use the data stored in the `ClassMetadata` -instance to get all mapped fields for example and iterate over them: - - fieldMappings as $fieldMapping) { - echo $fieldMapping['fieldName'] . "\n"; - } \ No newline at end of file diff --git a/manual/en/native-sql.rst b/manual/en/native-sql.rst index 059168713..992eefc06 100644 --- a/manual/en/native-sql.rst +++ b/manual/en/native-sql.rst @@ -1,3 +1,6 @@ +Native SQL +========== + A ``NativeQuery`` lets you execute native SQL, mapping the results according to your specifications. Such a specification that describes how an SQL result set is mapped to a Doctrine result is @@ -44,7 +47,9 @@ components: root entities or joined entities must be present in the SQL query and mapped accordingly using ``ResultSetMapping#addMetaResult``. - **TIP** It might not surprise you that Doctrine uses +.. note:: + + It might not surprise you that Doctrine uses ``ResultSetMapping``s internally when you create DQL queries. As the query gets parsed and transformed to SQL, Doctrine fills a ``ResultSetMapping`` that describes how the results should be diff --git a/manual/en/native-sql.txt b/manual/en/native-sql.txt deleted file mode 100644 index 867bc523c..000000000 --- a/manual/en/native-sql.txt +++ /dev/null @@ -1,242 +0,0 @@ -A `NativeQuery` lets you execute native SQL, mapping the results according to your specifications. -Such a specification that describes how an SQL result set is mapped to a Doctrine result is -represented by a `ResultSetMapping`. It describes how each column of the database result should -be mapped by Doctrine in terms of the object graph. This allows you to map arbitrary SQL code to objects, such as -highly vendor-optimized SQL or stored-procedures. - -## The NativeQuery class - -To create a `NativeQuery` you use the method `EntityManager#createNativeQuery($sql, $resultSetMapping)`. As you can see in the signature of this method, it expects 2 ingredients: The SQL you want to execute and the `ResultSetMapping` that describes how the results will be mapped. - -Once you obtained an instance of a `NativeQuery`, you can bind parameters to it and finally execute it. - -## The ResultSetMapping - -Understanding the `ResultSetMapping` is the key to using a `NativeQuery`. -A Doctrine result can contain the following components: - - * Entity results. These represent root result elements. - * Joined entity results. These represent joined entities in associations of root entity results. - * Field results. These represent a column in the result set that maps to a field of an entity. A field result always belongs to an entity result or joined entity result. - * Scalar results. These represent scalar values in the result set that will appear in each result row. Adding scalar results to a ResultSetMapping can also cause the overall result to become **mixed** (see DQL - Doctrine Query Language) if the same ResultSetMapping also contains entity results. - * Meta results. These represent columns that contain meta-information, such as foreign keys and discriminator columns. - When querying for objects (`getResult()`), all meta columns of root entities or joined entities must be present in the SQL query - and mapped accordingly using `ResultSetMapping#addMetaResult`. - -> **TIP** -> It might not surprise you that Doctrine uses `ResultSetMapping`s internally when you -> create DQL queries. As the query gets parsed and transformed to SQL, Doctrine fills -> a `ResultSetMapping` that describes how the results should be processed by the hydration -> routines. - -We will now look at each of the result types that can appear in a ResultSetMapping in detail. - -### Entity results - -An entity result describes an entity type that appears as a root element in the transformed result. You add an entity result through `ResultSetMapping#addEntityResult()`. -Let's take a look at the method signature in detail: - - addEntityResult('User', 'u'); - $rsm->addFieldResult('u', 'id', 'id'); - $rsm->addFieldResult('u', 'name', 'name'); - - $query = $this->_em->createNativeQuery('SELECT id, name FROM users WHERE name = ?', $rsm); - $query->setParameter(1, 'romanb'); - - $users = $query->getResult(); - -The result would look like this: - - array( - [0] => User (Object) - ) - -Note that this would be a partial object if the entity has more fields than just id and name. In the example above the column and field names are identical but that is not necessary, of course. Also note that the query string passed to createNativeQuery is **real native SQL**. Doctrine does not touch this SQL in any way. - -In the previous basic example, a User had no relations and the table the class is mapped to owns no foreign keys. -The next example assumes User has a unidirectional or bidirectional one-to-one association to a CmsAddress, -where the User is the owning side and thus owns the foreign key. - - addEntityResult('User', 'u'); - $rsm->addFieldResult('u', 'id', 'id'); - $rsm->addFieldResult('u', 'name', 'name'); - $rsm->addMetaResult('u', 'address_id', 'address_id'); - - $query = $this->_em->createNativeQuery('SELECT id, name, address_id FROM users WHERE name = ?', $rsm); - $query->setParameter(1, 'romanb'); - - $users = $query->getResult(); - -Foreign keys are used by Doctrine for lazy-loading purposes when querying for objects. -In the previous example, each user object in the result will have a proxy (a "ghost") in place -of the address that contains the address_id. When the ghost proxy is accessed, it loads itself -based on this key. - -Consequently, associations that are *fetch-joined* do not require the foreign keys to be present -in the SQL result set, only associations that are lazy. - - addEntityResult('User', 'u'); - $rsm->addFieldResult('u', 'id', 'id'); - $rsm->addFieldResult('u', 'name', 'name'); - $rsm->addJoinedEntityResult('Address' , 'a', 'u', 'address'); - $rsm->addFieldResult('a', 'address_id', 'id'); - $rsm->addFieldResult('a', 'street', 'street'); - $rsm->addFieldResult('a', 'city', 'city'); - - $sql = 'SELECT u.id, u.name, a.id AS address_id, a.street, a.city FROM users u ' . - 'INNER JOIN address a ON u.address_id = a.id WHERE u.name = ?'; - $query = $this->_em->createNativeQuery($sql, $rsm); - $query->setParameter(1, 'romanb'); - - $users = $query->getResult(); - -In this case the nested entity `Address` is registered with the `ResultSetMapping#addJoinedEntityResult` -method, which notifies Doctrine that this entity is not hydrated at the root level, but as a joined entity -somewhere inside the object graph. In this case we specify the alias 'u' as third parameter and `address` -as fourth parameter, which means the `Address` is hydrated into the `User::$address` property. - -If a fetched entity is part of a mapped hierarchy that requires a discriminator column, this -column must be present in the result set as a meta column so that Doctrine can create the -appropriate concrete type. This is shown in the following example where we assume that there -are one or more subclasses that extend User and either Class Table Inheritance or Single Table Inheritance -is used to map the hierarchy (both use a discriminator column). - - addEntityResult('User', 'u'); - $rsm->addFieldResult('u', 'id', 'id'); - $rsm->addFieldResult('u', 'name', 'name'); - $rsm->addMetaResult('u', 'discr', 'discr'); // discriminator column - $rsm->setDiscriminatorColumn('u', 'discr'); - - $query = $this->_em->createNativeQuery('SELECT id, name, discr FROM users WHERE name = ?', $rsm); - $query->setParameter(1, 'romanb'); - - $users = $query->getResult(); - -Note that in the case of Class Table Inheritance, an example as above would result in partial objects -if any objects in the result are actually a subtype of User. When using DQL, Doctrine automatically -includes the necessary joins for this mapping strategy but with native SQL it is your responsibility. \ No newline at end of file diff --git a/manual/en/partial-objects.rst b/manual/en/partial-objects.rst index e2d353af2..f6a6a17c0 100644 --- a/manual/en/partial-objects.rst +++ b/manual/en/partial-objects.rst @@ -1,10 +1,15 @@ +Partial Objects +=============== + A partial object is an object whose state is not fully initialized after being reconstituted from the database and that is disconnected from the rest of its data. The following section will describe why partial objects are problematic and what the approach of Doctrine2 to this problem is. - **NOTE** The partial object problem in general does not apply to +.. note:: + + The partial object problem in general does not apply to methods or queries where you do not retrieve the query result as objects. Examples are: ``Query#getArrayResult()``, ``Query#getScalarResult()``, ``Query#getSingleScalarResult()``, diff --git a/manual/en/partial-objects.txt b/manual/en/partial-objects.txt deleted file mode 100644 index 83e89b233..000000000 --- a/manual/en/partial-objects.txt +++ /dev/null @@ -1,49 +0,0 @@ -A partial object is an object whose state is not fully initialized after being -reconstituted from the database and that is disconnected from the rest of its data. -The following section will describe why partial objects are problematic and what the approach of Doctrine2 to this problem is. - -> **NOTE** -> The partial object problem in general does not apply to methods or -> queries where you do not retrieve the query result as objects. Examples are: -> `Query#getArrayResult()`, `Query#getScalarResult()`, `Query#getSingleScalarResult()`, -> etc. - -## What is the problem? - -In short, partial objects are problematic because they are usually objects with -broken invariants. As such, code that uses these partial objects tends to be -very fragile and either needs to "know" which fields or methods can be safely -accessed or add checks around every field access or method invocation. The same -holds true for the internals, i.e. the method implementations, of such objects. -You usually simply assume the state you need in the method is available, after -all you properly constructed this object before you pushed it into the database, -right? These blind assumptions can quickly lead to null reference errors when -working with such partial objects. - -It gets worse with the scenario of an optional association (0..1 to 1). When -the associated field is NULL, you don't know whether this object does not have -an associated object or whether it was simply not loaded when the owning object -was loaded from the database. - -These are reasons why many ORMs do not allow partial objects at all and instead -you always have to load an object with all its fields (associations being proxied). -One secure way to allow partial objects is if the programming language/platform -allows the ORM tool to hook deeply into the object and instrument it in such a -way that individual fields (not only associations) can be loaded lazily on first -access. This is possible in Java, for example, through bytecode instrumentation. -In PHP though this is not possible, so there is no way to have "secure" partial -objects in an ORM with transparent persistence. - -Doctrine, by default, does not allow partial objects. That means, any query that -only selects partial object data and wants to retrieve the result as objects -(i.e. `Query#getResult()`) will raise an exception telling you that -partial objects are dangerous. If you want to force a query to return you partial -objects, possibly as a performance tweak, you can use the `partial` keyword as follows: - - createQuery("select partial u.{id,name} from MyApp\Domain\User u"); - -## When should I force partial objects? - -Mainly for optimization purposes, but be careful of premature optimization as partial objects -lead to potentially more fragile code. \ No newline at end of file diff --git a/manual/en/php-mapping.rst b/manual/en/php-mapping.rst index 4a0326524..21fb33fec 100644 --- a/manual/en/php-mapping.rst +++ b/manual/en/php-mapping.rst @@ -1,3 +1,6 @@ +PHP Mapping +=========== + Doctrine 2 also allows you to provide the ORM metadata in the form of plain PHP code using the ``ClassMetadata`` API. You can write the code in PHP files or inside of a static function named diff --git a/manual/en/php-mapping.txt b/manual/en/php-mapping.txt deleted file mode 100644 index 05ea41ca3..000000000 --- a/manual/en/php-mapping.txt +++ /dev/null @@ -1,199 +0,0 @@ -Doctrine 2 also allows you to provide the ORM metadata in the form of plain -PHP code using the `ClassMetadata` API. You can write the code in PHP files or -inside of a static function named `loadMetadata($class)` on the entity class itself. - -## PHP Files - -If you wish to write your mapping information inside PHP files that are named -after the entity and included to populate the metadata for an entity you can do -so by using the `PHPDriver`: - - getConfiguration()->setMetadataDriverImpl($driver); - -Now imagine we had an entity named `Entities\User` and we wanted to write a mapping -file for it using the above configured `PHPDriver` instance: - - mapField(array( - 'id' => true, - 'fieldName' => 'id', - 'type' => 'integer' - )); - - $metadata->mapField(array( - 'fieldName' => 'username', - 'type' => 'string' - )); - -Now we can easily retrieve the populated `ClassMetadata` instance where the `PHPDriver` -includes the file and the `ClassMetadataFactory` caches it for later retrieval: - - getMetadataFor('Entities\User'); - -## Static Function - -In addition to the PHP files you can also specify your mapping information inside -of a static function defined on the entity class itself. This is useful for cases -where you want to keep your entity and mapping information together but don't want -to use annotations. For this you just need to use the `StaticPHPDriver`: - - getConfiguration()->setMetadataDriverImpl($driver); - -Now you just need to define a static function named `loadMetadata($metadata)` on your entity: - - mapField(array( - 'id' => true, - 'fieldName' => 'id', - 'type' => 'integer' - )); - - $metadata->mapField(array( - 'fieldName' => 'username', - 'type' => 'string' - )); - } - } - -## ClassMetadataInfo API - -The `ClassMetadataInfo` class is the base data object for storing the mapping -metadata for a single entity. It contains all the getters and setters you need -populate and retrieve information for an entity. - -### General Setters - - * `setTableName($tableName)` - * `setPrimaryTable(array $primaryTableDefinition)` - * `setCustomRepositoryClass($repositoryClassName)` - * `setIdGeneratorType($generatorType)` - * `setIdGenerator($generator)` - * `setSequenceGeneratorDefinition(array $definition)` - * `setChangeTrackingPolicy($policy)` - * `setIdentifier(array $identifier)` - -### Inheritance Setters - - * `setInheritanceType($type)` - * `setSubclasses(array $subclasses)` - * `setParentClasses(array $classNames)` - * `setDiscriminatorColumn($columnDef)` - * `setDiscriminatorMap(array $map)` - -### Field Mapping Setters - - * `mapField(array $mapping)` - * `mapOneToOne(array $mapping)` - * `mapOneToMany(array $mapping)` - * `mapManyToOne(array $mapping)` - * `mapManyToMany(array $mapping)` - -### Lifecycle Callback Setters - - * `addLifecycleCallback($callback, $event)` - * `setLifecycleCallbacks(array $callbacks)` - -### Versioning Setters - - * `setVersionMapping(array &$mapping)` - * `setVersioned($bool)` - * `setVersionField()` - -### General Getters - - * `getTableName()` - * `getTemporaryIdTableName()` - -### Identifier Getters - - * `getIdentifierColumnNames()` - * `usesIdGenerator()` - * `isIdentifier($fieldName)` - * `isIdGeneratorIdentity()` - * `isIdGeneratorSequence()` - * `isIdGeneratorTable()` - * `isIdentifierNatural()` - * `getIdentifierFieldNames()` - * `getSingleIdentifierFieldName()` - * `getSingleIdentifierColumnName()` - -### Inheritance Getters - - * `isInheritanceTypeNone()` - * `isInheritanceTypeJoined()` - * `isInheritanceTypeSingleTable()` - * `isInheritanceTypeTablePerClass()` - * `isInheritedField($fieldName)` - * `isInheritedAssociation($fieldName)` - -### Change Tracking Getters - - * `isChangeTrackingDeferredExplicit()` - * `isChangeTrackingDeferredImplicit()` - * `isChangeTrackingNotify()` - -### Field & Association Getters - - * `isUniqueField($fieldName)` - * `isNullable($fieldName)` - * `getColumnName($fieldName)` - * `getFieldMapping($fieldName)` - * `getAssociationMapping($fieldName)` - * `getAssociationMappings()` - * `getFieldName($columnName)` - * `hasField($fieldName)` - * `getColumnNames(array $fieldNames = null)` - * `getTypeOfField($fieldName)` - * `getTypeOfColumn($columnName)` - * `hasAssociation($fieldName)` - * `isSingleValuedAssociation($fieldName)` - * `isCollectionValuedAssociation($fieldName)` - -### Lifecycle Callback Getters - - * `hasLifecycleCallbacks($lifecycleEvent)` - * `getLifecycleCallbacks($event)` - -## ClassMetadata API - -The `ClassMetadata` class extends `ClassMetadataInfo` and adds the runtime functionality -required by Doctrine. It adds a few extra methods related to runtime reflection -for working with the entities themselves. - - * `getReflectionClass()` - * `getReflectionProperties()` - * `getReflectionProperty($name)` - * `getSingleIdReflectionProperty()` - * `getIdentifierValues($entity)` - * `setIdentifierValues($entity, $id)` - * `setFieldValue($entity, $field, $value)` - * `getFieldValue($entity, $field)` \ No newline at end of file diff --git a/manual/en/query-builder.rst b/manual/en/query-builder.rst index 5b883ae39..240cf6113 100644 --- a/manual/en/query-builder.rst +++ b/manual/en/query-builder.rst @@ -1,5 +1,5 @@ The QueryBuilder ----------------- +================ A ``QueryBuilder`` provides an API that is designed for conditionally constructing a DQL query in several steps. diff --git a/manual/en/query-builder.txt b/manual/en/query-builder.txt deleted file mode 100644 index 5f15bed7a..000000000 --- a/manual/en/query-builder.txt +++ /dev/null @@ -1,408 +0,0 @@ - -## The QueryBuilder - -A `QueryBuilder` provides an API that is designed for conditionally constructing a DQL query in several steps. - -It provides a set of classes and methods that is able to programmatically build queries, and also provides a fluent API. -This means that you can change between one methodology to the other as you want, and also pick one if you prefer. - -### Constructing a new QueryBuilder object - -The same way you build a normal Query, you build a `QueryBuilder` object, just providing the correct method name. -Here is an example how to build a `QueryBuilder` object: - - createQueryBuilder(); - -Once you have created an instance of QueryBuilder, it provides a set of useful informative functions that you can use. -One good example is to inspect what type of object the `QueryBuilder` is. - - getType(); // Prints: 0 - -There're currently 3 possible return values for `getType()`: - -* `QueryBuilder::SELECT`, which returns value 0 -* `QueryBuilder::DELETE`, returning value 1 -* `QueryBuilder::UPDATE`, which returns value 2 - -It is possible to retrieve the associated `EntityManager` of the current `QueryBuilder`, its DQL and also a `Query` object when you finish building your DQL. - - getEntityManager(); - - // example4: retrieve the DQL string of what was defined in QueryBuilder - $dql = $qb->getDql(); - - // example5: retrieve the associated Query object with the processed DQL - $q = $qb->getQuery(); - -Internally, `QueryBuilder` works with a DQL cache to increase performance. Any changes that may affect the generated DQL actually modifies the state of `QueryBuilder` to a stage we call STATE_DIRTY. -One `QueryBuilder` can be in two different states: - -* `QueryBuilder::STATE_CLEAN`, which means DQL haven't been altered since last retrieval or nothing were added since its instantiation -* `QueryBuilder::STATE_DIRTY`, means DQL query must (and will) be processed on next retrieval - -### Working with QueryBuilder - -All helper methods in `QueryBuilder` actually rely on a single one: `add()`. -This method is responsible of building every piece of DQL. It takes 3 parameters: `$dqlPartName`, `$dqlPart` and `$append` (default=false) - -* `$dqlPartName`: Where the `$dqlPart` should be placed. Possible values: select, from, where, groupBy, having, orderBy -* `$dqlPart`: What should be placed in `$dqlPartName`. Accepts a string or any instance of `Doctrine\ORM\Query\Expr\*` -* `$append`: Optional flag (default=false) if the `$dqlPart` should override all previously defined items in `$dqlPartName` or not - -- - - add('select', 'u') - ->add('from', 'User u') - ->add('where', 'u.id = ?1') - ->add('orderBy', 'u.name ASC'); - -#### Binding parameters to your query - -Doctrine supports dynamic binding of parameters to your query, similar to preparing queries. You can use both strings and numbers as placeholders, although both have a slightly different syntax. Additionally, you must make your choice: Mixing both styles is not allowed. Binding parameters can simply be achieved as follows: - - add('select', 'u') - ->add('from', 'User u') - ->add('where', 'u.id = ?1') - ->add('orderBy', 'u.name ASC'); - ->setParameter(1, 100); // Sets ?1 to 100, and thus we will fetch a user with u.id = 100 - -You are not forced to enumerate your placeholders as the alternative syntax is available: - - - add('select', 'u') - ->add('from', 'User u') - ->add('where', 'u.id = :identifier') - ->add('orderBy', 'u.name ASC'); - ->setParameter('identifier', 100); // Sets :identifier to 100, and thus we will fetch a user with u.id = 100 - -Note that numeric placeholders start with a ? followed by a number while the named placeholders start with a : followed by a string. - -If you've got several parameters to bind to your query, you can also use setParameters() instead of setParameter() with the following syntax: - - setParameters(array(1 => 'value for ?1', 2 => 'value for ?2')); - - -Getting already bound parameters is easy - simply use the above mentioned syntax with "getParameter()" or "getParameters()": - - getParameters(array(1, 2)); - // Equivalent to - $param = array($qb->getParameter(1), $qb->getParameter(2)); - -Note: If you try to get a parameter that was not bound yet, getParameter() simply returns NULL. - -#### Expr\* classes - -When you call `add()` with string, it internally evaluates to an instance of `Doctrine\ORM\Query\Expr\Expr\*` class. -Here is the same query of example 6 written using `Doctrine\ORM\Query\Expr\Expr\*` classes: - - add('select', new Expr\Select(array('u'))) - ->add('from', new Expr\From('User', 'u')) - ->add('where', new Expr\Comparison('u.id', '=', '?1')) - ->add('orderBy', new Expr\OrderBy('u.name', 'ASC')); - -Of course this is the hardest way to build a DQL query in Doctrine. To simplify some of these efforts, we introduce what we call as `Expr` helper class. - -#### The Expr class - -To workaround most of the issues that `add()` method may cause, Doctrine created a class that can be considered as a helper for building queries. -This class is called `Expr`, which provides a set of useful static methods to help building queries: - - add('select', $qb->expr()->select('u')) - ->add('from', $qb->expr()->from('User', 'u')) - ->add('where', $qb->expr()->orx( - $qb->expr()->eq('u.id', '?1'), - $qb->expr()->like('u.nickname', '?2') - )) - ->add('orderBy', $qb->expr()->orderBy('u.surname', 'ASC')); - -Although it still sounds complex, the ability to programmatically create conditions are the main feature of `Expr`. -Here it is a complete list of supported helper methods available: - - expr()->select('u') - public function select($select = null); // Returns Expr\Select instance - - // Example - $qb->expr()->from('User', 'u') - public function from($from, $alias); // Returns Expr\From instance - - // Example - $qb->expr()->leftJoin('u.Phonenumbers', 'p', Expr\Join::ON, 'p.user_id = u.id AND p.country_code = 55'); - // Example - $qb->expr()->leftJoin('u. Phonenumbers', 'p', 'ON', $qb->expr()->andx($qb->expr()->eq('p.user_id', 'u.id'), $qb->expr()->eq('p.country_code', '55')); - public function leftJoin($join, $alias, $conditionType = null, $condition = null); // Returns Expr\Join instance - - // Example - $qb->expr()->innerJoin('u.Group', 'g', Expr\Join::WITH, 'g.manager_level = 100'); - // Example - $qb->expr()->innerJoin('u.Group', 'g', 'WITH', $qb->expr()->eq('g.manager_level', '100')); - public function innerJoin($join, $alias, $conditionType = null, $condition = null); // Returns Expr\Join instance - - // Example - $qb->expr()->orderBy('u.surname', 'ASC')->add('u.firstname', 'ASC')->... - public function orderBy($sort = null, $order = null); // Returns Expr\OrderBy instance - - // Example - $qb->expr()->groupBy()->add('u.id')->... - public function groupBy($groupBy = null); // Returns Expr\GroupBy instance - - - /** Conditional objects **/ - - // Example - $qb->expr()->andx($cond1 [, $condN])->add(...)->... - public function andx($x = null); // Returns Expr\Andx instance - - // Example - $qb->expr()->orx($cond1 [, $condN])->add(...)->... - public function orx($x = null); // Returns Expr\Orx instance - - - /** Comparison objects **/ - - // Example - $qb->expr()->eq('u.id', '?1') => u.id = ?1 - public function eq($x, $y); // Returns Expr\Comparison instance - - // Example - $qb->expr()->neq('u.id', '?1') => u.id <> ?1 - public function neq($x, $y); // Returns Expr\Comparison instance - - // Example - $qb->expr()->lt('u.id', '?1') => u.id < ?1 - public function lt($x, $y); // Returns Expr\Comparison instance - - // Example - $qb->expr()->lte('u.id', '?1') => u.id <= ?1 - public function lte($x, $y); // Returns Expr\Comparison instance - - // Example - $qb->expr()->gt('u.id', '?1') => u.id > ?1 - public function gt($x, $y); // Returns Expr\Comparison instance - - // Example - $qb->expr()->gte('u.id', '?1') => u.id >= ?1 - public function gte($x, $y); // Returns Expr\Comparison instance - - - /** Arithmetic objects **/ - - // Example - $qb->expr()->prod('u.id', '2') => u.id * 2 - public function prod($x, $y); // Returns Expr\Math instance - - // Example - $qb->expr()->diff('u.id', '2') => u.id - 2 - public function diff($x, $y); // Returns Expr\Math instance - - // Example - $qb->expr()->sum('u.id', '2') => u.id + 2 - public function sum($x, $y); // Returns Expr\Math instance - - // Example - $qb->expr()->quot('u.id', '2') => u.id / 2 - public function quot($x, $y); // Returns Expr\Math instance - - - /** Pseudo-function objects **/ - - // Example - $qb->expr()->exists($qb2->getDql()) - public function exists($subquery); // Returns Expr\Func instance - - // Example - $qb->expr()->all($qb2->getDql()) - public function all($subquery); // Returns Expr\Func instance - - // Example - $qb->expr()->some($qb2->getDql()) - public function some($subquery); // Returns Expr\Func instance - - // Example - $qb->expr()->any($qb2->getDql()) - public function any($subquery); // Returns Expr\Func instance - - // Example - $qb->expr()->not($qb->expr()->eq('u.id', '?1')) - public function not($restriction); // Returns Expr\Func instance - - // Example - $qb->expr()->in('u.id', array(1, 2, 3)) - // Make sure that you do NOT use something similar to $qb->expr()->in('value', array('stringvalue')) as this will cause Doctrine to throw an Exception. - // Instead, use $qb->expr()->in('value', array('?1')) and bind your parameter to ?1 (see section above) - public function in($x, $y); // Returns Expr\Func instance - - // Example - $qb->expr()->notIn('u.id', '2') - public function notIn($x, $y); // Returns Expr\Func instance - - // Example - $qb->expr()->like('u.firstname', $qb->expr()->literal('Gui%')) - public function like($x, $y); // Returns Expr\Comparison instance - - // Example - $qb->expr()->between('u.id', '1', '10') - public function between($val, $x, $y); // Returns Expr\Func - - - /** Function objects **/ - - // Example - $qb->expr()->trim('u.firstname') - public function trim($x); // Returns Expr\Func - - // Example - $qb->expr()->concat('u.firstname', $qb->expr()->concat(' ', 'u.lastname')) - public function concat($x, $y); // Returns Expr\Func - - // Example - $qb->expr()->substr('u.firstname', 0, 1) - public function substr($x, $from, $len); // Returns Expr\Func - - // Example - $qb->expr()->lower('u.firstname') - public function lower($x); // Returns Expr\Func - - // Example - $qb->expr()->upper('u.firstname') - public function upper($x); // Returns Expr\Func - - // Example - $qb->expr()->length('u.firstname') - public function length($x); // Returns Expr\Func - - // Example - $qb->expr()->avg('u.age') - public function avg($x); // Returns Expr\Func - - // Example - $qb->expr()->max('u.age') - public function max($x); // Returns Expr\Func - - // Example - $qb->expr()->min('u.age') - public function min($x); // Returns Expr\Func - - // Example - $qb->expr()->abs('u.currentBalance') - public function abs($x); // Returns Expr\Func - - // Example - $qb->expr()->sqrt('u.currentBalance') - public function sqrt($x); // Returns Expr\Func - - // Example - $qb->expr()->count('u.firstname') - public function count($x); // Returns Expr\Func - - // Example - $qb->expr()->countDistinct('u.surname') - public function countDistinct($x); // Returns Expr\Func - } - -#### Helper methods - -Until now we have described the lowest level (thought of as the hardcore method) of creating queries. It may be useful to work at this level for optimization purposes, but most of the time it is preferred to work at a higher level of abstraction. -To simplify even more the way you build a query in Doctrine, we can take advantage of what we call Helper methods. For all base code, there is a set of useful methods to simplify a programmer's life. -To illustrate how to work with them, here is the same example 6 re-written using `QueryBuilder` helper methods: - - select('u') - ->from('User', 'u') - ->where('u.id = ?1') - ->orderBy('u.name ASC'); - -`QueryBuilder` helper methods are considered the standard way to build DQL queries. Although it is supported, it should be avoided to use string based queries and greatly encouraged to use `$qb->expr()->*` methods. -Here is a converted example 8 to suggested standard way to build queries: - - select(array('u')) // string 'u' is converted to array internally - ->from('User', 'u') - ->where($qb->expr()->orx( - $qb->expr()->eq('u.id', '?1'), - $qb->expr()->like('u.nickname', '?2') - )) - ->orderBy('u.surname', 'ASC')); - -Here is a complete list of helper methods available in `QueryBuilder`: - - select('u') - // Example - $qb->select(array('u', 'p')) - // Example - $qb->select($qb->expr()->select('u', 'p')) - public function select($select = null); - - // Example - $qb->delete('User', 'u') - public function delete($delete = null, $alias = null); - - // Example - $qb->update('Group', 'g') - public function update($update = null, $alias = null); - - // Example - $qb->set('u.firstName', $qb->expr()->literal('Arnold')) - // Example - $qb->set('u.numChilds', 'u.numChilds + ?1') - // Example - $qb->set('u.numChilds', $qb->expr()->sum('u.numChilds', '?1')) - public function set($key, $value); - - // Example - $qb->from('Phonenumber', 'p') - public function from($from, $alias = null); - - // Example - $qb->innerJoin('u.Group', 'g', Expr\Join::ON, $qb->expr()->and($qb->expr()->eq('u.group_id', 'g.id'), 'g.name = ?1')) - // Example - $qb->innerJoin('u.Group', 'g', 'ON', 'u.group_id = g.id AND g.name = ?1') - public function innerJoin($join, $alias = null, $conditionType = null, $condition = null); - - // Example - $qb->leftJoin('u.Phonenumbers', 'p', Expr\Join::WITH, $qb->expr()->eq('p.area_code', 55)) - // Example - $qb->leftJoin('u.Phonenumbers', 'p', 'WITH', 'p.area_code = 55') - public function leftJoin($join, $alias = null, $conditionType = null, $condition = null); - - // NOTE: ->where() overrides all previously set conditions - // - // Example - $qb->where('u.firstName = ?1', $qb->expr()->eq('u.surname', '?2')) - // Example - $qb->where($qb->expr()->andx($qb->expr()->eq('u.firstName', '?1'), $qb->expr()->eq('u.surname', '?2'))) - // Example - $qb->where('u.firstName = ?1 AND u.surname = ?2') - public function where($where); - - // Example - $qb->andWhere($qb->expr()->orx($qb->expr()->lte('u.age', 40), 'u.numChild = 0')) - public function andWhere($where); - - // Example - $qb->orWhere($qb->expr()->between('u.id', 1, 10)); - public function orWhere($where); - - // NOTE: -> groupBy() overrides all previously set grouping conditions - // - // Example - $qb->groupBy('u.id') - public function groupBy($groupBy); - - // Example - $qb->addGroupBy('g.name') - public function addGroupBy($groupBy); - - // NOTE: -> having() overrides all previously set having conditions - // - // Example - $qb->having('u.salary >= ?1') - // Example - $qb->having($qb->expr()->gte('u.salary', '?1')) - public function having($having); - - // Example - $qb->andHaving($qb->expr()->gt($qb->expr()->count('u.numChild'), 0)) - public function andHaving($having); - - // Example - $qb->orHaving($qb->expr()->lte('g.managerLevel', '100')) - public function orHaving($having); - - // NOTE: -> orderBy() overrides all previously set ordering conditions - // - // Example - $qb->orderBy('u.surname', 'DESC') - public function orderBy($sort, $order = null); - - // Example - $qb->addOrderBy('u.firstName') - public function addOrderBy($sort, $order = null); // Default $order = 'ASC' - } diff --git a/manual/en/tools.rst b/manual/en/tools.rst index 79941ea1d..2274b38d1 100644 --- a/manual/en/tools.rst +++ b/manual/en/tools.rst @@ -1,5 +1,8 @@ -The Doctrine Console --------------------- +Tools +===== + +Doctrine Console +---------------- The Doctrine Console is a Command Line Interface tool for simplifying common tasks during the development of a project that @@ -170,7 +173,7 @@ The following Commands are currently available: Database Schema Generation -------------------------- - **Note** +.. note:: SchemaTool can do harm to your database. It will drop or alter tables, indexes, sequences and such. Please use this tool with @@ -274,7 +277,7 @@ will output the SQL for the ran operation. Before using the orm:schema-tool commands, remember to configure your cli-config.php properly. - **NOTE** +.. note:: When using the Annotation Mapping Driver you have to either setup your autoloader in the cli-config.php correctly to find all the @@ -364,7 +367,9 @@ You can also reverse engineer a database using the $ php doctrine orm:convert-mapping --from-database yml /path/to/mapping-path-converted-to-yml - **CAUTION** Reverse Engineering is not always working perfectly +.. warning:: + + Reverse Engineering is not always working perfectly depending on special cases. It will only detect Many-To-One relations (even if they are One-To-One) and will try to create entities from Many-To-Many tables. It also has problems with naming diff --git a/manual/en/tools.txt b/manual/en/tools.txt deleted file mode 100644 index 221ce89ce..000000000 --- a/manual/en/tools.txt +++ /dev/null @@ -1,254 +0,0 @@ -## The Doctrine Console - -The Doctrine Console is a Command Line Interface tool for simplifying common tasks during the development of a project that uses Doctrine 2. - -### Installation - -If you installed Doctrine 2 through PEAR, the `doctrine` command line tool should already be available to you. - -If you use Doctrine through SVN or a release package you need to copy the `doctrine` and `doctrine.php` files from the `tools/sandbox` or `bin` folder, respectively, to a location of your choice, for example a `tools` folder of your project. -You probably need to edit `doctrine.php` to adjust some paths to the new environment, most importantly the first line that includes the `Doctrine\Common\ClassLoader`. - -### Getting Help - -Type `doctrine` on the command line and you should see an overview of the available commands or use the --help flag to get information on the available commands. If you want to know more about the use of generate entities for example, you can call: - - doctrine orm:generate-entities --help - -### Configuration - -Whenever the `doctrine` command line tool is invoked, it can access alls Commands that were registered by developer. -There is no auto-detection mechanism at work. The `bin\doctrine.php` file already registers all the commands that -currently ship with Doctrine DBAL and ORM. If you want to use additional commands you have to register them yourself. - -All the commands of the Doctrine Console require either the `db` or the `em` helpers to be defined in order to work correctly. Doctrine Console requires the definition of a HelperSet that is the DI tool to be injected in the Console. -In case of a project that is dealing exclusively with DBAL, the ConnectionHelper is required: - - new \Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper($conn) - )); - $cli->setHelperSet($helperSet); - -When dealing with the ORM package, the EntityManagerHelper is required: - - new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($em) - )); - $cli->setHelperSet($helperSet); - -The HelperSet instance has to be generated in a separate file (i.e. `cli-config.php`) that contains typical Doctrine -bootstrap code and predefines the needed HelperSet attributes mentioned above. A typical `cli-config.php` file looks as follows: - - register(); - - $classLoader = new \Doctrine\Common\ClassLoader('Proxies', __DIR__); - $classLoader->register(); - - $config = new \Doctrine\ORM\Configuration(); - $config->setMetadataCacheImpl(new \Doctrine\Common\Cache\ArrayCache); - $config->setProxyDir(__DIR__ . '/Proxies'); - $config->setProxyNamespace('Proxies'); - - $connectionOptions = array( - 'driver' => 'pdo_sqlite', - 'path' => 'database.sqlite' - ); - - $em = \Doctrine\ORM\EntityManager::create($connectionOptions, $config); - - $helperSet = new \Symfony\Components\Console\Helper\HelperSet(array( - 'db' => new \Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper($em->getConnection()), - 'em' => new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($em) - )); - -It is important to define a correct HelperSet that doctrine.php script will ultimately use. The Doctrine Binary -will automatically find the first instance of HelperSet in the global variable namespace and use this. - -You can also add your own commands on-top of the Doctrine supported tools. -To include a new command on Doctrine Console, you need to do: - - addCommand(new \MyProject\Tools\Console\Commands\MyCustomCommand()); - -Additionally, include multiple commands (and overriding previously defined ones) is possible through the command: - - addCommands(array( - new \MyProject\Tools\Console\Commands\MyCustomCommand(), - new \MyProject\Tools\Console\Commands\SomethingCommand(), - new \MyProject\Tools\Console\Commands\AnotherCommand(), - new \MyProject\Tools\Console\Commands\OneMoreCommand(), - )); - -### Command Overview - -The following Commands are currently available: - - * `help` Displays help for a command (?) - * `list` Lists commands - * `dbal:import` Import SQL file(s) directly to Database. - * `dbal:run-sql` Executes arbitrary SQL directly from the command line. - * `orm:clear-cache:metadata` Clear all metadata cache of the various cache drivers. - * `orm:clear-cache:query` Clear all query cache of the various cache drivers. - * `orm:clear-cache:result` Clear result cache of the various cache drivers. - * `orm:convert-d1-schema` Converts Doctrine 1.X schema into a Doctrine 2.X schema. - * `orm:convert-mapping` Convert mapping information between supported formats. - * `orm:ensure-production-settings` Verify that Doctrine is properly configured for a production environment. - * `orm:generate-entities` Generate entity classes and method stubs from your mapping information. - * `orm:generate-proxies` Generates proxy classes for entity classes. - * `orm:generate-repositories` Generate repository classes from your mapping information. - * `orm:run-dql` Executes arbitrary DQL directly from the command line. - * `orm:schema-tool:create` Processes the schema and either create it directly on EntityManager Storage Connection or generate the SQL output. - * `orm:schema-tool:drop` Processes the schema and either drop the database schema of EntityManager Storage Connection or generate the SQL output. - * `orm:schema-tool:update` Processes the schema and either update the database schema of EntityManager Storage Connection or generate the SQL output. - -## Database Schema Generation - -> **Note** -> -> SchemaTool can do harm to your database. It will drop or alter tables, indexes, sequences and such. Please use -> this tool with caution in development and not on a production server. It is meant for helping you develop your -> Database Schema, but NOT with migrating schema from A to B in production. A safe approach would be generating -> the SQL on development server and saving it into SQL Migration files that are executed manually on the production -> server. -> -> SchemaTool assumes your Doctrine Project uses the given database on its own. Update and Drop commands will -> mess with other tables if they are not related to the current project that is using Doctrine. Please be careful! - -To generate your database schema from your Doctrine mapping files you can use the -`SchemaTool` class or the `schema-tool` Console Command. - -When using the SchemaTool class directly, create your schema using the `createSchema()` method. First create an instance of the `SchemaTool` and pass it an instance of the `EntityManager` that you want to use to create the schema. This method receives an array of `ClassMetadataInfo` instances. - - getClassMetadata('Entities\User'), - $em->getClassMetadata('Entities\Profile') - ); - $tool->createSchema($classes); - -To drop the schema you can use the `dropSchema()` method. - - dropSchema($classes); - -This drops all the tables that are currently used by your metadata model. -When you are changing your metadata a lot during development you might want -to drop the complete database instead of only the tables of the current model -to clean up with orphaned tables. - - dropSchema($classes, \Doctrine\ORM\Tools\SchemaTool::DROP_DATABASE); - -You can also use database introspection to update your schema easily with the -`updateSchema()` method. It will compare your existing database schema to the -passed array of `ClassMetdataInfo` instances. - - updateSchema($classes); - -If you want to use this functionality from the command line you can use the -`schema-tool` command. - -To create the schema use the `create` command: - - $ php doctrine orm:schema-tool:create - -To drop the schema use the `drop` command: - - $ php doctrine orm:schema-tool:drop - -If you want to drop and then recreate the schema then use both options: - - $ php doctrine orm:schema-tool:drop - $ php doctrine orm:schema-tool:create - -As you would think, if you want to update your schema use the `update` command: - - $ php doctrine orm:schema-tool:update - -All of the above commands also accept a `--dump-sql` option that will output the SQL -for the ran operation. - - $ php doctrine orm:schema-tool:create --dump-sql - -Before using the orm:schema-tool commands, remember to configure your cli-config.php properly. - -> **NOTE** -> -> When using the Annotation Mapping Driver you have to either setup your autoloader in the cli-config.php -> correctly to find all the entities, or you can use the second argument of the `EntityManagerHelper` to -> specify all the paths of your entities (or mapping files), i.e. -> `new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($em, $mappingPaths);` - -## Convert Mapping Information - -To convert some mapping information between the various supported formats you can -use the `ClassMetadataExporter` to get exporter instances for the different formats: - - getExporter('yml', '/path/to/export/yml'); - -Now you can export some `ClassMetadata` instances: - - getClassMetadata('Entities\User'), - $em->getClassMetadata('Entities\Profile') - ); - $exporter->setMetadata($classes); - $exporter->export(); - -This functionality is also available from the command line to convert your -loaded mapping information to another format. The `orm:convert-mapping` command -accepts two arguments, the type to convert to and the path to generate it: - - $ php doctrine orm:convert-mapping xml /path/to/mapping-path-converted-to-xml - -## Reverse Engineering - -You can use the `DatabaseDriver` to reverse engineer a database to an array of -`ClassMetadataInfo` instances and generate YAML, XML, etc. from them. - -First you need to retrieve the metadata instances with the `DatabaseDriver`: - - getConfiguration()->setMetadataDriverImpl( - new \Doctrine\ORM\Mapping\Driver\DatabaseDriver( - $em->getConnection()->getSchemaManager() - ) - ); - - $cmf = new DisconnectedClassMetadataFactory($em); - $metadata = $cmf->getAllMetadata(); - -Now you can get an exporter instance and export the loaded metadata to yml: - - getExporter('yml', '/path/to/export/yml'); - $exporter->setMetadata($metadata); - $exporter->export(); - -You can also reverse engineer a database using the `orm:convert-mapping` command: - - $ php doctrine orm:convert-mapping --from-database yml /path/to/mapping-path-converted-to-yml - -> **CAUTION** -> Reverse Engineering is not always working perfectly depending on special cases. -> It will only detect Many-To-One relations (even if they are One-To-One) and -> will try to create entities from Many-To-Many tables. It also has problems -> with naming of foreign keys that have multiple column names. Any Reverse Engineered -> Database-Schema needs considerable manual work to become a useful domain model. \ No newline at end of file diff --git a/manual/en/transactions-and-concurrency.rst b/manual/en/transactions-and-concurrency.rst index 19692f1ac..717783340 100644 --- a/manual/en/transactions-and-concurrency.rst +++ b/manual/en/transactions-and-concurrency.rst @@ -1,3 +1,6 @@ +Transactions and Concurrency +============================ + Transaction Demarcation ----------------------- diff --git a/manual/en/transactions-and-concurrency.txt b/manual/en/transactions-and-concurrency.txt deleted file mode 100644 index 550f8e52e..000000000 --- a/manual/en/transactions-and-concurrency.txt +++ /dev/null @@ -1,249 +0,0 @@ -## Transaction Demarcation - -Transaction demarcation is the task of defining your transaction boundaries. Proper transaction demarcation is very -important because if not done properly it can negatively affect the performance of your application. -Many databases and database abstraction layers like PDO by default operate in auto-commit mode, -which means that every single SQL statement is wrapped in a small transaction. Without any explicit -transaction demarcation from your side, this quickly results in poor performance because transactions are not cheap. - -For the most part, Doctrine 2 already takes care of proper transaction demarcation for you: All the write -operations (INSERT/UPDATE/DELETE) are queued until `EntityManager#flush()` is invoked which wraps all -of these changes in a single transaction. - -However, Doctrine 2 also allows (and encourages) you to take over and control transaction demarcation yourself. - -These are two ways to deal with transactions when using the Doctrine ORM and are now described in more detail. - -### Approach 1: Implicitly - -The first approach is to use the implicit transaction handling provided by the Doctrine ORM -EntityManager. Given the following code snippet, without any explicit transaction demarcation: - - setName('George'); - $em->persist($user); - $em->flush(); - -Since we do not do any custom transaction demarcation in the above code, `EntityManager#flush()` will begin -and commit/rollback a transaction. This behavior is made possible by the aggregation of the DML operations -by the Doctrine ORM and is sufficient if all the data manipulation that is part of a unit of work happens -through the domain model and thus the ORM. - - -### Approach 2: Explicitly - -The explicit alternative is to use the `Doctrine\DBAL\Connection` API -directly to control the transaction boundaries. The code then looks like this: - - getConnection()->beginTransaction(); // suspend auto-commit - try { - //... do some work - $user = new User; - $user->setName('George'); - $em->persist($user); - $em->flush(); - $em->getConnection()->commit(); - } catch (Exception $e) { - $em->getConnection()->rollback(); - $em->close(); - throw $e; - } - -Explicit transaction demarcation is required when you want to include custom DBAL operations in a unit of work -or when you want to make use of some methods of the `EntityManager` API that require an active transaction. -Such methods will throw a `TransactionRequiredException` to inform you of that requirement. - -A more convenient alternative for explicit transaction demarcation is the use of provided control -abstractions in the form of `Connection#transactional($func)` and `EntityManager#transactional($func)`. -When used, these control abstractions ensure that you never forget to rollback the transaction or -close the `EntityManager`, apart from the obvious code reduction. An example that is functionally -equivalent to the previously shown code looks as follows: - - transactional(function($em) { - //... do some work - $user = new User; - $user->setName('George'); - $em->persist($user); - }); - -The difference between `Connection#transactional($func)` and `EntityManager#transactional($func)` is -that the latter abstraction flushes the `EntityManager` prior to transaction commit and also closes -the `EntityManager` properly when an exception occurs (in addition to rolling back the transaction). - - -### Exception Handling - -When using implicit transaction demarcation and an exception occurs during `EntityManager#flush()`, the transaction -is automatically rolled back and the `EntityManager` closed. - -When using explicit transaction demarcation and an exception occurs, the transaction should be rolled back immediately -and the `EntityManager` closed by invoking `EntityManager#close()` and subsequently discarded, as demonstrated in -the example above. This can be handled elegantly by the control abstractions shown earlier. -Note that when catching `Exception` you should generally re-throw the exception. If you intend to -recover from some exceptions, catch them explicitly in earlier catch blocks (but do not forget to rollback the -transaction and close the `EntityManager` there as well). All other best practices of exception handling apply -similarly (i.e. either log or re-throw, not both, etc.). - -As a result of this procedure, all previously managed or removed instances of the `EntityManager` become detached. -The state of the detached objects will be the state at the point at which the transaction was rolled back. -The state of the objects is in no way rolled back and thus the objects are now out of synch with the database. -The application can continue to use the detached objects, knowing that their state is potentially no longer -accurate. - -If you intend to start another unit of work after an exception has occurred you should do that with a new `EntityManager`. - -## Locking Support - -Doctrine 2 offers support for Pessimistic- and Optimistic-locking strategies natively. This allows to take -very fine-grained control over what kind of locking is required for your Entities in your application. - -### Optimistic Locking - -Database transactions are fine for concurrency control during a single request. However, a database transaction -should not span across requests, the so-called "user think time". Therefore a long-running "business transaction" -that spans multiple requests needs to involve several database transactions. Thus, database transactions alone -can no longer control concurrency during such a long-running business transaction. Concurrency control becomes -the partial responsibility of the application itself. - -Doctrine has integrated support for automatic optimistic locking via a version field. In this approach any entity -that should be protected against concurrent modifications during long-running business transactions gets a version -field that is either a simple number (mapping type: integer) or a timestamp (mapping type: datetime). When changes -to such an entity are persisted at the end of a long-running conversation the version of the entity is compared to -the version in the database and if they don't match, an `OptimisticLockException` is thrown, indicating that the -entity has been modified by someone else already. - -You designate a version field in an entity as follows. In this example we'll use an integer. - - find('User', $theEntityId, LockMode::OPTIMISTIC, $expectedVersion); - - // do the work - - $em->flush(); - } catch(OptimisticLockException $e) { - echo "Sorry, but someone else has already changed this entity. Please apply the changes again!"; - } - -Or you can use `EntityManager#lock()` to find out: - - find('User', $theEntityId); - - try { - // assert version - $em->lock($entity, LockMode::OPTIMISTIC, $expectedVersion); - - } catch(OptimisticLockException $e) { - echo "Sorry, but someone else has already changed this entity. Please apply the changes again!"; - } - -#### Important Implementation Notes - -You can easily get the optimistic locking workflow wrong if you compare the wrong versions. -Say you have Alice and Bob accessing a hypothetical bank account: - -* Alice reads the headline of the blog post being "Foo", at optimistic lock version 1 (GET Request) -* Bob reads the headline of the blog post being "Foo", at optimistic lock version 1 (GET Request) -* Bob updates the headline to "Bar", upgrading the optimistic lock version to 2 (POST Request of a Form) -* Alice updates the headline to "Baz", ... (POST Request of a Form) - -Now at the last stage of this scenario the blog post has to be read again from the database before -Alice's headline can be applied. At this point you will want to check if the blog post is still at version 1 -(which it is not in this scenario). - -Using optimistic locking correctly, you *have* to add the version as an additional hidden field -(or into the SESSION for more safety). Otherwise you cannot verify the version is still the one being originally read from -the database when Alice performed her GET request for the blog post. If this happens you might -see lost updates you wanted to prevent with Optimistic Locking. - -See the example code, The form (GET Request): - - find('BlogPost', 123456); - - echo ''; - echo ''; - -And the change headline action (POST Request): - - find('BlogPost', $postId, \Doctrine\DBAL\LockMode::OPTIMISTIC, $postVersion); - -### Pessimistic Locking - -Doctrine 2 supports Pessimistic Locking at the database level. No attempt is being made to implement pessimistic locking -inside Doctrine, rather vendor-specific and ANSI-SQL commands are used to acquire row-level locks. Every Entity can -be part of a pessimistic lock, there is no special metadata required to use this feature. - -However for Pessimistic Locking to work you have to disable the Auto-Commit Mode of your Database and start a -transaction around your pessimistic lock use-case using the "Approach 2: Explicit Transaction Demarcation" described -above. Doctrine 2 will throw an Exception if you attempt to acquire an pessimistic lock and no transaction is running. - -Doctrine 2 currently supports two pessimistic lock modes: - -* Pessimistic Write (`Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE`), locks the underlying database rows for concurrent Read and Write Operations. -* Pessimistic Read (`Doctrine\DBAL\LockMode::PESSIMISTIC_READ`), locks other concurrent requests that attempt to update or lock rows in write mode. - -You can use pessimistic locks in three different scenarios: - -1. Using `EntityManager#find($className, $id, \Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE)` or `EntityManager#find($className, $id, \Doctrine\DBAL\LockMode::PESSIMISTIC_READ)` -2. Using `EntityManager#lock($entity, \Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE)` or `EntityManager#lock($entity, \Doctrine\DBAL\LockMode::PESSIMISTIC_READ)` -3. Using `Query#setLockMode(\Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE)` or `Query#setLockMode(\Doctrine\DBAL\LockMode::PESSIMISTIC_READ)` - diff --git a/manual/en/working-with-associations.rst b/manual/en/working-with-associations.rst index 12d2f10a6..784b0d836 100644 --- a/manual/en/working-with-associations.rst +++ b/manual/en/working-with-associations.rst @@ -1,3 +1,6 @@ +Working with Associations +========================= + Associations between entities are represented just like in regular object-oriented PHP, with references to other objects or collections of objects. When it comes to persistence, it is @@ -101,9 +104,8 @@ information about its type and if its the owning or inverse side. This two entities generate the following MySQL Schema (Foreign Key definitions omitted): -:: +.. code-block:: sql - [sql] CREATE TABLE User ( id VARCHAR(255) NOT NULL, firstComment_id VARCHAR(255) DEFAULT NULL, @@ -262,7 +264,7 @@ essentially an ordered map (just like a PHP array). That is why the separate method that has O(n) complexity using ``array_search``, where n is the size of the map. - **NOTE** +.. note:: Since Doctrine always only looks at the owning side of a bidirectional association for updates, it is not necessary for @@ -350,7 +352,7 @@ is needed. As you can see, proper bidirectional association management in plain OOP is a non-trivial task and encapsulating all the details inside the classes can be challenging. - **NOTE** +.. note:: If you want to make sure that your collections are perfectly encapsulated you should not return them from a diff --git a/manual/en/working-with-associations.txt b/manual/en/working-with-associations.txt deleted file mode 100644 index 8da311188..000000000 --- a/manual/en/working-with-associations.txt +++ /dev/null @@ -1,417 +0,0 @@ -Associations between entities are represented just like in regular object-oriented PHP, with references to other objects -or collections of objects. When it comes to persistence, it is important to understand three main things: - - * The concept of owning and inverse sides in bidirectional associations as described [here](http://www.doctrine-project.org/documentation/manual/2_0/en/association-mapping#owning-side-and-inverse-side). - * If an entity is removed from a collection, the association is removed, not the entity itself. A collection of entities always only represents the association to the containing entities, not the entity itself. - * Collection-valued persistent fields have to be instances of the `Doctrine\Common\Collections\Collection` interface. [See here](http://www.doctrine-project.org/documentation/manual/2_0/en/architecture#entities:persistent-fields) for more details. - -Changes to associations in your code are not synchronized to the database directly, but upon calling `EntityManager#flush()`. - -To describe all the concepts of working with associations we introduce a specific set of example entities that show -all the different flavors of association management in Doctrine. - -## Association Example Entities - -We will use a simple comment system with Users and Comments as entities to show examples of association management. -See the PHP docblocks of each association in the following example for information about its type and if its the owning or inverse side. - - commentsRead; - } - - public function setFirstComment(Comment $c) { - $this->firstComment = $c; - } - } - -The interaction code would then look like in the following snippet (`$em` here is an instance of the EntityManager): - - find('User', $userId); - - // unidirectional many to many - $comment = $em->find('Comment', $readCommentId); - $user->getReadComments()->add($comment); - - $em->flush(); - - // unidirectional many to one - $myFirstComment = new Comment(); - $user->setFirstComment($myFirstComment); - - $em->persist($myFirstComment); - $em->flush(); - -In the case of bi-directional associations you have to update the fields on both sides: - - commentsAuthored; - } - - public function getFavoriteComments() { - return $this->favorites; - } - } - - class Comment - { - // ... - - public function getUserFavorites() { - return $this->userFavorites; - } - - public function setAuthor(User $author = null) { - $this->author = $author; - } - } - - // Many-to-Many - $user->getFavorites()->add($favoriteComment); - $favoriteComment->getUserFavorites()->add($user); - - $em->flush(); - - // Many-To-One / One-To-Many Bidirectional - $newComment = new Comment(); - $user->getAuthoredComments()->add($newComment); - $newComment->setAuthor($user); - - $em->persist($newComment); - $em->flush(); - - -Notice how always both sides of the bidirectional association are updated. The previous unidirectional associations were simpler to handle. - -## Removing Associations - -Removing an association between two entities is similarly straight-forward. There are two strategies -to do so, by key and by element. Here are some examples: - - getComments()->removeElement($comment); - $comment->setAuthor(null); - - $user->getFavorites()->removeElement($comment); - $comment->getUserFavorites()->removeElement($user); - - // Remove by Key - $user->getComments()->removeElement($ithComment); - $comment->setAuthor(null); - -You need to call `$em->flush()` to make persist these changes in the database permanently. - -Notice how both sides of the bidirectional association are always updated. Unidirectional associations are consequently -simpler to handle. Also note that if you type-hint your methods, i.e. `setAddress(Address $address)`, then PHP does only -allows null values if `null` is set as default value. Otherwise setAddress(null) will fail for removing the association. -If you insist on type-hinting a typical way to deal with this is to provide a special method, like `removeAddress()`. -This can also provide better encapsulation as it hides the internal meaning of not having an address. - -When working with collections, keep in mind that a Collection is essentially an ordered map (just like a PHP array). -That is why the `remove` operation accepts an index/key. `removeElement` is a separate method -that has O(n) complexity using `array_search`, where n is the size of the map. - -> **NOTE** -> -> Since Doctrine always only looks at the owning side of a bidirectional association for updates, it is not necessary -> for write operations that an inverse collection of a bidirectional one-to-many or many-to-many association is updated. -> This knowledge can often be used to improve performance by avoiding the loading of the inverse collection. - -You can also clear the contents of a whole collection using the `Collections::clear()` method. You -should be aware that using this method can lead to a straight and optimized database delete or update call -during the flush operation that is not aware of entities that have been re-added to the collection. - -Say you clear a collection of tags by calling `$post->getTags()->clear();` and then call -`$post->getTags()->add($tag)`. This will not recognize tag being already added before and issue -two database calls. - -## Association Management Methods - -It is generally a good idea to encapsulate proper association management inside the entity classes. This makes it easier to use the class correctly and can encapsulate details about how the association is maintained. - -The following code shows updates to the previous User and Comment example that encapsulate much of -the association management code: - - commentsRead[] = $comment; - } - - public function addComment(Comment $comment) { - if (count($this->commentsAuthored) == 0) { - $this->setFirstComment($comment); - } - $this->comments[] = $comment; - $comment->setAuthor($this); - } - - private function setFirstComment(Comment $c) { - $this->firstComment = $c; - } - - public function addFavorite(Comment $comment) { - $this->favorites->add($comment); - $comment->addUserFavorite($this); - } - - public function removeFavorite(Comment $comment) { - $this->favorites->removeElement($comment); - $comment->removeUserFavorite($this); - } - } - - class Comment - { - // .. - - public function addUserFavorite(User $user) { - $this->userFavorites[] = $user; - } - - public function removeUserFavorite(User $user) { - $this->userFavorites->removeElement($user); - } - } - -You will notice that `addUserFavorite` and `removeUserFavorite` do not call `addFavorite` and `removeFavorite`, -thus the bidirectional association is strictly-speaking still incomplete. However if you would naively add the -`addFavorite` in `addUserFavorite`, you end up with an infinite loop, so more work is needed. -As you can see, proper bidirectional association management in plain OOP is a non-trivial task -and encapsulating all the details inside the classes can be challenging. - -> **NOTE** -> -> If you want to make sure that your collections are perfectly encapsulated you should not return -> them from a `getCollectionName()` method directly, but call `$collection->toArray()`. This way a client programmer -> for the entity cannot circumvent the logic you implement on your entity for association management. For example: - - commentsRead->toArray(); - } - } - -This will however always initialize the collection, with all the performance penalties given the size. In -some scenarios of large collections it might even be a good idea to completely hide the read access behind -methods on the EntityRepository. - -There is no single, best way for association management. It greatly depends on the requirements of your concrete -domain model as well as your preferences. - -## Synchronizing Bidirectional Collections - -In the case of Many-To-Many associations you as the developer are responsible to keep the collections on the -owning and inverse side up in sync, when you apply changes to them. Doctrine can only guarantee a consistent -state for the hydration, not for your client code. - -Using the User-Comment entities from above, a very simple example can show the possible caveats you can encounter: - - getFavorites()->add($favoriteComment); - // not calling $favoriteComment->getUserFavorites()->add($user); - - $user->getFavorites()->contains($favoriteComment); // TRUE - $favoriteComment->getUserFavorites()->contains($user); // FALSE - -There are to approaches to handle this problem in your code: - -1. Ignore updating the inverse side of bidirectional collections, BUT never read from them in requests that changed - their state. In the next Request Doctrine hydrates the consistent collection state again. -2. Always keep the bidirectional collections in sync through association management methods. Reads of - the Collections directly after changes are consistent then. - -## Transitive persistence / Cascade Operations - -Persisting, removing, detaching and merging individual entities can become pretty -cumbersome, especially when a larger object graph with collections is involved. -Therefore Doctrine 2 provides a mechanism for transitive persistence through -cascading of these operations. Each association to another entity or a collection -of entities can be configured to automatically cascade certain operations. By -default, no operations are cascaded. - -The following cascade options exist: - - * persist : Cascades persist operations to the associated entities. - * remove : Cascades remove operations to the associated entities. - * merge : Cascades merge operations to the associated entities. - * detach : Cascades detach operations to the associated entities. - * all : Cascades persist, remove, merge and detach operations to associated entities. - -The following example is an extension to the User-Comment example of this chapter. -Suppose in our application a user is created whenever he writes his first comment. -In this case we would use the following code: - - addComment($myFirstComment); - - $em->persist($user); - $em->persist($myFirstComment); - $em->flush(); - -Even if you *persist* a new User that contains our new Comment this code would fail -if you removed the call to `EntityManager#persist($myFirstComment)`. Doctrine 2 does -not cascade the persist operation to all nested entities that are new as well. - -More complicated is the deletion of all a users comments when he is removed from the system: - - $user = $em->find('User', $deleteUserId); - - foreach ($user->getAuthoredComments() AS $comment) { - $em->remove($comment); - } - $em->remove($user); - $em->flush(); - -Without the loop over all the authored comments Doctrine would use an UPDATE statement only -to set the foreign key to NULL and only the User would be deleted from the database -during the flush()-Operation. - -To have Doctrine handle both cases automatically we can change the `User#commentsAuthored` -property to cascade both the "persist" and the "remove" operation. - - persist($user); $em->flush(); - **CAUTION** Generated entity identifiers / primary keys are +.. warning:: + + Generated entity identifiers / primary keys are guaranteed to be available after the next successful flush operation that involves the entity in question. You can not rely on a generated identifier to be available directly after invoking @@ -244,7 +251,9 @@ the ``EntityManager#remove($entity)`` method. By applying the which means that its persistent state will be deleted once ``EntityManager#flush()`` is invoked. - **CAUTION** Just like ``persist``, invoking ``remove`` on an entity +.. warning:: + + Just like ``persist``, invoking ``remove`` on an entity does NOT cause an immediate SQL DELETE to be issued on the database. The entity will be deleted on the next invocation of ``EntityManager#flush()`` that involves that entity. @@ -423,7 +432,9 @@ the ``merge`` operation is to reattach entities to an EntityManager that come from some cache (and are therefore detached) and you want to modify and persist such an entity. - **NOTE** If you load some detached entities from a cache and you do +.. note:: + + If you load some detached entities from a cache and you do not need to persist or delete them or otherwise make use of them without the need for persistence services there is no need to use ``merge``. I.e. you can simply pass detached objects from a cache @@ -516,7 +527,9 @@ to change tracking (see "Change Tracking Policies") and, of course, memory consumption, so you may want to check it from time to time during development. - **CAUTION** Do not invoke ``flush`` after every change to an entity +.. warning:: + + Do not invoke ``flush`` after every change to an entity or every single invocation of persist/remove/merge/... This is an anti-pattern and unnecessarily reduces the performance of your application. Instead, form units of work that operate on your diff --git a/manual/en/working-with-objects.txt b/manual/en/working-with-objects.txt deleted file mode 100644 index ad0a943ec..000000000 --- a/manual/en/working-with-objects.txt +++ /dev/null @@ -1,549 +0,0 @@ - -In this chapter we will help you understand the `EntityManager` and the `UnitOfWork`. -A Unit of Work is similar to an object-level transaction. A new Unit of Work is -implicitly started when an EntityManager is initially created or after -`EntityManager#flush()` has been invoked. A Unit of Work is committed -(and a new one started) by invoking `EntityManager#flush()`. - -A Unit of Work can be manually closed by calling EntityManager#close(). Any -changes to objects within this Unit of Work that have not yet been persisted -are lost. - -> **NOTE** -> -> It is very important to understand that only `EntityManager#flush()` ever causes -> write operations against the database to be executed. Any other methods such -> as `EntityManager#persist($entity)` or `EntityManager#remove($entity)` only -> notify the UnitOfWork to perform these operations during flush. -> -> Not calling `EntityManager#flush()` will lead to all changes during that request being lost. - -## Entities and the Identity Map - -Entities are objects with identity. Their identity has a conceptual meaning inside your domain. -In a CMS application each article has a unique id. You can uniquely identify each article -by that id. - -Take the following example, where you find an article with the headline "Hello World" -with the ID 1234: - - find('CMS\Article', 1234); - $article->setHeadline('Hello World dude!'); - - $article2 = $entityManager->find('CMS\Article', 1234); - echo $article2->getHeadline(); - -In this case the Article is accessed from the entity manager twice, but modified in between. -Doctrine 2 realizes this and will only ever give you access to one instance of the Article -with ID 1234, no matter how often do you retrieve it from the EntityManager and even no -matter what kind of Query method you are using (find, Repository Finder or DQL). -This is called "Identity Map" pattern, which means Doctrine keeps a map of each entity -and ids that have been retrieved per PHP request and keeps returning you the same instances. - -In the previous example the echo prints "Hello World dude!" to the screen. You can -even verify that `$article` and `$article2` are indeed pointing to the same instance -by running the following code: - - comments = new ArrayCollection(); - } - - public function getAuthor() { return $this->author; } - public function getComments() { return $this->comments; } - } - - $article = $em->find('Article', 1); - -This code only retrieves the `User` instance with id 1 executing a single SELECT statement -against the user table in the database. You can still access the associated properties author -and comments and the associated objects they contain. - -This works by utilizing the lazy loading pattern. Instead of passing you back a real -Author instance and a collection of comments Doctrine will create proxy instances for you. -Only if you access these proxies for the first time they will go through the EntityManager -and load their state from the database. - -This lazy-loading process happens behind the scenes, hidden from your code. See the following code: - - find('Article', 1); - - // accessing a method of the user instance triggers the lazy-load - echo "Author: " . $article->getAuthor()->getName() . "\n"; - - // Lazy Loading Proxies pass instanceof tests: - if ($article->getAuthor() instanceof User) { - // a User Proxy is a generated "UserProxy" class - } - - // accessing the comments as an iterator triggers the lazy-load - // retrieving ALL the comments of this article from the database - // using a single SELECT statement - foreach ($article->getComments() AS $comment) { - echo $comment->getText() . "\n\n"; - } - - // Article::$comments passes instanceof tests for the Collection interface - // But it will NOT pass for the ArrayCollection interface - if ($article->getComments() instanceof \Doctrine\Common\Collections\Collection) { - echo "This will always be true!"; - } - -A slice of the generated proxy classes code looks like the following piece of code. A real proxy -class override ALL public methods along the lines of the `getName()` method shown below: - - _load(); - return parent::getName(); - } - // .. other public methods of User - } - -> **Warning** -> -> Traversing the object graph for parts that are lazy-loaded will easily trigger lots -> of SQL queries and will perform badly if used to heavily. Make sure to use DQL -> to fetch-join all the parts of the object-graph that you need as efficiently as possible. - -## Persisting entities - -An entity can be made persistent by passing it to the `EntityManager#persist($entity)` -method. By applying the persist operation on some entity, that entity becomes MANAGED, -which means that its persistence is from now on managed by an EntityManager. As a -result the persistent state of such an entity will subsequently be properly -synchronized with the database when `EntityManager#flush()` is invoked. - -> **CAUTION** -> Invoking the `persist` method on an entity does NOT cause an immediate SQL INSERT to be -> issued on the database. Doctrine applies a strategy called "transactional write-behind", -> which means that it will delay most SQL commands until `EntityManager#flush()` is -> invoked which will then issue all necessary SQL statements to synchronize your objects -> with the database in the most efficient way and a single, short transaction, -> taking care of maintaining referential integrity. - -Example: - - setName('Mr.Right'); - $em->persist($user); - $em->flush(); - -> **CAUTION** -> Generated entity identifiers / primary keys are guaranteed to be available after the -> next successful flush operation that involves the entity in question. -> You can not rely on a generated identifier to be available directly after invoking `persist`. -> The inverse is also true. You can not rely on a generated identifier being not available -> after a failed flush operation. - -The semantics of the persist operation, applied on an entity X, are as follows: - -* If X is a new entity, it becomes managed. The entity X will be entered into the database as a result of the flush operation. -* If X is a preexisting managed entity, it is ignored by the persist operation. However, the persist operation is cascaded to entities referenced by X, if the relationships from X to these other entities are mapped with cascade=PERSIST or cascade=ALL (see "Transitive Persistence"). -* If X is a removed entity, it becomes managed. -* If X is a detached entity, an exception will be thrown on flush. - - -## Removing entities - -An entity can be removed from persistent storage by passing it to the `EntityManager#remove($entity)` method. By applying the `remove` operation on some entity, that entity becomes REMOVED, which means that its persistent state will be deleted once `EntityManager#flush()` is invoked. - -> **CAUTION** -> Just like `persist`, invoking `remove` on an entity does NOT cause an immediate SQL -> DELETE to be issued on the database. The entity will be deleted on the next invocation -> of `EntityManager#flush()` that involves that entity. - -Example: - - remove($user); - $em->flush(); - -The semantics of the remove operation, applied to an entity X are as follows: - -* If X is a new entity, it is ignored by the remove operation. However, the remove operation is cascaded to entities referenced by X, if the relationship from X to these other entities is mapped with cascade=REMOVE or cascade=ALL (see "Transitive Persistence"). -* If X is a managed entity, the remove operation causes it to become removed. The remove operation is cascaded to entities referenced by X, if the relationships from X to these other entities is mapped with cascade=REMOVE or cascade=ALL (see "Transitive Persistence"). -* If X is a detached entity, an InvalidArgumentException will be thrown. -* If X is a removed entity, it is ignored by the remove operation. -* A removed entity X will be removed from the database as a result of the flush operation. - -After an entity has been removed its in-memory state is the same as before the removal, except for generated identifiers. - -Removing an entity will also automatically delete any existing records in many-to-many -join tables that link this entity. The action taken depends on the value of the `@joinColumn` -mapping attribute "onDelete". Either Doctrine issues a dedicated `DELETE` statement -for records of each join table or it depends on the foreign key semantics of -onDelete="CASCADE". - -Deleting an object with all its associated objects can be achieved in multiple -ways with very different performance impacts. - -1. If an association is marked as `CASCADE=REMOVE` Doctrine 2 will fetch this - association. If its a Single association it will pass this entity to - ´EntityManager#remove()`. If the association is a collection, Doctrine will loop over all - its elements and pass them to `EntityManager#remove()`. In both cases the - cascade remove semantics are applied recursively. For large object graphs - this removal strategy can be very costly. -2. Using a DQL `DELETE` statement allows you to delete multiple entities of a - type with a single command and without hydrating these entities. This - can be very efficient to delete large object graphs from the database. -3. Using foreign key semantics `onDelete="CASCADE"` can force the database - to remove all associated objects internally. This strategy is a bit - tricky to get right but can be very powerful and fast. You should be aware - however that using strategy 1 (`CASCADE=REMOVE`) completely by-passes - any foreign key `onDelete=CASCADE` option, because Doctrine will fetch and remove - all associated entities explicitly nevertheless. - -## Detaching entities - -An entity is detached from an EntityManager and thus no longer managed by -invoking the `EntityManager#detach($entity)` method on it or by cascading -the detach operation to it. Changes made to the detached entity, if any -(including removal of the entity), will not be synchronized to the database -after the entity has been detached. - -Doctrine will not hold on to any references to a detached entity. - -Example: - - detach($entity); - -The semantics of the detach operation, applied to an entity X are as follows: - -* If X is a managed entity, the detach operation causes it to become detached. The detach operation is cascaded to entities referenced by X, if the relationships from X to these other entities is mapped with cascade=DETACH or cascade=ALL (see "Transitive Persistence"). Entities which previously referenced X will continue to reference X. -* If X is a new or detached entity, it is ignored by the detach operation. -* If X is a removed entity, the detach operation is cascaded to entities referenced by X, if the relationships from X to these other entities is mapped with cascade=DETACH or cascade=ALL (see "Transitive Persistence"). Entities which previously referenced X will continue to reference X. - -There are several situations in which an entity is detached automatically without invoking the `detach` method: - -* When `EntityManager#clear()` is invoked, all entities that are currently managed by the EntityManager instance become detached. -* When serializing an entity. The entity retrieved upon subsequent unserialization will be detached (This is the case for all entities that are serialized and stored in some cache, i.e. when using the Query Result Cache). - -The `detach` operation is usually not as frequently needed and used as `persist` and `remove`. - - -## Merging entities - -Merging entities refers to the merging of (usually detached) entities into the -context of an EntityManager so that they become managed again. To merge the -state of an entity into an EntityManager use the `EntityManager#merge($entity)` -method. The state of the passed entity will be merged into a managed copy of -this entity and this copy will subsequently be returned. - -Example: - - merge($detachedEntity); - // $entity now refers to the fully managed copy returned by the merge operation. - // The EntityManager $em now manages the persistence of $entity as usual. - -> **CAUTION** -> When you want to serialize/unserialize entities you have to make all entity properties -> protected, never private. The reason for this is, if you serialize a class that was a proxy -> instance before, the private variables won't be serialized and a PHP Notice is thrown. - -The semantics of the merge operation, applied to an entity X, are as follows: - -* If X is a detached entity, the state of X is copied onto a pre-existing managed entity instance X' of the same identity. -* If X is a new entity instance, a new managed copy X' will be created and the state of X is copied onto this managed instance. -* If X is a removed entity instance, an InvalidArgumentException will be thrown. -* If X is a managed entity, it is ignored by the merge operation, however, the merge operation is cascaded to entities referenced by relationships from X if these relationships have been mapped with the cascade element value MERGE or ALL (see "Transitive Persistence"). -* For all entities Y referenced by relationships from X having the cascade element value -MERGE or ALL, Y is merged recursively as Y'. For all such Y referenced by X, X' is set to reference Y'. (Note that if X is managed then X is the same object as X'.) -* If X is an entity merged to X', with a reference to another entity Y, where cascade=MERGE or cascade=ALL is not specified, then navigation of the same association from X' yields a reference to a managed object Y' with the same persistent identity as Y. - -The `merge` operation will throw an `OptimisticLockException` if the entity -being merged uses optimistic locking through a version field and the versions -of the entity being merged and the managed copy don't match. This usually means -that the entity has been modified while being detached. - -The `merge` operation is usually not as frequently needed and used as `persist` -and `remove`. The most common scenario for the `merge` operation is to reattach -entities to an EntityManager that come from some cache (and are therefore detached) -and you want to modify and persist such an entity. - -> **NOTE** -> If you load some detached entities from a cache and you do not need to persist or -> delete them or otherwise make use of them without the need for persistence services -> there is no need to use `merge`. I.e. you can simply pass detached objects from a cache -> directly to the view. - -## Synchronization with the Database - -The state of persistent entities is synchronized with the database on flush of an `EntityManager` -which commits the underlying `UnitOfWork`. The synchronization involves writing any updates to -persistent entities and their relationships to the database. Thereby bidirectional relationships -are persisted based on the references held by the owning side of the relationship as explained -in the Association Mapping chapter. - -When `EntityManager#flush()` is called, Doctrine inspects all managed, new and removed entities -and will perform the following operations. - -### Synchronizing New and Managed Entities - -The flush operation applies to a managed entity with the following semantics: - -* The entity itself is synchronized to the database using a SQL UPDATE statement, only if at least one persistent field has changed. -* No SQL updates are executed if the entity did not change. - -The flush operation applies to a new entity with the following semantics: - -* The entity itself is synchronized to the database using a SQL INSERT statement. - -For all (initialized) relationships of the new or managed entity the following semantics apply to each -associated entity X: - -* If X is new and persist operations are configured to cascade on the relationship, - X will be persisted. -* If X is new and no persist operations are configured to cascade on the relationship, - an exception will be thrown as this indicates a programming error. -* If X is removed and persist operations are configured to cascade on the relationship, - an exception will be thrown as this indicates a programming error (X would be re-persisted by the cascade). -* If X is detached and persist operations are configured to cascade on the relationship, - an exception will be thrown (This is semantically the same as passing X to persist()). - -### Synchronizing Removed Entities - -The flush operation applies to a removed entity by deleting its persistent state from the database. -No cascade options are relevant for removed entities on flush, the cascade remove option is already -executed during `EntityManager#remove($entity)`. - -### The size of a Unit of Work - -The size of a Unit of Work mainly refers to the number of managed entities at -a particular point in time. - -### The cost of flushing - -How costly a flush operation is, mainly depends on two factors: - -* The size of the EntityManager's current UnitOfWork. -* The configured change tracking policies - -You can get the size of a UnitOfWork as follows: - - getUnitOfWork()->size(); - -The size represents the number of managed entities in the Unit of Work. This -size affects the performance of flush() operations due to change tracking -(see "Change Tracking Policies") and, of course, memory consumption, so you -may want to check it from time to time during development. - -> **CAUTION** -> Do not invoke `flush` after every change to an entity or every single invocation of -> persist/remove/merge/... This is an anti-pattern and unnecessarily reduces the -> performance of your application. Instead, form units of work that operate on your objects -> and call `flush` when you are done. While serving a single HTTP request there should -> be usually no need for invoking `flush` more than 0-2 times. - -### Direct access to a Unit of Work - -You can get direct access to the Unit of Work by calling `EntityManager#getUnitOfWork()`. -This will return the UnitOfWork instance the EntityManager is currently using. - - getUnitOfWork(); - -> **NOTE** -> Directly manipulating a UnitOfWork is not recommended. When working directly with the -> UnitOfWork API, respect methods marked as INTERNAL by not using them and carefully read -> the API documentation. - -### Entity State - -As outlined in the architecture overview an entity can be in one of four possible states: -NEW, MANAGED, REMOVED, DETACHED. If you explicitly need to find out what the current state -of an entity is in the context of a certain `EntityManager` you can ask the underlying -`UnitOfWork`: - - getUnitOfWork()->getEntityState($entity)) { - case UnitOfWork::MANAGED: - ... - case UnitOfWork::REMOVED: - ... - case UnitOfWork::DETACHED: - ... - case UnitOfWork::NEW: - ... - } - -An entity is in MANAGED state if it is associated with an `EntityManager` and it is not REMOVED. - -An entity is in REMOVED state after it has been passed to `EntityManager#remove()` until the -next flush operation of the same EntityManager. A REMOVED entity is still associated with an -`EntityManager` until the next flush operation. - -An entity is in DETACHED state if it has persistent state and identity but is currently not -associated with an `EntityManager`. - -An entity is in NEW state if has no persistent state and identity and is not associated with an -`EntityManager` (for example those just created via the "new" operator). - - -## Querying - -Doctrine 2 provides the following ways, in increasing level of power and flexibility, to query for persistent objects. You should always start with the simplest one that suits your needs. - -### By Primary Key - -The most basic way to query for a persistent object is by its identifier / primary key using the `EntityManager#find($entityName, $id)` method. Here is an example: - - find('MyProject\Domain\User', $id); - -The return value is either the found entity instance or null if no instance could be found with the given identifier. - -Essentially, `EntityManager#find()` is just a shortcut for the following: - - getRepository('MyProject\Domain\User')->find($id); - -`EntityManager#getRepository($entityName)` returns a repository object which provides many ways to retrieve entities of the specified type. By default, the repository instance is of type `Doctrine\ORM\EntityRepository`. You can also use custom repository classes as shown later. - -### By Simple Conditions - -To query for one or more entities based on several conditions that form a logical conjunction, use the `findBy` and `findOneBy` methods on a repository as follows: - - getRepository('MyProject\Domain\User')->findBy(array('age' => 20)); - - // All users that are 20 years old and have a surname of 'Miller' - $users = $em->getRepository('MyProject\Domain\User')->findBy(array('age' => 20, 'surname' => 'Miller')); - - // A single user by its nickname - $user = $em->getRepository('MyProject\Domain\User')->findOneBy(array('nickname' => 'romanb')); - -An EntityRepository also provides a mechanism for more concise calls through its use of `__call`. Thus, the following two examples are equivalent: - - getRepository('MyProject\Domain\User')->findOneBy(array('nickname' => 'romanb')); - - // A single user by its nickname (__call magic) - $user = $em->getRepository('MyProject\Domain\User')->findOneByNickname('romanb'); - - -### By Eager Loading - -Whenever you query for an entity that has persistent associations and these associations are mapped as EAGER, they will automatically be loaded together with the entity being queried and is thus immediately available to your application. - - -### By Lazy Loading - -Whenever you have a managed entity instance at hand, you can traverse and use any associations of that entity that are configured LAZY as if they were in-memory already. Doctrine will automatically load the associated objects on demand through the concept of lazy-loading. - - -### By DQL - -The most powerful and flexible method to query for persistent objects is the Doctrine Query Language, an object query language. DQL enables you to query for persistent objects in the language of objects. DQL understands classes, fields, inheritance and associations. -DQL is syntactically very similar to the familiar SQL but *it is not SQL*. - -A DQL query is represented by an instance of the `Doctrine\ORM\Query` class. You create a query using `EntityManager#createQuery($dql)`. Here is a simple example: - - createQuery("select u from MyDomain\Model\User u where u.age >= 20 and u.age <= 30"); - $users = $q->getResult(); - -Note that this query contains no knowledge about the relational schema, only about the object model. DQL supports positional as well as named parameters, many functions, (fetch) joins, aggregates, subqueries and much more. Detailed information about DQL and its syntax as well as the Doctrine\ORM\Query class can be found in [the dedicated chapter](http://www.doctrine-project.org/documentation/manual/2_0/en/dql-doctrine-query-language). For programmatically building up queries based on conditions that are only known at runtime, Doctrine provides the special `Doctrine\ORM\QueryBuilder` class. More information on constructing queries with a QueryBuilder can be found [in the dedicated chapter](http://www.doctrine-project.org/documentation/manual/2_0/en/query-builder). - - -### By Native Queries - -As an alternative to DQL or as a fallback for special SQL statements native queries can be used. -Native queries are built by using a hand-crafted SQL query and a ResultSetMapping that describes -how the SQL result set should be transformed by Doctrine. More information about native queries -can be found in [the dedicated chapter](http://www.doctrine-project.org/documentation/manual/2_0/en/native-sql). - -### Custom Repositories - -By default the EntityManager returns a default implementation of `Doctrine\ORM\EntityRepository` when -you call `EntityManager#getRepository($entityClass)`. You can overwrite this behaviour by specifying -the class name of your own Entity Repository in the Annotation, XML or YAML metadata. -In large applications that require lots of specialized DQL queries using a custom repository is -one recommended way of grouping these queries in a central location. - - _em->createQuery('SELECT u FROM MyDomain\Model\User u WHERE u.status = "admin"') - ->getResult(); - } - } - -You can access your repository now by calling: - - getRepository('MyDomain\Model\User')->getAllAdminUsers(); - diff --git a/manual/en/xml-mapping.rst b/manual/en/xml-mapping.rst index b384dd638..e93ded5a1 100644 --- a/manual/en/xml-mapping.rst +++ b/manual/en/xml-mapping.rst @@ -1,3 +1,6 @@ +XML Mapping +=========== + The XML mapping driver enables you to provide the ORM metadata in form of XML documents. @@ -13,9 +16,8 @@ code-completion based on such an XML Schema document. The following is an outline of a XML mapping document with the proper xmlns/xsi setup for the latest code in trunk. -:: +.. code-block:: xml - [xml] `` element as a direct child of the ```` element: -:: +.. code-block:: xml - [xml] @@ -188,9 +188,8 @@ element as a children to the ```` element. The field element is only used for primitive types that are not the ID of the entity. For the ID mapping you have to use the ```` element. -:: +.. code-block:: xml - [xml] @@ -238,9 +237,8 @@ surrogate keys are recommended for use with Doctrine 2. The Id field allows to define properties of the identifier and allows a subset of the ```` element attributes: -:: +.. code-block:: xml - [xml] @@ -270,9 +268,8 @@ to nest a ```` element inside the id-element. This of course only works for surrogate keys. For composite keys you always have to use the ``ASSIGNED`` strategy. -:: +.. code-block:: xml - [xml] @@ -333,9 +330,8 @@ from, which itself is not an entity however. The chapter on *Inheritance Mapping* describes a Mapped Superclass in detail. You can define it in XML using the ```` tag. -:: +.. code-block:: xml - [xml] @@ -366,9 +362,8 @@ You can specify the inheritance type in the ```` element and then use the ```` and ```` attributes. -:: +.. code-block:: xml - [xml] @@ -381,7 +376,7 @@ and then use the ```` and The allowed values for inheritance-type attribute are ``JOINED`` or ``SINGLE_TABLE``. - **NOTE** +.. note:: All inheritance related definitions have to be defined on the root entity of the hierarchy. @@ -393,9 +388,8 @@ Defining Lifecycle Callbacks You can define the lifecycle callback methods on your entities using the ```` element: -:: +.. code-block:: xml - [xml] @@ -412,9 +406,8 @@ depend on the associations being on the inverse or owning side. For the inverse side the mapping is as simple as: -:: +.. code-block:: xml - [xml] @@ -431,9 +424,8 @@ Required attributes for inverse One-To-One: For the owning side this mapping would look like: -:: +.. code-block:: xml - [xml] @@ -467,9 +459,8 @@ association, which means it contains the foreign key. The completed explicitly defined mapping is: -:: +.. code-block:: xml - [xml] @@ -484,9 +475,8 @@ bidirectional association. This simplifies the mapping compared to the one-to-one case. The minimal mapping for this association looks like: -:: +.. code-block:: xml - [xml] @@ -516,9 +506,8 @@ to the naming of the join-column/foreign key. The explicitly defined mapping includes a ```` tag nested inside the many-to-one association tag: -:: +.. code-block:: xml - [xml] @@ -537,9 +526,8 @@ association. There exists no such thing as a uni-directional one-to-many association, which means this association only ever exists for bi-directional associations. -:: +.. code-block:: xml - [xml] @@ -566,9 +554,8 @@ From all the associations the many-to-many has the most complex definition. When you rely on the mapping defaults you can omit many definitions and rely on their implicit values. -:: +.. code-block:: xml - [xml] @@ -596,9 +583,8 @@ The mapping defaults would lead to a join-table with the name "User\_Group" being created that contains two columns "user\_id" and "group\_id". The explicit definition of this mapping would be: -:: +.. code-block:: xml - [xml] @@ -626,9 +612,8 @@ related entities. You can specify the cascade operations in the ```` element inside any of the association mapping tags. -:: +.. code-block:: xml - [xml] @@ -677,9 +662,8 @@ Defining Order of To-Many Associations You can require one-to-many or many-to-many associations to be retrieved using an additional ``ORDER BY``. -:: +.. code-block:: xml - [xml] @@ -695,9 +679,8 @@ To define additional indexes or unique constraints on the entities table you can use the ```` and ```` elements: -:: +.. code-block:: xml - [xml] diff --git a/manual/en/xml-mapping.txt b/manual/en/xml-mapping.txt deleted file mode 100644 index 2dd1806b7..000000000 --- a/manual/en/xml-mapping.txt +++ /dev/null @@ -1,509 +0,0 @@ -The XML mapping driver enables you to provide the ORM metadata in form of XML documents. - -The XML driver is backed by an XML Schema document that describes the structure of a mapping document. The most recent version of the XML Schema document is available online at [http://www.doctrine-project.org/schemas/orm/doctrine-mapping.xsd](http://www.doctrine-project.org/schemas/orm/doctrine-mapping.xsd). In order to point to the latest version of the document of a particular stable release branch, just append the release number, i.e.: doctrine-mapping-2.0.xsd The most convenient way to work with XML mapping files is to use an IDE/editor that can provide code-completion based on such an XML Schema document. The following is an outline of a XML mapping document with the proper xmlns/xsi setup for the latest code in trunk. - - [xml] - - - ... - - - -The XML mapping document of a class is loaded on-demand the first time it is requested and subsequently stored in the metadata cache. In order to work, this requires certain conventions: - - * Each entity/mapped superclass must get its own dedicated XML mapping document. - * The name of the mapping document must consist of the fully qualified name of the class, where namespace - separators are replaced by dots (.). For example an Entity with the fully qualified class-name "MyProject\Entities\User" - would require a mapping file "MyProject.Entities.User.dcm.xml" unless the extension is changed. - * All mapping documents should get the extension ".dcm.xml" to identify it as a Doctrine mapping file. This is more of - a convention and you are not forced to do this. You can change the file extension easily enough. - -- - - setFileExtension('.xml'); - -It is recommended to put all XML mapping documents in a single folder but you can spread the documents over several folders if you want to. In order to tell the XmlDriver where to look for your mapping documents, supply an array of paths as the first argument of the constructor, like this: - - setMetadataDriverImpl($driver); - - -## Example - -As a quick start, here is a small example document that makes use of several common elements: - - [xml] - // Doctrine.Tests.ORM.Mapping.User.dcm.xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Be aware that class-names specified in the XML files should be fully qualified. - -## XML-Element Reference - -The XML-Element reference explains all the tags and attributes that the Doctrine Mapping XSD Schema defines. -You should read the Basic-, Association- and Inheritance Mapping chapters to understand what each of this -definitions means in detail. - -### Defining an Entity - -Each XML Mapping File contains the definition of one entity, specified as the `` element -as a direct child of the `` element: - - [xml] - - - - - - -Required attributes: - -* name - The fully qualified class-name of the entity. - -Optional attributes: - -* table - The Table-Name to be used for this entity. Otherwise the Unqualified Class-Name is used by default. -* repository-class - The fully qualified class-name of an alternative `Doctrine\ORM\EntityRepository` implementation to be used with this entity. -* inheritance-type - The type of inheritance, defaults to none. A more detailed description follows in the *Defining Inheritance Mappings* section. - -### Defining Fields - -Each entity class can contain zero to infinite fields that are managed by Doctrine. You can define -them using the `` element as a children to the `` element. The field element is only -used for primitive types that are not the ID of the entity. For the ID mapping you have to use the `` element. - - [xml] - - - - - - - - - -Required attributes: - -* name - The name of the Property/Field on the given Entity PHP class. - -Optional attributes: - -* type - The `Doctrine\DBAL\Types\Type` name, defaults to "string" -* column - Name of the column in the database, defaults to the field name. -* length - The length of the given type, for use with strings only. -* unique - Should this field contain a unique value across the table? Defaults to false. -* nullable - Should this field allow NULL as a value? Defaults to false. -* version - Should this field be used for optimistic locking? Only works on fields with type integer or datetime. -* scale - Scale of a decimal type. -* precision - Precision of a decimal type. -* column-definition - Optional alternative SQL representation for this column. This definition begin after the - field-name and has to specify the complete column definition. Using this feature will turn this field dirty - for Schema-Tool update commands at all times. - -### Defining Identity and Generator Strategies - -An entity has to have at least one `` element. For composite keys you can specify more than one id-element, -however surrogate keys are recommended for use with Doctrine 2. The Id field allows to define properties of -the identifier and allows a subset of the `` element attributes: - - [xml] - - - - -Required attributes: - -* name - The name of the Property/Field on the given Entity PHP class. -* type - The `Doctrine\DBAL\Types\Type` name, preferably "string" or "integer". - -Optional attributes: - -* column - Name of the column in the database, defaults to the field name. - -Using the simplified definition above Doctrine will use no identifier strategy for this entity. That means -you have to manually set the identifier before calling `EntityManager#persist($entity)`. This is the -so called `ASSIGNED` strategy. - -If you want to switch the identifier generation strategy you have to nest a `` element inside -the id-element. This of course only works for surrogate keys. For composite keys you always have to use -the `ASSIGNED` strategy. - - [xml] - - - - - - -The following values are allowed for the `` strategy attribute: - -* AUTO - Automatic detection of the identifier strategy based on the preferred solution of the database vendor. -* IDENTITY - Use of a IDENTIFY strategy such as Auto-Increment IDs available to Doctrine AFTER the INSERT statement has been executed. -* SEQUENCE - Use of a database sequence to retrieve the entity-ids. This is possible before the INSERT statement is executed. - -If you are using the SEQUENCE strategy you can define an additional element to describe the sequence: - - [xml] - - - - - - - -Required attributes for ``: - -* sequence-name - The name of the sequence - -Optional attributes for ``: - -* allocation-size - By how much steps should the sequence be incremented when a value is retrieved. Defaults to 1 -* initial-value - What should the initial value of the sequence be. - -> **NOTE** -> -> If you want to implement a cross-vendor compatible application you have to specify and -> additionally define the element, if Doctrine chooses the sequence strategy for a platform. - -### Defining a Mapped Superclass - -Sometimes you want to define a class that multiple entities inherit from, which itself is not an entity however. -The chapter on *Inheritance Mapping* describes a Mapped Superclass in detail. You can define it in XML using -the `` tag. - - [xml] - - - - - - - -Required attributes: - -* name - Class name of the mapped superclass. - -You can nest any number of `` and unidirectional `` or `` associations inside -a mapped superclass. - -### Defining Inheritance Mappings - -There are currently two inheritance persistence strategies that you can choose from when defining entities that -inherit from each other. Single Table inheritance saves the fields of the complete inheritance hierarchy in a single table, -joined table inheritance creates a table for each entity combining the fields using join conditions. - -You can specify the inheritance type in the `` element and then use the `` and -`` attributes. - - [xml] - - - - - - - - - -The allowed values for inheritance-type attribute are `JOINED` or `SINGLE_TABLE`. - -> **NOTE** -> -> All inheritance related definitions have to be defined on the root entity of the hierarchy. - -### Defining Lifecycle Callbacks - -You can define the lifecycle callback methods on your entities using the `` element: - - [xml] - - - - - - - -### Defining One-To-One Relations - -You can define One-To-One Relations/Associations using the `` element. The required -and optional attributes depend on the associations being on the inverse or owning side. - -For the inverse side the mapping is as simple as: - - [xml] - - - - -Required attributes for inverse One-To-One: - -* field - Name of the property/field on the entity's PHP class. -* target-entity - Name of the entity associated entity class. If this is not qualified the namespace of the current class is prepended. *IMPORTANT:* No leading backslash! -* mapped-by - Name of the field on the owning side (here Address entity) that contains the owning side association. - -For the owning side this mapping would look like: - - [xml] - - - - -Required attributes for owning One-to-One: - -* field - Name of the property/field on the entity's PHP class. -* target-entity - Name of the entity associated entity class. If this is not qualified the namespace of the current class is prepended. *IMPORTANT:* No leading backslash! - -Optional attributes for owning One-to-One: - -* inversed-by - If the association is bidirectional the inversed-by attribute has to be specified with the name of the field on the inverse entity that contains the back-reference. -* orphan-removal - If true, the inverse side entity is always deleted when the owning side entity is. Defaults to false. -* fetch - Either LAZY or FETCH, defaults to LAZY. This attribute makes only sense on the owning side, the inverse side *ALWAYS* has to use the `FETCH` strategy. - -The definition for the owning side relies on a bunch of mapping defaults for the join column names. -Without the nested `` element Doctrine assumes to foreign key to be called `user_id` on the Address -Entities table. This is because the `MyProject\Address` entity is the owning side of this association, which means -it contains the foreign key. - -The completed explicitly defined mapping is: - - [xml] - - - - - - -### Defining Many-To-One Associations - -The many-to-one association is *ALWAYS* the owning side of any bidirectional association. This simplifies the mapping -compared to the one-to-one case. The minimal mapping for this association looks like: - - [xml] - - - - -Required attributes: - -* field - Name of the property/field on the entity's PHP class. -* target-entity - Name of the entity associated entity class. If this is not qualified the namespace of the current class is prepended. *IMPORTANT:* No leading backslash! - -Optional attributes: - -* inversed-by - If the association is bidirectional the inversed-by attribute has to be specified with the name of the field on the inverse entity that contains the back-reference. -* orphan-removal - If true the entity on the inverse side is always deleted when the owning side entity is and it is not connected to any other owning side entity anymore. Defaults to false. -* fetch - Either LAZY or FETCH, defaults to LAZY. - -This definition relies on a bunch of mapping defaults with regards to the naming of the join-column/foreign key. The -explicitly defined mapping includes a `` tag nested inside the many-to-one association tag: - - [xml] - - - - - - -The join-column attribute `name` specifies the column name of the foreign key and -the `referenced-column-name` attribute specifies the name of the primary key column -on the User entity. - -### Defining One-To-Many Associations - -The one-to-many association is *ALWAYS* the inverse side of any association. There exists no such thing as a -uni-directional one-to-many association, which means this association only ever exists for bi-directional associations. - - [xml] - - - - -Required attributes: - -* field - Name of the property/field on the entity's PHP class. -* target-entity - Name of the entity associated entity class. If this is not qualified the namespace of the current class is prepended. *IMPORTANT:* No leading backslash! -* mapped-by - Name of the field on the owning side (here Phonenumber entity) that contains the owning side association. - -Optional attributes: - -* fetch - Either LAZY or FETCH, defaults to LAZY. - -### Defining Many-To-Many Associations - -From all the associations the many-to-many has the most complex definition. When you rely on the mapping defaults -you can omit many definitions and rely on their implicit values. - - [xml] - - - - -Required attributes: - -* field - Name of the property/field on the entity's PHP class. -* target-entity - Name of the entity associated entity class. If this is not qualified the namespace of the current class is prepended. *IMPORTANT:* No leading backslash! - -Optional attributes: - -* mapped-by - Name of the field on the owning side that contains the owning side association if the defined many-to-many association is on the inverse side. -* inversed-by - If the association is bidirectional the inversed-by attribute has to be specified with the name of the field on the inverse entity that contains the back-reference. -* fetch - Either LAZY or FETCH, defaults to LAZY. - -The mapping defaults would lead to a join-table with the name "User_Group" being created that contains two columns -"user_id" and "group_id". The explicit definition of this mapping would be: - - [xml] - - - - - - - - - - - - - -Here both the `` and `` tags are necessary to tell Doctrine for which side the -specified join-columns apply. These are nested inside a `` attribute which allows to specify -the table name of the many-to-many join-table. - -### Cascade Element - -Doctrine allows cascading of several UnitOfWork operations to related entities. You can specify the cascade -operations in the `` element inside any of the association mapping tags. - - [xml] - - - - - - - - -Besides `` the following operations can be specified by their respective tags: - -* `` -* `` -* `` -* `` - -### Join Column Element - -In any explicitly defined association mapping you will need the `` tag. It defines how the -foreign key and primary key names are called that are used for joining two entities. - -Required attributes: - -* name - The column name of the foreign key. -* referenced-column-name - The column name of the associated entities primary key - -Optional attributes: - -* unique - If the join column should contain a UNIQUE constraint. This makes sense for Many-To-Many join-columns only to simulate a one-to-many unidirectional using a join-table. -* nullable - should the join column be nullable, defaults to true. -* on-delete - Foreign Key Cascade action to perform when entity is deleted, defaults to NO ACTION/RESTRICT but can be set to "CASCADE". - -### Defining Order of To-Many Associations - -You can require one-to-many or many-to-many associations to be retrieved using an additional `ORDER BY`. - - [xml] - - - - - - - - -### Defining Indexes or Unique Constraints - -To define additional indexes or unique constraints on the entities table you can use the -`` and `` elements: - - [xml] - - - - - - - - - - - - -You have to specify the column and not the entity-class field names in the index and unique-constraint -definitions. \ No newline at end of file diff --git a/manual/en/yaml-mapping.rst b/manual/en/yaml-mapping.rst index 54245c5c2..9f62eea8d 100644 --- a/manual/en/yaml-mapping.rst +++ b/manual/en/yaml-mapping.rst @@ -1,3 +1,6 @@ +YAML Mapping +============ + The YAML mapping driver enables you to provide the ORM metadata in form of YAML documents. @@ -42,9 +45,8 @@ Example As a quick start, here is a small example document that makes use of several common elements: -:: +.. code-block:: yaml - [yml] # Doctrine.Tests.ORM.Mapping.User.dcm.yml Doctrine\Tests\ORM\Mapping\User: type: entity diff --git a/manual/en/yaml-mapping.txt b/manual/en/yaml-mapping.txt deleted file mode 100644 index e043eb121..000000000 --- a/manual/en/yaml-mapping.txt +++ /dev/null @@ -1,66 +0,0 @@ -The YAML mapping driver enables you to provide the ORM metadata in form of YAML documents. - -The YAML mapping document of a class is loaded on-demand the first time it is requested and subsequently stored in the metadata cache. In order to work, this requires certain conventions: - - * Each entity/mapped superclass must get its own dedicated YAML mapping document. - * The name of the mapping document must consist of the fully qualified name of the class, where namespace separators are replaced by dots (.). - * All mapping documents should get the extension ".dcm.yml" to identify it as a Doctrine mapping file. This is more of a convention and you are not forced to do this. You can change the file extension easily enough. - -- - - setFileExtension('.yml'); - -It is recommended to put all YAML mapping documents in a single folder but you can spread the documents over several folders if you want to. In order to tell the YamlDriver where to look for your mapping documents, supply an array of paths as the first argument of the constructor, like this: - - setMetadataDriverImpl($driver); - - -## Example - -As a quick start, here is a small example document that makes use of several common elements: - - [yml] - # Doctrine.Tests.ORM.Mapping.User.dcm.yml - Doctrine\Tests\ORM\Mapping\User: - type: entity - table: cms_users - id: - id: - type: integer - generator: - strategy: AUTO - fields: - name: - type: string - length: 50 - oneToOne: - address: - targetEntity: Address - joinColumn: - name: address_id - referencedColumnName: id - oneToMany: - phonenumbers: - targetEntity: Phonenumber - mappedBy: user - cascade: cascadePersist - manyToMany: - groups: - targetEntity: Group - joinTable: - name: cms_users_groups - joinColumns: - user_id: - referencedColumnName: id - inverseJoinColumns: - group_id: - referencedColumnName: id - lifecycleCallbacks: - prePersist: [ doStuffOnPrePersist, doOtherStuffOnPrePersistToo ] - postPersist: [ doStuffOnPostPersist ] - - Be aware that class-names specified in the YAML files should be fully qualified. \ No newline at end of file From c22bddc9a75da8192d07cbd1f23c78690cc16a07 Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Tue, 9 Nov 2010 22:17:31 +0100 Subject: [PATCH 05/10] DDC-866 Fix deprecated EBNF rule --- manual/en/dql-doctrine-query-language.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manual/en/dql-doctrine-query-language.rst b/manual/en/dql-doctrine-query-language.rst index e99916d2c..0c824cd57 100644 --- a/manual/en/dql-doctrine-query-language.rst +++ b/manual/en/dql-doctrine-query-language.rst @@ -1297,7 +1297,7 @@ Path Expressions StateFieldPathExpression ::= IdentificationVariable "." StateField | SingleValuedAssociationPathExpression "." StateField /* "u.Group" */ - SingleValuedAssociationPathExpression ::= IdentificationVariable "." {SingleValuedAssociationField "."}* SingleValuedAssociationField + SingleValuedAssociationPathExpression ::= IdentificationVariable "." SingleValuedAssociationField /* "u.Group.Permissions" */ CollectionValuedPathExpression ::= IdentificationVariable "." {SingleValuedAssociationField "."}* CollectionValuedAssociationField From ee042bc642629f88110343ecf3a78c980db9f05b Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Tue, 9 Nov 2010 22:18:25 +0100 Subject: [PATCH 06/10] Some changes left --- manual/en/index.rst | 2 +- manual/en/introduction.rst | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/manual/en/index.rst b/manual/en/index.rst index 91eb8f6b6..cb638ddbb 100644 --- a/manual/en/index.rst +++ b/manual/en/index.rst @@ -36,7 +36,7 @@ Contents: tools metadata-drivers best-practices - limitations-and-Known-issues + limitations-and-known-issues Indices and tables ================== diff --git a/manual/en/introduction.rst b/manual/en/introduction.rst index f4e540574..66e9f3a41 100644 --- a/manual/en/introduction.rst +++ b/manual/en/introduction.rst @@ -1,3 +1,6 @@ +Introduction +============ + Welcome ------- From 46983465fd52c5c5bb1285a496d6cbc1cbef94a3 Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Fri, 3 Dec 2010 20:13:10 +0100 Subject: [PATCH 07/10] Finialized ReST doc changes, merged changes from latest Markdown docs. --- cookbook/en.rst | 34 --- cookbook/en.txt | 11 - cookbook/en/Makefile | 89 -------- cookbook/en/conf.py | 196 ----------------- cookbook/en/index.rst | 32 --- cookbook/en/make.bat | 113 ---------- {manual/en => en}/Makefile | 0 en/_templates/layout.html | 198 +++++++++++++++++ {manual/en => en}/conf.py | 14 +- .../en => en/cookbook}/aggregate-fields.rst | 24 ++- .../en => en/cookbook}/dql-custom-walkers.rst | 16 +- .../cookbook}/dql-user-defined-functions.rst | 27 +-- ...menting-arrayaccess-for-domain-objects.rst | 8 +- ...nting-the-notify-changetracking-policy.rst | 6 +- .../implementing-wakeup-or-clone.rst | 6 +- .../integrating-with-codeigniter.rst | 9 +- .../en => en/cookbook}/sql-table-prefixes.rst | 4 +- .../strategy-cookbook-introduction.rst | 6 +- .../cookbook}/validation-of-entities.rst | 18 +- en/index.rst | 70 ++++++ {manual/en => en}/make.bat | 0 .../reference}/annotations-reference.rst | 201 +++++++++++------- {manual/en => en/reference}/architecture.rst | 2 + .../reference}/association-mapping.rst | 49 ++--- {manual/en => en/reference}/basic-mapping.rst | 41 ++-- .../en => en/reference}/batch-processing.rst | 24 ++- .../en => en/reference}/best-practices.rst | 2 +- {manual/en => en/reference}/caching.rst | 82 +++---- .../reference}/change-tracking-policies.rst | 6 +- {manual/en => en/reference}/configuration.rst | 40 ++-- .../dql-doctrine-query-language.rst | 161 +++++++------- {manual/en => en/reference}/events.rst | 38 ++-- .../reference}/improving-performance.rst | 7 +- .../reference}/inheritance-mapping.rst | 6 +- {manual/en => en/reference}/introduction.rst | 31 ++- .../limitations-and-known-issues.rst | 4 +- .../en => en/reference}/metadata-drivers.rst | 22 +- {manual/en => en/reference}/native-sql.rst | 22 +- .../en => en/reference}/partial-objects.rst | 2 +- {manual/en => en/reference}/php-mapping.rst | 16 +- {manual/en => en/reference}/query-builder.rst | 28 +-- {manual/en => en/reference}/tools.rst | 46 ++-- .../transactions-and-concurrency.rst | 18 +- .../reference}/working-with-associations.rst | 31 ++- .../reference}/working-with-objects.rst | 65 +++--- {manual/en => en/reference}/xml-mapping.rst | 7 +- {manual/en => en/reference}/yaml-mapping.rst | 4 +- .../getting-started-xml-edition.rst | 77 +++---- generate-docs.sh | 2 +- manual/en.rst | 79 ------- manual/en.txt | 26 --- manual/en/index.rst | 47 ---- 52 files changed, 897 insertions(+), 1170 deletions(-) delete mode 100644 cookbook/en.rst delete mode 100644 cookbook/en.txt delete mode 100644 cookbook/en/Makefile delete mode 100644 cookbook/en/conf.py delete mode 100644 cookbook/en/index.rst delete mode 100644 cookbook/en/make.bat rename {manual/en => en}/Makefile (100%) create mode 100644 en/_templates/layout.html rename {manual/en => en}/conf.py (95%) rename {cookbook/en => en/cookbook}/aggregate-fields.rst (97%) rename {cookbook/en => en/cookbook}/dql-custom-walkers.rst (97%) rename {cookbook/en => en/cookbook}/dql-user-defined-functions.rst (93%) rename {cookbook/en => en/cookbook}/implementing-arrayaccess-for-domain-objects.rst (96%) rename {cookbook/en => en/cookbook}/implementing-the-notify-changetracking-policy.rst (95%) rename {cookbook/en => en/cookbook}/implementing-wakeup-or-clone.rst (95%) rename {cookbook/en => en/cookbook}/integrating-with-codeigniter.rst (95%) rename {cookbook/en => en/cookbook}/sql-table-prefixes.rst (98%) rename {cookbook/en => en/cookbook}/strategy-cookbook-introduction.rst (99%) rename {cookbook/en => en/cookbook}/validation-of-entities.rst (95%) create mode 100644 en/index.rst rename {manual/en => en}/make.bat (100%) rename {manual/en => en/reference}/annotations-reference.rst (82%) rename {manual/en => en/reference}/architecture.rst (99%) rename {manual/en => en/reference}/association-mapping.rst (98%) rename {manual/en => en/reference}/basic-mapping.rst (96%) rename {manual/en => en/reference}/batch-processing.rst (93%) rename {manual/en => en/reference}/best-practices.rst (99%) rename {manual/en => en/reference}/caching.rst (91%) rename {manual/en => en/reference}/change-tracking-policies.rst (98%) rename {manual/en => en/reference}/configuration.rst (97%) rename {manual/en => en/reference}/dql-doctrine-query-language.rst (96%) rename {manual/en => en/reference}/events.rst (98%) rename {manual/en => en/reference}/improving-performance.rst (92%) rename {manual/en => en/reference}/inheritance-mapping.rst (99%) rename {manual/en => en/reference}/introduction.rst (96%) rename {manual/en => en/reference}/limitations-and-known-issues.rst (99%) rename {manual/en => en/reference}/metadata-drivers.rst (95%) rename {manual/en => en/reference}/native-sql.rst (98%) rename {manual/en => en/reference}/partial-objects.rst (99%) rename {manual/en => en/reference}/php-mapping.rst (95%) rename {manual/en => en/reference}/query-builder.rst (98%) rename {manual/en => en/reference}/tools.rst (96%) rename {manual/en => en/reference}/transactions-and-concurrency.rst (98%) rename {manual/en => en/reference}/working-with-associations.rst (97%) rename {manual/en => en/reference}/working-with-objects.rst (96%) rename {manual/en => en/reference}/xml-mapping.rst (99%) rename {manual/en => en/reference}/yaml-mapping.rst (98%) rename {cookbook/en => en/tutorials}/getting-started-xml-edition.rst (97%) delete mode 100644 manual/en.rst delete mode 100644 manual/en.txt delete mode 100644 manual/en/index.rst diff --git a/cookbook/en.rst b/cookbook/en.rst deleted file mode 100644 index 2c5786b1d..000000000 --- a/cookbook/en.rst +++ /dev/null @@ -1,34 +0,0 @@ -Getting Started XML-Edition -=========================== - -Implementing ArrayAccess for domain objects -=========================================== - -Implementing the NOTIFY change-tracking policy -============================================== - -Validation of Entities -====================== - -Implementing wakeup or clone -============================ - -Integrating with CodeIgniter -============================ - -DQL Custom Walkers -================== - -DQL User Defined Functions -========================== - -SQL Table Prefixes -================== - -Strategy Cookbook Introduction -============================== - -Aggregate Fields -================ - - diff --git a/cookbook/en.txt b/cookbook/en.txt deleted file mode 100644 index 6a77ba99d..000000000 --- a/cookbook/en.txt +++ /dev/null @@ -1,11 +0,0 @@ -# Getting Started XML-Edition -# Implementing ArrayAccess for domain objects -# Implementing the NOTIFY change-tracking policy -# Validation of Entities -# Implementing wakeup or clone -# Integrating with CodeIgniter -# DQL Custom Walkers -# DQL User Defined Functions -# SQL Table Prefixes -# Strategy Cookbook Introduction -# Aggregate Fields \ No newline at end of file diff --git a/cookbook/en/Makefile b/cookbook/en/Makefile deleted file mode 100644 index 987598317..000000000 --- a/cookbook/en/Makefile +++ /dev/null @@ -1,89 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Doctrine2ORMCookbook.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Doctrine2ORMCookbook.qhc" - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ - "run these through (pdf)latex." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/cookbook/en/conf.py b/cookbook/en/conf.py deleted file mode 100644 index 18997a35d..000000000 --- a/cookbook/en/conf.py +++ /dev/null @@ -1,196 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Doctrine 2 ORM Cookbook documentation build configuration file, created by -# sphinx-quickstart on Mon Nov 1 21:13:13 2010. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.append(os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Doctrine 2 ORM Cookbook' -copyright = u'2010, Doctrine Project Team' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '2.0' -# The full version, including alpha/beta/rc tags. -release = '2.0.0-BETA4' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -language = 'en' - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -highlight_language = 'php' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_use_modindex = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Doctrine2ORMCookbookdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'Doctrine2ORMCookbook.tex', u'Doctrine 2 ORM Cookbook Documentation', - u'Doctrine Project Team', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_use_modindex = True diff --git a/cookbook/en/index.rst b/cookbook/en/index.rst deleted file mode 100644 index 4c4be6adc..000000000 --- a/cookbook/en/index.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. Doctrine 2 ORM Cookbook documentation master file, created by - sphinx-quickstart on Mon Nov 1 21:13:13 2010. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Doctrine 2 ORM Cookbook's documentation! -=================================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - getting-started-xml-edition - implementing-arrayaccess-for-domain-objects - implementing-the-notify-changetracking-policy - validations-of-entities - implementing-wakeup-or-clone - integrating-with-codeigniter - dql-custom-walkers - dql-user-defined-functions - sql-table-prefixes - strategy-cookbook-introdution - aggregates-fields - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/cookbook/en/make.bat b/cookbook/en/make.bat deleted file mode 100644 index 9f1a938d9..000000000 --- a/cookbook/en/make.bat +++ /dev/null @@ -1,113 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -set SPHINXBUILD=sphinx-build -set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. changes to make an overview over all changed/added/deprecated items - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Doctrine2ORMCookbook.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Doctrine2ORMCookbook.ghc - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -:end diff --git a/manual/en/Makefile b/en/Makefile similarity index 100% rename from manual/en/Makefile rename to en/Makefile diff --git a/en/_templates/layout.html b/en/_templates/layout.html new file mode 100644 index 000000000..3380dbe13 --- /dev/null +++ b/en/_templates/layout.html @@ -0,0 +1,198 @@ +{%- block doctype -%} + +{%- endblock %} +{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %} +{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %} +{%- set url_root = pathto('', 1) %} +{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} + +{%- macro relbar() %} +
+

{{ _('Navigation') }}

+
    + {%- for rellink in rellinks %} +
  • + {{ rellink[3] }} + {%- if not loop.first %}{{ reldelim2 }}{% endif %}
    • + {%- endfor %} + {%- block rootrellink %} +
  • {{ shorttitle|e }}{{ reldelim1 }}
    • + {%- endblock %} + {%- for parent in parents %} +
  • {{ parent.title }}{{ reldelim1 }}
    • + {%- endfor %} + {%- block relbaritems %} {% endblock %} +
+
+{%- endmacro %} + +{%- macro sidebar() %} + {%- if not embedded %}{% if not theme_nosidebar|tobool %} +
+
+ {%- block sidebarlogo %} + {%- if logo %} + + {%- endif %} + {%- endblock %} + {%- block sidebartoc %} + {%- if display_toc %} +

{{ _('Table Of Contents') }}

+ {{ toc }} + {%- endif %} + {%- endblock %} + {%- block sidebarrel %} + {%- if prev %} +

{{ _('Previous topic') }}

+

{{ prev.title }}

+ {%- endif %} + {%- if next %} +

{{ _('Next topic') }}

+

{{ next.title }}

+ {%- endif %} + {%- endblock %} + {%- block sidebarsourcelink %} + {%- if show_source and has_source and sourcename %} +

{{ _('This Page') }}

+ + {%- endif %} + {%- endblock %} + {%- if customsidebar %} + {% include customsidebar %} + {%- endif %} + {%- block sidebarsearch %} + {%- if pagename != "search" %} + + + {%- endif %} + {%- endblock %} +
+
+ {%- endif %}{% endif %} +{%- endmacro %} + + + + + {{ metatags }} + {%- if not embedded and docstitle %} + {%- set titlesuffix = " — "|safe + docstitle|e %} + {%- else %} + {%- set titlesuffix = "" %} + {%- endif %} + {{ title|striptags }}{{ titlesuffix }} + + + {%- if not embedded %} + + {%- for scriptfile in script_files %} + + {%- endfor %} + {%- if use_opensearch %} + + {%- endif %} + {%- if favicon %} + + {%- endif %} + {%- endif %} +{%- block linktags %} + {%- if hasdoc('about') %} + + {%- endif %} + {%- if hasdoc('genindex') %} + + {%- endif %} + {%- if hasdoc('search') %} + + {%- endif %} + {%- if hasdoc('copyright') %} + + {%- endif %} + + {%- if parents %} + + {%- endif %} + {%- if next %} + + {%- endif %} + {%- if prev %} + + {%- endif %} +{%- endblock %} +{%- block extrahead %} {% endblock %} + + +{%- block header %}{% endblock %} + +{%- block relbar1 %}{{ relbar() }}{% endblock %} + +{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %} + +
+{%- block document %} +
+ {%- if not embedded %}{% if not theme_nosidebar|tobool %} +
+ {%- endif %}{% endif %} +
+ {% block body %} {% endblock %} +
+ {%- if not embedded %}{% if not theme_nosidebar|tobool %} +
+ {%- endif %}{% endif %} +
+{%- endblock %} + +{%- block sidebar2 %}{{ sidebar() }}{% endblock %} +
+
+ +{%- block relbar2 %}{{ relbar() }}{% endblock %} + +{%- block footer %} +
+ {%- if hasdoc('copyright') %} + {% trans path=pathto('copyright'), copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} + {%- else %} + {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} + {%- endif %} + {%- if last_updated %} + {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} + {%- endif %} + {%- if show_sphinx %} + {% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %} + {%- endif %} +
+{%- endblock %} + + diff --git a/manual/en/conf.py b/en/conf.py similarity index 95% rename from manual/en/conf.py rename to en/conf.py index b972b640f..7069824f1 100644 --- a/manual/en/conf.py +++ b/en/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # # Doctrine 2 ORM documentation build configuration file, created by -# sphinx-quickstart on Mon Nov 1 21:19:39 2010. +# sphinx-quickstart on Fri Dec 3 18:10:24 2010. # # This file is execfile()d with the current directory set to its containing dir. # @@ -38,7 +38,7 @@ master_doc = 'index' # General information about the project. project = u'Doctrine 2 ORM' -copyright = u'2010, Roman Borschel, Guilherme Blanco, Benjamin Eberlei, Jonathan Wage' +copyright = u'2010, Doctrine Project Team' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -47,11 +47,11 @@ copyright = u'2010, Roman Borschel, Guilherme Blanco, Benjamin Eberlei, Jonathan # The short X.Y version. version = '2.0' # The full version, including alpha/beta/rc tags. -release = '2.0.0-BETA4' +release = '2.0.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -language = 'en' +language = 'php' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -78,13 +78,11 @@ exclude_trees = ['_build'] # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +show_authors = True # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -highlight_language = 'php' - # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] @@ -175,7 +173,7 @@ htmlhelp_basename = 'Doctrine2ORMdoc' # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'Doctrine2ORM.tex', u'Doctrine 2 ORM Documentation', - u'Roman Borschel, Guilherme Blanco, Benjamin Eberlei, Jonathan Wage', 'manual'), + u'Doctrine Project Team', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of diff --git a/cookbook/en/aggregate-fields.rst b/en/cookbook/aggregate-fields.rst similarity index 97% rename from cookbook/en/aggregate-fields.rst rename to en/cookbook/aggregate-fields.rst index ef91a4d62..521f5d025 100644 --- a/cookbook/en/aggregate-fields.rst +++ b/en/cookbook/aggregate-fields.rst @@ -1,6 +1,8 @@ Aggregate Fields ================ +.. sectionauthor:: Benjamin Eberlei + You will often come across the requirement to display aggregate values of data that can be computed by using the MIN, MAX, COUNT or SUM SQL functions. For any ORM this is a tricky issue @@ -27,7 +29,7 @@ added on the ``Entry`` object. Our entities look like: -:: +.. code-block:: php ``Entry`` relation with this method: -:: +.. code-block:: php + The Doctrine Query Language (DQL) is a proprietary sql-dialect that substitutes tables and columns for Entity names and their fields. Using DQL you write a query against the database using your @@ -58,7 +60,7 @@ Say you have a blog and posts all with one category and one author. A query for the front-page or any archive page might look something like: -.. code-clock:: sql +.. code-block:: sql SELECT p, c, a FROM BlogPost p JOIN p.category c JOIN p.author a WHERE ... @@ -72,7 +74,7 @@ posts that match the WHERE clause of this query to be able to predict the number of pages to show to the user. A draft of the DQL query for pagination would look like: -.. code-clock:: sql +.. code-block:: sql SELECT count(DISTINCT p.id) FROM BlogPost p JOIN p.category c JOIN p.author a WHERE ... @@ -80,7 +82,7 @@ Now you could go and write each of these queries by hand, or you can use a tree walker to modify the AST for you. Lets see how the API would look for this use-case: -:: +.. code-block:: php + By default DQL supports a limited subset of all the vendor-specific SQL functions common between all the vendors. However in many cases once you have decided on a specific database vendor, you will never @@ -8,13 +10,12 @@ change it during the life of your project. This decision for a specific vendor potentially allows you to make use of powerful SQL features that are unique to the vendor. - **Note** - - It is worth to mention that Doctrine 2 also allows you to handwrite - your SQL instead of extending the DQL parser, which is sort of an - advanced extension point. You can map arbitrary SQL to your objects - and gain access to vendor specific functionalities using the - ``EntityManager#createNativeQuery()`` API. +It is worth to mention that Doctrine 2 also allows you to handwrite +your SQL instead of extending the DQL parser. Extending DQL is sort of an +advanced extension point. You can map arbitrary SQL to your objects +and gain access to vendor specific functionalities using the +``EntityManager#createNativeQuery()`` API as described in +the :doc:`Native Query <../reference/native-sql>` chapter. The DQL Parser has hooks to register functions that can then be @@ -37,7 +38,7 @@ Registering your own DQL functions You can register your functions adding them to the ORM configuration: -:: +.. code-block:: php p.created diff --git a/cookbook/en/implementing-arrayaccess-for-domain-objects.rst b/en/cookbook/implementing-arrayaccess-for-domain-objects.rst similarity index 96% rename from cookbook/en/implementing-arrayaccess-for-domain-objects.rst rename to en/cookbook/implementing-arrayaccess-for-domain-objects.rst index aeb9a7ada..4eb2b717b 100644 --- a/cookbook/en/implementing-arrayaccess-for-domain-objects.rst +++ b/en/cookbook/implementing-arrayaccess-for-domain-objects.rst @@ -1,6 +1,8 @@ Implementing ArrayAccess for Domain Objects =========================================== +.. sectionauthor:: Roman Borschel (roman@code-factory.org) + This recipe will show you how to implement ArrayAccess for your domain objects in order to allow more uniform access, for example in templates. In these examples we will implement ArrayAccess on a @@ -18,7 +20,7 @@ at runtime. Note that this implementation has 2 main caveats: - It will not work with private fields - It will not go through any getters/setters -:: +.. code-block:: php `_, it is usually not allowed for an entity to implement ``__wakeup`` @@ -15,7 +17,7 @@ Safely implementing \_\_wakeup To safely implement ``__wakeup``, simply enclose your implementation code in an identity check as follows: -:: +.. code-block:: php setMetadataCacheImpl($cache); + $driverImpl = $config->newDefaultAnnotationDriver(array(APPPATH.'models/Entities')); + $config->setMetadataDriverImpl($driverImpl); + $config->setQueryCacheImpl($cache); // Proxy configuration @@ -115,7 +118,7 @@ Now to use it Whenever you need a reference to the entity manager inside one of your controllers, views, or models you can do this: -:: +.. code-block:: php doctrine->em; @@ -126,7 +129,7 @@ EntityManager do your Doctrine 2.0 voodoo as normal. Note: If you do not choose to autoload the Doctrine library, you will need to put this line before you get a reference to it: -:: +.. code-block:: php load->library('doctrine'); diff --git a/cookbook/en/sql-table-prefixes.rst b/en/cookbook/sql-table-prefixes.rst similarity index 98% rename from cookbook/en/sql-table-prefixes.rst rename to en/cookbook/sql-table-prefixes.rst index 8f3ee3809..7e1579286 100644 --- a/cookbook/en/sql-table-prefixes.rst +++ b/en/cookbook/sql-table-prefixes.rst @@ -20,7 +20,7 @@ DoctrineExtensions namespace. You create this file in your library/DoctrineExtensions directory, but will need to set up appropriate autoloaders. -:: +.. code-block:: php + Doctrine 2 does not ship with any internal validators, the reason being that we think all the frameworks out there already ship with quite decent ones that can be integrated into your Domain easily. @@ -26,7 +28,7 @@ Say we have an ``Order`` with several ``OrderLine`` instances. We never want to allow any customer to order for a larger sum than he is allowed to: -:: +.. code-block:: php @@ -95,7 +96,7 @@ Of course you can do any type of primitive checks, not null, email-validation, string size, integer and date ranges in your validation callbacks. -:: +.. code-block:: php `_ - - +Further readings: :doc:`Lifecycle Events <../reference/events>` diff --git a/en/index.rst b/en/index.rst new file mode 100644 index 000000000..877bdc7c3 --- /dev/null +++ b/en/index.rst @@ -0,0 +1,70 @@ +Welcome to Doctrine 2 ORM's documentation! +========================================== + +Reference Guide +--------------- + +.. toctree:: + :maxdepth: 1 + :numbered: + + reference/introduction + reference/architecture + reference/configuration + reference/basic-mapping + reference/association-mapping + reference/inheritance-mapping + reference/working-with-objects + reference/working-with-associations + reference/transactions-and-concurrency + reference/events + reference/batch-processing + reference/dql-doctrine-query-language + reference/query-builder + reference/native-sql + reference/change-tracking-policies + reference/partial-objects + reference/xml-mapping + reference/yaml-mapping + reference/annotations-reference + reference/php-mapping + reference/caching + reference/improving-performance + reference/best-practices + reference/tools + reference/metadata-drivers + reference/best-practices + reference/limitations-and-known-issues + +Tutorials +--------- + +.. toctree:: + :maxdepth: 1 + + tutorials/getting-started-xml-edition + +Cookbook +-------- + +.. toctree:: + :maxdepth: 1 + + cookbook/aggregate-fields + cookbook/dql-custom-walkers + cookbook/dql-user-defined-functions + cookbook/implementing-arrayaccess-for-domain-objects + cookbook/implementing-the-notify-changetracking-policy + cookbook/implementing-wakeup-or-clone + cookbook/integrating-with-codeigniter + cookbook/sql-table-prefixes + cookbook/strategy-cookbook-introduction + cookbook/validation-of-entities + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/manual/en/make.bat b/en/make.bat similarity index 100% rename from manual/en/make.bat rename to en/make.bat diff --git a/manual/en/annotations-reference.rst b/en/reference/annotations-reference.rst similarity index 82% rename from manual/en/annotations-reference.rst rename to en/reference/annotations-reference.rst index 3b5cefddd..8795ed1a6 100644 --- a/manual/en/annotations-reference.rst +++ b/en/reference/annotations-reference.rst @@ -8,39 +8,41 @@ Index ----- -- `@Column <#ann_column>`_ -- `@ChangeTrackingPolicy <#ann_changetrackingpolicy>`_ -- `@DiscriminatorColumn <#ann_discriminatorcolumn>`_ -- `@DiscriminatorMap <#ann_discriminatormap>`_ -- `@Entity <#ann_entity>`_ -- `@GeneratedValue <#ann_generatedvalue>`_ -- `@HasLifecycleCallbacks <#ann_haslifecyclecallbacks>`_ -- `@Index <#ann_indexes>`_ -- `@Id <#ann_id>`_ -- `@InheritanceType <#ann_inheritancetype>`_ -- `@JoinColumn <#ann_joincolumn>`_ -- `@JoinTable <#ann_jointable>`_ -- `@ManyToOne <#ann_manytoone>`_ -- `@ManyToMany <#ann_manytomany>`_ -- `@MappedSuperclass <#ann_mappedsuperclass>`_ -- `@OneToOne <#ann_onetoone>`_ -- `@OneToMany <#ann_onetomany>`_ -- `@OrderBy <#ann_orderby>`_ -- `@PostLoad <#ann_postload>`_ -- `@PostPersist <#ann_postpersist>`_ -- `@PostRemove <#ann_postremove>`_ -- `@PostUpdate <#ann_postupdate>`_ -- `@PrePersist <#ann_prepersist>`_ -- `@PreRemove <#ann_preremove>`_ -- `@PreUpdate <#ann_preupdate>`_ -- `@SequenceGenerator <#ann_sequencegenerator>`_ -- `@Table <#ann_table>`_ -- `@UniqueConstraint <#ann_uniqueconstraint>`_ -- `@Version <#ann_version>`_ +- :ref:`@Column ` +- :ref:`@ChangeTrackingPolicy ` +- :ref:`@DiscriminatorColumn ` +- :ref:`@DiscriminatorMap ` +- :ref:`@Entity ` +- :ref:`@GeneratedValue ` +- :ref:`@HasLifecycleCallbacks ` +- :ref:`@Index ` +- :ref:`@Id ` +- :ref:`@InheritanceType ` +- :ref:`@JoinColumn ` +- :ref:`@JoinTable ` +- :ref:`@ManyToOne ` +- :ref:`@ManyToMany ` +- :ref:`@MappedSuperclass ` +- :ref:`@OneToOne ` +- :ref:`@OneToMany ` +- :ref:`@OrderBy ` +- :ref:`@PostLoad ` +- :ref:`@PostPersist ` +- :ref:`@PostRemove ` +- :ref:`@PostUpdate ` +- :ref:`@PrePersist ` +- :ref:`@PreRemove ` +- :ref:`@PreUpdate ` +- :ref:`@SequenceGenerator ` +- :ref:`@Table ` +- :ref:`@UniqueConstraint ` +- :ref:`@Version ` Reference --------- +.. _annref_column: + @Column ~~~~~~~ @@ -79,11 +81,11 @@ Optional attributes: attribute still handles the conversion between PHP and Database values. If you use this attribute on a column that is used for joins between tables you should also take a look at - `@JoinColumn <#ann_joincolumn>`_. + :ref:`@JoinColumn `. Examples: -:: +.. code-block:: php `_ +The :doc:`details on all the available change tracking policies ` can be found in the configuration section. Example: -:: +.. code-block:: php `_. This +instance variable which is annotated by :ref:`@Id `. This annotation is optional and only has meaning when used in conjunction with @Id. @@ -220,7 +231,7 @@ Required attributes: Example: -:: +.. code-block:: php `_ annotation on +Annotation is used inside the :ref:`@Table ` annotation on the entity-class level. It allows to hint the SchemaTool to generate a database index on the specified table columns. It only has meaning in the SchemaTool schema generation context. @@ -273,7 +288,7 @@ Required attributes: Example: -:: +.. code-block:: php `_ and -`@DiscriminatorColumn <#ann_discriminatorcolumn>`_ annotations. +:ref:`@DiscriminatorMap ` and +:ref:`@DiscriminatorColumn ` annotations. Examples: -:: +.. code-block:: php `_, `@OneToOne <#ann_onetoone>`_ fields -and in the Context of `@JoinTable <#ann_jointable>`_ nested inside +:ref:`@ManyToOne `, :ref:`@OneToOne ` fields +and in the Context of :ref:`@JoinTable ` nested inside a @ManyToMany. This annotation is not required. If its not specified the attributes *name* and *referencedColumnName* are inferred from the table and primary key names. @@ -378,13 +399,13 @@ Optional attributes: this attribute on @JoinColumn is necessary if you need slightly different column definitions for joining columns, for example regarding NULL/NOT NULL defaults. However by default a - "columnDefinition" attribute on `@Column <#ann_column>`_ also sets + "columnDefinition" attribute on :ref:`@Column ` also sets the related @JoinColumn's columnDefinition. This is necessary to make foreign keys work. Example: -:: +.. code-block:: php `_ or `@OneToOne <#ann_onetoone>`_ +:ref:`@ManyToOne ` or :ref:`@OneToOne ` relation with an entity that has multiple identifiers. +.. _annref_jointable: + @JoinTable ~~~~~~~~~~~~~~ -Using `@OneToMany <#ann_onetomany>`_ or -`@ManyToMany <#ann_manytomany>`_ on the owning side of the relation +Using :ref:`@OneToMany ` or +:ref:`@ManyToMany ` on the owning side of the relation requires to specify the @JoinTable annotation which describes the details of the database join table. If you do not specify @JoinTable on these relations reasonable mapping defaults apply @@ -427,7 +452,7 @@ Optional attributes: Example: -:: +.. code-block:: php `_ is an +between two entities. :ref:`@JoinTable ` is an additional, optional annotation that has reasonable default configuration values using the table and names of the two related entities. @@ -505,7 +534,7 @@ Optional attributes: Example: -:: +.. code-block:: php `_. +:doc:`more details on the restrictions of mapped superclasses `. + +.. _annref_onetoone: @OneToOne ~~~~~~~~~~~~~~ The @OneToOne annotation works almost exactly as the -`@ManyToOne <#ann_manytoone>`_ with one additional option that can +:ref:`@ManyToOne ` with one additional option that can be specified. The configuration defaults for -`@JoinColumn <#ann_joincolumn>`_ using the target entity table and +:ref:`@JoinColumn ` using the target entity table and primary key column names apply here too. Required attributes: @@ -567,7 +600,7 @@ Optional attributes: Example: -:: +.. code-block:: php `_ or `@OneToMany <#ann_onetomany>`_ +:ref:`@ManyToMany ` or :ref:`@OneToMany ` annotation to specify by which criteria the collection should be retrieved from the database by using an ORDER BY clause. @@ -620,7 +657,7 @@ snippet: Example: -:: +.. code-block:: php `_ annotation on +Annotation is used inside the :ref:`@Table ` annotation on the entity-class level. It allows to hint the SchemaTool to generate a database unique constraint on the specified table columns. It only has meaning in the SchemaTool schema generation @@ -769,7 +826,7 @@ Required attributes: Example: -:: +.. code-block:: php `_ annotations that have the type integer or -datetime. +:ref:`@Column ` annotations that have the type integer or +datetime. Combining @Version with :ref:`@Id ` is not supported. Example: -:: +.. code-block:: php find('Group', $groupId); @@ -266,13 +268,13 @@ associations are correctly defined. You can either use the Doctrine Command Line Tool: -:: +.. code-block:: php doctrine orm:validate-schema Or you can trigger the validation manually: -:: +.. code-block:: php use Doctrine\ORM\Tools\SchemaValidator; @@ -304,7 +306,7 @@ example of a ``Product`` that has one ``Shipping`` object associated to it. The ``Shipping`` side does not reference back to the ``Product`` so it is unidirectional. -:: +.. code-block:: php 10 However the following: diff --git a/manual/en/basic-mapping.rst b/en/reference/basic-mapping.rst similarity index 96% rename from manual/en/basic-mapping.rst rename to en/reference/basic-mapping.rst index 506337092..95a1d8c4d 100644 --- a/manual/en/basic-mapping.rst +++ b/en/reference/basic-mapping.rst @@ -23,7 +23,8 @@ chapters for XML and YAML mapping, respectively. .. note:: If you're wondering which mapping driver gives the best - performance, the answer is: None. Once the metadata of a class has + performance, the answer is: They all give exactly the same performance. + Once the metadata of a class has been read from the source (annotations, xml or yaml) it is stored in an instance of the ``Doctrine\ORM\Mapping\ClassMetadata`` class and these instances are stored in the metadata cache. Therefore at @@ -68,7 +69,7 @@ In order to mark a class for object-relational persistence it needs to be designated as an entity. This can be done through the ``@Entity`` marker annotation. -:: +.. code-block:: php getConnection(); @@ -327,7 +324,7 @@ Every entity class needs an identifier/primary key. You designate the field that serves as the identifier with the ``@Id`` marker annotation. Here is an example: -:: +.. code-block:: php createQuery('update MyProject\Model\Manager m set m.salary = m.salary * 0.9'); @@ -69,7 +69,7 @@ by step instead of loading the whole result into memory at once. The following example shows how to do this, combining the iteration with the batching strategy that was already used for bulk inserts: -:: +.. code-block:: php createQuery('delete from MyProject\Model\Manager m where m.salary > 100000'); @@ -121,7 +123,7 @@ An alternative solution for bulk deletes is to use the by step instead of loading the whole result into memory at once. The following example shows how to do this: -:: +.. code-block:: php iterate()`` implements the Iterator interface so you can process a large result without memory problems using the following approach: -:: +.. code-block:: php _em->createQuery('select u from MyProject\Model\User u'); @@ -163,7 +167,9 @@ problems using the following approach: $this->_em->detach($row[0]); } - **NOTE** Iterating results is not possible with queries that +.. note:: + + Iterating results is not possible with queries that fetch-join a collection-valued association. The nature of such SQL result sets is not suitable for incremental hydration. diff --git a/manual/en/best-practices.rst b/en/reference/best-practices.rst similarity index 99% rename from manual/en/best-practices.rst rename to en/reference/best-practices.rst index 28709666f..f58291d18 100644 --- a/manual/en/best-practices.rst +++ b/en/reference/best-practices.rst @@ -85,7 +85,7 @@ Initialize collections in the constructor It is recommended best practice to initialize any business collections in entities in the constructor. Example: -:: +.. code-block:: php `_ on the PHP website. It will give +`in the PHP Documentation `_. It will give you a little background information about what it is and how you can use it as well as how to install it. Below is a simple example of how you could use the APC cache driver by itself. -:: +.. code-block:: php `_ on the PHP website. It will +` on the PHP website `_. It will give you a little background information about what it is and how you can use it as well as how to install it. Below is a simple example of how you could use the Memcache cache driver by itself. -:: +.. code-block:: php save('cache_id', 'my_data'); @@ -136,7 +136,7 @@ below. You can save any type of data whether it be a string, array, object, etc. -:: +.. code-block:: php contains('cache_id')) { @@ -168,7 +168,7 @@ Now if you want to retrieve some cache entry you can use the ``fetch()`` method. It also accepts a single argument just like ``contains()`` which is the ID of the cache entry. -:: +.. code-block:: php fetch('my_array'); @@ -184,7 +184,7 @@ you can delete all entries. By Cache ID ^^^^^^^^^^^ -:: +.. code-block:: php delete('my_array'); @@ -192,7 +192,7 @@ By Cache ID You can also pass wild cards to the ``delete()`` method and it will return an array of IDs that were matched and deleted. -:: +.. code-block:: php delete('users_*'); @@ -203,7 +203,7 @@ By Regular Expression If you need a little more control than wild cards you can use a PHP regular expression to delete cache entries. -:: +.. code-block:: php deleteByRegex('/users_.*/'); @@ -216,7 +216,7 @@ a prefix or suffix is sufficient, it is recommended that you do that instead of using a regular expression because it will be much faster if you have many cache entries. -:: +.. code-block:: php deleteByPrefix('users_'); @@ -227,7 +227,7 @@ By Suffix Just like we did above with the prefix you can do the same with a suffix. -:: +.. code-block:: php deleteBySuffix('_my_account'); @@ -238,7 +238,7 @@ All If you simply want to delete all cache entries you can do so with the ``deleteAll()`` method. -:: +.. code-block:: php deleteAll(); @@ -249,12 +249,14 @@ Counting If you want to count how many entries are stored in the cache driver instance you can use the ``count()`` method. -:: +.. code-block:: php count(); - **NOTE** In order to use ``deleteByRegex()``, ``deleteByPrefix()``, +.. note:: + + In order to use ``deleteByRegex()``, ``deleteByPrefix()``, ``deleteBySuffix()``, ``deleteAll()``, ``count()`` or ``getIds()`` you must enable an option for the cache driver to manage your cache IDs internally. This is necessary because APC, Memcache, etc. don't @@ -279,7 +281,7 @@ naming collisions. This can be worked around by using namespaces. You can set the namespace a cache driver should use by using the ``setNamespace()`` method. -:: +.. code-block:: php setNamespace('my_namespace_'); @@ -303,7 +305,7 @@ change unless you alter the DQL query. This can be done by configuring the query cache implementation to use on your ORM configuration. -:: +.. code-block:: php setResultCacheImpl(new \Doctrine\Common\Cache\ApcCache()); @@ -325,7 +327,7 @@ cache implementation. Now when you're executing DQL queries you can configure them to use the result cache. -:: +.. code-block:: php createQuery('select u from \Entities\User u'); @@ -334,12 +336,14 @@ the result cache. You can also configure an individual query to use a different result cache driver. -:: +.. code-block:: php setResultCacheDriver(new \Doctrine\Common\Cache\ApcCache()); - **NOTE** Setting the result cache driver on the query will +.. note:: + + Setting the result cache driver on the query will automatically enable the result cache for the query. If you want to disable it pass false to ``useResultCache()``. @@ -352,7 +356,7 @@ result cache driver. If you want to set the time the cache has to live you can use the ``setResultCacheLifetime()`` method. -:: +.. code-block:: php setResultCacheLifetime(3600); @@ -361,7 +365,7 @@ The ID used to store the result set cache is a hash which is automatically generated for you if you don't set a custom ID yourself with the ``setResultCacheId()`` method. -:: +.. code-block:: php setResultCacheId('my_custom_id'); @@ -369,7 +373,7 @@ yourself with the ``setResultCacheId()`` method. You can also set the lifetime and cache ID by passing the values as the second and third argument to ``useResultCache()``. -:: +.. code-block:: php useResultCache(true, 3600, 'my_custom_id'); @@ -384,7 +388,7 @@ each request we should cache it using one of the cache drivers. Just like the query and result cache we need to configure it first. -:: +.. code-block:: php setMetadataCacheImpl(new \Doctrine\Common\Cache\ApcCache()); @@ -402,7 +406,7 @@ clearing the query, result and metadata cache. From the Doctrine command line you can run the following command. -:: +.. code-block:: php $ ./doctrine clear-cache @@ -412,19 +416,19 @@ what you clear you can use the following options. To clear the query cache use the ``--query`` option. -:: +.. code-block:: php $ ./doctrine clear-cache --query To clear the metadata cache use the ``--metadata`` option. -:: +.. code-block:: php $ ./doctrine clear-cache --metadata To clear the result cache use the ``--result`` option. -:: +.. code-block:: php $ ./doctrine clear-cache --result @@ -435,29 +439,31 @@ clear. Just like the API of the cache drivers you can clear based on an ID, regular expression, prefix or suffix. -:: +.. code-block:: php $ ./doctrine clear-cache --result --id=cache_id Or if you want to clear based on a regular expressions. -:: +.. code-block:: php $ ./doctrine clear-cache --result --regex=users_.* Or with a prefix. -:: +.. code-block:: php $ ./doctrine clear-cache --result --prefix=users_ And finally with a suffix. -:: +.. code-block:: php $ ./doctrine clear-cache --result --suffix=_my_account - **NOTE** Using the ``--id``, ``--regex``, etc. options with the +.. note:: + + Using the ``--id``, ``--regex``, etc. options with the ``--query`` and ``--metadata`` are not allowed as it is not necessary to be specific about what you clear. You only ever need to completely clear the cache to remove stale entries. @@ -477,6 +483,6 @@ Ways exist to work around this, like pre-populating your cache and not letting your users requests populate the cache. You can read more about cache slams -`here `_. +`in this blog post `_. diff --git a/manual/en/change-tracking-policies.rst b/en/reference/change-tracking-policies.rst similarity index 98% rename from manual/en/change-tracking-policies.rst rename to en/reference/change-tracking-policies.rst index 25f32d051..7bd884910 100644 --- a/manual/en/change-tracking-policies.rst +++ b/en/reference/change-tracking-policies.rst @@ -46,7 +46,7 @@ them to EntityManager#persist(). This policy can be configured as follows: -:: +.. code-block:: php setProxyDir($dir); @@ -181,7 +185,7 @@ down. Proxy Namespace (***REQUIRED***) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php setProxyNamespace($namespace); @@ -194,7 +198,7 @@ Doctrine, refer to the "Proxy Objects" section further down. Metadata Driver (***REQUIRED***) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php setMetadataDriverImpl($driver); @@ -220,7 +224,7 @@ or YamlDriver please refer to the dedicated chapters The annotation driver can be configured with a factory method on the ``Doctrine\ORM\Configuration``: -:: +.. code-block:: php newDefaultAnnotationDriver('/path/to/lib/MyProject/Entities'); @@ -236,7 +240,7 @@ directories of Entities. Metadata Cache (***RECOMMENDED***) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php setMetadataCacheImpl($cache); @@ -265,7 +269,7 @@ per-request basis. Query Cache (***RECOMMENDED***) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php setQueryCacheImpl($cache); @@ -295,7 +299,7 @@ per-request basis. SQL Logger (***Optional***) ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php setSQLLogger($logger); @@ -311,7 +315,7 @@ implementation that logs to the standard output using ``echo`` and Auto-generating Proxy Classes (***OPTIONAL***) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php setAutoGenerateProxyClasses($bool); @@ -385,7 +389,7 @@ useful, for example, as a performance enhancement, when you want to establish an association to an entity for which you have the identifier. You could simply do this: -:: +.. code-block:: php setAutoGenerateProxyClasses($bool); @@ -444,7 +448,7 @@ added to the entity class that are not yet in the proxy class. In such a case, simply use the Doctrine Console to (re)generate the proxy classes like so: -:: +.. code-block:: php $ ./doctrine orm:generate-proxies @@ -456,7 +460,7 @@ with them using two different metadata drivers, for example XML and YAML. You can use the DriverChain Metadata implementations to aggregate these drivers based on namespaces: -:: +.. code-block:: php 20: -:: +.. code-block:: php createQuery('SELECT u FROM MyProject\Model\User u WHERE u.age > 20'); @@ -115,7 +116,7 @@ Example: Regular join of the address: -:: +.. code-block:: php createQuery("SELECT u FROM User u JOIN u.address a WHERE a.city = 'Berlin'"); @@ -123,7 +124,7 @@ Regular join of the address: Fetch join of the address: -:: +.. code-block:: php createQuery("SELECT u, a FROM User u JOIN u.address a WHERE a.city = 'Berlin'"); @@ -165,7 +166,7 @@ on the hydration mode. Hydrate all User entities: -:: +.. code-block:: php createQuery('SELECT u FROM MyProject\Model\User u'); @@ -173,7 +174,7 @@ Hydrate all User entities: Retrieve the IDs of all CmsUsers: -:: +.. code-block:: php createQuery('SELECT u.id FROM CmsUser u'); @@ -181,7 +182,7 @@ Retrieve the IDs of all CmsUsers: Retrieve the IDs of all users that have written an article: -:: +.. code-block:: php createQuery('SELECT DISTINCT u.id FROM CmsArticle a JOIN a.user u'); @@ -190,7 +191,7 @@ Retrieve the IDs of all users that have written an article: Retrieve all articles and sort them by the name of the articles users instance: -:: +.. code-block:: php createQuery('SELECT a FROM CmsArticle a JOIN a.user u ORDER BY u.name ASC'); @@ -198,7 +199,7 @@ users instance: Retrieve the Username and Name of a CmsUser: -:: +.. code-block:: php createQuery('SELECT u.username, u.name FROM CmsUser u'); @@ -207,7 +208,7 @@ Retrieve the Username and Name of a CmsUser: Retrieve a ForumUser and his single associated entity: -:: +.. code-block:: php createQuery('SELECT u, a FROM ForumUser u JOIN u.avatar a'); @@ -216,7 +217,7 @@ Retrieve a ForumUser and his single associated entity: Retrieve a CmsUser and fetch join all the phonenumbers he has: -:: +.. code-block:: php createQuery('SELECT u, p FROM CmsUser u JOIN u.phonenumbers p'); @@ -225,7 +226,7 @@ Retrieve a CmsUser and fetch join all the phonenumbers he has: Hydrate a result in Ascending: -:: +.. code-block:: php createQuery('SELECT u FROM ForumUser u ORDER BY u.id ASC'); @@ -233,7 +234,7 @@ Hydrate a result in Ascending: Or in Descending Order: -:: +.. code-block:: php createQuery('SELECT u FROM ForumUser u ORDER BY u.id DESC'); @@ -241,7 +242,7 @@ Or in Descending Order: Using Aggregate Functions: -:: +.. code-block:: php createQuery('SELECT COUNT(u.id) FROM Entities\User u'); @@ -249,7 +250,7 @@ Using Aggregate Functions: With WHERE Clause and Positional Parameter: -:: +.. code-block:: php createQuery('SELECT u FROM ForumUser u WHERE u.id = ?1'); @@ -257,7 +258,7 @@ With WHERE Clause and Positional Parameter: With WHERE Clause and Named Parameter: -:: +.. code-block:: php createQuery('SELECT u FROM ForumUser u WHERE u.username = :name'); @@ -265,7 +266,7 @@ With WHERE Clause and Named Parameter: With Nested Conditions in WHERE Clause: -:: +.. code-block:: php createQuery('SELECT u from ForumUser u WHERE (u.username = :name OR u.username = :name2) AND u.id = :id'); @@ -273,7 +274,7 @@ With Nested Conditions in WHERE Clause: With COUNT DISTINCT: -:: +.. code-block:: php createQuery('SELECT COUNT(DISTINCT u.name) FROM CmsUser'); @@ -281,7 +282,7 @@ With COUNT DISTINCT: With Arithmetic Expression in WHERE clause: -:: +.. code-block:: php createQuery('SELECT u FROM CmsUser u WHERE ((u.id + 5000) * u.id + 3) < 10000000'); @@ -290,7 +291,7 @@ With Arithmetic Expression in WHERE clause: Using a LEFT JOIN to hydrate all user-ids and optionally associated article-ids: -:: +.. code-block:: php createQuery('SELECT u.id, a.id as article_id FROM CmsUser u LEFT JOIN u.articles a'); @@ -298,7 +299,7 @@ article-ids: Restricting a JOIN clause by additional conditions: -:: +.. code-block:: php createQuery("SELECT u FROM CmsUser u LEFT JOIN u.articles a WITH a.topic LIKE '%foo%'"); @@ -306,7 +307,7 @@ Restricting a JOIN clause by additional conditions: Using several Fetch JOINs: -:: +.. code-block:: php createQuery('SELECT u, a, p, c FROM CmsUser u JOIN u.articles a JOIN u.phonenumbers p JOIN a.comments c'); @@ -314,7 +315,7 @@ Using several Fetch JOINs: BETWEEN in WHERE clause: -:: +.. code-block:: php createQuery('SELECT u.name FROM CmsUser u WHERE u.id BETWEEN ?1 AND ?2'); @@ -322,7 +323,7 @@ BETWEEN in WHERE clause: DQL Functions in WHERE clause: -:: +.. code-block:: php createQuery("SELECT u.name FROM CmsUser u WHERE TRIM(u.name) = 'someone'"); @@ -330,7 +331,7 @@ DQL Functions in WHERE clause: IN() Expression: -:: +.. code-block:: php createQuery('SELECT u.name FROM CmsUser u WHERE u.id IN(46)'); @@ -344,7 +345,7 @@ IN() Expression: CONCAT() DQL Function: -:: +.. code-block:: php createQuery("SELECT u.id FROM CmsUser u WHERE CONCAT(u.name, 's') = ?1"); @@ -355,7 +356,7 @@ CONCAT() DQL Function: EXISTS in WHERE clause with correlated Subquery -:: +.. code-block:: php createQuery('SELECT u.id FROM CmsUser u WHERE EXISTS (SELECT p.phonenumber FROM CmsPhonenumber p WHERE p.user = u.id)'); @@ -363,7 +364,7 @@ EXISTS in WHERE clause with correlated Subquery Get all users who are members of $group. -:: +.. code-block:: php createQuery('SELECT u.id FROM CmsUser u WHERE :groupId MEMBER OF u.groups'); @@ -372,7 +373,7 @@ Get all users who are members of $group. Get all users that have more than 1 phonenumber -:: +.. code-block:: php createQuery('SELECT u FROM CmsUser u WHERE SIZE(u.phonenumbers) > 1'); @@ -380,7 +381,7 @@ Get all users that have more than 1 phonenumber Get all users that have no phonenumber -:: +.. code-block:: php createQuery('SELECT u FROM CmsUser u WHERE u.phonenumbers IS EMPTY'); @@ -389,7 +390,7 @@ Get all users that have no phonenumber Get all instances of a specific type, for use with inheritance hierarchies: -:: +.. code-block:: php createQuery('SELECT u FROM Doctrine\Tests\Models\Company\CompanyPerson u WHERE u INSTANCE OF Doctrine\Tests\Models\Company\CompanyEmployee'); @@ -408,7 +409,7 @@ and joining some data. If you want to select partial objects you can use the ``partial`` DQL keyword: -:: +.. code-block:: php createQuery('SELECT partial u.{id, username} FROM CmsUser u'); @@ -416,7 +417,7 @@ DQL keyword: You use the partial syntax when joining as well: -:: +.. code-block:: php createQuery('SELECT partial u.{id, username}, partial a.{id, name} FROM CmsUser u JOIN u.articles a'); @@ -441,7 +442,7 @@ with primary or unique fields though: Returns an array of the following kind, indexed by both user-id then phonenumber-id: -:: +.. code-block:: php array 0 => @@ -543,7 +544,7 @@ Arithmetic operators You can do math in DQL using numeric values, for example: -.. warning:: +.. code-block:: sql SELECT person.salary * 1.5 FROM CompanyPerson person WHERE person.salary < 100000 @@ -582,7 +583,7 @@ parser with own specialized platform functions. You can register custom DQL functions in your ORM Configuration: -:: +.. code-block:: php Object @@ -873,7 +876,7 @@ A pure result usually looks like this: A mixed result on the other hand has the following general structure: -:: +.. code-block:: php array array @@ -900,7 +903,7 @@ clause, we get a mixed result. Here is how the result could look like: -:: +.. code-block:: php array array @@ -913,7 +916,7 @@ Here is how the result could look like: And here is how you would access it in PHP code: -:: +.. code-block:: php createQuery('SELECT u FROM CmsUser u'); @@ -956,7 +959,7 @@ Array Hydration You can run the same query with array hydration and the result set is hydrated into an array that represents the object graph: -:: +.. code-block:: php createQuery('SELECT u FROM CmsUser u'); @@ -964,7 +967,7 @@ is hydrated into an array that represents the object graph: You can use the ``getArrayResult()`` shortcut as well: -:: +.. code-block:: php getArrayResult(); @@ -975,7 +978,7 @@ Scalar Hydration If you want to return a flat rectangular result set instead of an object graph you can use scalar hydration: -:: +.. code-block:: php createQuery('SELECT u FROM CmsUser u'); @@ -996,7 +999,7 @@ Single Scalar Hydration If you a query which returns just a single scalar value you can use single scalar hydration: -:: +.. code-block:: php createQuery('SELECT COUNT(a.id) FROM CmsUser u LEFT JOIN u.articles a WHERE u.username = ?1 GROUP BY u.id'); @@ -1005,7 +1008,7 @@ single scalar hydration: You can use the ``getSingleScalarResult()`` shortcut as well: -:: +.. code-block:: php getSingleScalarResult(); @@ -1016,7 +1019,7 @@ Custom Hydration Modes You can easily add your own custom hydration modes by first creating a class which extends ``AbstractHydrator``: -:: +.. code-block:: php getConfiguration()->addCustomHydrationMode('CustomHydrator', 'MyProject\Hydrators\CustomHydrator'); Now the hydrator is ready to be used in your queries: -:: +.. code-block:: php createQuery('SELECT u FROM CmsUser u'); @@ -1087,7 +1090,7 @@ cached at all. You have to enable the result cache on a per query basis. The following example shows a complete workflow using the Result Cache API: -:: +.. code-block:: php createQuery('SELECT u FROM MyProject\Model\User u WHERE u.id = ?1'); @@ -1229,14 +1232,14 @@ Terminals Query Language ~~~~~~~~~~~~~~ -:: +.. code-block:: php QueryLanguage ::= SelectStatement | UpdateStatement | DeleteStatement Statements ~~~~~~~~~~ -:: +.. code-block:: php SelectStatement ::= SelectClause FromClause [WhereClause] [GroupByClause] [HavingClause] [OrderByClause] UpdateStatement ::= UpdateClause [WhereClause] @@ -1245,7 +1248,7 @@ Statements Identifiers ~~~~~~~~~~~ -:: +.. code-block:: php /* Alias Identification usage (the "u" of "u.name") */ IdentificationVariable ::= identifier @@ -1282,7 +1285,7 @@ Identifiers Path Expressions ~~~~~~~~~~~~~~~~ -:: +.. code-block:: php /* "u.Group" or "u.Phonenumbers" declarations */ JoinAssociationPathExpression ::= IdentificationVariable "." (CollectionValuedAssociationField | SingleValuedAssociationField) @@ -1311,7 +1314,7 @@ Path Expressions Clauses ~~~~~~~ -:: +.. code-block:: php SelectClause ::= "SELECT" ["DISTINCT"] SelectExpression {"," SelectExpression}* SimpleSelectClause ::= "SELECT" ["DISTINCT"] SimpleSelectExpression @@ -1328,7 +1331,7 @@ Clauses Items ~~~~~ -:: +.. code-block:: php UpdateItem ::= IdentificationVariable "." (StateField | SingleValuedAssociationField) "=" NewValue OrderByItem ::= (ResultVariable | StateFieldPathExpression) ["ASC" | "DESC"] @@ -1338,7 +1341,7 @@ Items From, Join and Index by ~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php IdentificationVariableDeclaration ::= RangeVariableDeclaration [IndexBy] {JoinVariableDeclaration}* SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration | (AssociationPathExpression ["AS"] AliasIdentificationVariable) @@ -1351,7 +1354,7 @@ From, Join and Index by Select Expressions ~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php SelectExpression ::= IdentificationVariable | PartialObjectExpression | (AggregateExpression | "(" Subselect ")" | FunctionDeclaration | ScalarExpression) [["AS"] AliasResultVariable] SimpleSelectExpression ::= ScalarExpression | IdentificationVariable | @@ -1362,7 +1365,7 @@ Select Expressions Conditional Expressions ~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php ConditionalExpression ::= ConditionalTerm {"OR" ConditionalTerm}* ConditionalTerm ::= ConditionalFactor {"AND" ConditionalFactor}* @@ -1375,7 +1378,7 @@ Conditional Expressions Collection Expressions ~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php EmptyCollectionComparisonExpression ::= CollectionValuedPathExpression "IS" ["NOT"] "EMPTY" CollectionMemberExpression ::= EntityExpression ["NOT"] "MEMBER" ["OF"] CollectionValuedPathExpression @@ -1383,7 +1386,7 @@ Collection Expressions Literal Values ~~~~~~~~~~~~~~ -:: +.. code-block:: php Literal ::= string | char | integer | float | boolean InParameter ::= Literal | InputParameter @@ -1391,7 +1394,7 @@ Literal Values Input Parameter ~~~~~~~~~~~~~~~ -:: +.. code-block:: php InputParameter ::= PositionalParameter | NamedParameter PositionalParameter ::= "?" integer @@ -1400,7 +1403,7 @@ Input Parameter Arithmetic Expressions ~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php ArithmeticExpression ::= SimpleArithmeticExpression | "(" Subselect ")" SimpleArithmeticExpression ::= ArithmeticTerm {("+" | "-") ArithmeticTerm}* @@ -1413,7 +1416,7 @@ Arithmetic Expressions Scalar and Type Expressions ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php ScalarExpression ::= SimpleArithmeticExpression | StringPrimary | DateTimePrimary | StateFieldPathExpression BooleanPrimary | CaseExpression | EntityTypeExpression @@ -1440,7 +1443,7 @@ Scalar and Type Expressions Aggregate Expressions ~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: php AggregateExpression ::= ("AVG" | "MAX" | "MIN" | "SUM") "(" ["DISTINCT"] StateFieldPathExpression ")" | "COUNT" "(" ["DISTINCT"] (IdentificationVariable | SingleValuedPathExpression) ")" @@ -1450,7 +1453,7 @@ Other Expressions QUANTIFIED/BETWEEN/COMPARISON/LIKE/NULL/EXISTS -:: +.. code-block:: php QuantifiedExpression ::= ("ALL" | "ANY" | "SOME") "(" Subselect ")" BetweenExpression ::= ArithmeticExpression ["NOT"] "BETWEEN" ArithmeticExpression "AND" ArithmeticExpression @@ -1464,7 +1467,7 @@ QUANTIFIED/BETWEEN/COMPARISON/LIKE/NULL/EXISTS Functions ~~~~~~~~~ -:: +.. code-block:: php FunctionDeclaration ::= FunctionsReturningStrings | FunctionsReturningNumerics | FunctionsReturningDateTime diff --git a/manual/en/events.rst b/en/reference/events.rst similarity index 98% rename from manual/en/events.rst rename to en/reference/events.rst index ebdeee81b..836980d41 100644 --- a/manual/en/events.rst +++ b/en/reference/events.rst @@ -12,7 +12,7 @@ central point of Doctrine's event listener system. Listeners are registered on the manager and events are dispatched through the manager. -:: +.. code-block:: php dispatchEvent(EventTest::preFoo); @@ -63,7 +63,7 @@ Events can be dispatched by using the ``dispatchEvent()`` method. You can easily remove a listener with the ``removeEventListener()`` method. -:: +.. code-block:: php removeEventListener(array(self::preFoo, self::postFoo), $this); @@ -74,7 +74,7 @@ which implements the ``\Doctrine\Common\EventSubscriber`` interface and implements a ``getSubscribedEvents()`` method which returns an array of events it should be subscribed to. -:: +.. code-block:: php dispatchEvent(TestEvent::preFoo); @@ -106,7 +106,7 @@ notified for that event. Now you can test the ``$eventSubscriber`` instance to see if the ``preFoo()`` method was invoked. -:: +.. code-block:: php preFooInvoked) { @@ -178,7 +178,7 @@ the life-time of their registered entities. You can access the Event constants from the ``Events`` class in the ORM package. -:: +.. code-block:: php getEventManager()->addEventListener(array(Events::preUpdate), MyEventListener()); @@ -436,7 +434,7 @@ To make use of the onFlush event you have to be familiar with the internal UnitOfWork API, which grants you access to the previously mentioned sets. See this example: -:: +.. code-block:: php If you want to use the Doctrine Database Abstraction Layer you can install it with the following command. -:: +.. code-block:: bash $ sudo pear install pear.doctrine-project.org/DoctrineDBAL- Or, if you want to get the works and go for the ORM you can install it with the following command. -:: +.. code-block:: bash $ sudo pear install pear.doctrine-project.org/DoctrineORM- @@ -122,7 +122,7 @@ it with the following command. writing this is ``2.0.0BETA3`` for the ORM, so you could install it like the following: - :: + .. code-block:: bash $ sudo pear install pear.doctrine-project.org/DoctrineORM-2.0.0BETA3 @@ -130,7 +130,7 @@ it with the following command. When you have a package installed via PEAR you can require and load the ``ClassLoader`` with the following code. -:: +.. code-block:: php @@ -394,11 +394,8 @@ Can you **find** the easier way?). 6) Explore Doctrine 2! -See the following links if you want to start with more complex -tutorials rather than reading the manual: - - -- Doctrine2 Cookbook: - `Getting Started XML Edition `_ +Instead of reading through the reference manual we also recommend to look at the tutorials: + +:doc:`Getting Started XML Edition <../tutorials/getting-started-xml-edition>` diff --git a/manual/en/limitations-and-known-issues.rst b/en/reference/limitations-and-known-issues.rst similarity index 99% rename from manual/en/limitations-and-known-issues.rst rename to en/reference/limitations-and-known-issues.rst index 8631c2d7d..dbf5cd7e5 100644 --- a/manual/en/limitations-and-known-issues.rst +++ b/en/reference/limitations-and-known-issues.rst @@ -60,7 +60,7 @@ the fundamental difference between the two different ``product_attributes`` tables you should see how they translate into a Doctrine Mapping (Using Annotations): -:: +.. code-block:: php getConfiguration()->setMetadataCacheImpl(new ApcCache()); @@ -40,7 +42,7 @@ If you want to use one of the included core metadata drivers you just need to configure it. All the drivers are in the ``Doctrine\ORM\Mapping\Driver`` namespace: -:: +.. code-block:: php getMetadataFactory(); @@ -180,7 +184,7 @@ Now you can learn about the entity and use the data stored in the ``ClassMetadata`` instance to get all mapped fields for example and iterate over them: -:: +.. code-block:: php fieldMappings as $fieldMapping) { diff --git a/manual/en/native-sql.rst b/en/reference/native-sql.rst similarity index 98% rename from manual/en/native-sql.rst rename to en/reference/native-sql.rst index 992eefc06..77bd0ad78 100644 --- a/manual/en/native-sql.rst +++ b/en/reference/native-sql.rst @@ -67,7 +67,7 @@ element in the transformed result. You add an entity result through ``ResultSetMapping#addEntityResult()``. Let's take a look at the method signature in detail: -:: +.. code-block:: php User (Object) @@ -269,7 +269,7 @@ assumes User has a unidirectional or bidirectional one-to-one association to a CmsAddress, where the User is the owning side and thus owns the foreign key. -:: +.. code-block:: php createQuery("select partial u.{id,name} from MyApp\Domain\User u"); diff --git a/manual/en/php-mapping.rst b/en/reference/php-mapping.rst similarity index 95% rename from manual/en/php-mapping.rst rename to en/reference/php-mapping.rst index 21fb33fec..6ba0755c3 100644 --- a/manual/en/php-mapping.rst +++ b/en/reference/php-mapping.rst @@ -13,7 +13,7 @@ If you wish to write your mapping information inside PHP files that are named after the entity and included to populate the metadata for an entity you can do so by using the ``PHPDriver``: -:: +.. code-block:: php getMetadataFor('Entities\User'); + $class = $em->getClassMetadata('Entities\User'); + // or + $class = $em->getMetadataFactory()->getMetadataFor('Entities\User'); Static Function --------------- @@ -72,7 +74,7 @@ itself. This is useful for cases where you want to keep your entity and mapping information together but don't want to use annotations. For this you just need to use the ``StaticPHPDriver``: -:: +.. code-block:: php expr()->*`` methods. Here is a converted example 8 to suggested standard way to build queries: -:: +.. code-block:: php addCommand(new \MyProject\Tools\Console\Commands\MyCustomCommand()); @@ -119,7 +119,7 @@ do: Additionally, include multiple commands (and overriding previously defined ones) is possible through the command: -:: +.. code-block:: php addCommands(array( @@ -200,7 +200,7 @@ the ``createSchema()`` method. First create an instance of the that you want to use to create the schema. This method receives an array of ``ClassMetadataInfo`` instances. -:: +.. code-block:: php dropSchema($classes); @@ -222,7 +222,7 @@ model. When you are changing your metadata a lot during development you might want to drop the complete database instead of only the tables of the current model to clean up with orphaned tables. -:: +.. code-block:: php dropSchema($classes, \Doctrine\ORM\Tools\SchemaTool::DROP_DATABASE); @@ -232,7 +232,7 @@ easily with the ``updateSchema()`` method. It will compare your existing database schema to the passed array of ``ClassMetdataInfo`` instances. -:: +.. code-block:: php updateSchema($classes); @@ -242,20 +242,20 @@ use the ``schema-tool`` command. To create the schema use the ``create`` command: -:: +.. code-block:: php $ php doctrine orm:schema-tool:create To drop the schema use the ``drop`` command: -:: +.. code-block:: php $ php doctrine orm:schema-tool:drop If you want to drop and then recreate the schema then use both options: -:: +.. code-block:: php $ php doctrine orm:schema-tool:drop $ php doctrine orm:schema-tool:create @@ -263,14 +263,14 @@ options: As you would think, if you want to update your schema use the ``update`` command: -:: +.. code-block:: php $ php doctrine orm:schema-tool:update All of the above commands also accept a ``--dump-sql`` option that will output the SQL for the ran operation. -:: +.. code-block:: php $ php doctrine orm:schema-tool:create --dump-sql @@ -294,7 +294,7 @@ To convert some mapping information between the various supported formats you can use the ``ClassMetadataExporter`` to get exporter instances for the different formats: -:: +.. code-block:: php getExporter('yml', '/path/to/export/yml'); Now you can export some ``ClassMetadata`` instances: -:: +.. code-block:: php getConfiguration()->setMetadataDriverImpl( @@ -353,7 +353,7 @@ First you need to retrieve the metadata instances with the Now you can get an exporter instance and export the loaded metadata to yml: -:: +.. code-block:: php getExporter('yml', '/path/to/export/yml'); @@ -363,11 +363,11 @@ to yml: You can also reverse engineer a database using the ``orm:convert-mapping`` command: -:: +.. code-block:: php $ php doctrine orm:convert-mapping --from-database yml /path/to/mapping-path-converted-to-yml -.. warning:: +.. note:: Reverse Engineering is not always working perfectly depending on special cases. It will only detect Many-To-One diff --git a/manual/en/transactions-and-concurrency.rst b/en/reference/transactions-and-concurrency.rst similarity index 98% rename from manual/en/transactions-and-concurrency.rst rename to en/reference/transactions-and-concurrency.rst index 717783340..56a9c7db7 100644 --- a/manual/en/transactions-and-concurrency.rst +++ b/en/reference/transactions-and-concurrency.rst @@ -33,7 +33,7 @@ The first approach is to use the implicit transaction handling provided by the Doctrine ORM EntityManager. Given the following code snippet, without any explicit transaction demarcation: -:: +.. code-block:: php find('BlogPost', 123456); @@ -301,7 +301,7 @@ See the example code, The form (GET Request): And the change headline action (POST Request): -:: +.. code-block:: php `_. +- The :ref:`concept of owning and inverse sides ` + in bidirectional associations. - If an entity is removed from a collection, the association is removed, not the entity itself. A collection of entities always only represents the association to the containing entities, not the entity itself. -- Collection-valued persistent fields have to be instances of the +- Collection-valued :ref:`persistent fields ` have to be instances of the ``Doctrine\Common\Collections\Collection`` interface. - `See here `_ - for more details. Changes to associations in your code are not synchronized to the database directly, but upon calling ``EntityManager#flush()``. @@ -34,7 +31,7 @@ entities to show examples of association management. See the PHP docblocks of each association in the following example for information about its type and if its the owning or inverse side. -:: +.. code-block:: php find('User', $userId); @@ -176,7 +173,7 @@ The interaction code would then look like in the following snippet In the case of bi-directional associations you have to update the fields on both sides: -:: +.. code-block:: php getFavorites()->add($favoriteComment); @@ -439,7 +436,7 @@ of this chapter. Suppose in our application a user is created whenever he writes his first comment. In this case we would use the following code: -:: +.. code-block:: php find('User', $deleteUserId); @@ -478,7 +475,7 @@ To have Doctrine handle both cases automatically we can change the ``User#commentsAuthored`` property to cascade both the "persist" and the "remove" operation. -:: +.. code-block:: php find('CMS\Article', 1234); @@ -60,7 +60,7 @@ screen. You can even verify that ``$article`` and ``$article2`` are indeed pointing to the same instance by running the following code: -:: +.. code-block:: php find('Article', 1); @@ -157,7 +157,7 @@ A slice of the generated proxy classes code looks like the following piece of code. A real proxy class override ALL public methods along the lines of the ``getName()`` method shown below: -:: +.. code-block:: php persist($user); $em->flush(); -.. warning:: +.. note:: Generated entity identifiers / primary keys are guaranteed to be available after the next successful flush @@ -251,7 +251,7 @@ the ``EntityManager#remove($entity)`` method. By applying the which means that its persistent state will be deleted once ``EntityManager#flush()`` is invoked. -.. warning:: +.. note:: Just like ``persist``, invoking ``remove`` on an entity does NOT cause an immediate SQL DELETE to be issued on the @@ -261,7 +261,7 @@ which means that its persistent state will be deleted once Example: -:: +.. code-block:: php remove($user); @@ -332,7 +332,7 @@ Doctrine will not hold on to any references to a detached entity. Example: -:: +.. code-block:: php detach($entity); @@ -381,7 +381,7 @@ this entity and this copy will subsequently be returned. Example: -:: +.. code-block:: php getUnitOfWork()->size(); @@ -527,7 +536,7 @@ to change tracking (see "Change Tracking Policies") and, of course, memory consumption, so you may want to check it from time to time during development. -.. warning:: +.. note:: Do not invoke ``flush`` after every change to an entity or every single invocation of persist/remove/merge/... This is an @@ -545,12 +554,14 @@ You can get direct access to the Unit of Work by calling ``EntityManager#getUnitOfWork()``. This will return the UnitOfWork instance the EntityManager is currently using. -:: +.. code-block:: php getUnitOfWork(); - **NOTE** Directly manipulating a UnitOfWork is not recommended. +.. note:: + + Directly manipulating a UnitOfWork is not recommended. When working directly with the UnitOfWork API, respect methods marked as INTERNAL by not using them and carefully read the API documentation. @@ -565,7 +576,7 @@ explicitly need to find out what the current state of an entity is in the context of a certain ``EntityManager`` you can ask the underlying ``UnitOfWork``: -:: +.. code-block:: php getUnitOfWork()->getEntityState($entity)) { @@ -610,7 +621,7 @@ identifier / primary key using the ``EntityManager#find($entityName, $id)`` method. Here is an example: -:: +.. code-block:: php `_. +:doc:`the dedicated chapter `. For programmatically building up queries based on conditions that are only known at runtime, Doctrine provides the special ``Doctrine\ORM\QueryBuilder`` class. More information on constructing queries with a QueryBuilder can be found -`in the dedicated chapter `_. +:doc:`in Query Builder chapter `. By Native Queries ~~~~~~~~~~~~~~~~~ @@ -742,7 +753,7 @@ applications that require lots of specialized DQL queries using a custom repository is one recommended way of grouping these queries in a central location. -:: +.. code-block:: php setFileExtension('.xml'); @@ -57,7 +57,7 @@ want to. In order to tell the XmlDriver where to look for your mapping documents, supply an array of paths as the first argument of the constructor, like this: -:: +.. code-block:: php diff --git a/manual/en/yaml-mapping.rst b/en/reference/yaml-mapping.rst similarity index 98% rename from manual/en/yaml-mapping.rst rename to en/reference/yaml-mapping.rst index 9f62eea8d..941ade9ef 100644 --- a/manual/en/yaml-mapping.rst +++ b/en/reference/yaml-mapping.rst @@ -21,7 +21,7 @@ In order to work, this requires certain conventions: - -:: +.. code-block:: php setFileExtension('.yml'); @@ -32,7 +32,7 @@ want to. In order to tell the YamlDriver where to look for your mapping documents, supply an array of paths as the first argument of the constructor, like this: -:: +.. code-block:: php `_. +**clone** nor **wakeup** or :doc:`do so safely <../cookbook/implementing-wakeup-or-clone>`. An entity contains persistable properties. A persistable property is an instance variable of the entity that contains the data which @@ -62,7 +61,7 @@ A first prototype A first simplified design for this domain model might look like the following set of classes: -:: +.. code-block:: php register(); + // See :doc:`Configuration <../reference/configuration>` for up to date autoloading details. $config = new Doctrine\ORM\Configuration(); // (2) @@ -549,7 +543,7 @@ can use whatever suits you best. The second block contains of the instantiation of the ORM Configuration object. Besides the configuration shown in the next blocks there are several others with are all explained in the -`Configuration section of the manual `_. +:doc:`Configuration section of the manual <../reference/configuration>`. The Proxy Configuration is a required block for your application, you have to specify where Doctrine writes the PHP code for Proxy @@ -598,7 +592,7 @@ For the command-line tool to work a cli-config.php file has to be present in the project root directory, where you will execute the doctrine command. Its a fairly simple file: -:: +.. code-block:: php cd myproject/ doctrine@my-desktop> doctrine orm:schema-tool:create @@ -623,7 +616,7 @@ Doctrine command-line tool: your doctrine command-line client. See the - `Tools section of the manual `_ + :doc:`Tools section of the manual <../reference/tools>` on how to setup the Doctrine console correctly. @@ -631,17 +624,15 @@ During the development you probably need to re-create the database several times when changing the Entity metadata. You can then either re-create the database: -:: +.. code-block:: bash - [console] doctrine@my-desktop> doctrine orm:schema-tool:drop doctrine@my-desktop> doctrine orm:schema-tool:create Or use the update functionality: -:: +.. code-block:: bash - [console] doctrine@my-desktop> doctrine orm:schema-tool:update The updating of databases uses a Diff Algorithm for a given @@ -655,7 +646,7 @@ Writing Entities into the Database Having created the schema we can now start and save entities in the database. For starters we need a create user use-case: -:: +.. code-block:: php find("User", $theReporterId); @@ -758,7 +749,7 @@ mapper for the required view representations. When opening the application, bugs can be paginated through a list-view, which is the first read-only use-case: -:: +.. code-block:: php find("Bug", (int)$theBugId); @@ -881,7 +872,7 @@ write scenarios: However we will soon see another problem with our entities using this approach. Try displaying the engineer's name: -:: +.. code-block:: php description."\n"; @@ -897,7 +888,7 @@ replaced by LazyLoading proxies. Sample code of this proxy generated code can be found in the specified Proxy Directory, it looks like: -:: +.. code-block:: php getDescription()."\n"; @@ -952,7 +943,7 @@ list of all open bugs the user reported or was assigned to. This will be achieved using DQL again, this time with some WHERE clauses and usage of bound parameters: -:: +.. code-block:: php find("Bug", (int)$theBugId); @@ -1024,12 +1015,10 @@ improvement compared to updating all the properties. This tutorial is over here, I hope you had fun. Additional content will be added to this tutorial incrementally, topics will include: -:: - - * Entity Repositories - * More on Association Mappings - * Lifecycle Events triggered in the UnitOfWork - * Ordering of Collections +* Entity Repositories +* More on Association Mappings +* Lifecycle Events triggered in the UnitOfWork +* Ordering of Collections Additional details on all the topics discussed here can be found in the respective manual chapters. diff --git a/generate-docs.sh b/generate-docs.sh index 07aaf048f..33e811f6c 100755 --- a/generate-docs.sh +++ b/generate-docs.sh @@ -1,2 +1,2 @@ #!/bin/bash -sphinx-build manual/en /var/www/docs +sphinx-build en /var/www/docs diff --git a/manual/en.rst b/manual/en.rst deleted file mode 100644 index f66e1b2fd..000000000 --- a/manual/en.rst +++ /dev/null @@ -1,79 +0,0 @@ -Introduction -============ - -Architecture -============ - -Configuration -============= - -Basic Mapping -============= - -Association Mapping -=================== - -Inheritance Mapping -=================== - -Working with objects -==================== - -Working with associations -========================= - -Transactions and Concurrency -============================ - -Events -====== - -Batch processing -================ - -DQL (Doctrine Query Language) -============================= - -Query Builder -============= - -Native SQL -========== - -Change Tracking Policies -======================== - -Partial Objects -=============== - -XML Mapping -=========== - -YAML Mapping -============ - -Annotations Reference -===================== - -PHP Mapping -=========== - -Caching -======= - -Improving Performance -===================== - -Tools -===== - -Metadata Drivers -================ - -Best Practices -============== - -Limitations and Known Issues -============================ - - diff --git a/manual/en.txt b/manual/en.txt deleted file mode 100644 index 95d8bdbec..000000000 --- a/manual/en.txt +++ /dev/null @@ -1,26 +0,0 @@ -# Introduction -# Architecture -# Configuration -# Basic Mapping -# Association Mapping -# Inheritance Mapping -# Working with objects -# Working with associations -# Transactions and Concurrency -# Events -# Batch processing -# DQL (Doctrine Query Language) -# Query Builder -# Native SQL -# Change Tracking Policies -# Partial Objects -# XML Mapping -# YAML Mapping -# Annotations Reference -# PHP Mapping -# Caching -# Improving Performance -# Tools -# Metadata Drivers -# Best Practices -# Limitations and Known Issues \ No newline at end of file diff --git a/manual/en/index.rst b/manual/en/index.rst deleted file mode 100644 index cb638ddbb..000000000 --- a/manual/en/index.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. Doctrine 2 ORM documentation master file, created by - sphinx-quickstart on Mon Nov 1 21:19:39 2010. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Doctrine 2 ORM's documentation! -========================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - introduction - architecture - configuration - basic-mapping - association-mapping - inheritance-mapping - working-with-objects - working-with-associations - transactions-and-concurrency - events - batch-processing - dql-doctrine-query-language - query-builder - native-sql - change-tracking-policies - partial-objects - xml-mapping - yaml-mapping - annotations-reference - php-mapping - caching - improving-performance - tools - metadata-drivers - best-practices - limitations-and-known-issues - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - From 01c2a099916a8da191eaf6d1a0f5b5ea07148bbd Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Fri, 3 Dec 2010 22:47:33 +0100 Subject: [PATCH 08/10] Add Working with DateTime chapter. --- en/cookbook/working-with-datetime.rst | 168 ++++++++++++++++++++++++++ en/index.rst | 1 + 2 files changed, 169 insertions(+) create mode 100644 en/cookbook/working-with-datetime.rst diff --git a/en/cookbook/working-with-datetime.rst b/en/cookbook/working-with-datetime.rst new file mode 100644 index 000000000..a4d9af898 --- /dev/null +++ b/en/cookbook/working-with-datetime.rst @@ -0,0 +1,168 @@ +Working with DateTime Instances +=============================== + +There are many nitty gritty details when working with PHPs DateTime instances. You have know their inner +workings pretty well not to make mistakes with date handling. This cookbook entry holds several +interesting pieces of information on how to work with PHP DateTime instances in Doctrine 2. + +DateTime changes are detected by Reference +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When calling ``EntityManager#flush()`` Doctrine computes the changesets of all the currently managed entities +and saves the differences to the database. In case of object properties (@Column(type="datetime") or @Column(type="object")) +these comparisons are always made **BY REFERENCE**. That means the following change will **NOT** be saved into the database: + +.. code-block:: php + + updated->modify("now"); + } + } + +The way to go would be: + +.. code-block:: php + + updated = new \DateTime("now"); + } + } + +Default Timezone Gotcha +~~~~~~~~~~~~~~~~~~~~~~~ + +By default Doctrine assumes that you are working with a default timezone. Each DateTime instance that +is created by Doctrine will be assigned the timezone that is currently the default, either through +the ``date.timezone`` ini setting or by calling ``date_default_timezone_set()``. + +This is very important to handle correctly if your application runs on different serves or is moved from one to another server +(with different timezone settings). You have to make sure that the timezone is the correct one +on all this systems. + +Handling different Timezones with the DateTime Type +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you first come across the requirement to save different you are still optimistic to manage this mess, +however let me crush your expectations fast. There is not a single database out there (supported by Doctrine 2) +that supports timezones correctly. Correctly here means that you can cover all the use-cases that +can come up with timezones. If you don't believe me you should read up on `Storing DateTime +in Databases `_. + +The problem is simple. Not a single database vendor saves the timezone, only the differences to UTC. +However with frequent daylight saving and political timezone changes you can have a UTC offset that moves +in different offset directions depending on the real location. + +The solution for this dialemma is simple. Don't use timezones with DateTime and Doctrine 2. However there is a workaround +that even allows correct date-time handling with timezones: + +1. Always convert any DateTime instance to UTC. +2. Only set Timezones for displaying purposes +3. Save the Timezone in the Entity for persistence. + +Say we have an application for an international postal company and employees insert events regarding postal-package +around the world, in their current timezones. To determine the exact time an event occoured means to save both +the UTC time at the time of the booking and the timezone the event happend in. + +.. code-block:: php + + format($platform->getDateTimeFormatString(), + (self::$utc) ? self::$utc : (self::$utc = new \DateTimeZone(\DateTimeZone::UTC)) + ); + } + + public function convertToPHPValue($value, AbstractPlatform $platform) + { + if ($value === null) { + return null; + } + + $val = \DateTime::createFromFormat( + $platform->getDateTimeFormatString(), + $value, + (self::$utc) ? self::$utc : (self::$utc = new \DateTimeZone(\DateTimeZone::UTC)) + ); + if (!$val) { + throw ConversionException::conversionFailed($value, $this->getName()); + } + return $val; + } + } + +This database type makes sure that every DateTime instance is always saved in UTC, relative +to the current timezone that the passed DateTime instance has. To be able to transform these values +back into their real timezone you have to save the timezone in a seperate field of the entity +requiring timezoned datetimes: + +.. code-block:: php + + localized = true; + $this->created = $createDate; + $this->timezone = $createDate->getTimeZone()->getName(); + } + + public function getCreated() + { + if (!$this->localized) { + $this->created->setTimeZone(new \DateTimeZone($this->timezone)); + } + return $this->created; + } + } + +This snippet makes use of the previously discussed "changeset by reference only" property of +objects. That means a new DateTime will only be used during updating if the reference +changes between retrieval and flush operation. This means we can easily go and modify +the instance by setting the previous local timezone. diff --git a/en/index.rst b/en/index.rst index 877bdc7c3..83803b8ec 100644 --- a/en/index.rst +++ b/en/index.rst @@ -60,6 +60,7 @@ Cookbook cookbook/sql-table-prefixes cookbook/strategy-cookbook-introduction cookbook/validation-of-entities + cookbook/working-with-datetime Indices and tables ================== From eb0fd4d066cc8299029019ec313ac82eb9728d76 Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Sat, 11 Dec 2010 01:01:44 +0100 Subject: [PATCH 09/10] Add section about database and unit of work being out of sync and how this effects your code. --- en/reference/dql-doctrine-query-language.rst | 1 + en/reference/working-with-objects.rst | 28 ++++++++++++++++++-- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/en/reference/dql-doctrine-query-language.rst b/en/reference/dql-doctrine-query-language.rst index 8716ba587..c71cdbbdb 100644 --- a/en/reference/dql-doctrine-query-language.rst +++ b/en/reference/dql-doctrine-query-language.rst @@ -781,6 +781,7 @@ automatically for you: SELECT p0_.id AS id0, p0_.name AS name1, e1_.department AS department2, p0_.discr AS discr3 FROM Employee e1_ INNER JOIN Person p0_ ON e1_.id = p0_.id WHERE p0_.name = ? + The Query class --------------- diff --git a/en/reference/working-with-objects.rst b/en/reference/working-with-objects.rst index 9244ea1ab..08e950843 100644 --- a/en/reference/working-with-objects.rst +++ b/en/reference/working-with-objects.rst @@ -256,8 +256,12 @@ which means that its persistent state will be deleted once Just like ``persist``, invoking ``remove`` on an entity does NOT cause an immediate SQL DELETE to be issued on the database. The entity will be deleted on the next invocation of - ``EntityManager#flush()`` that involves that entity. - + ``EntityManager#flush()`` that involves that entity. This + means that entities scheduled for removal can still be queried + for and appear in query and collection results. See + the section on :ref:`Database and UnitOfWork Out-Of-Sync ` + for more information. + Example: @@ -465,6 +469,26 @@ When ``EntityManager#flush()`` is called, Doctrine inspects all managed, new and removed entities and will perform the following operations. +.. _workingobjects_database_uow_outofsync: + +Effects of Database and UnitOfWork being Out-Of-Sync +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +As soon as you begin to change the state ofentities, call persist or remove the +contents of the UnitOfWork and the database will drive out of sync. They can +only be sychronized by calling ``EntityManager#flush()`. This section +describes the effects of database and UnitOfWork being out of sync. + +- Entities that are scheduled for removal can still be queried from the database. + They are returned from DQL and Repository queries and are visible in collections. +- Entities that are passed to ``EntityManager#persist`` do not turn up in query + results. +- Entities that have changed will not be overwritten with the state from the database. + This is because the identity map will detect the construction of an already existing + entity and assumes its the most up to date version. + +``EntityManager#flush()`` is never called implicitly by Doctrine. You always have to trigger it manually. + Synchronizing New and Managed Entities ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 9c6d3dbecd6b173523db6b43271deaaec4958b01 Mon Sep 17 00:00:00 2001 From: beberlei Date: Sat, 11 Dec 2010 11:29:37 +0100 Subject: [PATCH 10/10] Add link to Doctrine homepage to docs layout template. --- en/_templates/layout.html | 1 + 1 file changed, 1 insertion(+) diff --git a/en/_templates/layout.html b/en/_templates/layout.html index 3380dbe13..79878cee5 100644 --- a/en/_templates/layout.html +++ b/en/_templates/layout.html @@ -18,6 +18,7 @@ {%- if not loop.first %}{{ reldelim2 }}{% endif %} {%- endfor %} {%- block rootrellink %} +
  • Doctrine Homepage »
  • {{ shorttitle|e }}{{ reldelim1 }}
    • {%- endblock %} {%- for parent in parents %}