如何注册自定义 DQL 函数

编辑此页

Doctrine 允许你指定自定义 DQL 函数。关于此主题的更多信息，请阅读 Doctrine 的 cookbook 文章 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="https://symfony.com.cn/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:doctrine="https://symfony.com.cn/schema/dic/doctrine"
    xsi:schemaLocation="https://symfony.com.cn/schema/dic/services
        https://symfony.com.cn/schema/dic/services/services-1.0.xsd
        https://symfony.com.cn/schema/dic/doctrine
        https://symfony.com.cn/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);
};
    

注意

如果 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:
                # Place your functions here
                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="https://symfony.com.cn/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:doctrine="https://symfony.com.cn/schema/dic/doctrine"
    xsi:schemaLocation="https://symfony.com.cn/schema/dic/services
        https://symfony.com.cn/schema/dic/services/services-1.0.xsd
        https://symfony.com.cn/schema/dic/doctrine
        https://symfony.com.cn/schema/dic/doctrine/doctrine-1.0.xsd">

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

            <doctrine:entity-manager name="example_manager">
                <!-- place your functions here -->
                <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);
};
    

警告

DQL 函数由 Doctrine 在 Symfony 服务容器之外实例化，因此你无法将服务或参数注入到自定义 DQL 函数中。

本作品，包括代码示例，根据 Creative Commons BY-SA 3.0 许可协议获得许可。

版本