Passed
Push — main ( 67265c...6a5ba9 )
by Martin
36:25 queued 21:26
created

JsonbPathMatch::customizeFunction()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 1
eloc 1
c 1
b 0
f 1
nc 1
nop 0
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
rs 10
1
<?php
2
3
declare(strict_types=1);
4
5
namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
6
7
use Doctrine\ORM\Query\AST\Node;
8
use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
9
use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Traits\BooleanValidationTrait;
10
11
/**
12
 * Implementation of PostgreSQL JSONB_PATH_MATCH().
13
 *
14
 * Returns the SQL boolean result of a JSON path predicate check for the specified JSON value.
15
 * This is useful only with predicate check expressions, not SQL-standard JSON path expressions,
16
 * since it will either fail or return NULL if the path result is not a single boolean value.
17
 *
18
 * @see https://www.postgresql.org/docs/14/functions-json.html
19
 * @since 3.1
20
 *
21
 * @author Martin Georgiev <[email protected]>
22
 *
23
 * @example Using it in DQL: "SELECT JSONB_PATH_MATCH(e.jsonbData, 'exists($.a[*] ? (@ >= 2 && @ <= 4))')"
24
 */
25
class JsonbPathMatch extends BaseVariadicFunction
26
{
27
    use BooleanValidationTrait;
0 ignored issues
show
Bug introduced by
The trait MartinGeorgiev\Doctrine\...\BooleanValidationTrait requires the property $value which is not provided by MartinGeorgiev\Doctrine\...unctions\JsonbPathMatch.
Loading history...
28
29 4
    protected function getNodeMappingPattern(): array
30
    {
31 4
        return ['StringPrimary'];
32
    }
33
34 4
    protected function customizeFunction(): void
35
    {
36 4
        $this->setFunctionPrototype('jsonb_path_match(%s)');
37
    }
38
39 4
    protected function validateArguments(Node ...$arguments): void
40
    {
41 4
        $argumentCount = \count($arguments);
42 4
        if ($argumentCount < 2 || $argumentCount > 4) {
43 2
            throw InvalidArgumentForVariadicFunctionException::between('jsonb_path_match', 2, 4);
44
        }
45
46
        // Validate that the fourth parameter is a valid boolean if provided
47 2
        if ($argumentCount === 4) {
48 2
            $this->validateBoolean($arguments[3], 'JSONB_PATH_MATCH');
49
        }
50
    }
51
}
52