ilMDKeywordExposer Class Reference

Class ilMDKeywordExposer. More...

Inheritance diagram for ilMDKeywordExposer:

Collaboration diagram for ilMDKeywordExposer:

Public Member Functions
	isInterestedInContexts ()
	getContentModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	__construct (Container $dic)
	@inheritDoc More...
	getContentModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getLogoModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getResponsiveLogoModification (CalledContexts $screen_context_stack)
	getMainBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getMetaBarModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getBreadCrumbsModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getFooterModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getPageBuilderDecorator (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getShortTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
	getViewTitleModification (CalledContexts $screen_context_stack)
	@inheritDoc More...
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)
	@inheritDoc More...
	getFullyQualifiedClassName ()
	@inheritDoc More...
	getProviderNameForPresentation ()
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()
	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)
	isInterestedInContexts ()

Private Member Functions
	getGeneral (int $object_id)
	getRights (int $object_id)

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
	$context_collection
	$factory
Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	$dic

Detailed Description

Class ilMDKeywordExposer.

Author

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

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

Member Function Documentation

getContentModification()

ilMDKeywordExposer::getContentModification

(

CalledContexts

$screen_context_stack

)

@inheritDoc

Reimplemented from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider.

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

                                                                                 : ?ContentModification
    {
        if ($screen_context_stack->current()->hasReferenceId()) {
            $object_id = $screen_context_stack->current()->getReferenceId()->toObjectId()->toInt();
            
            if ($general = $this->getGeneral($object_id)) {
                // Keywords
                $keywords = [];
                foreach ($general->getKeywordIds() as $keyword_id) {
                    $keyword = $general->getKeyword($keyword_id);
                    $keywords[] = $keyword->getKeyword();
                }
    
                $delimiter = ilMDSettings::_getInstance()->getDelimiter() ?? ",";
                
                if (count($keywords) > 0) {
                    $this->globalScreen()->layout()->meta()->addMetaDatum('keywords', implode($delimiter, $keywords));
                }
                // Languages
                $languages = [];
                foreach ($general->getLanguageIds() as $language_id) {
                    $language = $general->getLanguage($language_id);
                    $languages[] = $language->getLanguageCode();
                }
                if (count($languages) > 0) {
                    $this->globalScreen()->layout()->meta()->addMetaDatum('languages', implode($delimiter, $languages));
                }
            }
    
            if ($rights = $this->getRights($object_id)) {
                // Copyright
                $copy_right_id = ilMDCopyrightSelectionEntry::_extractEntryId($rights->getDescription());
                if ($copy_right_id > 0) {
                    $entry = new ilMDCopyrightSelectionEntry($copy_right_id);
                    $this->globalScreen()->layout()->meta()->addMetaDatum('copyright', $entry->getTitle());
                }
            }
        }
        
        return null;
    }

References ilMDCopyrightSelectionEntry\_extractEntryId(), ilMDSettings\_getInstance(), ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), getGeneral(), getRights(), and ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

Here is the call graph for this function:

getGeneral()

ilMDKeywordExposer::getGeneral ( int  $object_id )

private

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

                                                : ?ilMDGeneral
    {
        if ($id = ilMDGeneral::_getId($object_id, $object_id)) {
            $gen = new ilMDGeneral();
            $gen->setMetaId($id);
            
            return $gen;
        }
        return null;
    }

References ilMDGeneral\_getId().

Referenced by getContentModification().

Here is the call graph for this function:

Here is the caller graph for this function:

getRights()

ilMDKeywordExposer::getRights ( int  $object_id )

private

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

                                               : ?ilMDRights
    {
        if ($id = ilMDRights::_getId($object_id, $object_id)) {
            $rig = new ilMDRights();
            $rig->setMetaId($id);
            
            return $rig;
        }
        return null;
    }

References ilMDRights\_getId().

Referenced by getContentModification().

Here is the call graph for this function:

Here is the caller graph for this function:

isInterestedInContexts()

ilMDKeywordExposer::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

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

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

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

Here is the call graph for this function:

---

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

• Services/MetaData/classes/GlobalScreen/class.ilMDKeywordExposer.php