ILIAS\MetaData\Paths\BuilderInterface Interface Reference

Inheritance diagram for ILIAS\MetaData\Paths\BuilderInterface:

Collaboration diagram for ILIAS\MetaData\Paths\BuilderInterface:

Public Member Functions
	withRelative (bool $is_relative)
	Relative paths start at some otherwise determined element, absolute paths start at root. More...
	withLeadsToExactlyOneElement (bool $leads_to_one)
	Building a path that is flagged to lead to exactly one element, but does not actually do so can throw errors later on. More...
	withNextStep (string $name, bool $add_as_first=false)
	Add the next step to the path. More...
	withNextStepToSuperElement (bool $add_as_first=false)
	Add going to the super element as the next step to the path. More...
	withAdditionalFilterAtCurrentStep (FilterType $type, string ... $values)
	Adds a filter to the current step, restricting what elements are included in it: More...
	get ()
	withNextStepFromStep (StepInterface $next_step, bool $add_as_first=false)

Detailed Description

Definition at line 28 of file BuilderInterface.php.

Member Function Documentation

get()

ILIAS\MetaData\Paths\BuilderInterface::get

(

)

Implemented in ILIAS\MetaData\Paths\Builder, ILIAS\MetaData\Services\Paths\Builder, and ILIAS\MetaData\Paths\NullBuilder.

withAdditionalFilterAtCurrentStep()

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

Adds a filter to the current 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.

Implemented in ILIAS\MetaData\Paths\Builder, ILIAS\MetaData\Services\Paths\Builder, and ILIAS\MetaData\Paths\NullBuilder.

Referenced by ILIAS\MetaData\Paths\Factory\addElementAsStep(), ILIAS\MetaData\Paths\Factory\addStepFromString(), and ILIAS\MetaData\Services\Paths\Builder\withAdditionalFilterAtCurrentStep().

Here is the caller graph for this function:

withLeadsToExactlyOneElement()

ILIAS\MetaData\Paths\BuilderInterface::withLeadsToExactlyOneElement

(

bool

$leads_to_one

)

Building a path that is flagged to lead to exactly one element, but does not actually do so can throw errors later on.

If you set this flag, be sure to set filters correctly. Default is false.

Implemented in ILIAS\MetaData\Paths\Builder, and ILIAS\MetaData\Paths\NullBuilder.

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

Here is the caller graph for this function:

withNextStep()

ILIAS\MetaData\Paths\BuilderInterface::withNextStep	(	string	$name,
		bool	$add_as_first = false
	)

Add the next step to the path.

If add_as_first is set true, the step is added as the first and not the last step.

Implemented in ILIAS\MetaData\Paths\Builder, and ILIAS\MetaData\Paths\NullBuilder.

Referenced by ILIAS\MetaData\Paths\Factory\addElementAsStep(), ILIAS\MetaData\Paths\Factory\addStepFromString(), and ILIAS\MetaData\Services\Paths\Builder\withNextStep().

Here is the caller graph for this function:

withNextStepFromStep()

ILIAS\MetaData\Paths\BuilderInterface::withNextStepFromStep	(	StepInterface	$next_step,
		bool	$add_as_first = false
	)

Implemented in ILIAS\MetaData\Paths\Builder, and ILIAS\MetaData\Paths\NullBuilder.

withNextStepToSuperElement()

ILIAS\MetaData\Paths\BuilderInterface::withNextStepToSuperElement

(

bool

$add_as_first = false

)

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

If add_to_front is set true, the step is added as the first and not the last step.

Implemented in ILIAS\MetaData\Paths\Builder, and ILIAS\MetaData\Paths\NullBuilder.

Referenced by ILIAS\MetaData\Paths\Factory\addStepFromString(), and ILIAS\MetaData\Services\Paths\Builder\withNextStepToSuperElement().

Here is the caller graph for this function:

withRelative()

ILIAS\MetaData\Paths\BuilderInterface::withRelative

(

bool

$is_relative

)

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

Default is false.

Implemented in ILIAS\MetaData\Paths\Builder, and ILIAS\MetaData\Paths\NullBuilder.

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

Here is the caller graph for this function:

---

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

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