Skip to content

Add Doctrine ORM installation instructions. #10798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add Doctrine ORM installation instructions. #10798

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions best_practices/business-logic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,15 @@ library or strategy you want for this.

In practice, many Symfony applications rely on the independent
`Doctrine project`_ to define their model using entities and repositories.

Doctrine support is not enabled by default in Symfony. So to use Doctrine
as shown in the examples below you will need to install `Doctrine ORM support`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can use the doc role here instead:

:doc:`Doctrine ORM support </doctrine>`

by executing the following command:

.. code-block:: terminal

$ composer require "symfony/orm-pack"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ composer require "symfony/orm-pack"
$ composer require symfony/orm-pack

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The quotes on the composer line was to keep it consistent with the Data Fixtures section later on the page. In my opinion neither should have quotes but both having quotes is better than one with quotes and one without.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, I see. You could add a commit to remove the quotes over there too to make it consistent across the whole docs in my opinion.


Just like with business logic, we recommend storing Doctrine entities in the
``src/Entity/`` directory.

Expand Down Expand Up @@ -268,6 +277,7 @@ Next: :doc:`/best_practices/controllers`

.. _`full definition`: https://en.wikipedia.org/wiki/Business_logic
.. _`Doctrine project`: http://www.doctrine-project.org/
.. _`Doctrine ORM support`: https://symfony.com/doc/current/doctrine.html
.. _`fixture class`: https://symfony.com/doc/current/bundles/DoctrineFixturesBundle/index.html#writing-simple-fixtures
.. _`PSR-1`: https://www.php-fig.org/psr/psr-1/
.. _`PSR-2`: https://www.php-fig.org/psr/psr-2/
Expand Down