MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\PostGIS\ST_RemoveIrrelevantPointsForView

Complexity

Total Complexity

6

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

5 Methods

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

<?php

declare(strict_types=1);

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

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

/**
 * Implementation of PostGIS ST_RemoveIrrelevantPointsForView() function.
 *
 * Removes points that are irrelevant for rendering at a given view.
 * Useful for simplifying geometries for display at specific zoom levels.
 *
 * @see https://postgis.net/docs/ST_RemoveIrrelevantPointsForView.html
 * @since 4.0
 *
 * @author Martin Georgiev <martin.georgiev@gmail.com>
 *
 * @example Using it in DQL: "SELECT ST_REMOVEIRRELEVANTPOINTSFORVIEW(g.geometry, box) FROM Entity g"
 * @example Using it in DQL: "SELECT ST_REMOVEIRRELEVANTPOINTSFORVIEW(g.geometry, box, 'true') FROM Entity g"
 * Returns geometry with irrelevant points removed.
 */
class ST_RemoveIrrelevantPointsForView 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\PostGIS\ST_RemoveIrrelevantPointsForView.

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

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

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

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

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

        if (\count($arguments) === 3) {
            $this->validateBoolean($arguments[2], $this->getFunctionName());
        }
    }
}