ILIAS\MetaData\Paths\Path Class Reference

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 ()

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.

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().

      {
        $this->is_relative = $is_relative;
        $this->leads_to_one = $leads_to_one;
        $this->steps = $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.

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

                                : string
    {
        return $this->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.

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

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

                                : bool
    {
        return $this->is_relative;
    }

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.

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

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

                                              : bool
    {
        return $this->leads_to_one;
    }

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.

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().

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

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.

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().

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

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.

References ILIAS\MetaData\Paths\Path\$as_string, ILIAS\MetaData\Paths\Path\isRelative(), ILIAS\MetaData\Paths\Path\leadsToExactlyOneElement(), ILIAS\MetaData\Paths\Path\steps(), and ILIAS\MetaData\Paths\Path\stepToString().

Referenced by ILIAS\MetaData\Paths\Path\__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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$as_string

string ILIAS\MetaData\Paths\Path::$as_string

protected

Definition at line 35 of file Path.php.

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

$is_relative

bool ILIAS\MetaData\Paths\Path::$is_relative

protected

Definition at line 32 of file Path.php.

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

$leads_to_one

bool ILIAS\MetaData\Paths\Path::$leads_to_one

protected

Definition at line 33 of file Path.php.

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

$steps

array ILIAS\MetaData\Paths\Path::$steps

protected

Definition at line 31 of file Path.php.

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

---

The documentation for this class was generated from the following file:

• components/ILIAS/MetaData/classes/Paths/Path.php