Collaboration diagram for ilWOPIAdministrationGUI:

Public Member Functions
	__construct ()

	executeCommand ()

Data Fields
const	CMD_DEFAULT = "index"

const	CMD_STORE = "store"

const	CMD_SHOW = 'show'

Private Member Functions
	index ()

	getSupportedSuffixes ()

	show ()

	store ()

Private Attributes
ilCtrlInterface	$ctrl

ilAccessHandler	$access

Services	$http

ilLanguage	$lng

ilGlobalTemplateInterface	$maint_tpl

ilSetting	$settings

Crawler	$crawler

int	$ref_id = null

ActionRepository	$action_repo

AppRepository	$app_repo

Factory	$ui_factory

Renderer	$ui_renderer

Detailed Description

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

ilWOPIAdministrationGUI: ilObjExternalToolsSettingsGUI

Definition at line 39 of file class.ilWOPIAdministrationGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilWOPIAdministrationGUI::__construct ( )

Definition at line 57 of file class.ilWOPIAdministrationGUI.php.

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ILIAS\Repository\lng(), null, and ILIAS\Repository\settings().

     {
         global $DIC;
         $this->ctrl = $DIC->ctrl();
         $this->access = $DIC->access();
         $this->http = $DIC->http();
         $this->settings = $DIC->settings();
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule("wopi");
         $this->maint_tpl = $DIC->ui()->mainTemplate();
         $this->ref_id = $this->http->wrapper()->query()->has("ref_id")
             ? (int) $this->http->wrapper()->query()->retrieve(
                 "ref_id",
                 $DIC->refinery()->to()->string()
             )
             : null;
         $this->crawler = new Crawler();
         $this->action_repo = new ActionDBRepository($DIC->database());
         $this->app_repo = new AppDBRepository($DIC->database());
 
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilWOPIAdministrationGUI::executeCommand ( )

Definition at line 81 of file class.ilWOPIAdministrationGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), index(), ILIAS\Repository\lng(), show(), and store().

                                     : void
     {
         if (!$this->access->checkAccess("read", "", $this->ref_id)) {
             $this->maint_tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
             $this->ctrl->redirectByClass(ilObjExternalToolsSettingsGUI::class);
         }
 
         $cmd = $this->ctrl->getCmd(self::CMD_DEFAULT);
         match ($cmd) {
             self::CMD_DEFAULT => $this->index(),
             self::CMD_SHOW => $this->show(),
             self::CMD_STORE => $this->store(),
             default => throw new ilException("command not found: " . $cmd),
         };
     }

Here is the call graph for this function:

◆ getSupportedSuffixes()

ilWOPIAdministrationGUI::getSupportedSuffixes ( )

private

Definition at line 128 of file class.ilWOPIAdministrationGUI.php.

References ILIAS\Repository\settings().

Referenced by index().

                                            : array
     {
         $wopi_activated = (bool) $this->settings->get("wopi_activated", '0');
         if (!$wopi_activated) {
             return [];
         }
         return [
             ActionTarget::EDIT->value => $this->action_repo->getSupportedSuffixes(ActionTarget::EDIT),
             ActionTarget::VIEW->value => $this->action_repo->getSupportedSuffixes(ActionTarget::VIEW),
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilWOPIAdministrationGUI::index ( )

private

Definition at line 97 of file class.ilWOPIAdministrationGUI.php.

References $info, ILIAS\Repository\access(), getSupportedSuffixes(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Referenced by executeCommand().

                             : void
     {
         $supported_suffixes = $this->getSupportedSuffixes();
         $info = '';
         if (!empty($supported_suffixes)) {
             $listing = $this->ui_factory->panel()->secondary()->legacy(
                 $this->lng->txt("currently_supported"),
                 $this->ui_factory->legacy(
                     $this->ui_renderer->render(
                         $this->ui_factory->listing()->descriptive([
                             $this->lng->txt('action_edit') => implode(", ", $supported_suffixes[ActionTarget::EDIT->value]),
                             $this->lng->txt('action_view') => implode(", ", $supported_suffixes[ActionTarget::VIEW->value]),
                         ])
                     )
                 )
             );
             $info = $this->ui_renderer->render($listing);
         }
 
         $form = new ilWOPISettingsForm(
             $this->settings,
             $this->access->checkAccess("write", "", $this->ref_id)
         );
 
         $this->maint_tpl->setContent(
             $form->getHTML()
         );
 
         $this->maint_tpl->setRightContent($info);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

ilWOPIAdministrationGUI::show ( )

private

Definition at line 140 of file class.ilWOPIAdministrationGUI.php.

References ILIAS\components\WOPI\Discovery\Action\getExtension(), ILIAS\components\WOPI\Discovery\Action\getLauncherUrl(), ILIAS\components\WOPI\Discovery\Action\getName(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                            : void
     {
         $actions = array_map(
             fn(Action $action): Item => $this->ui_factory->item()->standard($action->getExtension())->withProperties([
                 $this->lng->txt('launcher_url') => (string) $action->getLauncherUrl(),
                 $this->lng->txt('action') => $action->getName()
             ]),
             $this->action_repo->getActionsForTargets(ActionTarget::EDIT, ActionTarget::EMBED_EDIT)
         );
 
         $this->maint_tpl->setContent(
             $this->ui_renderer->render(
                 $this->ui_factory->item()->group(
                     $this->lng->txt('actions'),
                     $actions
                 )
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ store()

ilWOPIAdministrationGUI::store ( )

private

Definition at line 160 of file class.ilWOPIAdministrationGUI.php.

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, and ILIAS\Repository\settings().

Referenced by executeCommand().

                             : void
     {
         if (!$this->access->checkAccess("write", "", $this->ref_id)) {
             $this->maint_tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
             $this->ctrl->redirect($this, self::CMD_DEFAULT);
         }
 
         $form = new ilWOPISettingsForm(
             $this->settings,
             $this->access->checkAccess("write", "", $this->ref_id)
         );
 
         if ($form->proceed($this->http->request())) {
             global $DIC;
 
             $this->maint_tpl->setOnScreenMessage('success', $this->lng->txt("msg_wopi_settings_modified"), true);
 
             // Crawl
             $discovery_url = $this->settings->get("wopi_discovery_url");
             if ($discovery_url === null) {
                 $this->app_repo->clear($this->action_repo);
             } else {
                 $apps = $this->crawler->crawl(new URI($discovery_url));
                 if ($apps !== null) {
                     $this->app_repo->storeCollection($apps, $this->action_repo);
                 }
             }
 
             $this->ctrl->redirect($this, self::CMD_DEFAULT);
         }
 
         $this->maint_tpl->setContent($form->getHTML());
     }