Inheritance diagram for ilObjFilePreviewRendererGUI:

Collaboration diagram for ilObjFilePreviewRendererGUI:

Public Member Functions
	__construct (private ?int $object_id=null)

	has ()

	getTriggerComponents (bool $as_button=false)

	getRenderedTriggerComponents (bool $as_button=false)

	executeCommand ()

Data Fields
const	P_RID = "rid"

const	CMD_GET_ASYNC_MODAL = 'getAsyncModal'

Protected Member Functions
	resolveRidString (?int $object_id)

	isAccessGranted ()

Private Member Functions
	getAsyncModal ()

Private Attributes
ilDBInterface	$db

Factory	$ui_factory

Renderer	$ui_renderer

ilCtrlInterface	$ctrl

ResourceIdentification	$rid = null

Services	$irss

ILIAS HTTP Services	$http

WrapperFactory	$http_wrapper

ILIAS Refinery Factory	$refinery

FlavourDefinition	$flavour_definition

ilAccessHandler	$access

ilLanguage	$language

int	$preview_size

int	$pages_to_extract

bool	$activated = false

string	$file_name = ''

FlavourDefinition	$fallback_flavour_definition

Detailed Description

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

Definition at line 34 of file class.ilObjFilePreviewRendererGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFilePreviewRendererGUI::__construct ( private ?int $object_id = null )

Definition at line 99 of file class.ilObjFilePreviewRendererGUI.php.

References $DIC, ILIAS\LTI\ToolProvider\$settings, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\LTI\ToolProvider\getSettings(), ILIAS\FileDelivery\http(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\refinery(), and resolveRidString().

       {
         global $DIC;
 
         $settings = (new SettingsFactory())->getSettings();
         $this->activated = $settings->isPreviewEnabled();
 
         $this->db = $DIC->database();
         $this->ctrl = $DIC->ctrl();
 
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->irss = $DIC->resourceStorage();
         $this->http = $DIC->http();
         $this->http_wrapper = $DIC->http()->wrapper();
         $this->refinery = $DIC->refinery();
         $this->access = $DIC->access();
         $this->language = $DIC->language();
         $this->language->loadLanguageModule('file');
 
         $rid_string = $this->resolveRidString($this->object_id);
 
         $this->rid = $this->irss->manage()->find($rid_string);
         $this->flavour_definition = new PagesToExtract(
             $settings->isPersisting(),
             $settings->getImageSize(),
             $settings->getMaximumPreviews()
         );
         $this->fallback_flavour_definition = new FitToSquare(
             $settings->isPersisting(),
             $settings->getImageSize()
         );
         // Resolve File Name
         if ($this->rid !== null) {
             $this->file_name = $this->irss->manage()->getCurrentRevision($this->rid)->getTitle();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilObjFilePreviewRendererGUI::executeCommand ( )

Definition at line 197 of file class.ilObjFilePreviewRendererGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
         match ($cmd) {
             self::CMD_GET_ASYNC_MODAL => $this->{$cmd}(),
             default => throw new InvalidArgumentException('Command not found: ' . $cmd),
         };
     }

Here is the call graph for this function:

◆ getAsyncModal()

ilObjFilePreviewRendererGUI::getAsyncModal ( )

private

Definition at line 248 of file class.ilObjFilePreviewRendererGUI.php.

References $file_name, $response, $url, ILIAS\FileDelivery\http(), isAccessGranted(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                     : void
     {
         if (!$this->isAccessGranted()) {
             throw new LogicException('User cannot see this resource');
         }
 
         // Resolve Flavour for Definition
         $flavour = $this->irss->flavours()->get($this->rid, $this->flavour_definition);
         $flavour_urls = $this->irss->consume()->flavourUrls($flavour)->getURLsAsArray();
         if ($flavour_urls === []) { // Try Fallback
             $flavour = $this->irss->flavours()->get($this->rid, $this->fallback_flavour_definition);
             $flavour_urls = $this->irss->consume()->flavourUrls($flavour)->getURLsAsArray();
         }
 
         $page_title = function (?int $index): string {
             $index_string = $index !== null ? (($index + 1) . ' ') : '';
             return sprintf(
                 $this->language->txt('preview_caption'),
                 $index_string,
                 $this->file_name
             );
         };
 
         // Build Pages for Lightbox
         $pages = array_map(function (string $url, $i) use ($page_title): LightboxImagePage {
             $title = $page_title($i);
             return $this->ui_factory->modal()->lightboxImagePage(
                 $this->ui_factory->image()->responsive(
                     $url,
                     $title
                 ),
                 $title
             );
         }, $flavour_urls, count($flavour_urls) > 1 ? array_keys($flavour_urls) : []);
 
         // Fallback to a TextPage if no Flavour Images were found
         if ($pages === []) {
             $pages = $this->ui_factory->modal()->lightboxTextPage(
                 sprintf(
                     $this->language->txt('preview_not_possible'),
                     'Modules/File/classes/Preview/README.md'
                 ),
                 $this->language->txt('preview')
             );
         }
         $modal = $this->ui_factory->modal()->lightbox($pages);
 
         // Send response and end script
         $response = $this->http->response()->withBody(Streams::ofString($this->ui_renderer->render($modal)));
         $this->http->saveResponse($response);
         $this->http->sendResponse();
     }

Here is the call graph for this function:

◆ getRenderedTriggerComponents()

ilObjFilePreviewRendererGUI::getRenderedTriggerComponents ( bool $as_button = false )

Definition at line 192 of file class.ilObjFilePreviewRendererGUI.php.

References getTriggerComponents().

                                                                          : string
     {
         return $this->ui_renderer->render($this->getTriggerComponents($as_button));
     }

Here is the call graph for this function:

◆ getTriggerComponents()

ilObjFilePreviewRendererGUI::getTriggerComponents ( bool $as_button = false )

Definition at line 161 of file class.ilObjFilePreviewRendererGUI.php.

References ILIAS\Repository\ctrl(), isAccessGranted(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by getRenderedTriggerComponents().

                                                                  : array
     {
         if (!$this->isAccessGranted()) {
             throw new LogicException('User cannot see this resource');
         }
 
         $this->ctrl->setParameterByClass(self::class, self::P_RID, $this->rid->serialize());
 
         $modal = $this->ui_factory->modal()
                                   ->lightbox([])
                                   ->withAsyncRenderUrl(
                                       $this->ctrl->getLinkTargetByClass(self::class, self::CMD_GET_ASYNC_MODAL)
                                   );
 
         if (!$as_button) {
             $trigger = $this->ui_factory->symbol()->glyph()->eyeopen(
                 "#"
             )->withOnClick($modal->getShowSignal());
         } else {
             $trigger = $this->ui_factory->button()->standard(
                 $this->language->txt('show_preview'),
                 "#"
             )->withOnClick($modal->getShowSignal());
         }
 
         return [
             $modal,
             $trigger
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ has()

ilObjFilePreviewRendererGUI::has ( )

Definition at line 138 of file class.ilObjFilePreviewRendererGUI.php.

References isAccessGranted().

                          : bool
     {
         if (!$this->activated) {
             return false;
         }
         if ($this->rid === null) {
             return false;
         }
         if (
             !$this->irss->flavours()->possible(
                 $this->rid,
                 $this->flavour_definition
             )
             && !$this->irss->flavours()->possible(
                 $this->rid,
                 $this->fallback_flavour_definition
             )
         ) {
             return false;
         }
         return $this->isAccessGranted();
     }

Here is the call graph for this function:

◆ isAccessGranted()

ilObjFilePreviewRendererGUI::isAccessGranted ( )

protected

Definition at line 227 of file class.ilObjFilePreviewRendererGUI.php.

References $ref_id, ilObject\_getAllReferences(), and ILIAS\Repository\access().

Referenced by getAsyncModal(), getTriggerComponents(), and has().

                                         : bool
     {
         // if object_id is set, we can check the access using it's ref_ids
         if ($this->object_id !== null) {
             foreach (ilObject::_getAllReferences($this->object_id) as $ref_id) {
                 if ($this->access->checkAccess('read', '', $ref_id)) {
                     return true;
                 }
             }
             return false;
         }
         // else we ask the stakeholders if they allow access
         $resource = $this->irss->manage()->getResource($this->rid);
         foreach ($resource->getStakeholders() as $stakeholder) {
             if ($stakeholder->canBeAccessedByCurrentUser($this->rid)) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveRidString()

ilObjFilePreviewRendererGUI::resolveRidString ( ?int $object_id )

protected

Returns: mixed

Definition at line 209 of file class.ilObjFilePreviewRendererGUI.php.

References ILIAS\Repository\refinery().

Referenced by __construct().

                                                         : string
     {
         if ($object_id !== null) {
             return $this->db->fetchObject(
                 $this->db->queryF(
                     'SELECT rid FROM file_data WHERE file_id = %s',
                     ['integer'],
                     [$object_id]
                 )
             )->rid ?? '';
         }
         return $this->http_wrapper->query()->has(self::P_RID)
             ? $this->http_wrapper->query()->retrieve(
                 self::P_RID,
                 $this->refinery->to()->string()
             ) : '';
     }