MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ArrayToJson

Complexity

Total Complexity

6

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getFunctionName()	0	3	1
A	getNodeMappingPattern()	0	3	1
A	getMaxArgumentCount()	0	3	1
A	validateArguments()	0	7	2
A	getMinArgumentCount()	0	3	1

<?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\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 <martin.georgiev@gmail.com>
 *
 * @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;

The trait MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Traits\BooleanValidationTrait requires the property $value which is not provided by MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ArrayToJson.

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

    protected function getFunctionName(): string
    {
        return 'array_to_json';
    }

    protected function getMinArgumentCount(): int
    {
        return 1;
    }

    protected function getMaxArgumentCount(): int
    {
        return 2;
    }

    protected function validateArguments(Node ...$arguments): void
    {
        parent::validateArguments(...$arguments);

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