ILIAS\MetaData\Services\Paths\BuilderInterface Interface Reference

Collaboration diagram for ILIAS\MetaData\Services\Paths\BuilderInterface:

Public Member Functions
	withNextStep (string $name)
	Add the next step to the path, identified by the name of a LOM element. More...
	withNextStepToSuperElement ()
	Add going to the super element as the next step to the path. More...
	withAdditionalFilterAtCurrentStep (FilterType $type, string ... $values)
	Adds a filter to the latest added step, restricting what elements are included in it: More...
	get ()
	Get the path as constructed. More...

Detailed Description

Definition at line 26 of file BuilderInterface.php.

Member Function Documentation

get()

ILIAS\MetaData\Services\Paths\BuilderInterface::get

(

)

Get the path as constructed.

Exceptions

withAdditionalFilterAtCurrentStep()

ILIAS\MetaData\Services\Paths\BuilderInterface::withAdditionalFilterAtCurrentStep	(	FilterType	$type,
		string ...	$values
	)

Adds a filter to the latest added step, restricting what elements are included in it:

• mdid: Only elements with the corresponding ID.
• data: Only elements that carry data which matches the filter's value.
• index: The n-th element, beginning with 0. Non-numeric values are interpreted as referring to the last index. (Note that filters are applied in the order they are added, so the index applies to already filtered elements.)

Multiple values in the same filter are treated as OR, multiple filters at the same step are treated as AND.

Exceptions

withNextStep()

ILIAS\MetaData\Services\Paths\BuilderInterface::withNextStep

(

string

$name

)

Add the next step to the path, identified by the name of a LOM element.

withNextStepToSuperElement()

ILIAS\MetaData\Services\Paths\BuilderInterface::withNextStepToSuperElement

(

)

Add going to the super element as the next step to the path.

---

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

• components/ILIAS/MetaData/classes/Services/Paths/BuilderInterface.php