Collaboration diagram for ILIAS\File\Icon\ilObjFileIconsOverviewGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	changeActivation ()

	create ()

	update ()

	delete ()

Data Fields
const	CMD_INDEX = 'index'

const	CMD_OPEN_CREATION_FORM = 'openCreationForm'

const	CMD_OPEN_UPDATING_FORM = 'openUpdatingForm'

const	CMD_CHANGE_ACTIVATION = 'changeActivation'

const	CMD_CREATE = 'create'

const	CMD_UPDATE = 'update'

const	CMD_DELETE = 'delete'

const	P_RID = 'rid'

Private Member Functions
	index ()

	openCreationForm ()

	openUpdatingForm ()

Private Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ilToolbarGUI	$toolbar

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

ilGlobalTemplateInterface	$main_tpl

ILIAS HTTP Wrapper WrapperFactory	$wrapper

Psr Http Message RequestInterface	$http_request

ILIAS Refinery Factory	$refinery

ILIAS ResourceStorage Services	$storage

IconRepositoryInterface	$icon_repo

ilFileServicesSettings	$file_service_settings

Detailed Description

Definition at line 27 of file class.ilObjFileIconsOverviewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\File\Icon\ilObjFileIconsOverviewGUI::__construct ( )

final

Definition at line 51 of file class.ilObjFileIconsOverviewGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

     {
         global $DIC;
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule('file');
         $this->toolbar = $DIC->toolbar();
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->http_request = $DIC->http()->request();
         $this->wrapper = $DIC->http()->wrapper();
         $this->refinery = $DIC->refinery();
         $this->storage = $DIC->resourceStorage();
         $this->icon_repo = new IconDatabaseRepository();
         $this->file_service_settings = $DIC->fileServiceSettings();
     }

Here is the call graph for this function:

Member Function Documentation

◆ changeActivation()

ILIAS\File\Icon\ilObjFileIconsOverviewGUI::changeActivation ( )

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\executeCommand().

                                       : void
     {
         $to_str = $this->refinery->to()->string();
         $rid = $this->wrapper->query()->has(self::P_RID) ? $rid = $this->wrapper->query()->retrieve(
             self::P_RID,
             $to_str
         ) : "";
         $icon = $this->icon_repo->getIconByRid($rid);
         $suffixes = $icon->getSuffixes();
         $icon->isActive();
         $is_default_icon = $icon->isDefaultIcon();
 
         if (!$icon->isActive()) {
             // in case of a change from deactivated to activated no two icons with overlapping suffixes must be active at the same time
             if ($this->icon_repo->causesNoActiveSuffixesConflict($suffixes, true, $icon)) {
                 $this->icon_repo->updateIcon($rid, true, $is_default_icon, $suffixes);
 
                 $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_icon_activated'), true);
             } else {
                 $this->main_tpl->setOnScreenMessage(
                     'failure',
                     $this->lng->txt('msg_error_active_suffixes_conflict'),
                     true
                 );
             }
         } else {
             $this->icon_repo->updateIcon($rid, false, $is_default_icon, $suffixes);
             $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_icon_deactivated'), true);
         }
 
         $this->ctrl->redirect($this, self::CMD_INDEX);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ILIAS\File\Icon\ilObjFileIconsOverviewGUI::create ( )

Definition at line 171 of file class.ilObjFileIconsOverviewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\File\Icon\IconFormUI\INPUT_ACTIVE, ILIAS\File\Icon\IconFormUI\INPUT_ICON, ILIAS\File\Icon\IconFormUI\INPUT_SUFFIXES, ILIAS\Repository\lng(), and ILIAS\File\Icon\IconFormUI\MODE_CREATE.

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\executeCommand().

                             : void
     {
         $ui = new IconFormUI(new NullIcon(), IconFormUI::MODE_CREATE, $this->icon_repo);
         $form = $ui->getIconForm();
 
         if ($this->http_request->getMethod() === "POST") {
             $form = $form->withRequest($this->http_request);
             $result = $form->getData();
 
             if ($result !== null) {
                 $rid = $result[0][IconFormUI::INPUT_ICON][0];
                 $active = $result[0][IconFormUI::INPUT_ACTIVE];
                 $suffixes = $result[0][IconFormUI::INPUT_SUFFIXES];
 
                 $this->icon_repo->createIcon($rid, $active, false, $suffixes);
 
                 // check if one of the suffixes is not whitelisted
                 if (array_diff($suffixes, $this->file_service_settings->getWhiteListedSuffixes()) !== []) {
                     $this->main_tpl->setOnScreenMessage(
                         'info',
                         $this->lng->txt('msg_error_active_suffixes_not_whitelisted'),
                         true
                     );
                 }
 
                 // check if one of the suffixes is blacklisted
                 if (array_intersect($suffixes, $this->file_service_settings->getBlackListedSuffixes()) !== []) {
                     $this->main_tpl->setOnScreenMessage(
                         'info',
                         $this->lng->txt('msg_error_active_suffixes_blacklisted'),
                         true
                     );
                 }
 
                 $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_icon_created'), true);
                 $this->ctrl->redirect($this, self::CMD_INDEX);
             } else {
                 $this->main_tpl->setContent(
                     $this->ui_renderer->render([$form])
                 );
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ILIAS\File\Icon\ilObjFileIconsOverviewGUI::delete ( )

Definition at line 250 of file class.ilObjFileIconsOverviewGUI.php.

References $id, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                             : void
     {
         $to_str = $this->refinery->to()->string();
         $rid = $this->wrapper->query()->has(self::P_RID) ? $rid = $this->wrapper->query()->retrieve(
             self::P_RID,
             $to_str
         ) : "";
 
         // delete icon from irss
         $is_deleted_from_irss = false;
         $id = $this->storage->manage()->find($rid);
         if ($id instanceof \ILIAS\ResourceStorage\Identification\ResourceIdentification) {
             $this->storage->manage()->remove($id, new ilObjFileIconStakeholder());
             $is_deleted_from_irss = true;
         }
         // delete icon from db
         $is_deleted_from_db = $this->icon_repo->deleteIconByRid($rid);
 
         if ($is_deleted_from_irss && $is_deleted_from_db) {
             $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_icon_deletion'), true);
         } elseif ($is_deleted_from_irss) {
             $this->main_tpl->setOnScreenMessage(
                 'failure',
                 $this->lng->txt('msg_error_icon_deletion') . " " . $this->lng->txt('msg_icon_missing_from_db'),
                 true
             );
         } elseif ($is_deleted_from_db) {
             $this->main_tpl->setOnScreenMessage(
                 'failure',
                 $this->lng->txt('msg_error_icon_deletion') . " " . $this->lng->txt('msg_icon_missing_from_irss'),
                 true
             );
         } else {
             $this->main_tpl->setOnScreenMessage(
                 'failure',
                 $this->lng->txt('msg_error_icon_deletion') . " " . $this->lng->txt(
                     'msg_icon_missing_from_db'
                 ) . " " . $this->lng->txt('msg_icon_missing_from_irss'),
                 true
             );
         }
         $this->ctrl->redirect($this, self::CMD_INDEX);
     }

Here is the call graph for this function:

◆ executeCommand()

ILIAS\File\Icon\ilObjFileIconsOverviewGUI::executeCommand ( )

final

Definition at line 69 of file class.ilObjFileIconsOverviewGUI.php.

References ILIAS\File\Icon\ilObjFileIconsOverviewGUI\changeActivation(), ILIAS\File\Icon\ilObjFileIconsOverviewGUI\create(), ILIAS\Repository\ctrl(), ILIAS\File\Icon\ilObjFileIconsOverviewGUI\index(), ILIAS\File\Icon\ilObjFileIconsOverviewGUI\openCreationForm(), ILIAS\File\Icon\ilObjFileIconsOverviewGUI\openUpdatingForm(), and ILIAS\File\Icon\ilObjFileIconsOverviewGUI\update().

                                           : void
     {
         $next_class = $this->ctrl->getNextClass(self::class);
         if ($next_class === strtolower(ilIconUploadHandlerGUI::class)) {
             $upload_handler = new ilIconUploadHandlerGUI();
             $this->ctrl->forwardCommand($upload_handler);
         }
 
         match ($cmd = $this->ctrl->getCmd(self::CMD_INDEX)) {
             self::CMD_OPEN_CREATION_FORM => $this->openCreationForm(),
             self::CMD_OPEN_UPDATING_FORM => $this->openUpdatingForm(),
             self::CMD_CHANGE_ACTIVATION => $this->changeActivation(),
             self::CMD_CREATE => $this->create(),
             self::CMD_UPDATE => $this->update(),
             self::CMD_DELETE => $this->delete(),
             default => $this->index(),
         };
     }

Here is the call graph for this function:

◆ index()

ILIAS\File\Icon\ilObjFileIconsOverviewGUI::index ( )

private

Definition at line 88 of file class.ilObjFileIconsOverviewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\executeCommand().

                             : void
     {
         // toolbar: add new icon button
         $btn_new_icon = $this->ui_factory->button()->standard(
             $this->lng->txt('add_icon'),
             $this->ctrl->getLinkTargetByClass(self::class, self::CMD_OPEN_CREATION_FORM)
         );
         $this->toolbar->addComponent($btn_new_icon);
 
         // Listing of icons
         $listing = new IconListingUI(
             $this->icon_repo,
             $this
         );
 
         $content = [];
         $content[] = $listing->getFilter();
         $content[] = $listing->getIconList();
         $content[] = $listing->getDeletionModals();
 
         $this->main_tpl->setContent(
             $this->ui_renderer->render($content)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openCreationForm()

ILIAS\File\Icon\ilObjFileIconsOverviewGUI::openCreationForm ( )

private

Definition at line 113 of file class.ilObjFileIconsOverviewGUI.php.

References ILIAS\File\Icon\IconFormUI\MODE_CREATE.

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\executeCommand().

                                        : void
     {
         $icon_form_ui = new IconFormUI(new NullIcon('', true), IconFormUI::MODE_CREATE, $this->icon_repo);
         $icon_form = $icon_form_ui->getIconForm();
         $this->main_tpl->setContent(
             $this->ui_renderer->render($icon_form)
         );
     }

Here is the caller graph for this function:

◆ openUpdatingForm()

ILIAS\File\Icon\ilObjFileIconsOverviewGUI::openUpdatingForm ( )

private

Definition at line 122 of file class.ilObjFileIconsOverviewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\File\Icon\IconFormUI\MODE_EDIT, and ILIAS\Repository\refinery().

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\executeCommand().

                                        : void
     {
         $to_str = $this->refinery->to()->string();
         $rid = $this->wrapper->query()->has(self::P_RID) ? $rid = $this->wrapper->query()->retrieve(
             self::P_RID,
             $to_str
         ) : "";
         $this->ctrl->setParameter($this, self::P_RID, $rid); //store rid for giving icon to form in update function
         $icon = $this->icon_repo->getIconByRid($rid);
         $icon_form_ui = new IconFormUI($icon, IconFormUI::MODE_EDIT, $this->icon_repo);
         $icon_form = $icon_form_ui->getIconForm();
         $this->main_tpl->setContent(
             $this->ui_renderer->render($icon_form)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ILIAS\File\Icon\ilObjFileIconsOverviewGUI::update ( )

Definition at line 215 of file class.ilObjFileIconsOverviewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\File\Icon\IconFormUI\INPUT_ACTIVE, ILIAS\File\Icon\IconFormUI\INPUT_ICON, ILIAS\File\Icon\IconFormUI\INPUT_SUFFIXES, ILIAS\Repository\lng(), ILIAS\File\Icon\IconFormUI\MODE_EDIT, and ILIAS\Repository\refinery().

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\executeCommand().

                             : void
     {
         $to_str = $this->refinery->to()->string();
         $rid = $this->wrapper->query()->has(self::P_RID) ? $rid = $this->wrapper->query()->retrieve(
             self::P_RID,
             $to_str
         ) : "";
         $this->ctrl->saveParameter(
             $this,
             self::P_RID
         ); //save rid to still have it when re-submitting a previously wrongly filled out form
         $icon = $this->icon_repo->getIconByRid($rid);
         $ui = new IconFormUI($icon, IconFormUI::MODE_EDIT, $this->icon_repo);
         $form = $ui->getIconForm();
 
         if ($this->http_request->getMethod() === "POST") {
             $form = $form->withRequest($this->http_request);
             $result = $form->getData();
 
             if ($result !== null) {
                 $rid = $result[0][IconFormUI::INPUT_ICON][0];
                 $active = $result[0][IconFormUI::INPUT_ACTIVE];
                 $suffixes = $result[0][IconFormUI::INPUT_SUFFIXES];
 
                 $this->icon_repo->updateIcon($rid, $active, false, $suffixes);
                 $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_icon_updated'), true);
                 $this->ctrl->redirect($this, self::CMD_INDEX);
             } else {
                 $this->main_tpl->setContent(
                     $this->ui_renderer->render([$form])
                 );
             }
         }
     }