Inheritance diagram for ILIAS\MetaData\Manipulator\Manipulator:

Collaboration diagram for ILIAS\MetaData\Manipulator\Manipulator:

Public Member Functions
	__construct (ScaffoldProviderInterface $scaffold_provider, MarkerFactoryInterface $marker_factory, NavigatorFactoryInterface $navigator_factory, PathFactoryInterface $path_factory, PathUtilitiesFactoryInterface $path_utilities_factory)

	prepareCreateOrUpdate (SetInterface $set, PathInterface $path, string ... $values)

	prepareForceCreate (SetInterface $set, PathInterface $path, string ... $values)

Public Member Functions inherited from ILIAS\MetaData\Manipulator\ManipulatorInterface
	prepareDelete (SetInterface $set, PathInterface $path)

Protected Member Functions
	moveNavigatorBackwardsToFirstNonUnique (NavigatorInterface $navigator)

	remainingPathOfNavigator (NavigatorInterface $navigator)

	getLastNavigatorWithElements (PathInterface $path, ElementInterface $root)

	insertPathElementsAsScaffolds (PathInterface $path, ElementInterface $root, PathConditionsCollectionInterface $path_conditions_collection)

	createTargetElements (array $roots, array $paths, PathConditionsCollectionInterface $path_conditions)

	insertConditionPathElementsAsScaffolds (PathInterface $condition_path, ElementInterface $root)

	addAndMarkScaffoldByStep (ElementInterface $element, StepInterface $step)
	also returns the added scaffold, if valid More...

	markElementsCreateOrUpdate (array $target_elements, array $values)

	markElementsDelete (array $target_elements)

Protected Attributes
ScaffoldProviderInterface	$scaffold_provider

MarkerFactoryInterface	$marker_factory

NavigatorFactoryInterface	$navigator_factory

PathFactoryInterface	$path_factory

PathUtilitiesFactoryInterface	$path_utilities_factory

Detailed Description

Definition at line 41 of file Manipulator.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\Manipulator\Manipulator::__construct	(	ScaffoldProviderInterface	$scaffold_provider,
		MarkerFactoryInterface	$marker_factory,
		NavigatorFactoryInterface	$navigator_factory,
		PathFactoryInterface	$path_factory,
		PathUtilitiesFactoryInterface	$path_utilities_factory
	)

Definition at line 49 of file Manipulator.php.

References ILIAS\MetaData\Manipulator\Manipulator\$marker_factory, ILIAS\MetaData\Manipulator\Manipulator\$navigator_factory, $path, ILIAS\MetaData\Manipulator\Manipulator\$path_factory, ILIAS\MetaData\Manipulator\Manipulator\$path_utilities_factory, ILIAS\MetaData\Manipulator\Manipulator\$scaffold_provider, ILIAS\MetaData\Manipulator\Manipulator\markElementsDelete(), and ILIAS\MetaData\Manipulator\ManipulatorInterface\prepareDelete().

       {
         $this->scaffold_provider = $scaffold_provider;
         $this->marker_factory = $marker_factory;
         $this->navigator_factory = $navigator_factory;
         $this->path_factory = $path_factory;
         $this->path_utilities_factory = $path_utilities_factory;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAndMarkScaffoldByStep()

ILIAS\MetaData\Manipulator\Manipulator::addAndMarkScaffoldByStep	(	ElementInterface	$element,
		StepInterface	$step
	)

protected

also returns the added scaffold, if valid

Definition at line 397 of file Manipulator.php.

References $data, ILIAS\MetaData\Elements\Scaffolds\ScaffoldableInterface\addScaffoldToSubElements(), ILIAS\MetaData\Paths\Filters\DATA, ILIAS\MetaData\Paths\Steps\StepInterface\filters(), ILIAS\MetaData\Elements\ElementInterface\getSuperElement(), ILIAS\MetaData\Paths\Steps\StepInterface\name(), null, and ILIAS\MetaData\Paths\Steps\SUPER.

Referenced by ILIAS\MetaData\Manipulator\Manipulator\insertConditionPathElementsAsScaffolds(), and ILIAS\MetaData\Manipulator\Manipulator\insertPathElementsAsScaffolds().

      : ?ElementInterface {
         if ($step->name() === StepToken::SUPER) {
             return $element->getSuperElement();
         }
         $scaffold = $element->addScaffoldToSubElements(
             $this->scaffold_provider,
             $step->name()
         );
         if (!isset($scaffold)) {
             return null;
         }
         $data = '';
         foreach ($step->filters() as $filter) {
             if ($filter->type() === FilterType::DATA) {
                 $data = $filter->values()->current();
                 break;
             }
         }
         $scaffold->mark(
             $this->marker_factory,
             Action::CREATE_OR_UPDATE,
             $data
         );
         return $scaffold;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTargetElements()

ILIAS\MetaData\Manipulator\Manipulator::createTargetElements	(	array	$roots,
		array	$paths,
		PathConditionsCollectionInterface	$path_conditions
	)

protected

Parameters

ElementInterface[]	$roots
PathInterface[]	$paths

Returns: ElementInterface[]

Exceptions

ilMDPathException

Definition at line 359 of file Manipulator.php.

References ILIAS\MetaData\Manipulator\Manipulator\insertPathElementsAsScaffolds().

Referenced by ILIAS\MetaData\Manipulator\Manipulator\prepareForceCreate().

      : array {
         $target_elements = [];
         while (0 < count($paths)) {
             $target_elements[] = $this->insertPathElementsAsScaffolds(
                 array_shift($paths),
                 array_shift($roots),
                 $path_conditions
             );
         }
         return $target_elements;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastNavigatorWithElements()

ILIAS\MetaData\Manipulator\Manipulator::getLastNavigatorWithElements	(	PathInterface	$path,
		ElementInterface	$root
	)

protected

Definition at line 315 of file Manipulator.php.

References ILIAS\MetaData\Paths\Navigator\NavigatorInterface\nextStep().

Referenced by ILIAS\MetaData\Manipulator\Manipulator\prepareForceCreate().

      : NavigatorInterface {
         $navigator = $this->navigator_factory->navigator($path, $root);
         while ($navigator->hasNextStep() && $navigator->nextStep()->hasElements()) {
             $navigator = $navigator->nextStep();
         }
         return $navigator;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertConditionPathElementsAsScaffolds()

ILIAS\MetaData\Manipulator\Manipulator::insertConditionPathElementsAsScaffolds	(	PathInterface	$condition_path,
		ElementInterface	$root
	)

protected

Exceptions

ilMDPathException

Definition at line 378 of file Manipulator.php.

References ILIAS\MetaData\Manipulator\Manipulator\addAndMarkScaffoldByStep().

Referenced by ILIAS\MetaData\Manipulator\Manipulator\insertPathElementsAsScaffolds().

      : void {
         $navigator = $this->navigator_factory->navigator($condition_path, $root);
         $navigator = $navigator->nextStep();
         $scaffold = $root;
         while (!is_null($navigator)) {
             $scaffold = $this->addAndMarkScaffoldByStep($scaffold, $navigator->currentStep());
             if (is_null($scaffold)) {
                 throw new ilMDPathException('Cannot create scaffold, invalid path.');
             }
             $navigator = $navigator->nextStep();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertPathElementsAsScaffolds()

ILIAS\MetaData\Manipulator\Manipulator::insertPathElementsAsScaffolds	(	PathInterface	$path,
		ElementInterface	$root,
		PathConditionsCollectionInterface	$path_conditions_collection
	)

protected

Exceptions

ilMDPathException

Definition at line 329 of file Manipulator.php.

References ILIAS\MetaData\Manipulator\Manipulator\addAndMarkScaffoldByStep(), ILIAS\MetaData\Manipulator\Path\PathConditionsCollectionInterface\getConditionPathByStepName(), and ILIAS\MetaData\Manipulator\Manipulator\insertConditionPathElementsAsScaffolds().

Referenced by ILIAS\MetaData\Manipulator\Manipulator\createTargetElements(), and ILIAS\MetaData\Manipulator\Manipulator\prepareForceCreate().

      : ElementInterface {
         $navigator = $this->navigator_factory->navigator($path, $root);
         $navigator = $navigator->nextStep();
         $scaffold = $root;
         while (!is_null($navigator)) {
             $scaffold = $this->addAndMarkScaffoldByStep($scaffold, $navigator->currentStep());
             if (is_null($scaffold)) {
                 throw new ilMDPathException(
                     'Cannot create scaffold at step: ' . $navigator->currentStep()->name() . ', invalid path.'
                 );
             }
             $condition_path = $path_conditions_collection->getConditionPathByStepName($navigator->currentStep()->name());
             if ($condition_path->steps()->valid()) {
                 $this->insertConditionPathElementsAsScaffolds($condition_path, $scaffold);
             }
             $navigator = $navigator->nextStep();
         }
         return $scaffold;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markElementsCreateOrUpdate()

ILIAS\MetaData\Manipulator\Manipulator::markElementsCreateOrUpdate	(	array	$target_elements,
		array	$values
	)

protected

Parameters

	ElementInterface[]	$target_elements
array	$values

Definition at line 430 of file Manipulator.php.

References ILIAS\MetaData\Elements\Markers\MarkableInterface\mark().

Referenced by ILIAS\MetaData\Manipulator\Manipulator\prepareCreateOrUpdate(), and ILIAS\MetaData\Manipulator\Manipulator\prepareForceCreate().

                                                                                         : void
     {
         array_map(function (ElementInterface $element, ?string $value) {
             $element->mark($this->marker_factory, Action::CREATE_OR_UPDATE, $value);
         }, $target_elements, $values);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markElementsDelete()

ILIAS\MetaData\Manipulator\Manipulator::markElementsDelete ( array $target_elements )

protected

Definition at line 437 of file Manipulator.php.

References ILIAS\MetaData\Elements\Markers\DELETE, and ILIAS\MetaData\Elements\Markers\MarkableInterface\mark().

Referenced by ILIAS\MetaData\Manipulator\Manipulator\__construct().

                                                                  : void
     {
         array_map(function (ElementInterface $element) {
             $element->mark($this->marker_factory, Action::DELETE);
         }, $target_elements);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moveNavigatorBackwardsToFirstNonUnique()

ILIAS\MetaData\Manipulator\Manipulator::moveNavigatorBackwardsToFirstNonUnique ( NavigatorInterface $navigator )

protected

Exceptions

ilMDPathException

Definition at line 291 of file Manipulator.php.

References ILIAS\MetaData\Paths\Navigator\BaseNavigatorInterface\hasPreviousStep(), ILIAS\MetaData\Paths\Navigator\NavigatorInterface\lastElement(), and ILIAS\MetaData\Paths\Navigator\NavigatorInterface\previousStep().

Referenced by ILIAS\MetaData\Manipulator\Manipulator\prepareForceCreate().

                                                                                             : NavigatorInterface
     {
         while ($navigator->hasPreviousStep() && $navigator->lastElement()->getDefinition()->unique()) {
             $navigator = $navigator->previousStep();
         }
         return $navigator;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareCreateOrUpdate()

ILIAS\MetaData\Manipulator\Manipulator::prepareCreateOrUpdate	(	SetInterface	$set,
		PathInterface	$path,
		string ...	$values
	)

Exceptions

ilMDPathException

Implements ILIAS\MetaData\Manipulator\ManipulatorInterface.

Definition at line 88 of file Manipulator.php.

References $path, and ILIAS\MetaData\Manipulator\Manipulator\markElementsCreateOrUpdate().

      : SetInterface {
         $my_set = clone $set;
         $elements_to_update = $this->getElementsToUpdate($my_set->getRoot(), $path, ...$values);
         $remaining_values = array_slice($values, 0, count($values) - count($elements_to_update));
         $elements_to_create = $this->getElementsToCreate($my_set->getRoot(), $path, ...$remaining_values);
         $target_elements = array_merge($elements_to_update, $elements_to_create);
         $this->markElementsCreateOrUpdate($target_elements, $values);
         return $my_set;
     }

Here is the call graph for this function:

◆ prepareForceCreate()

ILIAS\MetaData\Manipulator\Manipulator::prepareForceCreate	(	SetInterface	$set,
		PathInterface	$path,
		string ...	$values
	)

Exceptions

ilMDPathException

Implements ILIAS\MetaData\Manipulator\ManipulatorInterface.

Definition at line 105 of file Manipulator.php.

References $path, ILIAS\MetaData\Manipulator\Manipulator\createTargetElements(), ILIAS\MetaData\Manipulator\Manipulator\getLastNavigatorWithElements(), ILIAS\MetaData\Manipulator\Manipulator\insertPathElementsAsScaffolds(), ILIAS\MetaData\Manipulator\Manipulator\markElementsCreateOrUpdate(), ILIAS\MetaData\Manipulator\Manipulator\moveNavigatorBackwardsToFirstNonUnique(), and ILIAS\MetaData\Manipulator\Manipulator\remainingPathOfNavigator().

      : SetInterface {
         $my_set = clone $set;
         $target_elements = $this->getElementsToCreate($my_set->getRoot(), $path, ...$values);
         $this->markElementsCreateOrUpdate($target_elements, $values);
         return $my_set;
     }

Here is the call graph for this function:

◆ remainingPathOfNavigator()

ILIAS\MetaData\Manipulator\Manipulator::remainingPathOfNavigator ( NavigatorInterface $navigator )

protected

Definition at line 299 of file Manipulator.php.

References ILIAS\MetaData\Paths\Navigator\BaseNavigatorInterface\currentStep(), and ILIAS\MetaData\Paths\Navigator\NavigatorInterface\nextStep().

Referenced by ILIAS\MetaData\Manipulator\Manipulator\prepareForceCreate().

                                                                               : PathInterface
     {
         $builder = $this->path_factory->custom()
             ->withRelative(true)
             ->withLeadsToExactlyOneElement(false);
         while (!is_null($navigator)) {
             if (is_null($navigator->currentStep())) {
                 $navigator = $navigator->nextStep();
                 continue;
             }
             $builder = $builder->withNextStepFromStep($navigator->currentStep(), false);
             $navigator = $navigator->nextStep();
         }
         return $builder->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $marker_factory

MarkerFactoryInterface ILIAS\MetaData\Manipulator\Manipulator::$marker_factory

protected

Definition at line 44 of file Manipulator.php.

Referenced by ILIAS\MetaData\Manipulator\Manipulator\__construct().

◆ $navigator_factory

NavigatorFactoryInterface ILIAS\MetaData\Manipulator\Manipulator::$navigator_factory

protected

Definition at line 45 of file Manipulator.php.

Referenced by ILIAS\MetaData\Manipulator\Manipulator\__construct().

◆ $path_factory

PathFactoryInterface ILIAS\MetaData\Manipulator\Manipulator::$path_factory

protected

Definition at line 46 of file Manipulator.php.

Referenced by ILIAS\MetaData\Manipulator\Manipulator\__construct().

◆ $path_utilities_factory

PathUtilitiesFactoryInterface ILIAS\MetaData\Manipulator\Manipulator::$path_utilities_factory

protected

Definition at line 47 of file Manipulator.php.

Referenced by ILIAS\MetaData\Manipulator\Manipulator\__construct().

◆ $scaffold_provider

ScaffoldProviderInterface ILIAS\MetaData\Manipulator\Manipulator::$scaffold_provider

protected

Definition at line 43 of file Manipulator.php.

Referenced by ILIAS\MetaData\Manipulator\Manipulator\__construct().

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

components/ILIAS/MetaData/classes/Manipulator/Manipulator.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAndMarkScaffoldByStep()

◆ createTargetElements()

◆ getLastNavigatorWithElements()

◆ insertConditionPathElementsAsScaffolds()

◆ insertPathElementsAsScaffolds()

◆ markElementsCreateOrUpdate()

◆ markElementsDelete()

◆ moveNavigatorBackwardsToFirstNonUnique()

◆ prepareCreateOrUpdate()

◆ prepareForceCreate()

◆ remainingPathOfNavigator()

Field Documentation

◆ $marker_factory

◆ $navigator_factory

◆ $path_factory

◆ $path_utilities_factory

◆ $scaffold_provider