ILIAS\MetaData\Settings\Vocabularies\Presentation Class Reference

Collaboration diagram for ILIAS\MetaData\Settings\Vocabularies\Presentation:

Public Member Functions
	__construct (ElementsPresentation $elements_presentation, PresentationUtilities $presentation_utils, VocabPresentation $vocab_presentation, SlotHandler $slot_handler, Structure $structure, NavigatorFactory $navigator_factory, PathFactory $path_factory)
	txt (string $key)
	txtFill (string $key, string ... $values)
	makeTypePresentable (VocabType $type)
	makeSlotPresentable (SlotIdentifier $slot)
	makeValuesPresentable (VocabularyInterface $vocabulary, ?int $limit=null)

Protected Member Functions
	translateConditionValue (ConditionInterface $condition, StructureElementInterface $element)
	findFirstCommonParent (StructureElementInterface $a, StructureElementInterface $b)
	getStructureElementFromPath (PathInterface $path, StructureElementInterface $start)

Protected Attributes
const int	MAX_PREVIEW_VALUES = 5
ElementsPresentation	$elements_presentation
PresentationUtilities	$presentation_utils
VocabPresentation	$vocab_presentation
SlotHandler	$slot_handler
Structure	$structure
NavigatorFactory	$navigator_factory
PathFactory	$path_factory
array	$vocabs

Detailed Description

Definition at line 37 of file Presentation.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Settings\Vocabularies\Presentation::__construct	(	ElementsPresentation	$elements_presentation,
		PresentationUtilities	$presentation_utils,
		VocabPresentation	$vocab_presentation,
		SlotHandler	$slot_handler,
		Structure	$structure,
		NavigatorFactory	$navigator_factory,
		PathFactory	$path_factory
	)

Definition at line 54 of file Presentation.php.

References ILIAS\MetaData\Settings\Vocabularies\Presentation\$elements_presentation, ILIAS\MetaData\Settings\Vocabularies\Presentation\$navigator_factory, ILIAS\MetaData\Settings\Vocabularies\Presentation\$path_factory, ILIAS\MetaData\Settings\Vocabularies\Presentation\$presentation_utils, ILIAS\MetaData\Settings\Vocabularies\Presentation\$slot_handler, ILIAS\MetaData\Settings\Vocabularies\Presentation\$structure, and ILIAS\MetaData\Settings\Vocabularies\Presentation\$vocab_presentation.

      {
        $this->elements_presentation = $elements_presentation;
        $this->presentation_utils = $presentation_utils;
        $this->vocab_presentation = $vocab_presentation;
        $this->slot_handler = $slot_handler;
        $this->structure = $structure;
        $this->navigator_factory = $navigator_factory;
        $this->path_factory = $path_factory;
    }

Member Function Documentation

findFirstCommonParent()

ILIAS\MetaData\Settings\Vocabularies\Presentation::findFirstCommonParent ( StructureElementInterface  $a, StructureElementInterface  $b  )

protected

Definition at line 189 of file Presentation.php.

References Vendor\Package\$a, Vendor\Package\$b, and ILIAS\MetaData\Elements\Structure\StructureElementInterface\getSuperElement().

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\makeSlotPresentable().

     : StructureElementInterface {
        $a_supers = [];
        while ($a) {
            $a_supers[] = $a;
            $a = $a->getSuperElement();
        }
        while ($b) {
            if (in_array($b, $a_supers, true)) {
                return $b;
            }
            $b = $b->getSuperElement();
        }
        return $a;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStructureElementFromPath()

ILIAS\MetaData\Settings\Vocabularies\Presentation::getStructureElementFromPath ( PathInterface  $path, StructureElementInterface  $start  )

protected

Definition at line 207 of file Presentation.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\makeSlotPresentable(), and ILIAS\MetaData\Settings\Vocabularies\Presentation\translateConditionValue().

     : StructureElementInterface {
        return $this->navigator_factory->structureNavigator(
            $path,
            $start
        )->elementAtFinalStep();
    }

Here is the caller graph for this function:

makeSlotPresentable()

ILIAS\MetaData\Settings\Vocabularies\Presentation::makeSlotPresentable

(

SlotIdentifier

$slot

)

Definition at line 93 of file Presentation.php.

References ILIAS\MetaData\Settings\Vocabularies\Presentation\findFirstCommonParent(), ILIAS\MetaData\Settings\Vocabularies\Presentation\getStructureElementFromPath(), null, and ILIAS\MetaData\Settings\Vocabularies\Presentation\translateConditionValue().

                                                             : string
    {
        //skip the name of the element if it does not add any information
        $skip_data = ['string', 'value'];

        $element = $this->getStructureElementFromPath(
            $this->slot_handler->pathForSlot($slot),
            $this->structure->getRoot()
        );
        $element_name = $this->elements_presentation->nameWithParents(
            $element,
            null,
            false,
            in_array($element->getDefinition()->name(), $skip_data),
        );

        if (!$this->slot_handler->isSlotConditional($slot)) {
            return $element_name;
        }

        $condition = $this->slot_handler->conditionForSlot($slot);

        $condition_element = $this->getStructureElementFromPath(
            $condition->path(),
            $element
        );
        $condition_element_name = $this->elements_presentation->nameWithParents(
            $condition_element,
            $this->findFirstCommonParent($element, $condition_element)->getSuperElement(),
            false,
            in_array($element->getDefinition()->name(), $skip_data),
        );

        return $this->presentation_utils->txtFill(
            'md_vocab_element_with_condition',
            $element_name,
            $condition_element_name,
            $this->translateConditionValue($condition, $element)
        );
    }

Here is the call graph for this function:

makeTypePresentable()

ILIAS\MetaData\Settings\Vocabularies\Presentation::makeTypePresentable

(

VocabType

$type

)

Definition at line 82 of file Presentation.php.

References ILIAS\MetaData\Vocabularies\COPYRIGHT.

                                                        : string
    {
        return match ($type) {
            VocabType::STANDARD => $this->presentation_utils->txt('md_vocab_type_standard'),
            VocabType::CONTROLLED_STRING => $this->presentation_utils->txt('md_vocab_type_controlled_string'),
            VocabType::CONTROLLED_VOCAB_VALUE => $this->presentation_utils->txt('md_vocab_type_controlled_vocab_value'),
            VocabType::COPYRIGHT => $this->presentation_utils->txt('md_vocab_type_copyright'),
            default => '',
        };
    }

makeValuesPresentable()

ILIAS\MetaData\Settings\Vocabularies\Presentation::makeValuesPresentable	(	VocabularyInterface	$vocabulary,
		?int	$limit = null
	)

Returns

string[]

Definition at line 137 of file Presentation.php.

References ILIAS\MetaData\Vocabularies\COPYRIGHT, null, and ILIAS\MetaData\Vocabularies\VocabularyInterface\type().

     : array {
        $presentable_values = [];
        $i = 0;

        $labelled_values = $this->vocab_presentation->labelsForVocabulary(
            $this->presentation_utils,
            $vocabulary
        );
        foreach ($labelled_values as $labelled_value) {
            if ($limit !== null && $i >= $limit) {
                $presentable_values[] = '...';
                break;
            }
            $i++;

            if (
                $vocabulary->type() === VocabType::STANDARD ||
                $vocabulary->type() === VocabType::COPYRIGHT
            ) {
                $presentable_values[] = $this->presentation_utils->sanitizeForHTML($labelled_value->label());
                continue;
            }

            $presentable_value = $labelled_value->value();
            if ($labelled_value->label() !== '') {
                $presentable_value = $labelled_value->label() . ' (' . $presentable_value . ')';
            }
            $presentable_values[] = $this->presentation_utils->sanitizeForHTML($presentable_value);
        }

        return $presentable_values;
    }

Here is the call graph for this function:

translateConditionValue()

ILIAS\MetaData\Settings\Vocabularies\Presentation::translateConditionValue ( ConditionInterface  $condition, StructureElementInterface  $element  )

protected

Definition at line 173 of file Presentation.php.

References ILIAS\MetaData\Settings\Vocabularies\Presentation\getStructureElementFromPath(), null, ILIAS\MetaData\Vocabularies\Slots\Conditions\ConditionInterface\path(), and ILIAS\MetaData\Vocabularies\Slots\Conditions\ConditionInterface\value().

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\makeSlotPresentable().

     : string {
        $path_from_root = $this->path_factory->toElement(
            $this->getStructureElementFromPath($condition->path(), $element),
        );
        $slot = $this->slot_handler->identiferFromPathAndCondition($path_from_root, null, null);
        return (string) $this->vocab_presentation->presentableLabels(
            $this->presentation_utils,
            $slot,
            false,
            $condition->value()
        )->current()?->label();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

txt()

ILIAS\MetaData\Settings\Vocabularies\Presentation::txt

(

string

$key

)

Definition at line 72 of file Presentation.php.

                                    : string
    {
        return $this->presentation_utils->txt($key);
    }

txtFill()

ILIAS\MetaData\Settings\Vocabularies\Presentation::txtFill	(	string	$key,
		string ...	$values
	)

Definition at line 77 of file Presentation.php.

                                                           : string
    {
        return $this->presentation_utils->txtFill($key, ...$values);
    }

Field Documentation

$elements_presentation

ElementsPresentation ILIAS\MetaData\Settings\Vocabularies\Presentation::$elements_presentation

protected

Definition at line 41 of file Presentation.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\__construct().

$navigator_factory

NavigatorFactory ILIAS\MetaData\Settings\Vocabularies\Presentation::$navigator_factory

protected

Definition at line 46 of file Presentation.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\__construct().

$path_factory

PathFactory ILIAS\MetaData\Settings\Vocabularies\Presentation::$path_factory

protected

Definition at line 47 of file Presentation.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\__construct().

$presentation_utils

PresentationUtilities ILIAS\MetaData\Settings\Vocabularies\Presentation::$presentation_utils

protected

Definition at line 42 of file Presentation.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\__construct().

$slot_handler

SlotHandler ILIAS\MetaData\Settings\Vocabularies\Presentation::$slot_handler

protected

Definition at line 44 of file Presentation.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\__construct().

$structure

Structure ILIAS\MetaData\Settings\Vocabularies\Presentation::$structure

protected

Definition at line 45 of file Presentation.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\__construct().

$vocab_presentation

VocabPresentation ILIAS\MetaData\Settings\Vocabularies\Presentation::$vocab_presentation

protected

Definition at line 43 of file Presentation.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\Presentation\__construct().

$vocabs

array ILIAS\MetaData\Settings\Vocabularies\Presentation::$vocabs

protected

Definition at line 52 of file Presentation.php.

MAX_PREVIEW_VALUES

const int ILIAS\MetaData\Settings\Vocabularies\Presentation::MAX_PREVIEW_VALUES = 5

protected

Definition at line 39 of file Presentation.php.

---

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

• components/ILIAS/MetaData/classes/Settings/Vocabularies/Presentation.php