symfony/archived-symfony-docs
1
0
Fork 0
mirror of https://github.com/symfony/symfony-docs.git synced 2026-03-23 16:22:10 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
7.3
archived-symfony-docs/doctrine.rst

1187 lines
40 KiB
ReStructuredText
Raw Permalink Blame History

Databases and the Doctrine ORM
==============================
.. admonition:: Screencast
:class: screencast
Do you prefer video tutorials? Check out the `Doctrine screencast series`_.
Symfony provides all the tools you need to use databases in your applications
thanks to `Doctrine`_, the best set of PHP libraries to work with databases.
These tools support relational databases like MySQL and PostgreSQL and also
NoSQL databases like MongoDB.
Databases are a broad topic, so the documentation is divided in three articles:
* This article explains the recommended way to work with **relational databases**
in Symfony applications;
* Read :doc:`this other article </doctrine/dbal>` if you need **low-level access**
to perform raw SQL queries to relational databases (similar to PHP's `PDO`_);
* Read `DoctrineMongoDBBundle docs`_ if you are working with **MongoDB databases**.
Installing Doctrine
-------------------
First, install Doctrine support via the ``orm`` :ref:`Symfony pack <symfony-packs>`,
as well as the MakerBundle, which will help generate some code:
.. code-block:: terminal
$ composer require symfony/orm-pack
$ composer require --dev symfony/maker-bundle
Configuring the Database
~~~~~~~~~~~~~~~~~~~~~~~~
The database connection information is stored as an environment variable called
``DATABASE_URL``. For development, you can find and customize this inside ``.env``:
.. code-block:: text
# .env (or override DATABASE_URL in .env.local to avoid committing your changes)
# customize this line!
DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=8.0.37"
# to use mariadb:
# Before doctrine/dbal < 3.7
# DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=mariadb-10.5.8"
# Since doctrine/dbal 3.7
# DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=10.5.8-MariaDB"
# to use sqlite:
# DATABASE_URL="sqlite:///%kernel.project_dir%/var/app.db"
# to use postgresql:
# DATABASE_URL="postgresql://db_user:db_password@127.0.0.1:5432/db_name?serverVersion=12.19 (Debian 12.19-1.pgdg120+1)&charset=utf8"
# to use oracle:
# DATABASE_URL="oci8://db_user:db_password@127.0.0.1:1521/db_name"
.. warning::
If the username, password, host or database name contain any character considered
special in a URI (such as ``: / ? # [ ] @ ! $ & ' ( ) * + , ; =``),
you must encode them. See `RFC 3986`_ for the full list of reserved characters.
You can use the :phpfunction:`urlencode` function to encode them or
the :ref:`urlencode environment variable processor <urlencode_environment_variable_processor>`.
In this case you need to remove the ``resolve:`` prefix in ``config/packages/doctrine.yaml``
to avoid errors: ``url: '%env(DATABASE_URL)%'``
.. tip::
To avoid URL-encoding issues with special characters in credentials, you can
use separate connection parameters instead of the URL format. Define each
value as its own environment variable and wrap it in single quotes in the
``.env`` file to prevent characters like ``$`` and ``#`` from being
interpreted:
.. code-block:: text
# .env
DATABASE_PASSWORD='p@ss$wo#rd'
Then configure Doctrine to use individual parameters:
.. code-block:: yaml
# config/packages/doctrine.yaml
doctrine:
dbal:
user: '%env(DATABASE_USER)%'
password: '%env(DATABASE_PASSWORD)%'
host: '%env(DATABASE_HOST)%'
port: '%env(DATABASE_PORT)%'
dbname: '%env(DATABASE_NAME)%'
driver: pdo_mysql
Now that your connection parameters are setup, Doctrine can create the ``db_name``
database for you:
.. code-block:: terminal
$ php bin/console doctrine:database:create
There are more options in ``config/packages/doctrine.yaml`` that you can configure,
including your ``server_version`` (e.g. 8.0.37 if you're using MySQL 8.0.37), which may
affect how Doctrine functions.
.. tip::
There are many other Doctrine commands. Run ``php bin/console list doctrine``
to see a full list.
.. _doctrine-adding-mapping:
Creating an Entity Class
------------------------
Suppose you're building an application where products need to be displayed.
Without even thinking about Doctrine or databases, you already know that
you need a ``Product`` object to represent those products.
You can use the ``make:entity`` command to create this class and any fields you
need. The command will ask you some questions - answer them like done below:
.. code-block:: bash
$ php bin/console make:entity
Class name of the entity to create or update:
> Product
New property name (press <return> to stop adding fields):
> name
Field type (enter ? to see all types) [string]:
> string
Field length [255]:
> 255
Can this field be null in the database (nullable) (yes/no) [no]:
> no
New property name (press <return> to stop adding fields):
> price
Field type (enter ? to see all types) [string]:
> integer
Can this field be null in the database (nullable) (yes/no) [no]:
> no
New property name (press <return> to stop adding fields):
>
(press enter again to finish)
Whoa! You now have a new ``src/Entity/Product.php`` file::
// src/Entity/Product.php
namespace App\Entity;
use App\Repository\ProductRepository;
use Doctrine\ORM\Mapping as ORM;
#[ORM\Entity(repositoryClass: ProductRepository::class)]
class Product
{
#[ORM\Id]
#[ORM\GeneratedValue]
#[ORM\Column]
private ?int $id = null;
#[ORM\Column(length: 255)]
private ?string $name = null;
#[ORM\Column]
private ?int $price = null;
public function getId(): ?int
{
return $this->id;
}
// ... getter and setter methods
}
.. tip::
Starting in `MakerBundle`_: v1.57.0 - You can pass either ``--with-uuid`` or
``--with-ulid`` to ``make:entity``. Leveraging Symfony's :doc:`Uid Component </components/uid>`,
this generates an entity with the ``id`` type as :ref:`Uuid <uuid>`
or :ref:`Ulid <ulid>` instead of ``int``.
.. note::
Starting in v1.44.0 - `MakerBundle`_: only supports entities using PHP attributes.
.. note::
Confused why the price is an integer? Don't worry: this is just an example.
But, storing prices as integers (e.g. 100 = $1 USD) can avoid rounding issues.
.. warning::
There is a `limit of 767 bytes for the index key prefix`_ when using
InnoDB tables in MySQL 5.6 and earlier versions. String columns with 255
character length and ``utf8mb4`` encoding surpass that limit. This means
that any column of type ``string`` and ``unique=true`` must set its
maximum ``length`` to ``190``. Otherwise, you'll see this error:
*"[PDOException] SQLSTATE[42000]: Syntax error or access violation:
1071 Specified key was too long; max key length is 767 bytes"*.
This class is called an "entity". And soon, you'll be able to save and query Product
objects to a ``product`` table in your database. Each property in the ``Product``
entity can be mapped to a column in that table. This is usually done with attributes:
the ``#[ORM\Column(...)]`` comments that you see above each property:
.. raw:: html
<object data="_images/doctrine/mapping_single_entity.svg" type="image/svg+xml"
alt="Doctrine mapping between properties of a Product PHP object and the data in the product database table"
></object>
The ``make:entity`` command is a tool to make life easier. But this is *your* code:
add/remove fields, add/remove methods or update configuration.
Doctrine supports a wide variety of field types, each with their own options.
Check out the `list of Doctrine mapping types`_ in the Doctrine documentation.
If you want to use XML instead of attributes, add ``type: xml`` and
``dir: '%kernel.project_dir%/config/doctrine'`` to the entity mappings in your
``config/packages/doctrine.yaml`` file.
.. warning::
Be careful not to use reserved SQL keywords as your table or column names
(e.g. ``GROUP`` or ``USER``). See Doctrine's `Reserved SQL keywords documentation`_
for details on how to escape these. Or, change the table name with
``#[ORM\Table(name: 'groups')]`` above the class or configure the column name with
the ``name: 'group_name'`` option.
.. _doctrine-creating-the-database-tables-schema:
Migrations: Creating the Database Tables/Schema
-----------------------------------------------
The ``Product`` class is fully-configured and ready to save to a ``product`` table.
If you just defined this class, your database doesn't actually have the ``product``
table yet. To add it, you can leverage the `DoctrineMigrationsBundle`_, which is
already installed:
.. code-block:: terminal
$ php bin/console make:migration
.. tip::
Starting in `MakerBundle`_: v1.56.0 - Passing ``--formatted`` to ``make:migration``
generates a nice and tidy migration file.
If everything worked, you should see something like this:
.. code-block:: text
SUCCESS!
Next: Review the new migration "migrations/Version20211116204726.php"
Then: Run the migration with php bin/console doctrine:migrations:migrate
If you open this file, it contains the SQL needed to update your database! To run
that SQL, execute your migrations:
.. code-block:: terminal
$ php bin/console doctrine:migrations:migrate
This command executes all migration files that have not already been run against
your database. You should run this command on production when you deploy to keep
your production database up-to-date.
.. _doctrine-add-more-fields:
Migrations & Adding more Fields
-------------------------------
But what if you need to add a new field property to ``Product``, like a
``description``? You can edit the class to add the new property. But, you can
also use ``make:entity`` again:
.. code-block:: bash
$ php bin/console make:entity
Class name of the entity to create or update
> Product
New property name (press <return> to stop adding fields):
> description
Field type (enter ? to see all types) [string]:
> text
Can this field be null in the database (nullable) (yes/no) [no]:
> no
New property name (press <return> to stop adding fields):
>
(press enter again to finish)
This adds the new ``description`` property and ``getDescription()`` and ``setDescription()``
methods:
.. code-block:: diff
// src/Entity/Product.php
// ...
+ use Doctrine\DBAL\Types\Types;
class Product
{
// ...
+ #[ORM\Column(type: Types::TEXT)]
+ private string $description;
// getDescription() & setDescription() were also added
}
The new property is mapped, but it doesn't exist yet in the ``product`` table. No
problem! Generate a new migration:
.. code-block:: terminal
$ php bin/console make:migration
This time, the SQL in the generated file will look like this:
.. code-block:: sql
ALTER TABLE product ADD description LONGTEXT NOT NULL
The migration system is *smart*. It compares all of your entities with the current
state of the database and generates the SQL needed to synchronize them! Like
before, execute your migrations:
.. code-block:: terminal
$ php bin/console doctrine:migrations:migrate
.. warning::
If you are using an SQLite database, you'll see the following error:
*PDOException: SQLSTATE[HY000]: General error: 1 Cannot add a NOT NULL
column with default value NULL*. Add a ``nullable=true`` option to the
``description`` property to fix the problem.
This will only execute the *one* new migration file, because DoctrineMigrationsBundle
knows that the first migration was already executed earlier. Internally, it
manages a ``migration_versions`` table to track this.
Each time you make a change to your schema, run these two commands to generate the
migration and then execute it. Be sure to commit the migration files and execute
them when you deploy.
.. _doctrine-generating-getters-and-setters:
.. tip::
If you prefer to add new properties manually, the ``make:entity`` command can
generate the getter & setter methods for you:
.. code-block:: terminal
$ php bin/console make:entity --regenerate
If you make some changes and want to regenerate *all* getter/setter methods,
also pass ``--overwrite``.
Persisting Objects to the Database
----------------------------------
It's time to save a ``Product`` object to the database! Let's create a new controller
to experiment:
.. code-block:: terminal
$ php bin/console make:controller ProductController
Inside the controller, you can create a new ``Product`` object, set data on it,
and save it::
// src/Controller/ProductController.php
namespace App\Controller;
// ...
use App\Entity\Product;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;
class ProductController extends AbstractController
{
#[Route('/product', name: 'create_product')]
public function createProduct(EntityManagerInterface $entityManager): Response
{
$product = new Product();
$product->setName('Keyboard');
$product->setPrice(1999);
$product->setDescription('Ergonomic and stylish!');
// tell Doctrine you want to (eventually) save the Product (no queries yet)
$entityManager->persist($product);
// actually executes the queries (i.e. the INSERT query)
$entityManager->flush();
return new Response('Saved new product with id '.$product->getId());
}
}
Try it out!
http://localhost:8000/product
Congratulations! You just created your first row in the ``product`` table. To prove it,
you can query the database directly:
.. code-block:: terminal
$ php bin/console dbal:run-sql 'SELECT * FROM product'
# on Windows systems not using Powershell, run this command instead:
# php bin/console dbal:run-sql "SELECT * FROM product"
Take a look at the previous example in more detail:
.. _doctrine-entity-manager:
* **line 13** The ``EntityManagerInterface $entityManager`` argument tells Symfony
to :ref:`inject the Entity Manager service <services-constructor-injection>` into
the controller method. This object is responsible for saving objects to, and
fetching objects from, the database.
* **lines 15-18** In this section, you instantiate and work with the ``$product``
object like any other normal PHP object.
* **line 21** The ``persist($product)`` call tells Doctrine to "manage" the
``$product`` object. This does **not** cause a query to be made to the database.
* **line 24** When the ``flush()`` method is called, Doctrine looks through
all of the objects that it's managing to see if they need to be persisted
to the database. In this example, the ``$product`` object's data doesn't
exist in the database, so the entity manager executes an ``INSERT`` query,
creating a new row in the ``product`` table.
.. note::
If the ``flush()`` call fails, a ``Doctrine\ORM\ORMException`` exception
is thrown. See `Transactions and Concurrency`_.
Whether you're creating or updating objects, the workflow is always the same: Doctrine
is smart enough to know if it should INSERT or UPDATE your entity.
.. _automatic_object_validation:
Validating Objects
------------------
:doc:`The Symfony validator </validation>` can reuse Doctrine metadata to perform
some basic validation tasks. First, add or configure the
:ref:`auto_mapping option <reference-validation-auto-mapping>` to define which
entities should be introspected by Symfony to add automatic validation constraints.
Consider the following controller code::
// src/Controller/ProductController.php
namespace App\Controller;
use App\Entity\Product;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;
use Symfony\Component\Validator\Validator\ValidatorInterface;
// ...
class ProductController extends AbstractController
{
#[Route('/product', name: 'create_product')]
public function createProduct(ValidatorInterface $validator): Response
{
$product = new Product();
// ... update the product data somehow (e.g. with a form) ...
$errors = $validator->validate($product);
if (count($errors) > 0) {
return new Response((string) $errors, 400);
}
// ...
}
}
Although the ``Product`` entity doesn't define any explicit
:doc:`validation configuration </validation>`, if the ``auto_mapping`` option
includes it in the list of entities to introspect, Symfony will infer some
validation rules for it and will apply them.
For example, given that the ``name`` property can't be ``null`` in the database, a
:doc:`NotNull constraint </reference/constraints/NotNull>` is added automatically
to the property (if it doesn't contain that constraint already).
The following table summarizes the mapping between Doctrine metadata and
the corresponding validation constraints added automatically by Symfony:
================== ========================================================= =====
Doctrine attribute Validation constraint Notes
================== ========================================================= =====
``nullable=false`` :doc:`NotNull </reference/constraints/NotNull>` Requires installing the :doc:`PropertyInfo component </components/property_info>`
``type`` :doc:`Type </reference/constraints/Type>` Requires installing the :doc:`PropertyInfo component </components/property_info>`
``unique=true`` :doc:`UniqueEntity </reference/constraints/UniqueEntity>`
``length`` :doc:`Length </reference/constraints/Length>`
================== ========================================================= =====
Because :doc:`the Form component </forms>` as well as `API Platform`_ internally
use the Validator component, all your forms and web APIs will also automatically
benefit from these automatic validation constraints.
This automatic validation is a nice feature to improve your productivity, but it
doesn't replace the validation configuration entirely. You still need to add
some :doc:`validation constraints </reference/constraints>` to ensure that data
provided by the user is correct.
Fetching Objects from the Database
----------------------------------
Fetching an object back out of the database is even easier. Suppose you want to
be able to go to ``/product/1`` to see your new product::
// src/Controller/ProductController.php
namespace App\Controller;
use App\Entity\Product;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;
// ...
class ProductController extends AbstractController
{
#[Route('/product/{id}', name: 'product_show')]
public function show(EntityManagerInterface $entityManager, int $id): Response
{
$product = $entityManager->getRepository(Product::class)->find($id);
if (!$product) {
throw $this->createNotFoundException(
'No product found for id '.$id
);
}
return new Response('Check out this great product: '.$product->getName());
// or render a template
// in the template, print things with {{ product.name }}
// return $this->render('product/show.html.twig', ['product' => $product]);
}
}
Another possibility is to use the ``ProductRepository`` using Symfony's autowiring
and injected by the dependency injection container::
// src/Controller/ProductController.php
namespace App\Controller;
use App\Entity\Product;
use App\Repository\ProductRepository;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;
// ...
class ProductController extends AbstractController
{
#[Route('/product/{id}', name: 'product_show')]
public function show(ProductRepository $productRepository, int $id): Response
{
$product = $productRepository
->find($id);
// ...
}
}
Try it out!
http://localhost:8000/product/1
When you query for a particular type of object, you always use what's known
as its "repository". You can think of a repository as a PHP class whose only
job is to help you fetch entities of a certain class.
Once you have a repository object, you have many helper methods::
$repository = $entityManager->getRepository(Product::class);
// look for a single Product by its primary key (usually "id")
$product = $repository->find($id);
// look for a single Product by name
$product = $repository->findOneBy(['name' => 'Keyboard']);
// or find by name and price
$product = $repository->findOneBy([
'name' => 'Keyboard',
'price' => 1999,
]);
// look for multiple Product objects matching the name, ordered by price
$products = $repository->findBy(
['name' => 'Keyboard'],
['price' => 'ASC']
);
// look for *all* Product objects
$products = $repository->findAll();
You can also add *custom* methods for more complex queries! More on that later in
the :ref:`doctrine-queries` section.
.. tip::
When rendering an HTML page, the web debug toolbar at the bottom of the page
will display the number of queries and the time it took to execute them:
.. image:: /_images/doctrine/doctrine_web_debug_toolbar.png
:alt: The web dev toolbar showing the Doctrine item.
:class: with-browser
If the number of database queries is too high, the icon will turn yellow to
indicate that something may not be correct. Click on the icon to open the
Symfony Profiler and see the exact queries that were executed. If you don't
see the web debug toolbar, install the ``profiler`` :ref:`Symfony pack <symfony-packs>`
by running this command: ``composer require --dev symfony/profiler-pack``.
For more information, read the :doc:`Symfony profiler documentation </profiler>`.
.. _doctrine-entity-value-resolver:
Automatically Fetching Objects (EntityValueResolver)
----------------------------------------------------
.. versionadded:: 2.7.1
Autowiring of the ``EntityValueResolver`` was introduced in DoctrineBundle 2.7.1.
In many cases, you can use the ``EntityValueResolver`` to do the query for you
automatically! You can simplify the controller to::
// src/Controller/ProductController.php
namespace App\Controller;
use App\Entity\Product;
use App\Repository\ProductRepository;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;
// ...
class ProductController extends AbstractController
{
#[Route('/product/{id}')]
public function show(Product $product): Response
{
// use the Product!
// ...
}
}
That's it! The attribute uses the ``{id}`` from the route to query for the ``Product``
by the ``id`` column. If it's not found, a 404 error is thrown.
You can change this behavior by making the controller argument optional. In that
case, no 404 is thrown automatically and you're free to handle the missing entity
yourself::
#[Route('/product/{id}')]
public function show(?Product $product): Response
{
if (null === $product) {
// run your own logic to return a custom response
}
// ...
}
.. tip::
When enabled globally, it's possible to disable the behavior on a specific
controller, by using the ``MapEntity`` set to ``disabled``::
public function show(
#[CurrentUser]
#[MapEntity(disabled: true)]
User $user
): Response {
// User is not resolved by the EntityValueResolver
// ...
}
Fetch Automatically
~~~~~~~~~~~~~~~~~~~
If your route wildcards match properties on your entity, then the resolver
will automatically fetch them::
/**
* Fetch via primary key because {id} is in the route.
*/
#[Route('/product/{id}')]
public function showByPk(Product $product): Response
{
}
/**
* Perform a findOneBy() where the slug property matches {slug}.
*/
#[Route('/product/{slug:product}')]
public function showBySlug(Product $product): Response
{
}
Automatic fetching works in these situations:
* If ``{id}`` is in your route, then this is used to fetch by
primary key via the ``find()`` method.
* The resolver will attempt to do a ``findOneBy()`` fetch by using
*all* of the wildcards in your route that are actually properties
on your entity (non-properties are ignored).
The ``{slug:product}`` syntax maps the route parameter named ``slug`` to the
controller argument named ``$product``. It also hints the resolver to look up
the corresponding ``Product`` object from the database using the slug.
.. versionadded:: 7.1
Route parameter mapping was introduced in Symfony 7.1.
You can also configure the mapping explicitly for any controller argument
using the ``MapEntity`` attribute. You can even control the behavior of the
``EntityValueResolver`` by using the `MapEntity options`_ ::
// src/Controller/ProductController.php
namespace App\Controller;
use App\Entity\Product;
use Symfony\Bridge\Doctrine\Attribute\MapEntity;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;
// ...
class ProductController extends AbstractController
{
#[Route('/product/{slug}')]
public function show(
#[MapEntity(mapping: ['slug' => 'slug'])]
Product $product
): Response {
// use the Product!
// ...
}
}
Fetch via an Expression
~~~~~~~~~~~~~~~~~~~~~~~
If automatic fetching doesn't work for your use case, you can write an expression
using the :doc:`ExpressionLanguage component </components/expression_language>`::
#[Route('/product/{product_id}')]
public function show(
#[MapEntity(expr: 'repository.find(product_id)')]
Product $product
): Response {
}
In the expression, the ``repository`` variable will be your entity's
Repository class and any route wildcards - like ``{product_id}`` are
available as variables.
The repository method called in the expression can also return a list of entities.
In that case, update the type of your controller argument::
#[Route('/posts_by/{author_id}')]
public function authorPosts(
#[MapEntity(class: Post::class, expr: 'repository.findBy({"author": author_id}, {}, 10)')]
iterable $posts
): Response {
}
.. versionadded:: 7.1
The mapping of the lists of entities was introduced in Symfony 7.1.
This can also be used to help resolve multiple arguments::
#[Route('/product/{id}/comments/{comment_id}')]
public function show(
Product $product,
#[MapEntity(expr: 'repository.find(comment_id)')]
Comment $comment
): Response {
}
In the example above, the ``$product`` argument is handled automatically,
but ``$comment`` is configured with the attribute since they cannot both follow
the default convention.
If you need to get other information from the request to query the database, you
can also access the request in your expression thanks to the ``request``
variable. Let's say you want the first or the last comment of a product depending on a query parameter named ``sort``::
#[Route('/product/{id}/comments')]
public function show(
Product $product,
#[MapEntity(expr: 'repository.findOneBy({"product": id}, {"createdAt": request.query.get("sort", "DESC")})')]
Comment $comment
): Response {
}
.. _doctrine-entity-value-resolver-resolve-target-entities:
Fetch via Interfaces
~~~~~~~~~~~~~~~~~~~~
Suppose your ``Product`` class implements an interface called ``ProductInterface``.
If you want to decouple your controllers from the concrete entity implementation,
you can reference the entity by its interface instead.
To enable this, first configure the
:doc:`resolve_target_entities option </doctrine/resolve_target_entity>`.
Then, your controller can type-hint the interface, and the entity will be
resolved automatically::
public function show(
#[MapEntity]
ProductInterface $product
): Response {
// ...
}
.. versionadded:: 7.3
Support for target entity resolution in the ``EntityValueResolver`` was
introduced Symfony 7.3
MapEntity Options
~~~~~~~~~~~~~~~~~
A number of options are available on the ``MapEntity`` attribute to
control behavior:
``id``
If an ``id`` option is configured and matches a route parameter, then
the resolver will find by the primary key::
#[Route('/product/{product_id}')]
public function show(
#[MapEntity(id: 'product_id')]
Product $product
): Response {
}
``mapping``
Configures the properties and values to use with the ``findOneBy()``
method: the key is the route placeholder name and the value is the Doctrine
property name::
#[Route('/product/{category}/{slug}/comments/{comment_slug}')]
public function show(
#[MapEntity(mapping: ['category' => 'category', 'slug' => 'slug'])]
Product $product,
#[MapEntity(mapping: ['comment_slug' => 'slug'])]
Comment $comment
): Response {
}
``stripNull``
If true, then when ``findOneBy()`` is used, any values that are
``null`` will not be used for the query.
``objectManager``
By default, the ``EntityValueResolver`` uses the *default*
object manager, but you can configure this::
#[Route('/product/{id}')]
public function show(
#[MapEntity(objectManager: 'foo')]
Product $product
): Response {
}
``evictCache``
If true, forces Doctrine to always fetch the entity from the database
instead of cache.
``disabled``
If true, the ``EntityValueResolver`` will not try to replace the argument.
``message``
An optional custom message displayed when there's a :class:`Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException`,
but **only in the development environment** (you won't see this message in production)::
#[Route('/product/{product_id}')]
public function show(
#[MapEntity(id: 'product_id', message: 'The product does not exist')]
Product $product
): Response {
}
.. versionadded:: 7.1
The ``message`` option was introduced in Symfony 7.1.
Updating an Object
------------------
Once you've fetched an object from Doctrine, you interact with it the same as
with any PHP model::
// src/Controller/ProductController.php
namespace App\Controller;
use App\Entity\Product;
use App\Repository\ProductRepository;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;
// ...
class ProductController extends AbstractController
{
#[Route('/product/edit/{id}', name: 'product_edit')]
public function update(EntityManagerInterface $entityManager, int $id): Response
{
$product = $entityManager->getRepository(Product::class)->find($id);
if (!$product) {
throw $this->createNotFoundException(
'No product found for id '.$id
);
}
$product->setName('New product name!');
$entityManager->flush();
return $this->redirectToRoute('product_show', [
'id' => $product->getId()
]);
}
}
Using Doctrine to edit an existing product consists of three steps:
#. fetching the object from Doctrine;
#. modifying the object;
#. calling ``flush()`` on the entity manager.
You *can* call ``$entityManager->persist($product)``, but it isn't necessary:
Doctrine is already "watching" your object for changes.
Deleting an Object
------------------
Deleting an object is very similar, but requires a call to the ``remove()``
method of the entity manager::
$entityManager->remove($product);
$entityManager->flush();
As you might expect, the ``remove()`` method notifies Doctrine that you'd
like to remove the given object from the database. The ``DELETE`` query isn't
actually executed until the ``flush()`` method is called.
.. _doctrine-queries:
Querying for Objects: The Repository
------------------------------------
You've already seen how the repository object allows you to run basic queries
without any work::
// from inside a controller
$repository = $entityManager->getRepository(Product::class);
$product = $repository->find($id);
But what if you need a more complex query? When you generated your entity with
``make:entity``, the command *also* generated a ``ProductRepository`` class::
// src/Repository/ProductRepository.php
namespace App\Repository;
use App\Entity\Product;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
use Doctrine\Persistence\ManagerRegistry;
class ProductRepository extends ServiceEntityRepository
{
public function __construct(ManagerRegistry $registry)
{
parent::__construct($registry, Product::class);
}
}
When you fetch your repository (i.e. ``->getRepository(Product::class)``), it is
*actually* an instance of *this* object! This is because of the ``repositoryClass``
config that was generated at the top of your ``Product`` entity class.
Suppose you want to query for all Product objects greater than a certain price. Add
a new method for this to your repository::
// src/Repository/ProductRepository.php
// ...
class ProductRepository extends ServiceEntityRepository
{
public function __construct(ManagerRegistry $registry)
{
parent::__construct($registry, Product::class);
}
/**
* @return Product[]
*/
public function findAllGreaterThanPrice(int $price): array
{
$entityManager = $this->getEntityManager();
$query = $entityManager->createQuery(
'SELECT p
FROM App\Entity\Product p
WHERE p.price > :price
ORDER BY p.price ASC'
)->setParameter('price', $price);
// returns an array of Product objects
return $query->getResult();
}
}
The string passed to ``createQuery()`` might look like SQL, but it is
`Doctrine Query Language`_. This allows you to type queries using commonly
known query language, but referencing PHP objects instead (i.e. in the ``FROM``
statement).
Now, you can call this method on the repository::
// from inside a controller
$minPrice = 1000;
$products = $entityManager->getRepository(Product::class)->findAllGreaterThanPrice($minPrice);
// ...
See :ref:`services-constructor-injection` for how to inject the repository into
any service.
Querying with the Query Builder
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Doctrine also provides a `Query Builder`_, an object-oriented way to write
queries. It is recommended to use this when queries are built dynamically (i.e.
based on PHP conditions)::
// src/Repository/ProductRepository.php
// ...
class ProductRepository extends ServiceEntityRepository
{
public function findAllGreaterThanPrice(int $price, bool $includeUnavailableProducts = false): array
{
// automatically knows to select Products
// the "p" is an alias you'll use in the rest of the query
$qb = $this->createQueryBuilder('p')
->where('p.price > :price')
->setParameter('price', $price)
->orderBy('p.price', 'ASC');
if (!$includeUnavailableProducts) {
$qb->andWhere('p.available = TRUE');
}
$query = $qb->getQuery();
return $query->execute();
// to get just one result:
// $product = $query->setMaxResults(1)->getOneOrNullResult();
}
}
Querying with SQL
~~~~~~~~~~~~~~~~~
In addition, you can query directly with SQL if you need to::
// src/Repository/ProductRepository.php
// ...
class ProductRepository extends ServiceEntityRepository
{
public function findAllGreaterThanPrice(int $price): array
{
$conn = $this->getEntityManager()->getConnection();
$sql = '
SELECT * FROM product p
WHERE p.price > :price
ORDER BY p.price ASC
';
$resultSet = $conn->executeQuery($sql, ['price' => $price]);
// returns an array of arrays (i.e. a raw data set)
return $resultSet->fetchAllAssociative();
}
}
With SQL, you will get back raw data, not objects (unless you use the `NativeQuery`_
functionality).
Configuration
-------------
See the :doc:`Doctrine config reference </reference/configuration/doctrine>`.
Relationships and Associations
------------------------------
Doctrine provides all the functionality you need to manage database relationships
(also known as associations), including ManyToOne, OneToMany, OneToOne and ManyToMany
relationships.
For info, see :doc:`/doctrine/associations`.
Database Testing
----------------
Read the article about :doc:`testing code that interacts with the database </testing/database>`.
Doctrine Extensions (Timestampable, Translatable, etc.)
-------------------------------------------------------
Doctrine community has created some extensions to implement common needs such as
*"set the value of the createdAt property automatically when creating an entity"*.
Read more about the `available Doctrine extensions`_ and use the
`StofDoctrineExtensionsBundle`_ to integrate them in your application.
Learn more
----------
.. toctree::
:maxdepth: 1
doctrine/associations
doctrine/events
doctrine/custom_dql_functions
doctrine/dbal
doctrine/multiple_entity_managers
doctrine/resolve_target_entity
testing/database
.. _`Doctrine`: https://www.doctrine-project.org/
.. _`RFC 3986`: https://www.ietf.org/rfc/rfc3986.txt
.. _`list of Doctrine mapping types`: https://www.doctrine-project.org/projects/doctrine-orm/en/current/reference/basic-mapping.html#reference-mapping-types
.. _`Query Builder`: https://www.doctrine-project.org/projects/doctrine-orm/en/current/reference/query-builder.html
.. _`Doctrine Query Language`: https://www.doctrine-project.org/projects/doctrine-orm/en/current/reference/dql-doctrine-query-language.html
.. _`Reserved SQL keywords documentation`: https://www.doctrine-project.org/projects/doctrine-orm/en/current/reference/basic-mapping.html#quoting-reserved-words
.. _`DoctrineMongoDBBundle docs`: https://symfony.com/doc/current/bundles/DoctrineMongoDBBundle/index.html
.. _`Transactions and Concurrency`: https://www.doctrine-project.org/projects/doctrine-orm/en/current/reference/transactions-and-concurrency.html
.. _`DoctrineMigrationsBundle`: https://github.com/doctrine/DoctrineMigrationsBundle
.. _`NativeQuery`: https://www.doctrine-project.org/projects/doctrine-orm/en/current/reference/native-sql.html
.. _`limit of 767 bytes for the index key prefix`: https://dev.mysql.com/doc/refman/5.6/en/innodb-limits.html
.. _`Doctrine screencast series`: https://symfonycasts.com/screencast/symfony-doctrine
.. _`API Platform`: https://api-platform.com/docs/core/validation/
.. _`PDO`: https://www.php.net/pdo
.. _`available Doctrine extensions`: https://github.com/doctrine-extensions/DoctrineExtensions
.. _`StofDoctrineExtensionsBundle`: https://github.com/stof/StofDoctrineExtensionsBundle
.. _`MakerBundle`: https://symfony.com/doc/current/bundles/SymfonyMakerBundle/index.html
Reference in New Issue View Git Blame Copy Permalink