ILIAS\MetaData\Paths\FactoryInterface Interface Reference

Inheritance diagram for ILIAS\MetaData\Paths\FactoryInterface:

Collaboration diagram for ILIAS\MetaData\Paths\FactoryInterface:

Public Member Functions
	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 ()

Detailed Description

Definition at line 25 of file FactoryInterface.php.

Member Function Documentation

betweenElements()

ILIAS\MetaData\Paths\FactoryInterface::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.

Implemented in ILIAS\MetaData\Paths\Factory, and ILIAS\MetaData\Paths\NullFactory.

custom()

ILIAS\MetaData\Paths\FactoryInterface::custom

(

)

Implemented in ILIAS\MetaData\Paths\Factory, and ILIAS\MetaData\Paths\NullFactory.

fromString()

ILIAS\MetaData\Paths\FactoryInterface::fromString

(

string

$string

)

Implemented in ILIAS\MetaData\Paths\Factory, and ILIAS\MetaData\Paths\NullFactory.

toElement()

ILIAS\MetaData\Paths\FactoryInterface::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.

Implemented in ILIAS\MetaData\Paths\Factory, and ILIAS\MetaData\Paths\NullFactory.

---

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

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