Registering Custom DQL Functions

Doctrine allows you to specify custom DQL functions. For more information on this topic, read Doctrine’s cookbook article “DQL User Defined Functions”.

In Symfony, you can register your custom DQL functions as follows:

• YAML

  # app/config/config.yml
  doctrine:
      orm:
          # ...
          entity_managers:
              default:
                  # ...
                  dql:
                      string_functions:
                          test_string: Acme\HelloBundle\DQL\StringFunction
                          second_string: Acme\HelloBundle\DQL\SecondStringFunction
                      numeric_functions:
                          test_numeric: Acme\HelloBundle\DQL\NumericFunction
                      datetime_functions:
                          test_datetime: Acme\HelloBundle\DQL\DatetimeFunction
  

• XML

  <!-- app/config/config.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 http://symfony.com/schema/dic/services/services-1.0.xsd
                          http://symfony.com/schema/dic/doctrine http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
  
      <doctrine:config>
          <doctrine:orm>
              <!-- ... -->
              <doctrine:entity-manager name="default">
                  <!-- ... -->
                  <doctrine:dql>
                      <doctrine:string-function name="test_string>Acme\HelloBundle\DQL\StringFunction</doctrine:string-function>
                      <doctrine:string-function name="second_string>Acme\HelloBundle\DQL\SecondStringFunction</doctrine:string-function>
                      <doctrine:numeric-function name="test_numeric>Acme\HelloBundle\DQL\NumericFunction</doctrine:numeric-function>
                      <doctrine:datetime-function name="test_datetime>Acme\HelloBundle\DQL\DatetimeFunction</doctrine:datetime-function>
                  </doctrine:dql>
              </doctrine:entity-manager>
          </doctrine:orm>
      </doctrine:config>
  </container>
  

• PHP

  // app/config/config.php
  $container->loadFromExtension('doctrine', array(
      'orm' => array(
          // ...
          'entity_managers' => array(
              'default' => array(
                  // ...
                  'dql' => array(
                      'string_functions' => array(
                          'test_string'   => 'Acme\HelloBundle\DQL\StringFunction',
                          'second_string' => 'Acme\HelloBundle\DQL\SecondStringFunction',
                      ),
                      'numeric_functions' => array(
                          'test_numeric' => 'Acme\HelloBundle\DQL\NumericFunction',
                      ),
                      'datetime_functions' => array(
                          'test_datetime' => 'Acme\HelloBundle\DQL\DatetimeFunction',
                      ),
                  ),
              ),
          ),
      ),
  ));