Doctrine (PHP)
Object–relational mapping for PHP
- 4 min read
- 4 chapters
Related on Lably
Through Class (programming), SQL and Object-oriented programming
One of Doctrine's key features is the option to write database queries in Doctrine Query Language (DQL), an object-oriented dialect of SQL.
Developers of two major PHP frameworks, Symfony and Laminas have official out-of-the-box support for Doctrine, while 3rd party Doctrine packages are available for Laravel, CodeIgniter and others.
Usage demonstration
Entities in Doctrine 2 are lightweight PHP Objects that contain persistable properties. A persistable property is an instance variable of the entity that is saved into and retrieved from the database by Doctrine's data mapping capabilities via the Entity Manager - an implementation of the data mapper pattern:
<span id="mwGw"></span> <span class="nv" id="mwHA">$user</span> <span class="o" id="mwHQ">=</span> <span class="k" id="mwHg">new</span> <span class="nx" id="mwHw">User</span><span class="p" id="mwIA">();</span> <span class="nv" id="mwIQ">$user</span><span class="o" id="mwIg">-></span><span class="na" id="mwIw">name</span> <span class="o" id="mwJA">=</span> <span class="s2" id="mwJQ">"john2"</span><span class="p" id="mwJg">;</span> <span class="nv" id="mwJw">$user</span><span class="o" id="mwKA">-></span><span class="na" id="mwKQ">password</span> <span class="o" id="mwKg">=</span> <span class="s2" id="mwKw">"doe"</span><span class="p" id="mwLA">;</span> <span class="c1" id="mwLQ">//$entityManager is an instance of Doctrine\ORM\EntityManagerInterface, usually obtained through dependency injection</span> <span class="nv" id="mwLg">$entityManager</span><span class="o" id="mwLw">-></span><span class="na" id="mwMA">persist</span><span class="p" id="mwMQ">(</span><span class="nv" id="mwMg">$user</span><span class="p" id="mwMw">);</span> <span class="nv" id="mwNA">$entityManager</span><span class="o" id="mwNQ">-></span><span class="na" id="mwNg">flush</span><span class="p" id="mwNw">();</span> <span class="k" id="mwOA">echo</span> <span class="s2" id="mwOQ">"The user with id </span><span class="si" id="mwOg">$user->id</span><span class="s2" id="mwOw"> has been saved."</span><span class="p" id="mwPA">;</span>
Doctrine 1.x follows the active record pattern for working with data, where a class corresponds with a database table. For instance, if a programmer wanted to create a new "User" object in a database, they would no longer need to write SQL queries, but instead could use the following PHP code:
<span id="mwRA"></span> <span class="nv" id="mwRQ">$user</span> <span class="o" id="mwRg">=</span> <span class="k" id="mwRw">new</span> <span class="nx" id="mwSA">User</span><span class="p" id="mwSQ">();</span> <span class="nv" id="mwSg">$user</span><span class="o" id="mwSw">-></span><span class="na" id="mwTA">name</span> <span class="o" id="mwTQ">=</span> <span class="s2" id="mwTg">"john"</span><span class="p" id="mwTw">;</span> <span class="nv" id="mwUA">$user</span><span class="o" id="mwUQ">-></span><span class="na" id="mwUg">password</span> <span class="o" id="mwUw">=</span> <span class="s2" id="mwVA">"doe"</span><span class="p" id="mwVQ">;</span> <span class="nv" id="mwVg">$user</span><span class="o" id="mwVw">-></span><span class="na" id="mwWA">save</span><span class="p" id="mwWQ">();</span> <span class="k" id="mwWg">echo</span> <span class="s2" id="mwWw">"The user with id </span><span class="si" id="mwXA">$user->id</span><span class="s2" id="mwXQ"> has been saved."</span><span class="p" id="mwXg">;</span>
Sign in to keep reading
3 more chapters are free with a Lably account.
Features
One feature of Doctrine is the low level of configuration that is needed to start a project. Doctrine can generate object classes from an existing database, and the programmer can then specify relations and add custom functionality to the generated classes. There is no need to generate or maintain complex XML database schemas, as seen in many other frameworks.
Another key feature of Doctrine is the ability to optionally write database queries in an OO (object oriented) SQL dialect called DQL (Doctrine Query Language) inspired by Hibernate's HQL. Alternately, the QueryBuilder class (Doctrine_Query in Doctrine 1.x) allows one to construct queries through a fluent interface. These interfaces provide developers with powerful alternatives to SQL which maintain flexibility and still allow for switching of database back-ends, without requiring any code duplication.
Writing queries explicitly however is not always necessary, as Doctrine performs joins and fetches related objects automatically. Small projects can be easily constructed without writing queries.
Other notable features of Doctrine are:
- support for hooks (methods which can validate or modify database input and output) and event listeners to structure business-related logic;
- column aggregation inheritance (similar objects can be stored in one database table, with one type-column specifying the subtype of the particular object - the correct subclass is always returned when a query is done);
- a caching framework, making use of several backends such as memcached, SQLite or APC;
- ACID transactions;
- database migrations;
- a "compile" function to combine many PHP files of the framework into one, to avoid the performance hit usually incurred by including the many PHP files of a framework.
History
Doctrine was started by Konsta Vesterinen, also known as zYne-. The project's initial commit was made on April 13, 2006. As the project became more mature, the adoption began to pick up. Before long, the community was active and development was receiving regular contributions, among others from the Google Summer of Code project.
Doctrine 1.0.0 was released on September 1, 2008.
The first stable version of Doctrine 2.0 was released on December 22, 2010, after 2.5 years of dedicated development starting in early 2008.
Influences
Doctrine has been influenced by dozens of projects and many different people. The largest influences have been the Java ORM solution Hibernate and the ActiveRecord architecture used in Ruby on Rails. The purpose of the Doctrine project is to build an equally powerful solution for the PHP language for high-load websites that have to maintain a constant flow of visitors. Doctrine ORM can be used to improve the performance of such websites.