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

Complexity

Total Complexity

4

Size/Duplication

Total Lines	20
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

4 Methods

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

<?php

declare(strict_types=1);

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

use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\BaseVariadicFunction;

/**
 * Implementation of PostGIS ST_Relate() function.
 *
 * Tests if two geometries have a topological relationship matching an Intersection Matrix pattern,
 * or computes their Intersection Matrix.
 *
 * @see https://postgis.net/docs/ST_Relate.html
 * @since 3.5
 *
 * @author Martin Georgiev <martin.georgiev@gmail.com>
 *
 * @example Using it in DQL: "WHERE ST_Relate(g.geometry1, g.geometry2, 'T*T***T**') = TRUE"
 * Returns boolean when 3 arguments provided, string (intersection matrix) when 2 arguments provided.
 */
class ST_Relate extends BaseVariadicFunction
{
    protected function getNodeMappingPattern(): array
    {
        return ['StringPrimary'];
    }

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

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

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