ArrayToJson::validateArguments() - Code Metrics - Inspection of "feat: extend existing function support with option..." - martin-georgiev/postgresql-for-doctrine - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — new-funcs2 ( 471c3f )

by Martin

created 2025-04-13 07:45 UTC

ArrayToJson::validateArguments() A

↳ Parent: ArrayToJson

Complexity

Conditions	4
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	5
nc	3
nop	1
dl	0
loc	10
ccs	6
cts	6
cp	1
crap	4
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;

use Doctrine\ORM\Query\AST\Node;
use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Traits\BooleanValidationTrait;

/**
 * Implementation of PostgreSQL ARRAY_TO_JSON().
 *
 * Returns the array as a JSON array. A PostgreSQL multidimensional array becomes a JSON array of arrays.
 * Line feeds will be added between dimension-1 elements if pretty_bool is true.
 *
 * @see https://www.postgresql.org/docs/16/functions-json.html
 * @since 0.10
 *
 * @author Martin Georgiev <[email protected]>
 *
 * @example Using it in DQL: "SELECT ARRAY_TO_JSON(e.array1) FROM Entity e"
 * @example Using it in DQL with pretty_bool: "SELECT ARRAY_TO_JSON(e.array1, 'true') FROM Entity e"
 */
class ArrayToJson extends BaseVariadicFunction
{
    use BooleanValidationTrait;


    protected function customizeFunction(): void
    {
        $this->setFunctionPrototype('array_to_json(%s)');
    }

    protected function validateArguments(Node ...$arguments): void
    {
        $argumentCount = \count($arguments);
        if ($argumentCount < 1 || $argumentCount > 2) {
            throw InvalidArgumentForVariadicFunctionException::between('array_to_json', 1, 2);
        }

        // Validate that the second parameter is a valid boolean if provided
        if ($argumentCount === 2) {
            $this->validateBoolean($arguments[1], 'ARRAY_TO_JSON');
        }
    }
}


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 ARRAY_TO_JSON().
13		*
14		* Returns the array as a JSON array. A PostgreSQL multidimensional array becomes a JSON array of arrays.
15		* Line feeds will be added between dimension-1 elements if pretty_bool is true.
16		*
17		* @see https://www.postgresql.org/docs/16/functions-json.html
18		* @since 0.10
19		*
20		* @author Martin Georgiev <[email protected]>
21		*
22		* @example Using it in DQL: "SELECT ARRAY_TO_JSON(e.array1) FROM Entity e"
23		* @example Using it in DQL with pretty_bool: "SELECT ARRAY_TO_JSON(e.array1, 'true') FROM Entity e"
24		*/
25		class ArrayToJson extends BaseVariadicFunction
26		{
27		use BooleanValidationTrait;
		0 ignored issues – show Bug introduced 2025-04-13 07:59 UTC by Report Bug Copy Issue Report The trait `MartinGeorgiev\Doctrine\...\BooleanValidationTrait` requires the property `$value` which is not provided by `MartinGeorgiev\Doctrine\...T\Functions\ArrayToJson`. Loading history...
28
29	3	protected function customizeFunction(): void
30		{
31	3	$this->setFunctionPrototype('array_to_json(%s)');
32		}
33
34	3	protected function validateArguments(Node ...$arguments): void
35		{
36	3	$argumentCount = \count($arguments);
37	3	if ($argumentCount < 1 \|\| $argumentCount > 2) {
38	1	throw InvalidArgumentForVariadicFunctionException::between('array_to_json', 1, 2);
39		}
40
41		// Validate that the second parameter is a valid boolean if provided
42	2	if ($argumentCount === 2) {
43	2	$this->validateBoolean($arguments[1], 'ARRAY_TO_JSON');
44		}
45		}
46		}
47

martin-georgiev / postgresql-for-doctrine

Push — new-funcs2 ( 471c3f )

ArrayToJson::validateArguments() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like