ILIAS\MetaData\Paths\Factory Class Reference

Inheritance diagram for ILIAS\MetaData\Paths\Factory:

Collaboration diagram for ILIAS\MetaData\Paths\Factory:

Public Member Functions
	__construct (StructureSetInterface $structure)
	fromString (string $string)
	toElement (BaseElementInterface $to, bool $leads_to_exactly_one=false)
	Returns absolute path from root to the given element. More...
	betweenElements (BaseElementInterface $from, BaseElementInterface $to, bool $leads_to_exactly_one=false)
	Returns relative path between two given elements. More...
	custom ()

Protected Member Functions
	setModesFromString (BuilderInterface $builder, string $string)
	addStepFromString (BuilderInterface $builder, string $string)
	addElementAsStep (BuilderInterface $builder, BaseElementInterface $element, bool $leads_to_exactly_one, bool $add_as_first)

Protected Attributes
StructureSetInterface	$structure

Detailed Description

Definition at line 29 of file Factory.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Paths\Factory::__construct

(

StructureSetInterface

$structure

)

Definition at line 33 of file Factory.php.

References ILIAS\MetaData\Paths\Factory\$structure.

    {
        $this->structure = $structure;
    }

Member Function Documentation

addElementAsStep()

ILIAS\MetaData\Paths\Factory::addElementAsStep ( BuilderInterface  $builder, BaseElementInterface  $element, bool  $leads_to_exactly_one, bool  $add_as_first  )

protected

Definition at line 174 of file Factory.php.

References $id, ILIAS\MetaData\Elements\Base\BaseElementInterface\getDefinition(), ILIAS\MetaData\Elements\Base\BaseElementInterface\getMDID(), if, ILIAS\MetaData\Paths\BuilderInterface\withAdditionalFilterAtCurrentStep(), and ILIAS\MetaData\Paths\BuilderInterface\withNextStep().

Referenced by ILIAS\MetaData\Paths\Factory\betweenElements(), and ILIAS\MetaData\Paths\Factory\toElement().

     : BuilderInterface {
        $builder = $builder->withNextStep(
            $element->getDefinition()->name(),
            $add_as_first
        );

        $id = $element->getMDID();
        if ($element instanceof StructureElement) {
            return $builder;
        }
        $id = is_int($id) ? (string) $id : $id->value;
        if ($leads_to_exactly_one) {
            $builder = $builder->withAdditionalFilterAtCurrentStep(
                FilterType::MDID,
                $id
            );
        }

        return $builder;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addStepFromString()

ILIAS\MetaData\Paths\Factory::addStepFromString ( BuilderInterface  $builder, string  $string  )

protected

Definition at line 72 of file Factory.php.

References ILIAS\MetaData\Paths\FILTER_VALUE_SEPARATOR, ILIAS\MetaData\Paths\Steps\SUPER, ILIAS\MetaData\Paths\BuilderInterface\withAdditionalFilterAtCurrentStep(), ILIAS\MetaData\Paths\BuilderInterface\withNextStep(), and ILIAS\MetaData\Paths\BuilderInterface\withNextStepToSuperElement().

Referenced by ILIAS\MetaData\Paths\Factory\fromString().

     : BuilderInterface {
        $exploded = explode(Token::FILTER_SEPARATOR->value, strtolower($string));
        $name = StepToken::tryFrom($exploded[0]) ?? $exploded[0];
        if ($name === StepToken::SUPER) {
            $builder = $builder->withNextStepToSuperElement(false);
        } else {
            $builder = $builder->withNextStep($name, false);
        }
        $exploded = array_slice($exploded, 1);
        foreach ($exploded as $filter_string) {
            $exploded_filter = explode(
                Token::FILTER_VALUE_SEPARATOR->value,
                strtolower($filter_string)
            );
            $type = FilterType::tryFrom($exploded_filter[0]);
            $exploded_filter = array_slice($exploded_filter, 1);
            if (!is_null($type)) {
                $builder = $builder = $builder->withAdditionalFilterAtCurrentStep(
                    $type,
                    ...$exploded_filter
                );
                continue;
            }
            throw new \ilMDPathException(
                'Cannot create path, invalid filter type.'
            );
        }
        return $builder;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

betweenElements()

ILIAS\MetaData\Paths\Factory::betweenElements	(	BaseElementInterface	$from,
		BaseElementInterface	$to,
		bool	$leads_to_exactly_one = false
	)

Returns relative path between two given elements.

If leads_to_exactly one is set true, it tries to add mdid filters where possible such that the path only leads to that specific element and not also others of the same type and position.

Implements ILIAS\MetaData\Paths\FactoryInterface.

Definition at line 132 of file Factory.php.

References ILIAS\MetaData\Paths\Factory\addElementAsStep(), and ILIAS\MetaData\Elements\Base\BaseElementInterface\getSuperElement().

     : PathInterface {
        $to_and_supers = [];
        while ($to) {
            array_unshift($to_and_supers, $to);
            $to = $to->getSuperElement();
        }

        $builder = $this
            ->custom()
            ->withRelative(true)
            ->withLeadsToExactlyOneElement($leads_to_exactly_one);

        while (!in_array($from, $to_and_supers, true)) {
            $builder = $builder->withNextStepToSuperElement();
            $from = $from->getSuperElement();
            if (!isset($from)) {
                throw new \ilMDPathException(
                    'Cannot build path between elements from disjunct sets.'
                );
            }
        }

        $to_and_supers = array_slice(
            $to_and_supers,
            array_search($from, $to_and_supers, true) + 1
        );
        foreach ($to_and_supers as $element) {
            $builder = $this->addElementAsStep(
                $builder,
                $element,
                $leads_to_exactly_one,
                false
            );
        }

        return $builder->get();
    }

Here is the call graph for this function:

custom()

ILIAS\MetaData\Paths\Factory::custom

(

)

Implements ILIAS\MetaData\Paths\FactoryInterface.

Definition at line 200 of file Factory.php.

Referenced by ILIAS\MetaData\Paths\Factory\fromString().

                            : BuilderInterface
    {
        return new Builder($this->structure);
    }

Here is the caller graph for this function:

fromString()

ILIAS\MetaData\Paths\Factory::fromString

(

string

$string

)

Implements ILIAS\MetaData\Paths\FactoryInterface.

Definition at line 38 of file Factory.php.

References ILIAS\MetaData\Paths\Factory\addStepFromString(), ILIAS\MetaData\Paths\Factory\custom(), and ILIAS\MetaData\Paths\Factory\setModesFromString().

                                              : PathInterface
    {
        $exploded = explode(Token::SEPARATOR->value, strtolower($string));
        $builder = $this->setModesFromString($this->custom(), $exploded[0]);
        $exploded = array_slice($exploded, 1);
        foreach ($exploded as $step_string) {
            $builder = $this->addStepFromString($builder, $step_string);
        }
        return $builder->get();
    }

Here is the call graph for this function:

setModesFromString()

ILIAS\MetaData\Paths\Factory::setModesFromString ( BuilderInterface  $builder, string  $string  )

protected

Definition at line 49 of file Factory.php.

References ILIAS\MetaData\Paths\BuilderInterface\withLeadsToExactlyOneElement(), and ILIAS\MetaData\Paths\BuilderInterface\withRelative().

Referenced by ILIAS\MetaData\Paths\Factory\fromString().

     : BuilderInterface {
        $pattern = '/^(' . strtolower(Token::LEADS_TO_EXACTLY_ONE->value) .
            ')?(' . strtolower(Token::START_AT_ROOT->value) . '|' .
            strtolower(Token::START_AT_CURRENT->value) . ')$/';
        if (!preg_match($pattern, $string, $matches)) {
            throw new \ilMDPathException(
                'Cannot create path, invalid modes in input string: ' . $string
            );
        }
        if (!empty($matches[1])) {
            $builder = $builder->withLeadsToExactlyOneElement(true);
        }
        if ($matches[2] === Token::START_AT_ROOT->value) {
            $builder = $builder->withRelative(false);
        } else {
            $builder = $builder->withRelative(true);
        }
        return $builder;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toElement()

ILIAS\MetaData\Paths\Factory::toElement	(	BaseElementInterface	$to,
		bool	$leads_to_exactly_one = false
	)

Returns absolute path from root to the given element.

If leads_to_exactly one is set true, it will add mdid filters where possible such that the path only leads to that specific element and not also others of the same type and position.

Implements ILIAS\MetaData\Paths\FactoryInterface.

Definition at line 105 of file Factory.php.

References ILIAS\MetaData\Paths\Factory\addElementAsStep(), ILIAS\MetaData\Elements\Base\BaseElementInterface\getSuperElement(), and ILIAS\MetaData\Elements\Base\BaseElementInterface\isRoot().

     : PathInterface {
        $builder = $this
            ->custom()
            ->withRelative(false)
            ->withLeadsToExactlyOneElement($leads_to_exactly_one);

        while (!$to->isRoot()) {
            $builder = $this->addElementAsStep(
                $builder,
                $to,
                $leads_to_exactly_one,
                true
            );
            $to = $to->getSuperElement();
            if (!isset($to)) {
                throw new \ilMDPathException(
                    'Cannot build path from element without root.'
                );
            }
        }

        return $builder->get();
    }

Here is the call graph for this function:

Field Documentation

$structure

StructureSetInterface ILIAS\MetaData\Paths\Factory::$structure

protected

Definition at line 31 of file Factory.php.

Referenced by ILIAS\MetaData\Paths\Factory\__construct().

---

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

• Services/MetaData/classes/Paths/Factory.php