class.ilIndex.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Export\ImportHandler\File\Path\Node;

use ILIAS\Export\ImportHandler\File\Path\Comparison\ilHandlerDummy;
use ILIAS\Export\ImportHandler\I\File\Path\Comparison\ilHandlerInterface;
use ILIAS\Export\ImportHandler\I\File\Path\Node\ilIndexInterface as ilIndexFilePathNodeInterface;

class ilIndex implements ilIndexFilePathNodeInterface
{
    protected ilHandlerInterface $comparison;
    protected int $index;
    protected bool $indexing_from_end_enabled;

    public function __construct()
    {
        $this->comparison = new ilHandlerDummy();
        $this->index = 0;
        $this->indexing_from_end_enabled = false;
    }

    public function withIndex(int $index): ilIndexFilePathNodeInterface
    {
        $clone = clone $this;
        $clone->index = $index;
        return $clone;
    }

    public function withComparison(ilHandlerInterface $comparison): ilIndexFilePathNodeInterface
    {
        $clone = clone $this;
        $clone->comparison = $comparison;
        return $clone;
    }

    public function withIndexingFromEndEnabled(bool $enabled): ilIndexFilePathNodeInterface
    {
        $clone = clone $this;
        $clone->indexing_from_end_enabled = $enabled;
        return $clone;
    }

    public function toString(): string
    {
        $indexing = '';

        if ($this->comparison instanceof ilHandlerDummy) {
            $indexing = $this->indexing_from_end_enabled
                ? '(last)-' . $this->index
                : $this->index;
        } else {
            $indexing = 'position()' . $this->comparison->toString();
        }

        return '[' . $indexing . ']';
    }

    public function requiresPathSeparator(): bool
    {
        return false;
    }
}