add json basic functions support

Author: pfilsx

src/ORM/Query/AST/Functions/JsonGetArrayElement.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\ORM\Query\AST\Functions;
+
+use Doctrine\ORM\Query\Lexer;
+use Doctrine\ORM\Query\Parser;
+
+/**
+ * Implementation of PostgreSql json array field retrieval by index
+ * @see https://www.postgresql.org/docs/current/functions-json.html
+ * @example JSON_GET_ARRAY_ELEMENT(entity.field, 1)
+ */
+final class JsonGetArrayElement extends JsonGetField
+{
+    public function parse(Parser $parser): void
+    {
+        $parser->match(Lexer::T_IDENTIFIER);
+        $parser->match(Lexer::T_OPEN_PARENTHESIS);
+
+        $this->field = $parser->StringPrimary();
+        $parser->match(Lexer::T_COMMA);
+        $this->path[] = $parser->ArithmeticPrimary();
+
+        if (!$parser->getLexer()->isNextToken(Lexer::T_CLOSE_PARENTHESIS)) {
+            while ($parser->getLexer()->isNextToken(Lexer::T_COMMA)) {
+                $parser->match(Lexer::T_COMMA);
+                $this->path[] = $parser->ArithmeticPrimary();
+            }
+        }
+
+        $parser->match(Lexer::T_CLOSE_PARENTHESIS);
+    }
+}

src/ORM/Query/AST/Functions/JsonGetArrayElementAsText.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\ORM\Query\AST\Functions;
+
+use Doctrine\ORM\Query\Lexer;
+use Doctrine\ORM\Query\Parser;
+
+/**
+ * Implementation of PostgreSql json array field retrieval by index
+ * @see https://www.postgresql.org/docs/current/functions-json.html
+ * @example JSON_GET_ARRAY_ELEMENT_AS_TEXT(entity.field, 1)
+ */
+final class JsonGetArrayElementAsText extends JsonGetFieldAsText
+{
+    public function parse(Parser $parser): void
+    {
+        $parser->match(Lexer::T_IDENTIFIER);
+        $parser->match(Lexer::T_OPEN_PARENTHESIS);
+
+        $this->field = $parser->StringPrimary();
+        $parser->match(Lexer::T_COMMA);
+        $this->path[] = $parser->ArithmeticPrimary();
+
+        if (!$parser->getLexer()->isNextToken(Lexer::T_CLOSE_PARENTHESIS)) {
+            while ($parser->getLexer()->isNextToken(Lexer::T_COMMA)) {
+                $parser->match(Lexer::T_COMMA);
+                $this->path[] = $parser->ArithmeticPrimary();
+            }
+        }
+
+        $parser->match(Lexer::T_CLOSE_PARENTHESIS);
+    }
+}

src/ORM/Query/AST/Functions/JsonGetField.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\ORM\Query\AST\Functions;
+
+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;
+
+/**
+ * Implementation of PostgreSql json object field retrieval by path
+ * @see https://www.postgresql.org/docs/current/functions-json.html
+ * @example JSON_GET_FIELD(entity.field, 'a', 'b')
+ */
+class JsonGetField extends FunctionNode
+{
+    protected Node $field;
+
+    /**
+     * @var Node[]
+     */
+    protected array $path = [];
+
+    public function parse(Parser $parser): void
+    {
+        $parser->match(Lexer::T_IDENTIFIER);
+        $parser->match(Lexer::T_OPEN_PARENTHESIS);
+
+        $this->field = $parser->StringPrimary();
+        $parser->match(Lexer::T_COMMA);
+        $this->path[] = $parser->StringPrimary();
+
+        if (!$parser->getLexer()->isNextToken(Lexer::T_CLOSE_PARENTHESIS)) {
+            while ($parser->getLexer()->isNextToken(Lexer::T_COMMA)) {
+                $parser->match(Lexer::T_COMMA);
+                $this->path[] = $parser->StringPrimary();
+            }
+        }
+
+        $parser->match(Lexer::T_CLOSE_PARENTHESIS);
+    }
+
+    public function getSql(SqlWalker $sqlWalker): string
+    {
+        return sprintf(
+            '%s->%s',
+            $this->field->dispatch($sqlWalker),
+            implode(
+                '->',
+                array_map(static fn (Node $node) => $node->dispatch($sqlWalker), $this->path)
+            )
+        );
+    }
+}

src/ORM/Query/AST/Functions/JsonGetFieldAsText.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\ORM\Query\AST\Functions;
+
+use Doctrine\ORM\Query\AST\Node;
+use Doctrine\ORM\Query\SqlWalker;
+
+/**
+ * Implementation of PostgreSql json object field as text retrieval by path
+ * @see https://www.postgresql.org/docs/current/functions-json.html
+ * @example JSON_GET_FIELD_AS_TEXT(entity.field, 'a', 'b')
+ */
+class JsonGetFieldAsText extends JsonGetField
+{
+    public function getSql(SqlWalker $sqlWalker): string
+    {
+        $path = array_map(static fn (Node $node) => $node->dispatch($sqlWalker), $this->path);
+
+        $lastPathElement = array_pop($path);
+
+        $sql = $this->field->dispatch($sqlWalker);
+
+        if (count($path) > 0) {
+            $sql .= sprintf('->%s', implode('->', $path));
+        }
+
+        return "$sql->>$lastPathElement";
+    }
+}

src/ORM/Query/AST/Functions/JsonGetObject.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\ORM\Query\AST\Functions;
+
+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;
+
+/**
+ * Implementation of PostgreSql json object retrieval by path
+ * @see https://www.postgresql.org/docs/current/functions-json.html
+ * @example JSON_GET_OBJECT(entity.field, '{a,b}')
+ */
+class JsonGetObject extends FunctionNode
+{
+    protected Node $field;
+
+    protected Node $path;
+
+    public function parse(Parser $parser): void
+    {
+        $parser->match(Lexer::T_IDENTIFIER);
+        $parser->match(Lexer::T_OPEN_PARENTHESIS);
+
+        $this->field = $parser->StringPrimary();
+        $parser->match(Lexer::T_COMMA);
+        $this->path = $parser->StringPrimary();
+        $parser->match(Lexer::T_CLOSE_PARENTHESIS);
+    }
+
+    public function getSql(SqlWalker $sqlWalker): string
+    {
+        return "{$this->field->dispatch($sqlWalker)} #> {$this->path->dispatch($sqlWalker)}";
+    }
+}

src/ORM/Query/AST/Functions/JsonGetObjectAsText.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\ORM\Query\AST\Functions;
+
+use Doctrine\ORM\Query\SqlWalker;
+
+/**
+ * Implementation of PostgreSql json object as text retrieval by path
+ * @see https://www.postgresql.org/docs/current/functions-json.html
+ * @example JSON_GET_OBJECT_AS_TEXT(entity.field, '{a,b}')
+ */
+final class JsonGetObjectAsText extends JsonGetObject
+{
+    public function getSql(SqlWalker $sqlWalker): string
+    {
+        return "{$this->field->dispatch($sqlWalker)} #>> {$this->path->dispatch($sqlWalker)}";
+    }
+}