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

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	getMinArgumentCount()	0	3	1
A	getFunctionName()	0	3	1
A	getMaxArgumentCount()	0	3	1
A	getNodeMappingPattern()	0	5	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 index function for ltree.
 *
 * Returns position of first occurrence of b in a, or -1 if not found.
 * The search starts at position offset; negative offset means start -offset labels from 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 INDEX(e.path, 'Child1') FROM Entity e"
 * Returns integer, position of first occurrence or -1 if not found.
 */
class Index extends BaseVariadicFunction
{
    protected function getNodeMappingPattern(): array
    {
        return [
            'StringPrimary,StringPrimary,SimpleArithmeticExpression',
            'StringPrimary,StringPrimary',
        ];
    }

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

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

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