DX: [dql] add a function JSON_EXTRACT

This might be used to sort lines which contains translatable string.

src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php

@@ -27,6 +27,7 @@ use Chill\MainBundle\Doctrine\DQL\GetJsonFieldByKey;
 use Chill\MainBundle\Doctrine\DQL\JsonAggregate;
 use Chill\MainBundle\Doctrine\DQL\JsonbArrayLength;
 use Chill\MainBundle\Doctrine\DQL\JsonbExistsInArray;
+use Chill\MainBundle\Doctrine\DQL\JsonExtract;
 use Chill\MainBundle\Doctrine\DQL\OverlapsI;
 use Chill\MainBundle\Doctrine\DQL\Replace;
 use Chill\MainBundle\Doctrine\DQL\Similarity;
@@ -231,6 +232,7 @@ class ChillMainExtension extends Extension implements
                                 'GET_JSON_FIELD_BY_KEY' => GetJsonFieldByKey::class,
                                 'AGGREGATE' => JsonAggregate::class,
                                 'REPLACE' => Replace::class,
+                                'JSON_EXTRACT' => JsonExtract::class,
                             ],
                             'numeric_functions' => [
                                 'JSONB_EXISTS_IN_ARRAY' => JsonbExistsInArray::class,

src/Bundle/ChillMainBundle/Doctrine/DQL/JsonExtract.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Doctrine\DQL;
+
+use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\Lexer;
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\SqlWalker;
+
+class JsonExtract extends FunctionNode
+{
+    private $element;
+
+    private $keyToExtract;
+
+    public function getSql(SqlWalker $sqlWalker)
+    {
+        return sprintf('%s->>%s', $this->element->dispatch($sqlWalker), $this->keyToExtract->dispatch($sqlWalker));
+    }
+
+    public function parse(Parser $parser)
+    {
+        $parser->match(Lexer::T_IDENTIFIER);
+        $parser->match(Lexer::T_OPEN_PARENTHESIS);
+
+        $this->element = $parser->ArithmeticPrimary();
+
+        $parser->match(Lexer::T_COMMA);
+
+        $this->keyToExtract = $parser->ArithmeticExpression();
+
+        $parser->match(Lexer::T_CLOSE_PARENTHESIS);
+    }
+}

src/Bundle/ChillMainBundle/Tests/Doctrine/DQL/JsonExtractTest.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Doctrine\DQL;
+
+use Chill\MainBundle\Entity\Country;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+final class JsonExtractTest extends KernelTestCase
+{
+    private EntityManagerInterface $em;
+
+    protected function setUp(): void
+    {
+        self::bootKernel();
+
+        $this->em = self::$container->get(EntityManagerInterface::class);
+    }
+
+    public function dataGenerateDql(): iterable
+    {
+        yield ['SELECT JSON_EXTRACT(c.name, \'fr\') FROM ' . Country::class . ' c', []];
+
+        yield ['SELECT JSON_EXTRACT(c.name, :lang) FROM ' . Country::class . ' c', ['lang' => 'fr']];
+    }
+
+    /**
+     * @dataProvider dataGenerateDql
+     */
+    public function testJsonExtract(string $dql, array $args)
+    {
+        $results = $this->em->createQuery($dql)
+            ->setMaxResults(2)
+            ->setParameters($args)
+            ->getResult();
+
+        $this->assertIsArray($results, 'simply test that the query return a result');
+    }
+}