Added JSON_VALUE for mysql platform

fixes #82

Author: Hikariii

.gitignore

@@ -2,4 +2,5 @@
 /composer.lock
 /vendor
 .phpunit.result.cache
+.phpunit.cache
 .phpcs-cache

src/Query/AST/Functions/AbstractJsonFunctionNode.php

@@ -16,7 +16,7 @@
 
 abstract class AbstractJsonFunctionNode extends FunctionNode
 {
-    public const FUNCTION_NAME = null;
+    public const FUNCTION_NAME = '';
 
     protected const ALPHA_NUMERIC = 'alphaNumeric';
     protected const STRING_PRIMARY_ARG = 'stringPrimary';

src/Query/AST/Functions/Mysql/JsonValue.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Scienta\DoctrineJsonFunctions\Query\AST\Functions\Mysql;
+
+use Doctrine\DBAL\Exception;
+use Doctrine\ORM\Query\AST\Node;
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\SqlWalker;
+use Doctrine\ORM\Query\TokenType;
+
+use function implode;
+use function sprintf;
+
+/**
+ * "JSON_VALUE" "(" StringPrimary "," StringPrimary "RETURNING" TypeExpression ")"
+ * @example JSON_VALUE('{"item": "shoes", "price": "49.95"}', '$.price', DECIMAL(4,2))
+ */
+class JsonValue extends MysqlJsonFunctionNode
+{
+    public const FUNCTION_NAME = 'JSON_VALUE';
+
+    /** @var list<Node> */
+    private array $jsonArguments = [];
+
+    private string | null $returningType;
+
+    public function parse(Parser $parser): void
+    {
+        $parser->match(TokenType::T_IDENTIFIER);
+        $parser->match(TokenType::T_OPEN_PARENTHESIS);
+
+        $this->jsonArguments[] = $parser->StringPrimary();
+
+        $parser->match(TokenType::T_COMMA);
+
+        $this->jsonArguments[] = $parser->StringPrimary();
+
+        $parser->match(TokenType::T_COMMA);
+
+        // match complex returning types
+        $parser->match(TokenType::T_IDENTIFIER);
+        $this->returningType = $parser->getLexer()->token->value;
+
+        if ($parser->getLexer()->isNextToken(TokenType::T_OPEN_PARENTHESIS)) {
+            $parser->match(TokenType::T_OPEN_PARENTHESIS);
+            $parameter = $parser->Literal();
+            $parameters = [$parameter->value];
+
+            if ($parser->getLexer()->isNextToken(TokenType::T_COMMA)) {
+                while ($parser->getLexer()->isNextToken(TokenType::T_COMMA)) {
+                    $parser->match(TokenType::T_COMMA);
+                    $parameter    = $parser->Literal();
+                    $parameters[] = $parameter->value;
+                }
+            }
+
+            $parser->match(TokenType::T_CLOSE_PARENTHESIS);
+            $this->returningType .= '(' . implode(',', $parameters) . ')';
+        }
+        $argumentParsed = $this->parseArguments($parser, $this->requiredArgumentTypes);
+
+        if (!empty($this->optionalArgumentTypes)) {
+            $this->parseOptionalArguments($parser, $argumentParsed);
+        }
+
+        $parser->match(TokenType::T_CLOSE_PARENTHESIS);
+    }
+
+    /**
+     * @param SqlWalker $sqlWalker
+     * @return string
+     * @throws Exception
+     * @throws \Doctrine\ORM\Query\AST\ASTException
+     */
+    public function getSql(SqlWalker $sqlWalker): string
+    {
+        $this->validatePlatform($sqlWalker);
+
+        /** @var list<string> $jsonStringArguments */
+        $jsonStringArguments = [];
+        foreach ($this->jsonArguments as $jsonArgument) {
+            if ($jsonArgument === null) {
+                $jsonStringArguments[] = 'NULL';
+            } else {
+                $jsonStringArguments[] = $jsonArgument->dispatch($sqlWalker);
+            }
+        }
+
+        return sprintf(
+            '%s(%s RETURNING %s)',
+            $this->getSQLFunction(),
+            implode(', ', $jsonStringArguments),
+            $this->returningType,
+        );
+    }
+}

tests/Query/Functions/Mysql/JsonValueTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Query\Functions\Mysql;
+
+use Scienta\DoctrineJsonFunctions\Tests\Query\MysqlTestCase;
+
+class JsonValueTest extends MysqlTestCase
+{
+    public function testJsonValueForData()
+    {
+        $this->assertDqlProducesSql(
+            "SELECT JSON_VALUE(j.jsonData, '$.a', UNSIGNED) FROM Scienta\DoctrineJsonFunctions\Tests\Entities\JsonData j",
+            "SELECT JSON_VALUE(j0_.jsonData, '$.a' RETURNING UNSIGNED) AS sclr_0 FROM JsonData j0_"
+        );
+    }
+
+    public function testJsonValueReturningDecimal()
+    {
+        $this->assertDqlProducesSql(
+            "SELECT JSON_VALUE('{\"item\": \"shoes\", \"price\": \"49.95\"}', '$.price', DECIMAL(4,2)) from Scienta\DoctrineJsonFunctions\Tests\Entities\Blank b",
+            "SELECT JSON_VALUE('{\"item\": \"shoes\", \"price\": \"49.95\"}', '$.price' RETURNING DECIMAL(4,2)) AS sclr_0 FROM Blank b0_"
+        );
+    }
+    public function testJsonValueForDataReturningVarchar()
+    {
+        $this->assertDqlProducesSql(
+            "SELECT JSON_VALUE(j.jsonData, '$.something', CHAR(255)) FROM Scienta\DoctrineJsonFunctions\Tests\Entities\JsonData j",
+            "SELECT JSON_VALUE(j0_.jsonData, '$.something' RETURNING CHAR(255)) AS sclr_0 FROM JsonData j0_"
+        );
+    }
+}

tests/Query/MysqlTestCase.php

@@ -53,5 +53,6 @@ public static function loadDqlFunctions(Configuration $configuration)
         $configuration->addCustomStringFunction(DqlFunctions\JsonType::FUNCTION_NAME, DqlFunctions\JsonType::class);
         $configuration->addCustomStringFunction(DqlFunctions\JsonUnquote::FUNCTION_NAME, DqlFunctions\JsonUnquote::class);
         $configuration->addCustomStringFunction(DqlFunctions\JsonValid::FUNCTION_NAME, DqlFunctions\JsonValid::class);
+        $configuration->addCustomStringFunction(DqlFunctions\JsonValue::FUNCTION_NAME, DqlFunctions\JsonValue::class);
     }
 }