Как зарегистрировать пользовательские функции DQL

Дата обновления перевода 2025-02-14

Как зарегистрировать пользовательские функции DQL

Doctrine позволяет вам указать пользовательские функции DQL. Чтобы узнать больше информации по этой теме, прочтите статью Cookbook Doctrine "`Определяемые пользователем функции DQL`_".

В Symfony вы можете зарегистрировать ваши пользовательские функции DQL следующим образом:

        1
2
3
4
5
6
7
8
9
10
11
12
        # config/packages/doctrine.yaml
doctrine:
    orm:
        # ...
        dql:
            string_functions:
                test_string: App\DQL\StringFunction
                second_string: App\DQL\SecondStringFunction
            numeric_functions:
                test_numeric: App\DQL\NumericFunction
            datetime_functions:
                test_datetime: App\DQL\DatetimeFunction
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
        <!-- config/packages/doctrine.xml -->
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:doctrine="http://symfony.com/schema/dic/doctrine"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/doctrine
        https://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">

    <doctrine:config>
        <doctrine:orm>
            <!-- ... -->
            <doctrine:dql>
                <doctrine:string-function name="test_string">App\DQL\StringFunction</doctrine:string-function>
                <doctrine:string-function name="second_string">App\DQL\SecondStringFunction</doctrine:string-function>
                <doctrine:numeric-function name="test_numeric">App\DQL\NumericFunction</doctrine:numeric-function>
                <doctrine:datetime-function name="test_datetime">App\DQL\DatetimeFunction</doctrine:datetime-function>
            </doctrine:dql>
        </doctrine:orm>
    </doctrine:config>
</container>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
        // config/packages/doctrine.php
use App\DQL\DatetimeFunction;
use App\DQL\NumericFunction;
use App\DQL\SecondStringFunction;
use App\DQL\StringFunction;
use Symfony\Config\DoctrineConfig;

return static function (DoctrineConfig $doctrine): void {
    $defaultDql = $doctrine->orm()
        ->entityManager('default')
            // ...
            ->dql();

    $defaultDql->stringFunction('test_string', StringFunction::class);
    $defaultDql->stringFunction('second_string', SecondStringFunction::class);
    $defaultDql->numericFunction('test_numeric', NumericFunction::class);
    $defaultDql->datetimeFunction('test_datetime', DatetimeFunction::class);
};
    

Note

Если entity_managers были ясно названы, конфигурация функций напрямую с ORM вызовет исключение Unrecognized option "dql" under "doctrine.orm". Блок конфигурации dql
должен быть определён под названным менеджером сущностей.

        1
2
3
4
5
6
7
8
9
10
        # config/packages/doctrine.yaml
doctrine:
    orm:
        # ...
        entity_managers:
            example_manager:
                # Поместите ваши функции здесь
                dql:
                    datetime_functions:
                        test_datetime: App\DQL\DatetimeFunction
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
        <!-- config/packages/doctrine.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:doctrine="http://symfony.com/schema/dic/doctrine"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/doctrine
        https://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">

    <doctrine:config>
        <doctrine:orm>
            <!-- ... -->

            <doctrine:entity-manager name="example_manager">
                <!-- поместите ваши функции здесь -->
                <doctrine:dql>
                    <doctrine:datetime-function name="test_datetime">
                        App\DQL\DatetimeFunction
                    </doctrine:datetime-function>
                </doctrine:dql>
            </doctrine:entity-manager>
        </doctrine:orm>
    </doctrine:config>
</container>
    

        1
2
3
4
5
6
7
8
9
10
11
12
        // config/packages/doctrine.php
use App\DQL\DatetimeFunction;
use Symfony\Config\DoctrineConfig;

return static function (DoctrineConfig $doctrine): void {
    $doctrine->orm()
        // ...
        ->entityManager('example_manager')
            // place your functions here
            ->dql()
                ->datetimeFunction('test_datetime', DatetimeFunction::class);
};
    

Warning

Функции DQL инстанциируются Doctrine вне сервис-контейнера Symfony, поэтому вы не можете внедрять сервисы или параметры в пользователькую функцию DQL.