Path.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Paths;

use ILIAS\MetaData\Paths\Steps\StepInterface;
use ILIAS\MetaData\Paths\Steps\StepToken;

class Path implements PathInterface, \Stringable
{
    protected array $steps;
    protected bool $is_relative;
    protected bool $leads_to_one;

    protected string $as_string;

    public function __construct(
        bool $is_relative,
        bool $leads_to_one,
        StepInterface ...$steps
    ) {
        $this->is_relative = $is_relative;
        $this->leads_to_one = $leads_to_one;
        $this->steps = $steps;
    }

    public function steps(): \Generator
    {
        yield from $this->steps;
    }

    public function isRelative(): bool
    {
        return $this->is_relative;
    }

    public function leadsToExactlyOneElement(): bool
    {
        return $this->leads_to_one;
    }

    public function toString(): string
    {
        if (isset($this->as_string)) {
            return $this->as_string;
        }

        $string = '';

        if ($this->leadsToExactlyOneElement()) {
            $string .= Token::LEADS_TO_EXACTLY_ONE->value;
        }
        if ($this->isRelative()) {
            $string .= Token::START_AT_CURRENT->value;
        } else {
            $string .= Token::START_AT_ROOT->value;
        }
        foreach ($this->steps() as $step) {
            $string .= Token::SEPARATOR->value;
            $string .= $this->stepToString($step);
        }

        return $this->as_string = $string;
    }

    protected function stepToString(StepInterface $step): string
    {
        $string = $step->name();
        if ($string instanceof StepToken) {
            $string = $string->value;
        }
        foreach ($step->filters() as $filter) {
            $string .= Token::FILTER_SEPARATOR->value .
                $filter->type()->value .
                Token::FILTER_VALUE_SEPARATOR->value;

            $string .= implode(
                Token::FILTER_VALUE_SEPARATOR->value,
                iterator_to_array($filter->values())
            );
        }
        return $string;
    }

    public function __toString(): string
    {
        return $this->toString();
    }
}