ILIAS\MetaData\Structure\Dictionaries\Dictionary Class Reference

Inheritance diagram for ILIAS\MetaData\Structure\Dictionaries\Dictionary:

Collaboration diagram for ILIAS\MetaData\Structure\Dictionaries\Dictionary:

Public Member Functions
	__construct (PathFactoryInterface $path_factory, NavigatorFactoryInterface $navigator_factory, TagAssignmentInterface ... $tag_assignments)
	tagsForElement (BaseElementInterface $element)
	If possible, takes into account the index of elements when finding tags (beginning with 0). More...

Protected Member Functions
	getAssignmentsForElement (PathInterface $path)
	doesIndexMatch (PathInterface $path, BaseElementInterface $element, TagInterface $tag)
	findIndexOfElement (PathInterface $path, ElementInterface $element)

Protected Attributes
PathFactoryInterface	$path_factory
NavigatorFactoryInterface	$navigator_factory

Private Attributes
array	$tag_assignments

Detailed Description

Definition at line 32 of file Dictionary.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Structure\Dictionaries\Dictionary::__construct	(	PathFactoryInterface	$path_factory,
		NavigatorFactoryInterface	$navigator_factory,
		TagAssignmentInterface ...	$tag_assignments
	)

Definition at line 42 of file Dictionary.php.

References ILIAS\MetaData\Structure\Dictionaries\Dictionary\$navigator_factory, ILIAS\MetaData\Structure\Dictionaries\Dictionary\$path_factory, and ILIAS\MetaData\Structure\Dictionaries\Dictionary\$tag_assignments.

      {
        $this->path_factory = $path_factory;
        $this->navigator_factory = $navigator_factory;
        $this->tag_assignments = $tag_assignments;
    }

Member Function Documentation

doesIndexMatch()

ILIAS\MetaData\Structure\Dictionaries\Dictionary::doesIndexMatch ( PathInterface  $path, BaseElementInterface  $element, TagInterface  $tag  )

protected

Definition at line 83 of file Dictionary.php.

References ILIAS\MetaData\Structure\Dictionaries\Dictionary\findIndexOfElement(), ILIAS\MetaData\Structure\Dictionaries\Tags\TagInterface\indices(), and ILIAS\MetaData\Structure\Dictionaries\Tags\TagInterface\isRestrictedToIndices().

Referenced by ILIAS\MetaData\Structure\Dictionaries\Dictionary\tagsForElement().

     : bool {
        if (!($element instanceof ElementInterface)) {
            return true;
        }
        if (!$tag->isRestrictedToIndices()) {
            return true;
        }
        $index = $this->findIndexOfElement($path, $element);
        if (in_array($index, iterator_to_array($tag->indices()), true)) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findIndexOfElement()

ILIAS\MetaData\Structure\Dictionaries\Dictionary::findIndexOfElement ( PathInterface  $path, ElementInterface  $element  )

protected

Definition at line 101 of file Dictionary.php.

References ILIAS\MetaData\Elements\Base\BaseElementInterface\getDefinition().

Referenced by ILIAS\MetaData\Structure\Dictionaries\Dictionary\doesIndexMatch().

     : int {
        $name = $element->getDefinition()->name();
        $navigator = $this->navigator_factory->navigator($path, $element);
        $index = 0;
        foreach ($navigator->elementsAtFinalStep() as $sibling_element) {
            if ($sibling_element === $element) {
                return $index;
            }
            $index++;
        }
        throw new \ilMDStructureException('Invalid metadata set');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignmentsForElement()

ILIAS\MetaData\Structure\Dictionaries\Dictionary::getAssignmentsForElement ( PathInterface  $path )

protected

Returns

TagAssignmentInterface[]

Definition at line 73 of file Dictionary.php.

Referenced by ILIAS\MetaData\Structure\Dictionaries\Dictionary\tagsForElement().

     : \Generator {
        foreach ($this->tag_assignments as $assignment) {
            if ($assignment->matchesPath($path)) {
                yield $assignment;
            }
        }
    }

Here is the caller graph for this function:

tagsForElement()

ILIAS\MetaData\Structure\Dictionaries\Dictionary::tagsForElement

(

BaseElementInterface

$element

)

If possible, takes into account the index of elements when finding tags (beginning with 0).

Returns

TagInterface[]

Definition at line 57 of file Dictionary.php.

References $path, ILIAS\MetaData\Structure\Dictionaries\Dictionary\doesIndexMatch(), and ILIAS\MetaData\Structure\Dictionaries\Dictionary\getAssignmentsForElement().

     : \Generator {
        $path = $this->path_factory->toElement($element);
        foreach ($this->getAssignmentsForElement($path) as $assignment) {
            $tag = $assignment->tag();
            if (!$this->doesIndexMatch($path, $element, $tag)) {
                continue;
            }
            yield $tag;
        }
    }

Here is the call graph for this function:

Field Documentation

$navigator_factory

NavigatorFactoryInterface ILIAS\MetaData\Structure\Dictionaries\Dictionary::$navigator_factory

protected

Definition at line 35 of file Dictionary.php.

Referenced by ILIAS\MetaData\Structure\Dictionaries\Dictionary\__construct().

$path_factory

PathFactoryInterface ILIAS\MetaData\Structure\Dictionaries\Dictionary::$path_factory

protected

Definition at line 34 of file Dictionary.php.

Referenced by ILIAS\MetaData\Structure\Dictionaries\Dictionary\__construct().

$tag_assignments

array ILIAS\MetaData\Structure\Dictionaries\Dictionary::$tag_assignments

private

Definition at line 40 of file Dictionary.php.

Referenced by ILIAS\MetaData\Structure\Dictionaries\Dictionary\__construct().

---

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

• components/ILIAS/MetaData/classes/Structure/Dictionaries/Dictionary.php