Inheritance diagram for ILIAS\MetaData\Paths\Path:

Collaboration diagram for ILIAS\MetaData\Paths\Path:

Public Member Functions
	__construct (bool $is_relative, bool $leads_to_one, StepInterface ... $steps)

	steps ()

	isRelative ()
	Relative paths start at some otherwise determined element, absolute paths start at root. More...

	leadsToExactlyOneElement ()
	Specifies whether the path should point to exactly one element, or whether it can also lead to no or many elements. More...

	toString ()

	__toString ()

	steps ()
	Get all steps in the path. More...

	isRelative ()
	Relative paths start at some otherwise determined element, absolute paths start at root. More...

	leadsToExactlyOneElement ()
	Specifies whether the path should point to exactly one element, or whether it can also lead to no or many elements. More...

	toString ()

Protected Member Functions
	stepToString (StepInterface $step)

Protected Attributes
array	$steps

bool	$is_relative

bool	$leads_to_one

string	$as_string

Detailed Description

Definition at line 26 of file Path.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\Paths\Path::__construct	(	bool	$is_relative,
		bool	$leads_to_one,
		StepInterface ...	$steps
	)

Definition at line 37 of file Path.php.

      {
        $this->is_relative = $is_relative;
        $this->leads_to_one = $leads_to_one;
        $this->steps = $steps;
    }

References ILIAS\MetaData\Paths\Path\$is_relative, ILIAS\MetaData\Paths\Path\$leads_to_one, ILIAS\MetaData\Paths\Path\$steps, and ILIAS\MetaData\Paths\Path\steps().

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

ILIAS\MetaData\Paths\Path::__toString ( )

Definition at line 108 of file Path.php.

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

References ILIAS\MetaData\Paths\Path\toString().

Here is the call graph for this function:

◆ isRelative()

ILIAS\MetaData\Paths\Path::isRelative ( )

Relative paths start at some otherwise determined element, absolute paths start at root.

Implements ILIAS\MetaData\Paths\PathInterface.

Definition at line 55 of file Path.php.

                                : bool
    {
        return $this->is_relative;
    }

References ILIAS\MetaData\Paths\Path\$is_relative.

Referenced by ILIAS\MetaData\Paths\Path\toString().

Here is the caller graph for this function:

◆ leadsToExactlyOneElement()

ILIAS\MetaData\Paths\Path::leadsToExactlyOneElement ( )

Specifies whether the path should point to exactly one element, or whether it can also lead to no or many elements.

Implements ILIAS\MetaData\Paths\PathInterface.

Definition at line 60 of file Path.php.

                                              : bool
    {
        return $this->leads_to_one;
    }

References ILIAS\MetaData\Paths\Path\$leads_to_one.

Referenced by ILIAS\MetaData\Paths\Path\toString().

Here is the caller graph for this function:

◆ steps()

ILIAS\MetaData\Paths\Path::steps ( )

Returns: StepInterface[]

Implements ILIAS\MetaData\Paths\PathInterface.

Definition at line 50 of file Path.php.

                           : \Generator
    {
        yield from $this->steps;
    }

References ILIAS\MetaData\Paths\Path\$steps, and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Referenced by ILIAS\MetaData\Paths\Path\__construct(), and ILIAS\MetaData\Paths\Path\toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stepToString()

ILIAS\MetaData\Paths\Path::stepToString ( StepInterface $step )

protected

Definition at line 89 of file Path.php.

                                                        : 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;
    }

References ILIAS\MetaData\Paths\FILTER_VALUE_SEPARATOR, ILIAS\MetaData\Paths\Steps\StepInterface\filters(), and ILIAS\MetaData\Paths\Steps\StepInterface\name().

Referenced by ILIAS\MetaData\Paths\Path\toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

ILIAS\MetaData\Paths\Path::toString ( )

Implements ILIAS\MetaData\Paths\PathInterface.

Definition at line 65 of file Path.php.

                              : 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;
    }