Collaboration diagram for ILIAS\File\Icon\IconListingUI:

Public Member Functions
	__construct (private IconRepositoryInterface $icon_repo, private ilObjFileIconsOverviewGUI $gui, private bool $write_access)

	getFilter ()

	getIconList ()

	getDeletionModals ()

Protected Member Functions
	initListing ()

Private Member Functions
	initFilter ()

	getDeletionConfirmationModal (Icon $a_icon)

Private Attributes
ilCtrl	$ctrl

ilLanguage	$lng

Factory	$ui_factory

ILIAS Refinery Factory	$refinery

Services	$storage

array	$deletion_modals = []

Standard	$icon_list

ilUIFilterService	$filter_service

ILIAS UI Component Input Container Filter Standard	$filter

Detailed Description

Author: Lukas Zehnder lukas.nosp@m.@sr..nosp@m.solut.nosp@m.ions

Definition at line 31 of file IconListingUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\File\Icon\IconListingUI::__construct	(	private IconRepositoryInterface	$icon_repo,
		private ilObjFileIconsOverviewGUI	$gui,
		private bool	$write_access
	)

Definition at line 43 of file IconListingUI.php.

      {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('file');
        $this->ui_factory = $DIC->ui()->factory();
        $this->refinery = $DIC->refinery();
        $this->storage = $DIC->resourceStorage();
        $this->filter_service = $DIC->uiService()->filter();
 
        $this->initFilter();
        $this->initListing();
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\File\Icon\IconListingUI\initFilter(), ILIAS\File\Icon\IconListingUI\initListing(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ getDeletionConfirmationModal()

ILIAS\File\Icon\IconListingUI::getDeletionConfirmationModal ( Icon $a_icon )

private

Definition at line 189 of file IconListingUI.php.

                                                               : Interruptive
    {
        $target = $this->ctrl->getLinkTargetByClass(
            ilObjFileIconsOverviewGUI::class,
            ilObjFileIconsOverviewGUI::CMD_DELETE
        );
        $rid = $this->refinery->kindlyTo()->string()->transform($a_icon->getRid());
 
        $id = $this->storage->manage()->find($rid);
        $icon_src = "";
        if ($id !== null) {
            $icon_src = $this->storage->consume()->src($id)->getSrc();
        }
        $img_icon = $this->ui_factory->image()->standard(
            $icon_src,
            "Icon"
        );
        $txt_suffixes = $this->lng->txt('suffixes') . ": " . $this->icon_repo->turnSuffixesArrayIntoString(
            $a_icon->getSuffixes()
        );
 
        return $this->ui_factory->modal()->interruptive(
            $this->lng->txt("delete"),
            $this->lng->txt('msg_confirm_entry_deletion'),
            $target
        )->withAffectedItems([
            $this->ui_factory->modal()->interruptiveItem()->standard(
                $rid,
                $txt_suffixes,
                $img_icon
            )
        ]);
    }

References $id, ILIAS\File\Icon\ilObjFileIconsOverviewGUI\CMD_DELETE, ILIAS\Repository\ctrl(), ILIAS\File\Icon\Icon\getRid(), ILIAS\File\Icon\Icon\getSuffixes(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by ILIAS\File\Icon\IconListingUI\initListing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeletionModals()

ILIAS\File\Icon\IconListingUI::getDeletionModals ( )

Returns: mixed[]

Definition at line 184 of file IconListingUI.php.

                                       : array
    {
        return $this->deletion_modals;
    }

References ILIAS\File\Icon\IconListingUI\$deletion_modals.

◆ getFilter()

ILIAS\File\Icon\IconListingUI::getFilter ( )

Definition at line 89 of file IconListingUI.php.

                               : \ILIAS\UI\Component\Input\Container\Filter\Standard
    {
        return $this->filter;
    }

References ILIAS\File\Icon\IconListingUI\$filter.

◆ getIconList()

ILIAS\File\Icon\IconListingUI::getIconList ( )

Definition at line 176 of file IconListingUI.php.

                                 : Standard
    {
        return $this->icon_list;
    }

References ILIAS\File\Icon\IconListingUI\$icon_list.

◆ initFilter()

ILIAS\File\Icon\IconListingUI::initFilter ( )

private

Definition at line 62 of file IconListingUI.php.

                                 : void
    {
        // Filters
        $this->filter = $this->filter_service->standard(
            $this->gui::class . '_filter7',
            $this->ctrl->getLinkTarget($this->gui),
            [
                'suffixes' => $this->ui_factory->input()->field()->text($this->lng->txt('suffixes')),
                'active' => $this->ui_factory->input()->field()->select($this->lng->txt('status'), [
                    '1' => $this->lng->txt('active'),
                    '0' => $this->lng->txt('inactive'),
                ])->withValue('1'),
                'is_default_icon' => $this->ui_factory->input()->field()->select($this->lng->txt('default'), [
                    '1' => $this->lng->txt('yes'),
                    '0' => $this->lng->txt('no'),
                ])
            ],
            [
                'suffix' => true,
                'status' => true,
                'type' => true,
            ],
            true,
            true
        );
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\filter().

Referenced by ILIAS\File\Icon\IconListingUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initListing()

ILIAS\File\Icon\IconListingUI::initListing ( )

protected

Definition at line 94 of file IconListingUI.php.

                                    : void
    {
        $icon_items = [];
        $this->icon_repo->getIcons();
 
        // Filterting
        $filter_data = $this->filter_service->getData($this->filter) ?? [];
 
        foreach ($this->icon_repo->getIconsForFilter($filter_data) as $icon) {
            $this->ctrl->setParameterByClass(
                ilObjFileIconsOverviewGUI::class,
                ilObjFileIconsOverviewGUI::P_RID,
                $icon->getRid()
            );
            $edit_target = $this->ctrl->getLinkTargetByClass(
                ilObjFileIconsOverviewGUI::class,
                ilObjFileIconsOverviewGUI::CMD_OPEN_UPDATING_FORM
            );
            $change_activation_target = $this->ctrl->getLinkTargetByClass(
                ilObjFileIconsOverviewGUI::class,
                ilObjFileIconsOverviewGUI::CMD_CHANGE_ACTIVATION
            );
            $this->deletion_modals[] = $deletion_modal = $this->getDeletionConfirmationModal($icon);
 
            if ($this->write_access) {
                $item_action_entries = [
                    $this->ui_factory->button()->shy(
                        $this->lng->txt('de_activate_icon'),
                        $change_activation_target
                    )
                ];
                if (!$icon->isDefaultIcon()) {
                    $item_action_entries[] = $this->ui_factory->button()->shy($this->lng->txt('edit'), $edit_target);
                    $item_action_entries[] = $this->ui_factory->button()->shy($this->lng->txt('delete'), '#')->withOnClick(
                        $deletion_modal->getShowSignal()
                    );
                }
            } else {
                $item_action_entries = [];
            }
 
            $item_actions = $this->ui_factory->dropdown()->standard($item_action_entries);
 
            $id = $this->storage->manage()->find($icon->getRid());
            $icon_src = "";
            if ($id !== null) {
                $icon_src = $this->storage->consume()->src($id)->getSrc();
            }
 
            $suffixes_array_into_string = $this->icon_repo->turnSuffixesArrayIntoString(
                $icon->getSuffixes()
            );
 
            $icon_image = $this->ui_factory->symbol()->icon()->custom(
                $icon_src,
                "Icon $suffixes_array_into_string"
            )->withSize('large');
 
            $icon_items[] = $this->ui_factory->item()
                                             ->standard($this->lng->txt('icon') . " $suffixes_array_into_string")
                                             ->withActions($item_actions)
                                             ->withProperties(
                                                 [
                                                     $this->lng->txt('active') => $icon->isActive() ? $this->lng->txt(
                                                         'yes'
                                                     ) : $this->lng->txt('no'),
                                                     $this->lng->txt('default') => $icon->isDefaultIcon(
                                                     ) ? $this->lng->txt('yes') : $this->lng->txt('no'),
                                                     $this->lng->txt(
                                                         'suffixes'
                                                     ) => $suffixes_array_into_string
                                                 ]
                                             )
                                             ->withLeadIcon($icon_image);
        }
 
        $this->icon_list = $this->ui_factory->panel()->listing()->standard(
            $this->lng->txt('suffix_specific_icons'),
            [$this->ui_factory->item()->group("", $icon_items)]
        );
    }

References $id, ILIAS\File\Icon\ilObjFileIconsOverviewGUI\CMD_CHANGE_ACTIVATION, ILIAS\File\Icon\ilObjFileIconsOverviewGUI\CMD_OPEN_UPDATING_FORM, ILIAS\Repository\ctrl(), ILIAS\Repository\filter(), ILIAS\File\Icon\IconListingUI\getDeletionConfirmationModal(), ILIAS\Repository\lng(), and ILIAS\File\Icon\ilObjFileIconsOverviewGUI\P_RID.

Referenced by ILIAS\File\Icon\IconListingUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ILIAS\File\Icon\IconListingUI::$ctrl

private

Definition at line 33 of file IconListingUI.php.

◆ $deletion_modals

array ILIAS\File\Icon\IconListingUI::$deletion_modals = []

private

Definition at line 38 of file IconListingUI.php.

Referenced by ILIAS\File\Icon\IconListingUI\getDeletionModals().

◆ $filter

ILIAS UI Component Input Container Filter Standard ILIAS\File\Icon\IconListingUI::$filter

private

Definition at line 41 of file IconListingUI.php.

Referenced by ILIAS\File\Icon\IconListingUI\getFilter().

◆ $filter_service

ilUIFilterService ILIAS\File\Icon\IconListingUI::$filter_service

private

Definition at line 40 of file IconListingUI.php.

◆ $icon_list

Standard ILIAS\File\Icon\IconListingUI::$icon_list

private

Definition at line 39 of file IconListingUI.php.

Referenced by ILIAS\File\Icon\IconListingUI\getIconList().

◆ $lng

ilLanguage ILIAS\File\Icon\IconListingUI::$lng

private

Definition at line 34 of file IconListingUI.php.

◆ $refinery

ILIAS Refinery Factory ILIAS\File\Icon\IconListingUI::$refinery

private

Definition at line 36 of file IconListingUI.php.

◆ $storage

Services ILIAS\File\Icon\IconListingUI::$storage

private

Definition at line 37 of file IconListingUI.php.

◆ $ui_factory

Factory ILIAS\File\Icon\IconListingUI::$ui_factory

private

Definition at line 35 of file IconListingUI.php.

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

components/ILIAS/File/classes/Icons/IconListingUI.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDeletionConfirmationModal()

◆ getDeletionModals()

◆ getFilter()

◆ getIconList()

◆ initFilter()

◆ initListing()

Field Documentation

◆ $ctrl

◆ $deletion_modals

◆ $filter

◆ $filter_service

◆ $icon_list

◆ $lng

◆ $refinery

◆ $storage

◆ $ui_factory