Add JSON_CONTAINS for MySQL (#354)

Author: MrMitch

README.md

@@ -13,7 +13,7 @@ MySQL, Oracle, PostgreSQL and SQLite.
 
 | DB | Functions |
 |:--:|:---------:|
-| MySQL | `ACOS, ADDTIME, AES_DECRYPT, AES_ENCRYPT, ANY_VALUE, ASCII, ASIN, ATAN, ATAN2, BINARY, BIT_COUNT, BIT_XOR, CAST, CEIL, CHAR_LENGTH, COLLATE, CONCAT_WS, CONVERT_TZ, COS, COT, COUNTIF, CRC32, DATE, DATE_FORMAT, DATEADD, DATEDIFF, DATESUB, DAY, DAYNAME, DAYOFWEEK, DAYOFYEAR, DEGREES, DIV, EXP, EXTRACT, FIELD, FIND_IN_SET, FLOOR, FORMAT, FROM_BASE64, FROM_UNIXTIME, GREATEST, GROUP_CONCAT, HEX, HOUR, IFELSE, IFNULL, INET_ATON, INET_NTOA, INET6_ATON, INET6_NTOA, INSTR, IS_IPV4, IS_IPV4_COMPAT, IS_IPV4_MAPPED, IS_IPV6, JSON_DEPTH, LAG, LAST_DAY, LEAD, LEAST, LOG, LOG10, LOG2, LPAD, MAKEDATE, MATCH, MD5, MINUTE, MONTH, MONTHNAME, NOW, NULLIF, OVER, PERIOD_DIFF, PI, POWER, QUARTER, RADIANS, RAND, REGEXP, REPLACE, ROUND, RPAD, SECOND, SECTOTIME, SHA1, SHA2, SIN, SOUNDEX, STD, STDDEV, STRTODATE, STR_TO_DATE, SUBSTRING_INDEX, TAN, TIME, TIMEDIFF, TIMESTAMPADD, TIMESTAMPDIFF, TIMETOSEC, TRUNCATE, UNHEX, UNIX_TIMESTAMP, UTC_TIMESTAMP, UUID_SHORT, VARIANCE, WEEK, WEEKDAY, YEAR, YEARMONTH, YEARWEEK` |
+| MySQL | `ACOS, ADDTIME, AES_DECRYPT, AES_ENCRYPT, ANY_VALUE, ASCII, ASIN, ATAN, ATAN2, BINARY, BIT_COUNT, BIT_XOR, CAST, CEIL, CHAR_LENGTH, COLLATE, CONCAT_WS, CONVERT_TZ, COS, COT, COUNTIF, CRC32, DATE, DATE_FORMAT, DATEADD, DATEDIFF, DATESUB, DAY, DAYNAME, DAYOFWEEK, DAYOFYEAR, DEGREES, DIV, EXP, EXTRACT, FIELD, FIND_IN_SET, FLOOR, FORMAT, FROM_BASE64, FROM_UNIXTIME, GREATEST, GROUP_CONCAT, HEX, HOUR, IFELSE, IFNULL, INET_ATON, INET_NTOA, INET6_ATON, INET6_NTOA, INSTR, IS_IPV4, IS_IPV4_COMPAT, IS_IPV4_MAPPED, IS_IPV6, JSON_CONTAINS, JSON_DEPTH, LAG, LAST_DAY, LEAD, LEAST, LOG, LOG10, LOG2, LPAD, MAKEDATE, MATCH, MD5, MINUTE, MONTH, MONTHNAME, NOW, NULLIF, OVER, PERIOD_DIFF, PI, POWER, QUARTER, RADIANS, RAND, REGEXP, REPLACE, ROUND, RPAD, SECOND, SECTOTIME, SHA1, SHA2, SIN, SOUNDEX, STD, STDDEV, STRTODATE, STR_TO_DATE, SUBSTRING_INDEX, TAN, TIME, TIMEDIFF, TIMESTAMPADD, TIMESTAMPDIFF, TIMETOSEC, TRUNCATE, UNHEX, UNIX_TIMESTAMP, UTC_TIMESTAMP, UUID_SHORT, VARIANCE, WEEK, WEEKDAY, YEAR, YEARMONTH, YEARWEEK` |
 | Oracle | `CEIL, DAY, FLOOR, HOUR, LISTAGG, MINUTE, MONTH, NVL, SECOND, TO_CHAR, TO_DATE, TRUNC, YEAR` |
 | Sqlite | `CASE WHEN THEN ELSE END, DATE, DATE_FORMAT*, DAY, HOUR, IFNULL, JULIANDAY, MINUTE, MONTH, REPLACE, ROUND, SECOND, STRFTIME, WEEK, WEEKDAY, YEAR` |
 | PostgreSQL | `AT_TIME_ZONE, COUNT_FILTER, DATE, DATE_PART, DATE_TRUNC, DAY, EXTRACT, GREATEST, HOUR, LEAST, MINUTE, MONTH, REGEXP_REPLACE, SECOND, STRING_AGG, TO_CHAR, TO_DATE, YEAR` |

config/mysql.yml

@@ -54,6 +54,7 @@ doctrine:
                  degrees: DoctrineExtensions\Query\Mysql\Degrees
                  exp: DoctrineExtensions\Query\Mysql\Exp
                  floor: DoctrineExtensions\Query\Mysql\Floor
+                 json_contains: DoctrineExtensions\Query\Mysql\JsonContains
                  json_depth: DoctrineExtensions\Query\Mysql\JsonDepth
                  log: DoctrineExtensions\Query\Mysql\Log
                  log10: DoctrineExtensions\Query\Mysql\Log10

src/Query/Mysql/JsonContains.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace DoctrineExtensions\Query\Mysql;
+
+use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\Lexer;
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\SqlWalker;
+
+class JsonContains extends FunctionNode
+{
+    protected $target;
+
+    protected $candidate;
+
+    protected $path;
+
+    public function parse(Parser $parser)
+    {
+        $parser->match(Lexer::T_IDENTIFIER);
+        $parser->match(Lexer::T_OPEN_PARENTHESIS);
+
+        $this->target = $parser->StringPrimary();
+
+        $parser->match(Lexer::T_COMMA);
+
+        $this->candidate = $parser->StringPrimary();
+
+        if ($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)
+    {
+        $target = $sqlWalker->walkStringPrimary($this->target);
+        $candidate = $sqlWalker->walkStringPrimary($this->candidate);
+
+        if ($this->path !== null) {
+            $path = $sqlWalker->walkStringPrimary($this->path);
+
+            return sprintf('JSON_CONTAINS(%s, %s, %s)', $target, $candidate, $path);
+        }
+
+        return sprintf('JSON_CONTAINS(%s, %s)', $target, $candidate);
+    }
+}

tests/Query/Mysql/JsonContainsTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace DoctrineExtensions\Tests\Query\Mysql;
+
+use DoctrineExtensions\Tests\Query\MysqlTestCase;
+
+class JsonContainsTest extends MysqlTestCase
+{
+    public function testJsonContainsWithoutPath(): void
+    {
+        $this->assertDqlProducesSql(
+            "SELECT JSON_CONTAINS('{}', :param) from DoctrineExtensions\Tests\Entities\Blank as blank",
+            "SELECT JSON_CONTAINS('{}', ?) AS sclr_0 FROM Blank b0_",
+            ['param' => '']
+        );
+    }
+
+    public function testJsonContainsWithPathAsParam(): void
+    {
+        $this->assertDqlProducesSql(
+            "SELECT JSON_CONTAINS('{}', :param, :path) from DoctrineExtensions\Tests\Entities\Blank as blank",
+            "SELECT JSON_CONTAINS('{}', ?, ?) AS sclr_0 FROM Blank b0_"
+        );
+    }
+
+    public function testJsonContainsWithPathAsExplicit(): void
+    {
+        $this->assertDqlProducesSql(
+            "SELECT JSON_CONTAINS('{}', :param, '$[0]') from DoctrineExtensions\Tests\Entities\Blank as blank",
+            "SELECT JSON_CONTAINS('{}', ?, '$[0]') AS sclr_0 FROM Blank b0_"
+        );
+    }
+}