ILIAS\MetaData\Vocabularies\LOMVocabularies Class Reference

Inheritance diagram for ILIAS\MetaData\Vocabularies\LOMVocabularies:

Collaboration diagram for ILIAS\MetaData\Vocabularies\LOMVocabularies:

Public Member Functions
	__construct (DictionaryInitiatorInterface $dictionary_initiator, NavigatorFactoryInterface $navigator_factory)
	vocabulariesForElement (BaseElementInterface $element)
	filteredVocabulariesForElement (ElementInterface $element, bool $ignore_marker)

Protected Member Functions
	checkCondition (ElementInterface $element, VocabularyInterface $vocabulary, bool $ignore_marker)
	getDataValueFromRelativePath (ElementInterface $start, PathInterface $path, bool $ignore_marker)

Protected Attributes
DictionaryInitiatorInterface	$initiator
NavigatorFactoryInterface	$navigator_factory
DictionaryInterface	$dictionary

Detailed Description

Definition at line 32 of file LOMVocabularies.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Vocabularies\LOMVocabularies::__construct	(	DictionaryInitiatorInterface	$dictionary_initiator,
		NavigatorFactoryInterface	$navigator_factory
	)

Definition at line 39 of file LOMVocabularies.php.

References ILIAS\MetaData\Vocabularies\LOMVocabularies\$navigator_factory.

      {
        $this->initiator = $dictionary_initiator;
        $this->navigator_factory = $navigator_factory;
    }

Member Function Documentation

checkCondition()

ILIAS\MetaData\Vocabularies\LOMVocabularies::checkCondition ( ElementInterface  $element, VocabularyInterface  $vocabulary, bool  $ignore_marker  )

protected

Definition at line 89 of file LOMVocabularies.php.

References ILIAS\MetaData\Vocabularies\VocabularyInterface\condition(), ILIAS\MetaData\Vocabularies\LOMVocabularies\getDataValueFromRelativePath(), and ILIAS\MetaData\Vocabularies\VocabularyInterface\isConditional().

Referenced by ILIAS\MetaData\Vocabularies\LOMVocabularies\filteredVocabulariesForElement().

     : bool {
        if (!$vocabulary->isConditional()) {
            return true;
        }
        $value = $this->getDataValueFromRelativePath(
            $element,
            $vocabulary->condition()->path(),
            $ignore_marker
        );
        if ($value === $vocabulary->condition()->value()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

filteredVocabulariesForElement()

ILIAS\MetaData\Vocabularies\LOMVocabularies::filteredVocabulariesForElement	(	ElementInterface	$element,
		bool	$ignore_marker
	)

Returns

VocabularyInterface[]

Implements ILIAS\MetaData\Vocabularies\VocabulariesInterface.

Definition at line 64 of file LOMVocabularies.php.

References $vocab, ILIAS\MetaData\Vocabularies\LOMVocabularies\checkCondition(), ILIAS\MetaData\Vocabularies\LOMVocabularies\getDataValueFromRelativePath(), ILIAS\MetaData\Elements\Base\BaseElementInterface\getDefinition(), and ILIAS\MetaData\Vocabularies\LOMVocabularies\vocabulariesForElement().

     : \Generator {
        $is_vocab_value = false;
        $source = null;
        if ($element->getDefinition()->dataType() === Type::VOCAB_VALUE) {
            $is_vocab_value = true;
            $source = $this->getDataValueFromRelativePath(
                $element,
                $this->initiator->pathFromValueToSource(),
                $ignore_marker
            );
        }
        foreach ($this->vocabulariesForElement($element) as $vocab) {
            if ($is_vocab_value && $vocab->source() !== $source) {
                continue;
            }
            if (!$this->checkCondition($element, $vocab, $ignore_marker)) {
                continue;
            }
            yield $vocab;
        }
    }

Here is the call graph for this function:

getDataValueFromRelativePath()

ILIAS\MetaData\Vocabularies\LOMVocabularies::getDataValueFromRelativePath ( ElementInterface  $start, PathInterface  $path, bool  $ignore_marker  )

protected

Definition at line 108 of file LOMVocabularies.php.

Referenced by ILIAS\MetaData\Vocabularies\LOMVocabularies\checkCondition(), and ILIAS\MetaData\Vocabularies\LOMVocabularies\filteredVocabulariesForElement().

     : ?string {
        $element = $this->navigator_factory->navigator(
            $path,
            $start
        )->lastElementAtFinalStep();

        if (!isset($element)) {
            return null;
        }
        if (
            !$ignore_marker &&
            ($element instanceof MarkableInterface) &&
            $element->isMarked()
        ) {
            return $element->getMarker()->dataValue();
        }
        return $element->getData()->value();
    }

Here is the caller graph for this function:

vocabulariesForElement()

ILIAS\MetaData\Vocabularies\LOMVocabularies::vocabulariesForElement

(

BaseElementInterface

$element

)

Returns

VocabularyInterface[]

Implements ILIAS\MetaData\Vocabularies\VocabulariesInterface.

Definition at line 50 of file LOMVocabularies.php.

Referenced by ILIAS\MetaData\Vocabularies\LOMVocabularies\filteredVocabulariesForElement().

     : \Generator {
        if (!isset($this->dictionary)) {
            $this->dictionary = $this->initiator->get();
        }
        foreach ($this->dictionary->tagsForElement($element) as $tag) {
            yield $tag->vocabulary();
        }
    }

Here is the caller graph for this function:

Field Documentation

$dictionary

DictionaryInterface ILIAS\MetaData\Vocabularies\LOMVocabularies::$dictionary

protected

Definition at line 37 of file LOMVocabularies.php.

$initiator

DictionaryInitiatorInterface ILIAS\MetaData\Vocabularies\LOMVocabularies::$initiator

protected

Definition at line 34 of file LOMVocabularies.php.

$navigator_factory

NavigatorFactoryInterface ILIAS\MetaData\Vocabularies\LOMVocabularies::$navigator_factory

protected

Definition at line 35 of file LOMVocabularies.php.

Referenced by ILIAS\MetaData\Vocabularies\LOMVocabularies\__construct().

---

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

• Services/MetaData/classes/Vocabularies/LOMVocabularies.php