ILIAS\MetaData\Services\Paths\Builder Class Reference

Inheritance diagram for ILIAS\MetaData\Services\Paths\Builder:

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

Public Member Functions
	__construct (InternalBuilderInterface $internal_builder)
	withNextStep (string $name)
	withNextStepToSuperElement ()
	withAdditionalFilterAtCurrentStep (FilterType $type, string ... $values)
	get ()
Public Member Functions inherited from ILIAS\MetaData\Paths\BuilderInterface
	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 Attributes
InternalBuilderInterface	$internal_builder

Detailed Description

Definition at line 27 of file Builder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Services\Paths\Builder::__construct

(

InternalBuilderInterface

$internal_builder

)

Definition at line 31 of file Builder.php.

    {
        $internal_builder->withRelative(false)
                         ->withLeadsToExactlyOneElement(false);
        $this->internal_builder = $internal_builder;
    }

References ILIAS\MetaData\Services\Paths\Builder\$internal_builder.

Member Function Documentation

get()

ILIAS\MetaData\Services\Paths\Builder::get

(

)

Exceptions

ilMDServicesException

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 75 of file Builder.php.

                         : PathInterface
    {
        try {
            return $this->internal_builder->get();
        } catch (\ilMDPathException $e) {
            throw new \ilMDServicesException($e->getMessage());
        }
 
    }

References Vendor\Package\$e.

withAdditionalFilterAtCurrentStep()

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

Exceptions

ilMDServicesException

Implements ILIAS\MetaData\Paths\BuilderInterface.

Definition at line 55 of file Builder.php.

     : BuilderInterface {
        $clone = clone $this;
        try {
            $clone->internal_builder = $clone->internal_builder->withAdditionalFilterAtCurrentStep(
                $type,
                ...$values
            );
        } catch (\ilMDPathException $e) {
            throw new \ilMDServicesException($e->getMessage());
        }
 
        return $clone;
    }

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

Here is the call graph for this function:

withNextStep()

ILIAS\MetaData\Services\Paths\Builder::withNextStep

(

string

$name

)

Definition at line 38 of file Builder.php.

                                              : BuilderInterface
    {
        $clone = clone $this;
        $clone->internal_builder = $clone->internal_builder->withNextStep($name);
        return $clone;
    }

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

Here is the call graph for this function:

withNextStepToSuperElement()

ILIAS\MetaData\Services\Paths\Builder::withNextStepToSuperElement

(

)

Definition at line 45 of file Builder.php.

                                                : BuilderInterface
    {
        $clone = clone $this;
        $clone->internal_builder = $clone->internal_builder->withNextStepToSuperElement();
        return $clone;
    }

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

Here is the call graph for this function:

Field Documentation

$internal_builder

InternalBuilderInterface ILIAS\MetaData\Services\Paths\Builder::$internal_builder

protected

Definition at line 29 of file Builder.php.

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

---

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

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