ILIAS\MetaData\Vocabularies\Slots\Handler Class Reference

Inheritance diagram for ILIAS\MetaData\Vocabularies\Slots\Handler:

Collaboration diagram for ILIAS\MetaData\Vocabularies\Slots\Handler:

Public Member Functions
	__construct (PathFactory $path_factory, NavigatorFactoryInterface $navigator_factory, StructureSetInterface $structure)
	pathForSlot (Identifier $identifier)
	isSlotConditional (Identifier $identifier)
	conditionForSlot (Identifier $identifier)
	identiferFromPathAndCondition (PathInterface $path_to_element, ?PathInterface $path_to_condition, ?string $condition_value)
	allSlotsForPath (PathInterface $path_to_element)
	doesSlotExist (PathInterface $path_to_element, ?PathInterface $path_to_condition, ?string $condition_value)
	dataTypeForSlot (Identifier $identifier)

Protected Member Functions
	buildPath (string ... $steps)
	buildCondition (string $condition_value, string|StepToken ... $steps_to_condition,)

Protected Attributes
PathFactory	$path_factory
NavigatorFactoryInterface	$navigator_factory
StructureSetInterface	$structure

Detailed Description

Definition at line 32 of file Handler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Vocabularies\Slots\Handler::__construct	(	PathFactory	$path_factory,
		NavigatorFactoryInterface	$navigator_factory,
		StructureSetInterface	$structure
	)

Definition at line 38 of file Handler.php.

References ILIAS\MetaData\Vocabularies\Slots\Handler\$navigator_factory, ILIAS\MetaData\Vocabularies\Slots\Handler\$path_factory, and ILIAS\MetaData\Vocabularies\Slots\Handler\$structure.

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

Member Function Documentation

allSlotsForPath()

ILIAS\MetaData\Vocabularies\Slots\Handler::allSlotsForPath

(

PathInterface

$path_to_element

)

Returns

Identifier[]

Implements ILIAS\MetaData\Vocabularies\Slots\HandlerInterface.

Definition at line 141 of file Handler.php.

References ILIAS\MetaData\Vocabularies\Slots\Handler\pathForSlot(), ILIAS\Export\ImportHandler\File\XML\Manifest\toString, and ILIAS\MetaData\Paths\PathInterface\toString().

                                                                   : \Generator
    {
        foreach (Identifier::cases() as $identifier) {
            if ($this->pathForSlot($identifier)->toString() === $path_to_element->toString()) {
                yield $identifier;
            }
        }
    }

Here is the call graph for this function:

buildCondition()

ILIAS\MetaData\Vocabularies\Slots\Handler::buildCondition ( string  $condition_value, string|StepToken ...  $steps_to_condition  )

protected

Definition at line 172 of file Handler.php.

References $path, and ILIAS\MetaData\Paths\Steps\SUPER.

Referenced by ILIAS\MetaData\Vocabularies\Slots\Handler\conditionForSlot().

     : ConditionInterface {
        $builder = $this->path_factory->custom();
        foreach ($steps_to_condition as $step) {
            if ($step === StepToken::SUPER) {
                $builder = $builder->withNextStepToSuperElement();
                continue;
            }
            $builder = $builder->withNextStep($step);
        }
        $path = $builder->withRelative(true)->get();

        return new Condition(
            $condition_value,
            $path
        );
    }

Here is the caller graph for this function:

buildPath()

ILIAS\MetaData\Vocabularies\Slots\Handler::buildPath ( string ...  $steps )

protected

Definition at line 163 of file Handler.php.

Referenced by ILIAS\MetaData\Vocabularies\Slots\Handler\pathForSlot().

                                                  : PathInterface
    {
        $builder = $this->path_factory->custom();
        foreach ($steps as $step) {
            $builder = $builder->withNextStep($step);
        }
        return $builder->get();
    }

Here is the caller graph for this function:

conditionForSlot()

ILIAS\MetaData\Vocabularies\Slots\Handler::conditionForSlot

(

Identifier

$identifier

)

Implements ILIAS\MetaData\Vocabularies\Slots\HandlerInterface.

Definition at line 91 of file Handler.php.

References ILIAS\MetaData\Vocabularies\Slots\Handler\buildCondition(), null, and ILIAS\MetaData\Paths\Steps\SUPER.

Referenced by ILIAS\MetaData\Vocabularies\Slots\Handler\identiferFromPathAndCondition(), and ILIAS\MetaData\Vocabularies\Slots\Handler\isSlotConditional().

                                                            : ?ConditionInterface
    {
        return match ($identifier) {
            Identifier::LIFECYCLE_CONTRIBUTE_PUBLISHER => $this->buildCondition(
                'publisher',
                StepToken::SUPER,
                'role',
                'value'
            ),
            Identifier::TECHNICAL_REQUIREMENT_BROWSER => $this->buildCondition(
                'browser',
                StepToken::SUPER,
                StepToken::SUPER,
                'type',
                'value'
            ),
            Identifier::TECHNICAL_REQUIREMENT_OS => $this->buildCondition(
                'operating system',
                StepToken::SUPER,
                StepToken::SUPER,
                'type',
                'value'
            ),
            default => null
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

dataTypeForSlot()

ILIAS\MetaData\Vocabularies\Slots\Handler::dataTypeForSlot

(

Identifier

$identifier

)

Implements ILIAS\MetaData\Vocabularies\Slots\HandlerInterface.

Definition at line 192 of file Handler.php.

References ILIAS\MetaData\Vocabularies\Slots\Handler\pathForSlot().

                                                           : DataType
    {
        return $this->navigator_factory->structureNavigator(
            $this->pathForSlot($identifier),
            $this->structure->getRoot()
        )->elementAtFinalStep()->getDefinition()->dataType();
    }

Here is the call graph for this function:

doesSlotExist()

ILIAS\MetaData\Vocabularies\Slots\Handler::doesSlotExist	(	PathInterface	$path_to_element,
		?PathInterface	$path_to_condition,
		?string	$condition_value
	)

Implements ILIAS\MetaData\Vocabularies\Slots\HandlerInterface.

Definition at line 150 of file Handler.php.

References ILIAS\MetaData\Vocabularies\Slots\Handler\identiferFromPathAndCondition(), and ILIAS\Data\Description\NULL.

     : bool {
        $identifier = $this->identiferFromPathAndCondition(
            $path_to_element,
            $path_to_condition,
            $condition_value
        );
        return $identifier !== Identifier::NULL;
    }

Here is the call graph for this function:

identiferFromPathAndCondition()

ILIAS\MetaData\Vocabularies\Slots\Handler::identiferFromPathAndCondition	(	PathInterface	$path_to_element,
		?PathInterface	$path_to_condition,
		?string	$condition_value
	)

Implements ILIAS\MetaData\Vocabularies\Slots\HandlerInterface.

Definition at line 118 of file Handler.php.

References ILIAS\MetaData\Vocabularies\Slots\Handler\conditionForSlot(), ILIAS\Data\Description\NULL, ILIAS\MetaData\Vocabularies\Slots\Handler\pathForSlot(), ILIAS\Export\ImportHandler\File\XML\Manifest\toString, and ILIAS\MetaData\Paths\PathInterface\toString().

Referenced by ILIAS\MetaData\Vocabularies\Slots\Handler\doesSlotExist().

     : Identifier {
        foreach (Identifier::cases() as $identifier) {
            if ($this->pathForSlot($identifier)->toString() !== $path_to_element->toString()) {
                continue;
            }

            $condition = $this->conditionForSlot($identifier);
            if (
                $condition?->value() !== $condition_value ||
                $condition?->path()?->toString() !== $path_to_condition?->toString()
            ) {
                continue;
            }

            return $identifier;
        }
        return Identifier::NULL;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSlotConditional()

ILIAS\MetaData\Vocabularies\Slots\Handler::isSlotConditional

(

Identifier

$identifier

)

Implements ILIAS\MetaData\Vocabularies\Slots\HandlerInterface.

Definition at line 86 of file Handler.php.

References ILIAS\MetaData\Vocabularies\Slots\Handler\conditionForSlot().

                                                             : bool
    {
        return !is_null($this->conditionForSlot($identifier));
    }

Here is the call graph for this function:

pathForSlot()

ILIAS\MetaData\Vocabularies\Slots\Handler::pathForSlot

(

Identifier

$identifier

)

Implements ILIAS\MetaData\Vocabularies\Slots\HandlerInterface.

Definition at line 48 of file Handler.php.

References ILIAS\MetaData\Vocabularies\Slots\Handler\buildPath(), ILIAS\MetaData\Vocabularies\Slots\CLASSIFICATION_TAXON_ENTRY, and ILIAS\Data\Description\NULL.

Referenced by ILIAS\MetaData\Vocabularies\Slots\Handler\allSlotsForPath(), ILIAS\MetaData\Vocabularies\Slots\Handler\dataTypeForSlot(), and ILIAS\MetaData\Vocabularies\Slots\Handler\identiferFromPathAndCondition().

                                                       : PathInterface
    {
        return match ($identifier) {
            Identifier::GENERAL_STRUCTURE => $this->buildPath('general', 'structure', 'value'),
            Identifier::GENERAL_AGGREGATION_LEVEL => $this->buildPath('general', 'aggregationLevel', 'value'),
            Identifier::GENERAL_COVERAGE => $this->buildPath('general', 'coverage', 'string'),
            Identifier::GENERAL_IDENTIFIER_CATALOG => $this->buildPath('general', 'identifier', 'catalog'),
            Identifier::LIFECYCLE_STATUS => $this->buildPath('lifeCycle', 'status', 'value'),
            Identifier::LIFECYCLE_CONTRIBUTE_ROLE => $this->buildPath('lifeCycle', 'contribute', 'role', 'value'),
            Identifier::LIFECYCLE_CONTRIBUTE_PUBLISHER => $this->buildPath('lifeCycle', 'contribute', 'entity'),
            Identifier::METAMETADATA_IDENTIFIER_CATALOG => $this->buildPath('metaMetadata', 'identifier', 'catalog'),
            Identifier::METAMETADATA_CONTRIBUTE_ROLE => $this->buildPath('metaMetadata', 'contribute', 'role', 'value'),
            Identifier::METAMETADATA_SCHEMA => $this->buildPath('metaMetadata', 'metadataSchema'),
            Identifier::TECHNICAL_REQUIREMENT_TYPE => $this->buildPath('technical', 'requirement', 'orComposite', 'type', 'value'),
            Identifier::TECHNICAL_REQUIREMENT_BROWSER, Identifier::TECHNICAL_REQUIREMENT_OS => $this->buildPath('technical', 'requirement', 'orComposite', 'name', 'value'),
            Identifier::TECHNICAL_OTHER_PLATFORM_REQUIREMENTS => $this->buildPath('technical', 'otherPlatformRequirements', 'string'),
            Identifier::TECHNICAL_FORMAT => $this->buildPath('technical', 'format'),
            Identifier::EDUCATIONAL_INTERACTIVITY_TYPE => $this->buildPath('educational', 'interactivityType', 'value'),
            Identifier::EDUCATIONAL_LEARNING_RESOURCE_TYPE => $this->buildPath('educational', 'learningResourceType', 'value'),
            Identifier::EDUCATIONAL_INTERACTIVITY_LEVEL => $this->buildPath('educational', 'interactivityLevel', 'value'),
            Identifier::EDUCATIONAL_SEMANTIC_DENSITY => $this->buildPath('educational', 'semanticDensity', 'value'),
            Identifier::EDCUCATIONAL_INTENDED_END_USER_ROLE => $this->buildPath('educational', 'intendedEndUserRole', 'value'),
            Identifier::EDUCATIONAL_CONTEXT => $this->buildPath('educational', 'context', 'value'),
            Identifier::EDUCATIONAL_DIFFICULTY => $this->buildPath('educational', 'difficulty', 'value'),
            Identifier::EDUCATIONAL_TYPICAL_AGE_RANGE => $this->buildPath('educational', 'typicalAgeRange', 'string'),
            Identifier::RIGHTS_COST => $this->buildPath('rights', 'cost', 'value'),
            Identifier::RIGHTS_CP_AND_OTHER_RESTRICTIONS => $this->buildPath('rights', 'copyrightAndOtherRestrictions', 'value'),
            Identifier::RIGHTS_DESCRIPTION => $this->buildPath('rights', 'description', 'string'),
            Identifier::RELATION_KIND => $this->buildPath('relation', 'kind', 'value'),
            Identifier::RELATION_RESOURCE_IDENTIFIER_CATALOG => $this->buildPath('relation', 'resource', 'identifier', 'catalog'),
            Identifier::CLASSIFICATION_PURPOSE => $this->buildPath('classification', 'purpose', 'value'),
            Identifier::CLASSIFICATION_KEYWORD => $this->buildPath('classification', 'keyword', 'string'),
            Identifier::CLASSIFICATION_TAXPATH_SOURCE => $this->buildPath('classification', 'taxonPath', 'source', 'string'),
            Identifier::CLASSIFICATION_TAXON_ENTRY => $this->buildPath('classification', 'taxonPath', 'taxon', 'entry', 'string'),
            Identifier::NULL => $this->buildPath()
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$navigator_factory

NavigatorFactoryInterface ILIAS\MetaData\Vocabularies\Slots\Handler::$navigator_factory

protected

Definition at line 35 of file Handler.php.

Referenced by ILIAS\MetaData\Vocabularies\Slots\Handler\__construct().

$path_factory

PathFactory ILIAS\MetaData\Vocabularies\Slots\Handler::$path_factory

protected

Definition at line 34 of file Handler.php.

Referenced by ILIAS\MetaData\Vocabularies\Slots\Handler\__construct().

$structure

StructureSetInterface ILIAS\MetaData\Vocabularies\Slots\Handler::$structure

protected

Definition at line 36 of file Handler.php.

Referenced by ILIAS\MetaData\Vocabularies\Slots\Handler\__construct().

---

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

• components/ILIAS/MetaData/classes/Vocabularies/Slots/Handler.php