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)

	get ()

	getWithoutValidation ()

	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)

Protected Member Functions
	getFinishedPath (bool $validate)

	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.

    {
        $this->structure = $structure;
    }

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

Member Function Documentation

◆ get()

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

Exceptions

ilMDPathException

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 126 of file Builder.php.

                         : PathInterface
    {
        return $this->getFinishedPath(true);
    }

◆ getFinishedPath()

ILIAS\MetaData\Paths\Builder::getFinishedPath ( bool $validate )

protected

Definition at line 139 of file Builder.php.

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

References $path.

◆ getWithoutValidation()

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

Definition at line 134 of file Builder.php.

                                          : PathInterface
    {
        return $this->getFinishedPath(false);
    }

◆ validatePathFromRoot()

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

protected

Exceptions

ilMDPathException

Definition at line 157 of file Builder.php.

                                                                : 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."
                );
            }
        }
    }

References $path, and ILIAS\MetaData\Paths\Steps\SUPER.

◆ withAdditionalFilterAtCurrentStep()

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

Exceptions

ilMDPathException

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 106 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 186 of file Builder.php.

                                             : 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;
    }

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

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

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

◆ withNextStepFromName()

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

protected

Definition at line 176 of file Builder.php.

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

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

     : 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;
    }

References ILIAS\MetaData\Paths\BuilderInterface\withAdditionalFilterAtCurrentStep().

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.

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

References ILIAS\MetaData\Paths\Steps\SUPER.

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

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

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

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.

◆ $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:

components/ILIAS/MetaData/classes/Paths/Builder.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ get()

◆ getFinishedPath()

◆ getWithoutValidation()

◆ 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