Inheritance diagram for ILIAS\MetaData\Paths\Builder:

Collaboration diagram for ILIAS\MetaData\Paths\Builder:

Public Member Functions
	__construct (StructureSetInterface $structure)

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

	withNextStepFromStep (StepInterface $next_step, bool $add_as_first=false)

	withAdditionalFilterAtCurrentStep (FilterType $type, string ... $values)
	Adds a filter to the current step, restricting what elements are included in it: More...

	get ()

Protected Member Functions
	validatePathFromRoot (PathInterface $path)

	withNextStepFromName (string\|StepToken $name, bool $add_as_first=false)

	withCurrentStepSaved ()

Protected Attributes
StructureSetInterface	$structure

array	$steps = []

string StepToken null	$current_step_name = null

array	$current_step_filters = []

bool	$current_add_as_first = false

bool	$is_relative = false

bool	$leads_to_one = false

Detailed Description

Definition at line 31 of file Builder.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\Paths\Builder::__construct ( StructureSetInterface $structure )

Definition at line 35 of file Builder.php.

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

     {
         $this->structure = $structure;
     }

Member Function Documentation

◆ get()

ILIAS\MetaData\Paths\Builder::get ( )

Exceptions

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 123 of file Builder.php.

References $path, ILIAS\MetaData\Paths\Builder\validatePathFromRoot(), and ILIAS\MetaData\Paths\Builder\withCurrentStepSaved().

                          : PathInterface
     {
         $clone = $this->withCurrentStepSaved();
         $path =  new Path(
             $clone->is_relative,
             $clone->leads_to_one,
             ...$clone->steps
         );
 
         if (!$path->isRelative()) {
             $this->validatePathFromRoot($path);
         }
         return $path;
     }

Here is the call graph for this function:

◆ validatePathFromRoot()

ILIAS\MetaData\Paths\Builder::validatePathFromRoot ( PathInterface $path )

protected

Exceptions

Definition at line 141 of file Builder.php.

References ILIAS\MetaData\Paths\PathInterface\steps(), ILIAS\MetaData\Paths\Steps\SUPER, and ILIAS\MetaData\Paths\PathInterface\toString().

Referenced by ILIAS\MetaData\Paths\Builder\get().

                                                                 : void
     {
         $element = $this->structure->getRoot();
         foreach ($path->steps() as $step) {
             $name = $step->name();
             if ($name === StepToken::SUPER) {
                 $element = $element->getSuperElement();
             } else {
                 $element = $element->getSubElement($name);
             }
             if (is_null($element)) {
                 $name = is_string($name) ? $name : $name->value;
                 throw new \ilMDPathException(
                     "In the path '" . $path->toString() . "', the step '" . $name . "' is invalid."
                 );
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withAdditionalFilterAtCurrentStep()

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

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 103 of file Builder.php.

      : BuilderInterface {
         if (!isset($this->current_step_name)) {
             throw new \ilMDPathException(
                 'Cannot add filter because there is no current step.'
             );
         }
         $clone = clone $this;
         $clone->current_step_filters[] = new Filter(
             $type,
             ...$values
         );
         return $clone;
     }

◆ withCurrentStepSaved()

ILIAS\MetaData\Paths\Builder::withCurrentStepSaved ( )

protected

Definition at line 170 of file Builder.php.

Referenced by ILIAS\MetaData\Paths\Builder\get(), and ILIAS\MetaData\Paths\Builder\withNextStepFromName().

                                              : Builder
     {
         $clone = clone $this;
         if (!isset($clone->current_step_name)) {
             return $clone;
         }
 
         $new_step = new Step(
             $clone->current_step_name,
             ...$clone->current_step_filters
         );
         if ($clone->current_add_as_first) {
             array_unshift($clone->steps, $new_step);
         } else {
             $clone->steps[] = $new_step;
         }
 
         $clone->current_step_name = null;
         $clone->current_step_filters = [];
         $clone->current_add_as_first = false;
 
         return $clone;
     }

Here is the caller graph for this function:

◆ withLeadsToExactlyOneElement()

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

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 63 of file Builder.php.

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

      : BuilderInterface {
         $clone = clone $this;
         $clone->leads_to_one = $leads_to_one;
         return $clone;
     }

◆ withNextStep()

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

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 71 of file Builder.php.

References ILIAS\MetaData\Paths\Builder\withNextStepFromName().

      : BuilderInterface {
         return $this->withNextStepFromName(
             $name,
             $add_as_first
         );
     }

Here is the call graph for this function:

◆ withNextStepFromName()

ILIAS\MetaData\Paths\Builder::withNextStepFromName	(	string\|StepToken	$name,
		bool	$add_as_first = `false`
	)

protected

Definition at line 160 of file Builder.php.

References ILIAS\MetaData\Paths\Builder\withCurrentStepSaved().

Referenced by ILIAS\MetaData\Paths\Builder\withNextStep(), ILIAS\MetaData\Paths\Builder\withNextStepFromStep(), and ILIAS\MetaData\Paths\Builder\withNextStepToSuperElement().

      : BuilderInterface {
         $clone = $this->withCurrentStepSaved();
         $clone->current_step_name = $name;
         $clone->current_add_as_first = $add_as_first;
         return $clone;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withNextStepFromStep()

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

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 89 of file Builder.php.

References ILIAS\MetaData\Paths\Steps\StepInterface\filters(), ILIAS\MetaData\Paths\Steps\StepInterface\name(), and ILIAS\MetaData\Paths\Builder\withNextStepFromName().

      : BuilderInterface {
         $builder = $this->withNextStepFromName($next_step->name(), $add_as_first);
         foreach ($next_step->filters() as $filter) {
             $builder = $builder->withAdditionalFilterAtCurrentStep(
                 $filter->type(),
                 ...$filter->values()
             );
         }
         return $builder;
     }

Here is the call graph for this function:

◆ withNextStepToSuperElement()

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

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 81 of file Builder.php.

References ILIAS\MetaData\Paths\Steps\SUPER, and ILIAS\MetaData\Paths\Builder\withNextStepFromName().

                                                                           : BuilderInterface
     {
         return $this->withNextStepFromName(
             StepToken::SUPER,
             $add_as_first
         );
     }

Here is the call graph for this function:

◆ withRelative()

ILIAS\MetaData\Paths\Builder::withRelative ( bool $is_relative )

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

Default is false.

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 56 of file Builder.php.

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

                                                    : BuilderInterface
     {
         $clone = clone $this;
         $clone->is_relative = $is_relative;
         return $clone;
     }

Field Documentation

◆ $current_add_as_first

bool ILIAS\MetaData\Paths\Builder::$current_add_as_first = false

protected

Definition at line 51 of file Builder.php.

◆ $current_step_filters

array ILIAS\MetaData\Paths\Builder::$current_step_filters = []

protected

Definition at line 50 of file Builder.php.

◆ $current_step_name

string StepToken null ILIAS\MetaData\Paths\Builder::$current_step_name = null

protected

Definition at line 45 of file Builder.php.

◆ $is_relative

bool ILIAS\MetaData\Paths\Builder::$is_relative = false

protected

Definition at line 53 of file Builder.php.

Referenced by ILIAS\MetaData\Paths\Builder\withRelative().

◆ $leads_to_one

bool ILIAS\MetaData\Paths\Builder::$leads_to_one = false

protected

Definition at line 54 of file Builder.php.

Referenced by ILIAS\MetaData\Paths\Builder\withLeadsToExactlyOneElement().

◆ $steps

array ILIAS\MetaData\Paths\Builder::$steps = []

protected

Definition at line 43 of file Builder.php.

◆ $structure

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

protected

Definition at line 33 of file Builder.php.

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

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

Services/MetaData/classes/Paths/Builder.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ get()

◆ validatePathFromRoot()

◆ withAdditionalFilterAtCurrentStep()

◆ withCurrentStepSaved()

◆ withLeadsToExactlyOneElement()

◆ withNextStep()

◆ withNextStepFromName()

◆ withNextStepFromStep()

◆ withNextStepToSuperElement()

◆ withRelative()

Field Documentation

◆ $current_add_as_first

◆ $current_step_filters

◆ $current_step_name

◆ $is_relative

◆ $leads_to_one

◆ $steps

◆ $structure