ilMDKeywordExposer Class Reference

Class ilMDKeywordExposer. More...

Inheritance diagram for ilMDKeywordExposer:

Collaboration diagram for ilMDKeywordExposer:

Public Member Functions
	__construct (\ILIAS\DI\Container $dic)
	isInterestedInContexts ()
	getContentModification (CalledContexts $screen_context_stack)
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	__construct (Container $dic)
	getContentModification (CalledContexts $screen_context_stack)
	getLogoModification (CalledContexts $screen_context_stack)
	getResponsiveLogoModification (CalledContexts $screen_context_stack)
	getMainBarModification (CalledContexts $screen_context_stack)
	getMetaBarModification (CalledContexts $screen_context_stack)
	getBreadCrumbsModification (CalledContexts $screen_context_stack)
	getFooterModification (CalledContexts $screen_context_stack)
	getPageBuilderDecorator (CalledContexts $screen_context_stack)
	getTitleModification (CalledContexts $screen_context_stack)
	getShortTitleModification (CalledContexts $screen_context_stack)
	getViewTitleModification (CalledContexts $screen_context_stack)
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (protected Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Protected Member Functions
	generalReader (int $object_id)
	copyrightReader (int $object_id)
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Protected Attributes
Metadata	$md
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
ContextCollection	$context_collection
DataFactory	$data
ModificationFactory	$factory

Detailed Description

Class ilMDKeywordExposer.

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 33 of file class.ilMDKeywordExposer.php.

Constructor & Destructor Documentation

__construct()

ilMDKeywordExposer::__construct

(

\ILIAS\DI\Container

$dic

)

Definition at line 37 of file class.ilMDKeywordExposer.php.

References ILIAS\GlobalScreen\Provider\__construct().

    {
        $this->md = $dic->learningObjectMetadata();
        parent::__construct($dic);
    }

Here is the call graph for this function:

Member Function Documentation

copyrightReader()

ilMDKeywordExposer::copyrightReader ( int  $object_id )

protected

Definition at line 105 of file class.ilMDKeywordExposer.php.

References $path, and ilObject\_lookupType().

Referenced by getContentModification().

                                                      : Reader
    {
        $path = $this->md->paths()->custom()
                                  ->withNextStep('rights')
                                  ->withNextStep('description')
                                  ->withNextStep('string')
                                  ->get();
        return $this->md->read(
            $object_id,
            $object_id,
            ilObject::_lookupType($object_id),
            $path
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

generalReader()

ilMDKeywordExposer::generalReader ( int  $object_id )

protected

Definition at line 94 of file class.ilMDKeywordExposer.php.

References $path, and ilObject\_lookupType().

Referenced by getContentModification().

                                                    : Reader
    {
        $path = $this->md->paths()->custom()->withNextStep('general')->get();
        return $this->md->read(
            $object_id,
            $object_id,
            ilObject::_lookupType($object_id),
            $path
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getContentModification()

ilMDKeywordExposer::getContentModification

(

CalledContexts

$screen_context_stack

)

Parameters

CalledContexts

$screen_context_stack

Returns

ContentModification

Implements ILIAS\GlobalScreen\Scope\Layout\Provider\ModificationProvider.

Definition at line 48 of file class.ilMDKeywordExposer.php.

References copyrightReader(), ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), generalReader(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), and null.

                                                                                : ?ContentModification
    {
        if ($screen_context_stack->current()->hasReferenceId()) {
            $object_id = $screen_context_stack->current()->getReferenceId()->toObjectId()->toInt();
            $paths = $this->md->paths();
            $reader = $this->generalReader($object_id);

            // Keywords
            $keywords = [];
            foreach ($reader->allData($paths->keywords()) as $keyword) {
                $keywords[] = $keyword->value();
            }
            if (count($keywords) > 0) {
                $this->globalScreen()->layout()->meta()->addMetaDatum(
                    $this->data->htmlMetadata()->userDefined('keywords', implode(',', $keywords))
                );
            }

            // Languages
            $languages = [];
            foreach ($reader->allData($paths->languages()) as $language) {
                $languages[] = $language->value();
            }
            if (count($languages) > 0) {
                $this->globalScreen()->layout()->meta()->addMetaDatum(
                    $this->data->htmlMetadata()->userDefined('languages', implode(',', $languages))
                );
            }

            // Copyright
            if ($this->md->copyrightHelper()->isCopyrightSelectionActive()) {
                $reader = $this->copyrightReader($object_id);
                if ($this->md->copyrightHelper()->hasPresetCopyright($reader)) {
                    $copyright = $this->md->copyrightHelper()->readPresetCopyright($reader)->presentAsString();
                } else {
                    $copyright = $this->md->copyrightHelper()->readCustomCopyright($reader);
                }
                $this->globalScreen()->layout()->meta()->addMetaDatum(
                    $this->data->htmlMetadata()->userDefined('copyright', $copyright)
                );
            }
        }

        return null;
    }

Here is the call graph for this function:

isInterestedInContexts()

ilMDKeywordExposer::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 43 of file class.ilMDKeywordExposer.php.

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\repository().

                                            : ContextCollection
    {
        return $this->context_collection->repository();
    }

Here is the call graph for this function:

Field Documentation

$md

Metadata ilMDKeywordExposer::$md

protected

Definition at line 35 of file class.ilMDKeywordExposer.php.

---

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

• components/ILIAS/MetaData/classes/GlobalScreen/class.ilMDKeywordExposer.php