Leveraging the Power of Doctrine ORM in Pimcore: A Comprehensive Guide

In the realm of modern web development, efficiently managing data and interacting with databases is crucial for building robust and scalable applications. Pimcore, a leading open-source platform for digital experience management, offers extensive capabilities for content and asset management. However, integrating a powerful Object-Relational Mapping (ORM) system like Doctrine can further enhance its database management functionalities.

Mercury created at 27.03.2024
0

There is one step missing in the video

Please check the last step below to register your repositories as services

In this comprehensive guide, we'll explore how to seamlessly integrate Doctrine ORM into Pimcore, empowering developers to leverage advanced database management capabilities and streamline data handling processes within their projects.

Why Integrate Doctrine ORM with Pimcore?

Doctrine ORM brings numerous benefits to Pimcore projects:

  1. 1. Simplified Data Management: Doctrine abstracts away the complexities of SQL queries and database interactions, allowing developers to work with PHP objects instead of raw SQL.

  2. 2. Enhanced Performance: Doctrine's query caching and lazy loading mechanisms optimize database performance, resulting in faster response times and improved scalability.

  3. 3. Advanced Querying Capabilities: With Doctrine Query Language (DQL), developers can write complex database queries in a more intuitive and expressive manner, enabling efficient data retrieval and manipulation.

  4. 4. Data Integrity and Transactions: Doctrine provides built-in support for transactions, ensuring data integrity and consistency during database operations.

Getting Started: Integrating Doctrine ORM with Pimcore

Here's a step-by-step guide to integrating Doctrine ORM into your Pimcore projects:

1. Require Symfony ORM Pack

Execute the following commands in your project root directory:

composer require symfony/orm-pack
composer require --dev symfony/maker-bundle

2. Update DB configuration

Edit your database.yaml (default located at config/local/database.yaml)

doctrine:
    dbal:
        connections:
            default: &defaultCon # add this anchor to reuse the same connection for app
                host: '%env(MYSQL_HOST)%'
                port: '%env(int:MYSQL_PORT)%'
                dbname: '%env(MYSQL_DATABASE)%'
                user: '%env(MYSQL_USER)%'
                password: '%env(MYSQL_PASSWORD)%'
                mapping_types: { enum: string, bit: boolean }
            app:
                <<: *defaultCon # set anchor defined above or set new credentials
                schema_filter: ~(^app_|migration_versions)~ # this only considers tables starting with app_ or the migration_versions table
    orm:
        auto_generate_proxy_classes: "%kernel.debug%"
        default_entity_manager: app
        entity_managers:
            default:
              connection: default
            app:
                connection: app # set your desired connection here
                mappings:
                    App:
                        is_bundle: false
                        dir: '%kernel.project_dir%/src/Entity'
                        prefix: 'App\Entity'
                        alias: App
                        type: attribute

3. Create "Entity" Folder

Create a directory called "Entity" in your src directory

cd src
mkdir Entity

4. Enable Maker bundle in bundles.php

Find your bundles.php in the config directory and add the following line

Symfony\Bundle\MakerBundle\MakerBundle::class => ['all' => true],

5. Configure Doctrine Migrations

First create a "Migrations" directory in your src directory

cd src
mkdir Migrations

then add a new doctrine_migrations.yaml in the config/packages directory

doctrine_migrations:
    migrations_paths:
        'App\Migrations': '%kernel.project_dir%/src/Migrations'
    em: default
    connection: ~

6. Create your Entities

Use the make command to generate your entities and follow the steps of the generation

Also see https://symfony.com/doc/current/doctrine.html#persisting-objects-to-the-database

bin/console make:entity

then manually add the table name via attribute in the entity php file (src/Entitiy/XYZ.php

#[ORM\Table(name: '`app_xyz`')]
class XYZ

Generate the migrations

instead of using the make:migration command we need to use doctrine:migrations:diff so we can configure the entity manager and namespace in the command.

Otherwise make:migration would use the default entity manager and therefore delete all your pimcore tables and also the namespace otherwise it would use the first migrations path it finds

bin/console doctrine:migrations:diff --em=app --namespace=App\\Migrations

now you can simply execute the migartions with doctrine:migrations:migrate and it will create and/or update your database tables.

Persisting and Fetching of Entities can be used as described in the Symfony Docs

Register your repositories as services

Add the following block in to your services.yaml file in config/services.yaml

App\Repository\:
    resource: '../src/Repository'
    public: true
    tags: [ 'doctrine.repository_service' ]
Comments (0)
  • No Comments
If you want to participate in the discussions. Please log in or consider registering