Inheritance diagram for ILIAS\Repository\Provider\RepositoryOpenGraphExposer:

Collaboration diagram for ILIAS\Repository\Provider\RepositoryOpenGraphExposer:

Public Member Functions
	__construct (\ILIAS\DI\Container $dic)

	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 (protected Container $dic)

	getFullyQualifiedClassName ()

	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 ()

Protected Member Functions
	getObjectOfContext (ScreenContext $context)

	getDefaultImage ()

	getLanguageCodesFromLOM (int $object_id, string $object_type)

	ensureRepoContext (CalledContexts $screen_context_stack)

	getPresentationImage (\ilObject $object)

Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Private Member Functions
	exposeObjectOpenGraphMetaData (\ilObject $object)

	exposeDefaultOpenGraphMetaData ()

Private Attributes
LOMServices	$lom_services

bool	$fetch_tile_image = false

Additional Inherited Members
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Layout\Provider\AbstractModificationProvider
ContextCollection	$context_collection

DataFactory	$data

ModificationFactory	$factory

Detailed Description

Author: Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

Definition at line 37 of file RepositoryOpenGraphExposer.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::__construct ( \ILIAS\DI\Container $dic )

Definition at line 44 of file RepositoryOpenGraphExposer.php.

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

References $dic, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ ensureRepoContext()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::ensureRepoContext ( CalledContexts $screen_context_stack )

protected

Definition at line 167 of file RepositoryOpenGraphExposer.php.

                                                                              : CalledContexts
    {
        $collection = new ContextCollection(
            $this->dic->globalScreen()->tool()->context()->availableContexts()
        );
        $collection = $collection->repository();
 
        if (!$screen_context_stack->hasMatch($collection)) {
            $screen_context_stack = $screen_context_stack->repository();
        }
        return $screen_context_stack;
    }

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\hasMatch(), and ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\repository().

Referenced by ILIAS\Repository\Provider\RepositoryOpenGraphExposer\getContentModification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exposeDefaultOpenGraphMetaData()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::exposeDefaultOpenGraphMetaData ( )

private

Definition at line 109 of file RepositoryOpenGraphExposer.php.

                                                     : void
    {
        $uri = $this->data->uri(ILIAS_HTTP_PATH);
 
        $this->globalScreen()->layout()->meta()->addOpenGraphMetaDatum(
            $this->data->openGraphMetadata()->website(
                $uri,
                $this->getDefaultImage(),
                $this->dic->language()->txt('permission_denied'),
                $uri->getHost(),
            )
        );
    }

References ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

Referenced by ILIAS\Repository\Provider\RepositoryOpenGraphExposer\getContentModification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exposeObjectOpenGraphMetaData()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::exposeObjectOpenGraphMetaData ( \ilObject $object )

private

Definition at line 78 of file RepositoryOpenGraphExposer.php.

                                                                     : void
    {
        $object_translation = $object->getObjectProperties()->getPropertyTranslations();
 
        $additional_locale_count = 0;
        $additional_locales = [];
 
        foreach ($this->getLanguageCodesFromLOM($object->getId(), $object->getType()) as $language_code) {
            if ($language_code !== $object_translation->getDefaultLanguage()) {
                $additional_locales[] = $language_code;
                $additional_locale_count++;
            }
        }
 
        $uri = $this->data->uri(\ilLink::_getStaticLink($object->getRefId(), $object->getType()));
 
        $image = $this->getPresentationImage($object);
 
        $this->globalScreen()->layout()->meta()->addOpenGraphMetaDatum(
            $this->data->openGraphMetadata()->website(
                $uri,
                $image,
                $object->getPresentationTitle(),
                $uri->getHost(),
                $object->getLongDescription() . ' ', // we add a space to ensure the description is not cut off
                $object_translation->getDefaultLanguage(),
                (1 < $additional_locale_count) ? array_slice($additional_locales, 1) : []
            )
        );
    }

References ilLink\_getStaticLink(), ilObject\getId(), ILIAS\Repository\Provider\RepositoryOpenGraphExposer\getLanguageCodesFromLOM(), ilObject\getLongDescription(), ilObject\getObjectProperties(), ILIAS\Repository\Provider\RepositoryOpenGraphExposer\getPresentationImage(), ilObject\getPresentationTitle(), ilObject\getRefId(), ilObject\getType(), and ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen().

Referenced by ILIAS\Repository\Provider\RepositoryOpenGraphExposer\getContentModification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContentModification()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::getContentModification ( CalledContexts $screen_context_stack )

@inheritDoc

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

Definition at line 60 of file RepositoryOpenGraphExposer.php.

                                                                                : ?ContentModification
    {
        $current_context = $this->ensureRepoContext($screen_context_stack)->current();
        $ref_id = $current_context->getReferenceId()->toInt();
 
        if (
            $ref_id > 0
            && $this->dic->access()->checkAccess('visible', '', $ref_id)
            && null !== ($object = $this->getObjectOfContext($current_context))
        ) {
            $this->exposeObjectOpenGraphMetaData($object);
        } else {
            $this->exposeDefaultOpenGraphMetaData();
        }
 
        return null;
    }

References $ref_id, ILIAS\Repository\Provider\RepositoryOpenGraphExposer\ensureRepoContext(), ILIAS\Repository\Provider\RepositoryOpenGraphExposer\exposeDefaultOpenGraphMetaData(), and ILIAS\Repository\Provider\RepositoryOpenGraphExposer\exposeObjectOpenGraphMetaData().

Here is the call graph for this function:

◆ getDefaultImage()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::getDefaultImage ( )

protected

Definition at line 138 of file RepositoryOpenGraphExposer.php.

                                        : OGImage
    {
        $image_path_resolver = new \ilImagePathResolver();
 
        return $this->data->openGraphMetadata()->image(
            $this->data->uri(
                ILIAS_HTTP_PATH . ltrim(
                    $image_path_resolver->resolveImagePath(
                        'logo/Sharing.jpg'
                    ),
                    '.'
                )
            ),
            'image/jpg'
        );
    }

Referenced by ILIAS\Repository\Provider\RepositoryOpenGraphExposer\getPresentationImage().

Here is the caller graph for this function:

◆ getLanguageCodesFromLOM()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::getLanguageCodesFromLOM	(	int	$object_id,
		string	$object_type
	)

protected

Returns: string[]

Definition at line 158 of file RepositoryOpenGraphExposer.php.

                                                                                   : \Generator
    {
        $languages_path = $this->lom_services->paths()->languages();
        $reader = $this->lom_services->read($object_id, 0, $object_type, $languages_path);
        foreach ($reader->allData($languages_path) as $lang_data) {
            yield $lang_data->value();
        }
    }

Referenced by ILIAS\Repository\Provider\RepositoryOpenGraphExposer\exposeObjectOpenGraphMetaData().

Here is the caller graph for this function:

◆ getObjectOfContext()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::getObjectOfContext ( ScreenContext $context )

protected

Definition at line 123 of file RepositoryOpenGraphExposer.php.

                                                                 : ?\ilObject
    {
        if (!$context->hasReferenceId()) {
            return null;
        }
 
        try {
            $current_object = \ilObjectFactory::getInstanceByRefId($context->getReferenceId()->toInt());
        } catch (\ilDatabaseException|\ilObjectNotFoundException) {
            $current_object = null;
        } finally {
            return $current_object;
        }
    }

References $context, and ilObjectFactory\getInstanceByRefId().

Here is the call graph for this function:

◆ getPresentationImage()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::getPresentationImage ( \ilObject $object )

protected

Definition at line 180 of file RepositoryOpenGraphExposer.php.

                                                              : OGImage
    {
        $image_factory = $this->dic->ui()->factory()->image();
        $image = $this->getDefaultImage();
        if (!$this->fetch_tile_image) {
            return $image;
        }
        try {
            // Use the tile image if available
            $tile_image = $object->getObjectProperties()->getPropertyTileImage()->getTileImage();
            if ($tile_image !== null && $tile_image->getRid() !== null) {
                $uri_string = $tile_image->getImage($image_factory)->getAdditionalHighResSources()['960']
                    ?? $tile_image->getImage($image_factory)->getSource();
 
                $image = $this->data->openGraphMetadata()->image(
                    $this->data->uri($uri_string),
                    'image/jpg'
                );
            }
        } catch (\Throwable $e) {
        }
        return $image;
    }

References Vendor\Package\$e, ILIAS\Repository\Provider\RepositoryOpenGraphExposer\getDefaultImage(), and ilObject\getObjectProperties().

Referenced by ILIAS\Repository\Provider\RepositoryOpenGraphExposer\exposeObjectOpenGraphMetaData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInterestedInContexts()

ILIAS\Repository\Provider\RepositoryOpenGraphExposer::isInterestedInContexts ( )

Returns: ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 50 of file RepositoryOpenGraphExposer.php.

                                            : ContextCollection
    {
        // the exposer is interested in any context, BUT the repository context
        // will be handled differently.
        return $this->context_collection
            ->internal()
            ->external()
            ->repository();
    }

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

Here is the call graph for this function:

Field Documentation

◆ $fetch_tile_image

bool ILIAS\Repository\Provider\RepositoryOpenGraphExposer::$fetch_tile_image = false

private

Definition at line 41 of file RepositoryOpenGraphExposer.php.

◆ $lom_services

LOMServices ILIAS\Repository\Provider\RepositoryOpenGraphExposer::$lom_services

private

Definition at line 39 of file RepositoryOpenGraphExposer.php.

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

components/ILIAS/Repository/GlobalScreen/classes/RepositoryOpenGraphExposer.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ ensureRepoContext()

◆ exposeDefaultOpenGraphMetaData()

◆ exposeObjectOpenGraphMetaData()

◆ getContentModification()

◆ getDefaultImage()

◆ getLanguageCodesFromLOM()

◆ getObjectOfContext()

◆ getPresentationImage()

◆ isInterestedInContexts()

Field Documentation

◆ $fetch_tile_image

◆ $lom_services