RowToJson::validateArguments() - Code Metrics - Inspection of "refactor: allow node mapping in variadic functions..." - martin-georgiev/postgresql-for-doctrine - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 67265c...6a5ba9 )

by Martin

created 2025-04-14 00:44 UTC

RowToJson::validateArguments() A

↳ Parent: RowToJson

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 ROW_TO_JSON().
 *
 * Returns the row as a JSON object. Line feeds will be added between level-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 ROW_TO_JSON(e.row) FROM Entity e"
 * @example Using it in DQL with pretty_bool: "SELECT ROW_TO_JSON(e.row, 'true') FROM Entity e"
 */
class RowToJson extends BaseVariadicFunction
{
    use BooleanValidationTrait;


    protected function getNodeMappingPattern(): array
    {
        return ['StringPrimary'];
    }

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

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

        // Validate that the second parameter is a valid boolean if provided
        if ($argumentCount === 2) {
            $this->validateBoolean($arguments[1], 'ROW_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 ROW_TO_JSON().
13		*
14		* Returns the row as a JSON object. Line feeds will be added between level-1 elements if pretty_bool is true.
15		*
16		* @see https://www.postgresql.org/docs/16/functions-json.html
17		* @since 0.10
18		*
19		* @author Martin Georgiev <[email protected]>
20		*
21		* @example Using it in DQL: "SELECT ROW_TO_JSON(e.row) FROM Entity e"
22		* @example Using it in DQL with pretty_bool: "SELECT ROW_TO_JSON(e.row, 'true') FROM Entity e"
23		*/
24		class RowToJson extends BaseVariadicFunction
25		{
26		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\...AST\Functions\RowToJson`. Loading history...
27
28	3	protected function getNodeMappingPattern(): array
29		{
30	3	return ['StringPrimary'];
31		}
32
33	3	protected function customizeFunction(): void
34		{
35	3	$this->setFunctionPrototype('row_to_json(%s)');
36		}
37
38	3	protected function validateArguments(Node ...$arguments): void
39		{
40	3	$argumentCount = \count($arguments);
41	3	if ($argumentCount < 1 \|\| $argumentCount > 2) {
42	1	throw InvalidArgumentForVariadicFunctionException::between('row_to_json', 1, 2);
43		}
44
45		// Validate that the second parameter is a valid boolean if provided
46	2	if ($argumentCount === 2) {
47	2	$this->validateBoolean($arguments[1], 'ROW_TO_JSON');
48		}
49		}
50		}
51

martin-georgiev / postgresql-for-doctrine

Push — main ( 67265c...6a5ba9 )

RowToJson::validateArguments() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like