ilSystemStyleIconsGUI Class Reference

ilSystemStyleIconsGUI: More...

Collaboration diagram for ilSystemStyleIconsGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilLanguage $lng, ilGlobalTemplateInterface $tpl, Factory $ui_factory, Renderer $renderer, WrapperFactory $request_wrapper, ilToolbarGUI $toolbar, Refinery $refinery, ilSkinFactory $skin_factory, ilTabsGUI $tabs, FileUpload $upload, string $skin_id, string $style_id)
	executeCommand ()

Protected Member Functions
	fail ()
	setSubStyleSubTabs (string $active='')
	edit ()
	preview ()
	getByColorValues (ilPropertyFormGUI $form)
	reset ()
	update ()
	editIcon ()
	addSelectIconToolbar (?string $icon_name='')
	renderIconPreview (ilSystemStyleIcon $icon)
	getStyleContainer ()
	setStyleContainer (ilSkinStyleContainer $style_container)
	getIconFolder ()
	setIconFolder (ilSystemStyleIconFolder $icon_folder)

Protected Attributes
ilCtrl	$ctrl
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilSkinStyleContainer	$style_container
ilSkinFactory	$skin_factory
ilSystemStyleMessageStack	$message_stack
Factory	$ui_factory
Renderer	$renderer
WrapperFactory	$request_wrapper
ilToolbarGUI	$toolbar
Refinery	$refinery
ilTabsGUI	$tabs
ilSystemStyleIconFolder	$icon_folder
FileUpload	$upload
string	$style_id

Detailed Description

ilSystemStyleIconsGUI:

Definition at line 31 of file class.ilSystemStyleIconsGUI.php.

Constructor & Destructor Documentation

__construct()

ilSystemStyleIconsGUI::__construct	(	ilCtrl	$ctrl,
		ilLanguage	$lng,
		ilGlobalTemplateInterface	$tpl,
		Factory	$ui_factory,
		Renderer	$renderer,
		WrapperFactory	$request_wrapper,
		ilToolbarGUI	$toolbar,
		Refinery	$refinery,
		ilSkinFactory	$skin_factory,
		ilTabsGUI	$tabs,
		FileUpload	$upload,
		string	$skin_id,
		string	$style_id
	)

Definition at line 49 of file class.ilSystemStyleIconsGUI.php.

References $ctrl, $lng, $refinery, $renderer, $request_wrapper, $skin_factory, $style_id, $tabs, $toolbar, $tpl, $ui_factory, $upload, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), setStyleContainer(), ilSkinFactory\skinStyleContainerFromId(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\upload().

      {
        $this->ctrl = $ctrl;
        $this->lng = $lng;
        $this->tpl = $tpl;
        $this->ui_factory = $ui_factory;
        $this->renderer = $renderer;
        $this->request_wrapper = $request_wrapper;
        $this->toolbar = $toolbar;
        $this->refinery = $refinery;
        $this->tabs = $tabs;
        $this->upload = $upload;
        $this->style_id = $style_id;
        $this->message_stack = new ilSystemStyleMessageStack($this->tpl);
        $this->skin_factory = $skin_factory;
        $this->style_container = $this->skin_factory->skinStyleContainerFromId($skin_id, $this->message_stack);

        $this->setStyleContainer($this->skin_factory->skinStyleContainerFromId($skin_id, $this->message_stack));
    }

Here is the call graph for this function:

Member Function Documentation

addSelectIconToolbar()

ilSystemStyleIconsGUI::addSelectIconToolbar ( ?string  $icon_name = '' )

protected

Definition at line 332 of file class.ilSystemStyleIconsGUI.php.

References $id, $message, $type, ilSystemStyleMessageStack\addMessage(), ilSystemStyleIcon\changeColors(), ILIAS\Repository\ctrl(), ilSystemStyleIcon\getColorSet(), getIconFolder(), ilSystemStyleMessageStack\getJoinedMessages(), ilSystemStyleIcon\getName(), ilSystemStyleIcon\getPath(), getStyleContainer(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilSystemStyleMessageStack\sendMessages(), ilSelectInputGUI\setOptions(), ilFormPropertyGUI\setRequired(), ILIAS\Repository\toolbar(), ilSystemStyleMessage\TYPE_ERROR, ilSystemStyleMessage\TYPE_SUCCESS, and ILIAS\Repository\upload().

Referenced by editIcon().

                                                                    : void
    {
        $si = new ilSelectInputGUI($this->lng->txt('select_icon'), 'selected_icon');

        $options = [];
        $this->getIconFolder()->sortIconsByPath();
        $substr_len = strlen($this->getIconFolder()->getPath()) + 1;
        foreach ($this->getIconFolder()->getIcons() as $icon) {
            if ($icon->getType() == 'svg') {
                $options[$icon->getPath()] = substr($icon->getPath(), $substr_len);
            }
        }

        $si->setOptions($options);

        $si->setValue($icon_name);

        $this->toolbar->addInputItem($si, true);

        $this->toolbar->addComponent($this->ui_factory->button()->standard(
            $this->lng->txt('select'),
            ''
        ));
        $this->toolbar->setFormAction($this->ctrl->getLinkTarget($this, 'editIcon'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

edit()

ilSystemStyleIconsGUI::edit ( )

protected

Definition at line 151 of file class.ilSystemStyleIconsGUI.php.

References getByColorValues().

Referenced by executeCommand().

                             : void
    {
        $form = $this->initByColorForm();
        $this->getByColorValues($form);
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editIcon()

ilSystemStyleIconsGUI::editIcon ( )

protected

Definition at line 308 of file class.ilSystemStyleIconsGUI.php.

References addSelectIconToolbar(), getIconFolder(), ILIAS\Repository\refinery(), and renderIconPreview().

Referenced by executeCommand().

                                 : void
    {
        $icon_name = '';
        if ($this->request_wrapper->post()->has('selected_icon')) {
            $icon_name = $this->request_wrapper->post()->retrieve(
                'selected_icon',
                $this->refinery->kindlyTo()->string()
            );
        } elseif ($this->request_wrapper->query()->has('selected_icon')) {
            $icon_name = $this->request_wrapper->query()->retrieve(
                'selected_icon',
                $this->refinery->kindlyTo()->string()
            );
        }

        $this->addSelectIconToolbar($icon_name);

        if ($icon_name) {
            $icon = $this->getIconFolder()->getIconByPath($icon_name);
            $form = $this->initByIconForm($icon);
            $this->tpl->setContent($form->getHTML() . $this->renderIconPreview($icon));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilSystemStyleIconsGUI::executeCommand

(

)

Definition at line 82 of file class.ilSystemStyleIconsGUI.php.

References Vendor\Package\$e, ILIAS\Repository\ctrl(), edit(), editIcon(), fail(), getStyleContainer(), setIconFolder(), setSubStyleSubTabs(), and ilSystemStyleMessage\TYPE_ERROR.

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        $this->setSubStyleSubTabs($cmd);

        if ($this->ctrl->getCmd() != 'reset') {
            try {
                $this->setIconFolder(new ilSystemStyleIconFolder($this->getStyleContainer()->getImagesSkinPath($this->style_id)));
            } catch (ilSystemStyleExceptionBase $e) {
                $this->message_stack->addMessage(new ilSystemStyleMessage(
                    $e->getMessage(),
                    ilSystemStyleMessage::TYPE_ERROR
                ));
                $cmd = 'fail';
            }
        }

        switch ($cmd) {
            case 'fail':
                $this->fail();
                break;
            case 'cancelIcon':
                $this->editIcon();
                break;
            case 'save':
            case 'edit':
            case 'editIcon':
            case 'update':
            case 'reset':
            case 'preview':
            case 'updateIcon':
                $this->$cmd();
                break;
            default:
                $this->edit();
                break;
        }
        $this->message_stack->sendMessages();
    }

Here is the call graph for this function:

fail()

ilSystemStyleIconsGUI::fail ( )

protected

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

Referenced by executeCommand().

                             : void
    {
        $form = $this->initByColorForm();
        $this->tpl->setContent($form->getHTML());
    }

Here is the caller graph for this function:

getByColorValues()

ilSystemStyleIconsGUI::getByColorValues ( ilPropertyFormGUI  $form )

protected

Definition at line 237 of file class.ilSystemStyleIconsGUI.php.

References $id, getIconFolder(), and ilPropertyFormGUI\setValuesByArray().

Referenced by edit().

                                                                : void
    {
        $values = [];

        $colors = $this->getIconFolder()->getColorSet()->getColors();
        foreach ($colors as $color) {
            $id = $color->getId();
            if (array_key_exists($color->getId(), $colors)) {
                $values[$id] = $colors[$color->getId()]->getColor();
            } else {
                $values[$id] = $color->getColor();
            }
        }

        $form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIconFolder()

ilSystemStyleIconsGUI::getIconFolder ( )

protected

Definition at line 518 of file class.ilSystemStyleIconsGUI.php.

References $icon_folder.

Referenced by addSelectIconToolbar(), editIcon(), getByColorValues(), preview(), renderIconPreview(), and update().

                                      : ilSystemStyleIconFolder
    {
        return $this->icon_folder;
    }

Here is the caller graph for this function:

getStyleContainer()

ilSystemStyleIconsGUI::getStyleContainer ( )

protected

Definition at line 508 of file class.ilSystemStyleIconsGUI.php.

References $style_container.

Referenced by addSelectIconToolbar(), executeCommand(), reset(), and update().

                                          : ilSkinStyleContainer
    {
        return $this->style_container;
    }

Here is the caller graph for this function:

preview()

ilSystemStyleIconsGUI::preview ( )

protected

Definition at line 158 of file class.ilSystemStyleIconsGUI.php.

References Vendor\Package\$e, $id, $type, ilSystemStyleIconColor\BLUE, ILIAS\Repository\ctrl(), getIconFolder(), ilSystemStyleIconColor\GREEN, ilSystemStyleIconColor\GREY, ILIAS\Repository\lng(), ilSystemStyleIconColor\RED, ilFormPropertyGUI\setRequired(), and ilSystemStyleMessage\TYPE_ERROR.

                                : void
    {
        $this->tpl->setContent($this->renderer->render($this->getIconsPreviews()));
    }

Here is the call graph for this function:

renderIconPreview()

ilSystemStyleIconsGUI::renderIconPreview ( ilSystemStyleIcon  $icon )

protected

Definition at line 465 of file class.ilSystemStyleIconsGUI.php.

References getIconFolder(), ilSystemStyleIcon\getName(), ilSystemStyleIcon\getPath(), and ILIAS\Repository\lng().

Referenced by editIcon().

                                                                 : string
    {
        $icon_image = $this->ui_factory->image()->standard($icon->getPath(), $icon->getName());

        $card = $this->ui_factory->card()->standard(
            $icon->getName(),
            $icon_image
        );

        $report = $this->ui_factory->panel()->standard($this->lng->txt('preview'), $this->ui_factory->deck([$card]));

        return $this->renderer->render($report);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilSystemStyleIconsGUI::reset ( )

protected

Definition at line 254 of file class.ilSystemStyleIconsGUI.php.

References ILIAS\Repository\ctrl(), getStyleContainer(), ILIAS\Repository\lng(), setIconFolder(), and ilSystemStyleMessage\TYPE_SUCCESS.

                              : void
    {
        $style = $this->getStyleContainer()->getSkin()->getStyle($this->style_id);
        $this->getStyleContainer()->resetImages($style);
        $this->setIconFolder(new ilSystemStyleIconFolder($this->getStyleContainer()->getImagesSkinPath($style->getId())));
        $message_stack = new ilSystemStyleMessageStack($this->tpl);
        $message_stack->addMessage(new ilSystemStyleMessage(
            $this->lng->txt('color_reset'),
            ilSystemStyleMessage::TYPE_SUCCESS
        ));
        $message_stack->sendMessages();

        $this->ctrl->redirect($this, 'edit');
    }

Here is the call graph for this function:

setIconFolder()

ilSystemStyleIconsGUI::setIconFolder ( ilSystemStyleIconFolder  $icon_folder )

protected

Definition at line 523 of file class.ilSystemStyleIconsGUI.php.

References $icon_folder.

Referenced by executeCommand(), reset(), and update().

                                                                          : void
    {
        $this->icon_folder = $icon_folder;
    }

Here is the caller graph for this function:

setStyleContainer()

ilSystemStyleIconsGUI::setStyleContainer ( ilSkinStyleContainer  $style_container )

protected

Definition at line 513 of file class.ilSystemStyleIconsGUI.php.

References $style_container.

Referenced by __construct().

                                                                               : void
    {
        $this->style_container = $style_container;
    }

Here is the caller graph for this function:

setSubStyleSubTabs()

ilSystemStyleIconsGUI::setSubStyleSubTabs ( string  $active = '' )

protected

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

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

Referenced by executeCommand().

                                                              : void
    {
        $this->tabs->addSubTab('edit', $this->lng->txt('edit_by_color'), $this->ctrl->getLinkTarget($this, 'edit'));
        $this->tabs->addSubTab(
            'editIcon',
            $this->lng->txt('edit_by_icon'),
            $this->ctrl->getLinkTarget($this, 'editIcon')
        );
        $this->tabs->addSubTab(
            'preview',
            $this->lng->txt('icons_gallery'),
            $this->ctrl->getLinkTarget($this, 'preview')
        );

        if ($active == 'preview') {
            $this->tabs->activateSubTab($active);
        } elseif ($active == 'cancelIcon' || $active == 'editIcon') {
            $this->tabs->activateSubTab('editIcon');
        } else {
            $this->tabs->activateSubTab('edit');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilSystemStyleIconsGUI::update ( )

protected

Definition at line 269 of file class.ilSystemStyleIconsGUI.php.

References ilSystemStyleMessageStack\addMessage(), ILIAS\Repository\ctrl(), getIconFolder(), getStyleContainer(), ILIAS\Repository\lng(), ilSystemStyleMessageStack\sendMessages(), setIconFolder(), ilSystemStyleMessage\TYPE_ERROR, and ilSystemStyleMessage\TYPE_SUCCESS.

                               : void
    {
        $form = $this->initByColorForm();
        if ($form->checkInput()) {
            $message_stack = new ilSystemStyleMessageStack($this->tpl);

            $color_changes = [];
            foreach ($this->getIconFolder()->getColorSet()->getColors() as $old_color) {
                $new_color = $form->getInput($old_color->getId());
                if (!preg_match('/[\dabcdef]{6}/i', $new_color)) {
                    $message_stack->addMessage(new ilSystemStyleMessage(
                        $this->lng->txt('invalid_color') . $new_color,
                        ilSystemStyleMessage::TYPE_ERROR
                    ));
                } elseif ($new_color != $old_color->getColor()) {
                    $color_changes[$old_color->getColor()] = $new_color;
                    $message_stack->addMessage(new ilSystemStyleMessage(
                        $this->lng->txt('color_changed_from') . ' ' . $old_color->getColor() . ' ' .
                        $this->lng->txt('color_changed_to') . ' ' . $new_color,
                        ilSystemStyleMessage::TYPE_SUCCESS
                    ));
                }
            }
            $this->getIconFolder()->changeIconColors($color_changes);
            $this->setIconFolder(new ilSystemStyleIconFolder($this->getStyleContainer()->getImagesSkinPath($this->style_id)));
            $skin = $this->getStyleContainer()->getSkin();
            $skin->getVersionStep($skin->getVersion());
            $this->getStyleContainer()->updateSkin($skin);
            $message_stack->addMessage(new ilSystemStyleMessage(
                $this->lng->txt('color_update'),
                ilSystemStyleMessage::TYPE_SUCCESS
            ));
            $message_stack->sendMessages();
            $this->ctrl->redirect($this, 'edit');
        }
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrl ilSystemStyleIconsGUI::$ctrl

protected

Definition at line 33 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

$icon_folder

ilSystemStyleIconFolder ilSystemStyleIconsGUI::$icon_folder

protected

Definition at line 45 of file class.ilSystemStyleIconsGUI.php.

Referenced by getIconFolder(), and setIconFolder().

$lng

ilLanguage ilSystemStyleIconsGUI::$lng

protected

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

Referenced by __construct().

$message_stack

ilSystemStyleMessageStack ilSystemStyleIconsGUI::$message_stack

protected

Definition at line 38 of file class.ilSystemStyleIconsGUI.php.

$refinery

Refinery ilSystemStyleIconsGUI::$refinery

protected

Definition at line 43 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

$renderer

Renderer ilSystemStyleIconsGUI::$renderer

protected

Definition at line 40 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

$request_wrapper

WrapperFactory ilSystemStyleIconsGUI::$request_wrapper

protected

Definition at line 41 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

$skin_factory

ilSkinFactory ilSystemStyleIconsGUI::$skin_factory

protected

Definition at line 37 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

$style_container

ilSkinStyleContainer ilSystemStyleIconsGUI::$style_container

protected

Definition at line 36 of file class.ilSystemStyleIconsGUI.php.

Referenced by getStyleContainer(), and setStyleContainer().

$style_id

string ilSystemStyleIconsGUI::$style_id

protected

Definition at line 47 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

$tabs

ilTabsGUI ilSystemStyleIconsGUI::$tabs

protected

Definition at line 44 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

$toolbar

ilToolbarGUI ilSystemStyleIconsGUI::$toolbar

protected

Definition at line 42 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

$tpl

ilGlobalTemplateInterface ilSystemStyleIconsGUI::$tpl

protected

Definition at line 35 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

$ui_factory

Factory ilSystemStyleIconsGUI::$ui_factory

protected

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

Referenced by __construct().

$upload

FileUpload ilSystemStyleIconsGUI::$upload

protected

Definition at line 46 of file class.ilSystemStyleIconsGUI.php.

Referenced by __construct().

---

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

• Services/Style/System/classes/Icons/class.ilSystemStyleIconsGUI.php