ilSystemStyleIconsGUI Class Reference

Collaboration diagram for ilSystemStyleIconsGUI:

Public Member Functions
	__construct ($skin_id="", $style_id="")
	ilSystemStyleIconsGUI constructor. More...
	executeCommand ()
	Execute command. More...
	getByColorValues (ilPropertyFormGUI $form)
	reset ()
	update ()
	getByIconValues (ilPropertyFormGUI $form, ilSystemStyleIcon $icon)
	getStyleContainer ()
	setStyleContainer ($style_container)
	getIconFolder ()
	setIconFolder ($icon_folder)

Protected Member Functions
	fail ()
	setSubStyleSubTabs ($active="")
	edit ()
	preview ()
	editIcon ()
	addSelectIconToolbar ($icon_name)
	renderIconPreview (ilSystemStyleIcon $icon)

Protected Attributes
	$ctrl
	$lng
	$tpl
	$style_container
	$icon_folder = null
	$tabs

Detailed Description

Author

Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version

$Id$*

ilSystemStyleIconsGUI:

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

Constructor & Destructor Documentation

__construct()

ilSystemStyleIconsGUI::__construct	(		$skin_id = "",
			$style_id = ""
	)

ilSystemStyleIconsGUI constructor.

Parameters

string	$skin_id
string	$style_id

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

References $_GET, $DIC, Vendor\Package\$e, ilSystemStyleSkinContainer\generateFromId(), getStyleContainer(), ilUtil\sendFailure(), setIconFolder(), and setStyleContainer().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tpl = $DIC["tpl"];
        $this->tabs = $DIC->tabs();

        if ($skin_id == "") {
            $skin_id = $_GET["skin_id"];
        }
        if ($style_id == "") {
            $style_id = $_GET["style_id"];
        }
        $this->setStyleContainer(ilSystemStyleSkinContainer::generateFromId($skin_id));
        if ($this->ctrl->getCmd() != "reset") {
            try {
                $this->setIconFolder(new ilSystemStyleIconFolder($this->getStyleContainer()->getImagesSkinPath($style_id)));
            } catch (ilSystemStyleExceptionBase $e) {
                ilUtil::sendFailure($e->getMessage());
                $this->ctrl->setCmd("fail");
            }
        }
    }

Here is the call graph for this function:

Member Function Documentation

addSelectIconToolbar()

ilSystemStyleIconsGUI::addSelectIconToolbar (   $icon_name )

protected

Parameters

$icon_name

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

References $DIC, $si, ilSystemStyleIcon\getColorSet(), getIconFolder(), ilSubmitButton\getInstance(), ilSystemStyleIcon\getName(), ilSystemStyleIcon\getPath(), ilFormPropertyGUI\setRequired(), and ilFileInputGUI\setSuffixes().

Referenced by editIcon().

    {
        global $DIC;

        $toolbar = $DIC->toolbar();

        $si = new ilSelectInputGUI($this->lng->txt("select_icon"), "selected_icon");

        $options = array();
        $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);

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

        $select_btn = ilSubmitButton::getInstance();
        $select_btn->setCaption($this->lng->txt("select"), false);
        $toolbar->addButtonInstance($select_btn);
        $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 133 of file class.ilSystemStyleIconsGUI.php.

References getByColorValues().

Referenced by executeCommand().

    {
        $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 302 of file class.ilSystemStyleIconsGUI.php.

References $_GET, $_POST, addSelectIconToolbar(), getIconFolder(), and renderIconPreview().

Referenced by executeCommand().

    {
        $icon_name = $_POST['selected_icon']?$_POST['selected_icon']:$_GET['selected_icon'];

        $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

(

)

Execute command.

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

References edit(), editIcon(), fail(), and setSubStyleSubTabs().

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

        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;
        }
    }

Here is the call graph for this function:

fail()

ilSystemStyleIconsGUI::fail ( )

protected

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

Referenced by executeCommand().

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

Here is the caller graph for this function:

getByColorValues()

ilSystemStyleIconsGUI::getByColorValues

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

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

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

Referenced by edit().

    {
        $values = [];

        if ($this->getIconFolder()) {
            $colors = $this->getIconFolder()->getColorSet()->getColors();
            foreach ($colors as $color) {
                $id = $color->getId();
                if ($colors[$color->getId()]) {
                    $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:

getByIconValues()

ilSystemStyleIconsGUI::getByIconValues	(	ilPropertyFormGUI	$form,
		ilSystemStyleIcon	$icon
	)

Parameters

ilPropertyFormGUI	$form
ilSystemStyleIcon	$icon

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

References $_POST, $DIC, $message, $type, ilSystemStyleIcon\changeColors(), ilSystemStyleIcon\getColorSet(), getIconFolder(), ilSystemStyleIcon\getPath(), getStyleContainer(), ilPropertyFormGUI\setValuesByArray(), ilSystemStyleMessage\TYPE_ERROR, and ilSystemStyleMessage\TYPE_SUCCESS.

    {
        $values = [];

        foreach ($this->getIconFolder()->getColorSet()->getColors()  as $color) {
            $values[$color->getId()] = $color->getColor();
        }
        $values["selected_icon"] = $icon->getPath();

        $form->setValuesByArray($values);
    }

Here is the call graph for this function:

getIconFolder()

ilSystemStyleIconsGUI::getIconFolder

(

)

Returns

ilSystemStyleIconFolder

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

References $icon_folder.

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

    {
        return $this->icon_folder;
    }

Here is the caller graph for this function:

getStyleContainer()

ilSystemStyleIconsGUI::getStyleContainer

(

)

Returns

ilSystemStyleSkinContainer

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

References $style_container.

Referenced by __construct(), getByIconValues(), reset(), and update().

    {
        return $this->style_container;
    }

Here is the caller graph for this function:

preview()

ilSystemStyleIconsGUI::preview ( )

protected

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

References Vendor\Package\$e, $section, $type, ilSystemStyleIconColor\BLUE, getIconFolder(), ilSystemStyleIconColor\GREEN, ilSystemStyleIconColor\GREY, ilSystemStyleIconColor\RED, ilUtil\sendFailure(), and ilFormPropertyGUI\setRequired().

    {
        $this->tpl->setContent($this->renderIconsPreviews());
    }

Here is the call graph for this function:

renderIconPreview()

ilSystemStyleIconsGUI::renderIconPreview ( ilSystemStyleIcon  $icon )

protected

Parameters

ilSystemStyleIcon

$icon

Returns

string

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

References $DIC, Vendor\Package\$f, getIconFolder(), ilSystemStyleIcon\getName(), and ilSystemStyleIcon\getPath().

Referenced by editIcon().

    {
        global $DIC;

        $f = $DIC->ui()->factory();

        $icon_image = $f->image()->standard($icon->getPath(), $icon->getName());

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

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

        return $DIC->ui()->renderer()->render($report);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilSystemStyleIconsGUI::reset

(

)

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

References $_GET, getStyleContainer(), setIconFolder(), and ilSystemStyleMessage\TYPE_SUCCESS.

    {
        $style = $this->getStyleContainer()->getSkin()->getStyle($_GET["style_id"]);
        $this->getStyleContainer()->resetImages($style);
        $this->setIconFolder(new ilSystemStyleIconFolder($this->getStyleContainer()->getImagesSkinPath($style->getId())));
        $message_stack = new ilSystemStyleMessageStack();
        $message_stack->addMessage(new ilSystemStyleMessage(
            $this->lng->txt("color_reset"),
            ilSystemStyleMessage::TYPE_SUCCESS
        ));
        $message_stack->sendMessages(true);

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

Here is the call graph for this function:

setIconFolder()

ilSystemStyleIconsGUI::setIconFolder

(

$icon_folder

)

Parameters

ilSystemStyleIconFolder

$icon_folder

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

References $icon_folder.

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

    {
        $this->icon_folder = $icon_folder;
    }

Here is the caller graph for this function:

setStyleContainer()

ilSystemStyleIconsGUI::setStyleContainer

(

$style_container

)

Parameters

ilSystemStyleSkinContainer

$style_container

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

References $style_container.

Referenced by __construct().

    {
        $this->style_container = $style_container;
    }

Here is the caller graph for this function:

setSubStyleSubTabs()

ilSystemStyleIconsGUI::setSubStyleSubTabs (   $active = "" )

protected

Parameters

string

$active

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

Referenced by executeCommand().

    {
        $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 caller graph for this function:

update()

ilSystemStyleIconsGUI::update

(

)

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

References $_GET, getIconFolder(), getStyleContainer(), setIconFolder(), ilSystemStyleMessage\TYPE_ERROR, and ilSystemStyleMessage\TYPE_SUCCESS.

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

            $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($_GET["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(true);
            $this->ctrl->redirect($this, "edit");
        }
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilSystemStyleIconsGUI::$ctrl

protected

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

$icon_folder

ilSystemStyleIconsGUI::$icon_folder = null

protected

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

Referenced by getIconFolder(), and setIconFolder().

$lng

ilSystemStyleIconsGUI::$lng

protected

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

$style_container

ilSystemStyleIconsGUI::$style_container

protected

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

Referenced by getStyleContainer(), and setStyleContainer().

$tabs

ilSystemStyleIconsGUI::$tabs

protected

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

$tpl

ilSystemStyleIconsGUI::$tpl

protected

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

---

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

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