MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Ltree\Subpath

Complexity

Total Complexity

4

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

4 Methods

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

<?php

declare(strict_types=1);

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

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

/**
 * Implementation of PostgreSQL subpath function.
 *
 * Returns subpath of ltree starting at position offset, with length len.
 * If offset is negative, subpath starts that far from the end of the path.
 * If len is negative, leaves that many labels off the end of the path.
 *
 * @see https://www.postgresql.org/docs/17/ltree.html#LTREE-FUNCTIONS
 * @since 3.5
 *
 * @author Martin Georgiev <martin.georgiev@gmail.com>
 *
 * @example Using it in DQL: "SELECT SUBPATH(e.path, 0, 2) FROM Entity e"
 * Returns ltree, subpath starting at position offset, with length len.
 */
class Subpath extends BaseVariadicFunction
{
    protected function getNodeMappingPattern(): array
    {
        return [
            'StringPrimary,SimpleArithmeticExpression,SimpleArithmeticExpression',
            'StringPrimary,SimpleArithmeticExpression',
        ];
    }

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

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

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