Create a custom dql function to build json object (JSON_BUILD_OBJECT)

src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php

@@ -33,6 +33,7 @@ use Chill\MainBundle\Doctrine\DQL\Greatest;
 use Chill\MainBundle\Doctrine\DQL\JsonAggregate;
 use Chill\MainBundle\Doctrine\DQL\JsonbArrayLength;
 use Chill\MainBundle\Doctrine\DQL\JsonbExistsInArray;
+use Chill\MainBundle\Doctrine\DQL\JsonBuildObject;
 use Chill\MainBundle\Doctrine\DQL\JsonExtract;
 use Chill\MainBundle\Doctrine\DQL\Least;
 use Chill\MainBundle\Doctrine\DQL\OverlapsI;
@@ -255,6 +256,7 @@ class ChillMainExtension extends Extension implements
                                 'AGGREGATE' => JsonAggregate::class,
                                 'REPLACE' => Replace::class,
                                 'JSON_EXTRACT' => JsonExtract::class,
+                                'JSON_BUILD_OBJECT' => JsonBuildObject::class,
                             ],
                             'numeric_functions' => [
                                 'JSONB_EXISTS_IN_ARRAY' => JsonbExistsInArray::class,

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

@@ -0,0 +1,53 @@
+<?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\AST\Node;
+use Doctrine\ORM\Query\Lexer;
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\SqlWalker;
+
+/**
+ * Return an aggregation of values in a json representation, as a string.
+ *
+ * Internally, this function use the postgresql `jsonb_agg` function. Using
+ * json allow to aggregate data from different types without have to cast them.
+ */
+class JsonBuildObject extends FunctionNode
+{
+    /**
+     * @var array|Node[]
+     */
+    private array $exprs = [];
+
+    public function getSql(SqlWalker $sqlWalker)
+    {
+        return 'JSONB_BUILD_OBJECT(' . implode(', ', array_map(static fn (Node $expr) => $expr->dispatch($sqlWalker), $this->exprs)) . ')';
+    }
+
+    public function parse(Parser $parser)
+    {
+        $lexer = $parser->getLexer();
+        $parser->match(Lexer::T_IDENTIFIER);
+        $parser->match(Lexer::T_OPEN_PARENTHESIS);
+
+        $this->exprs[] = $parser->ArithmeticPrimary();
+
+        while (Lexer::T_COMMA === $lexer->lookahead['type']) {
+            $parser->match(Lexer::T_COMMA);
+            $this->exprs[] = $parser->ArithmeticPrimary();
+        }
+
+        $parser->match(Lexer::T_CLOSE_PARENTHESIS);
+    }
+}

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

@@ -0,0 +1,61 @@
+<?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\Tests\Doctrine\DQL;
+
+use Chill\MainBundle\Entity\Address;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\AbstractQuery;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+class JsonBuildObjectTest extends KernelTestCase
+{
+    private EntityManagerInterface $entityManager;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        self::bootKernel();
+        $this->entityManager = self::$container->get(EntityManagerInterface::class);
+    }
+
+    /**
+     * @dataProvider provideQueries
+     */
+    public function testQuery(string $sql, array $params, array $paramType): void
+    {
+        $query = $this->entityManager->createQuery($sql);
+
+        foreach ($params as $k => $v) {
+            $query->setParameter($k, $v, $paramType[$k]);
+        }
+        $query->setMaxResults(1);
+
+        $result = $query->getResult(AbstractQuery::HYDRATE_ARRAY);
+
+        self::assertIsArray($result);
+    }
+
+    public function provideQueries(): iterable
+    {
+        yield ["SELECT JSON_BUILD_OBJECT(1, 2, 3, 4) FROM " . Address::class . " a", [], []];
+        yield ["SELECT JSON_BUILD_OBJECT('st', a.street, 'sn', a.streetNumber) FROM " . Address::class . ' a', [], []];
+        // next query make the test fails. But we do not need it for now.
+        //yield ["SELECT JSON_BUILD_OBJECT(a.street, :param), LOWER(:param) FROM " . Address::class . " a", ['param' => 1], ['param' => Types::INTEGER]];
+    }
+
+}