ilSystemStyleSettingsGUI Class Reference

Collaboration diagram for ilSystemStyleSettingsGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute command. More...
	getPropertiesValues ($form)
	Get values for edit properties form. More...

Protected Member Functions
	setSubStyleSubTabs ($active="")
	edit ()
	save ()
	saveStyle (ilSystemStyleMessageStack $message_stack)
	saveSubStyle (ilSystemStyleMessageStack $message_stack)
	editSystemStyleForm ()

Protected Attributes
	$ctrl
	$lng
	$tpl
	$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$*

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

Constructor & Destructor Documentation

__construct()

ilSystemStyleSettingsGUI::__construct

(

)

Constructor.

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

References $DIC.

        {
                global $DIC;

                $this->ctrl = $DIC->ctrl();
                $this->lng = $DIC->language();
                $this->tabs = $DIC->tabs();

                $this->tpl = $DIC["tpl"];
        }

Member Function Documentation

edit()

ilSystemStyleSettingsGUI::edit ( )

protected

Definition at line 112 of file class.ilSystemStyleSettingsGUI.php.

References editSystemStyleForm(), and getPropertiesValues().

Referenced by executeCommand().

                                 {
                $form = $this->editSystemStyleForm();
                $this->getPropertiesValues($form);
                $this->tpl->setContent($form->getHTML());

        }

Here is the call graph for this function:

Here is the caller graph for this function:

editSystemStyleForm()

ilSystemStyleSettingsGUI::editSystemStyleForm ( )

protected

Returns

ilPropertyFormGUI

Exceptions

ilSystemStyleException

Definition at line 294 of file class.ilSystemStyleSettingsGUI.php.

References $_GET, $section, $style, ilNonEditableValueGUI\setInfo(), ilFormPropertyGUI\setInfo(), and ilTextInputGUI\setMaxLength().

Referenced by edit(), and save().

                                                {
                $form = new ilPropertyFormGUI();
                $system_style_conf = new ilSystemStyleConfig();

                $skin = ilSkinXML::parseFromXML($system_style_conf->getCustomizingSkinPath().$_GET["skin_id"]."/template.xml");
                $style = $skin->getStyle($_GET["style_id"]);

                $form->setFormAction($this->ctrl->getFormActionByClass("ilsystemstylesettingsgui"));


                if(!$style->isSubstyle()){
                        $form->setTitle($this->lng->txt("skin"));

                        $ti = new ilTextInputGUI($this->lng->txt("skin_id"), "skin_id");
                        $ti->setMaxLength(128);
                        $ti->setSize(40);
                        $ti->setRequired(true);
                        $ti->setInfo($this->lng->txt("skin_id_description"));
                        $form->addItem($ti);

                        $ti = new ilTextInputGUI($this->lng->txt("skin_name"), "skin_name");
                        $ti->setInfo($this->lng->txt("skin_name_description"));
                        $ti->setMaxLength(128);
                        $ti->setSize(40);
                        $ti->setRequired(true);
                        $form->addItem($ti);

                        if($skin->isVersionChangeable()) {
                $ti = new ilNonEditableValueGUI($this->lng->txt("skin_version"), "skin_version");
                $ti->setInfo($this->lng->txt("skin_version_description"));
                $ti->setValue($skin->getVersion());
                $form->addItem($ti);
            }

                        $section = new ilFormSectionHeaderGUI();
                        $section->setTitle($this->lng->txt("style"));
                        $form->addItem($section);
                }else{
                        $form->setTitle($this->lng->txt("sub_style"));
                }

                $ti = new ilTextInputGUI($this->lng->txt("style_id"), "style_id");
                $ti->setMaxLength(128);
                $ti->setSize(40);
                $ti->setRequired(true);
                $ti->setInfo($this->lng->txt("style_id_description"));
                $form->addItem($ti);

                $ti = new ilTextInputGUI($this->lng->txt("style_name"), "style_name");
                $ti->setMaxLength(128);
                $ti->setSize(40);
                $ti->setRequired(true);
                $ti->setInfo($this->lng->txt("style_name_description"));
                $form->addItem($ti);

                $ti = new ilTextInputGUI($this->lng->txt("image_dir"), "image_dir");
                $ti->setMaxLength(128);
                $ti->setSize(40);
                $ti->setInfo($this->lng->txt("image_dir_description"));
                $form->addItem($ti);

                $ti = new ilTextInputGUI($this->lng->txt("font_dir"), "font_dir");
                $ti->setMaxLength(128);
                $ti->setSize(40);
                $ti->setInfo($this->lng->txt("font_dir_description"));
                $form->addItem($ti);

                $ti = new ilTextInputGUI($this->lng->txt("sound_dir"), "sound_dir");
                $ti->setMaxLength(128);
                $ti->setSize(40);
                $ti->setInfo($this->lng->txt("sound_dir_description"));
                $form->addItem($ti);

                if(!$style->isSubstyle()){
                        $section = new ilFormSectionHeaderGUI();
                        $section->setTitle($this->lng->txt("system_style_activation"));
                        $form->addItem($section);

                        $active = new ilCheckboxInputGUI($this->lng->txt("system_style_activation"), "active");
                        $active->setInfo($this->lng->txt("system_style_activation_description"));

                        $set_default = new ilCheckboxInputGUI($this->lng->txt("default"), "default");
                        $set_default->setInfo($this->lng->txt("system_style_default_description"));
                        $active->addSubItem($set_default);

                        $set_personal = new ilCheckboxInputGUI($this->lng->txt("personal"), "personal");
                        $set_personal->setInfo($this->lng->txt("system_style_personal_description"));
                        $active->addSubItem($set_personal);


                        $form->addItem($active);
                }

                $form->addCommandButton("save", $this->lng->txt("save"));
                $form->addCommandButton("cancel", $this->lng->txt("cancel"));

                return $form;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilSystemStyleSettingsGUI::executeCommand

(

)

Execute command.

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

References $_GET, $cmd, $style, edit(), and setSubStyleSubTabs().

        {
                $cmd = $this->ctrl->getCmd() ? $this->ctrl->getCmd():"edit";
                $system_style_conf = new ilSystemStyleConfig();
                $skin = ilSkinXML::parseFromXML($system_style_conf->getCustomizingSkinPath().$_GET["skin_id"]."/template.xml");
                $style = $skin->getStyle($_GET["style_id"]);

                if($style->isSubstyle()){
                        if($cmd == "edit"|| $cmd == "view"){
                                $this->setSubStyleSubTabs("edit");
                        }else{
                                $this->setSubStyleSubTabs("assignStyle");
                        }

                }

                switch ($cmd)
                {
                        case "deleteAssignments":
                                $assign_gui = new ilSubStyleAssignmentGUI($this);
                                $assign_gui->deleteAssignments($skin,$style);
                                break;
                        case "saveAssignment":
                                $assign_gui = new ilSubStyleAssignmentGUI($this);
                                $assign_gui->saveAssignment($skin,$style);
                                break;
                        case "addAssignment":
                                $assign_gui = new ilSubStyleAssignmentGUI($this);
                                $assign_gui->addAssignment($skin,$style);
                                break;
                        case "assignStyle":
                                $assign_gui = new ilSubStyleAssignmentGUI($this);
                                $assign_gui->assignStyle($skin,$style);
                                break;
                        case "save":
                        case "edit":
                                $this->$cmd();
                                break;
                        default:
                                $this->edit();
                                break;
                }
        }

Here is the call graph for this function:

getPropertiesValues()

ilSystemStyleSettingsGUI::getPropertiesValues

(

$form

)

Get values for edit properties form.

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

References $_GET, $DIC, $style, ilSystemStyleSettings\_lookupActivatedStyle(), ilSystemStyleSettings\getCurrentDefaultSkin(), ilSystemStyleSettings\getCurrentDefaultStyle(), ilSystemStyleException\NO_SKIN_ID, and ilSystemStyleException\NO_STYLE_ID.

Referenced by edit().

        {
                global $DIC;

                if(!$_GET["skin_id"]){
                        throw new ilSystemStyleException(ilSystemStyleException::NO_SKIN_ID);
                }
                if(!$_GET["style_id"]){
                        throw new ilSystemStyleException(ilSystemStyleException::NO_STYLE_ID);
                }
                $system_style_config = new ilSystemStyleConfig();
                $skin = ilSkinXML::parseFromXML($system_style_config->getCustomizingSkinPath().$_GET["skin_id"]."/template.xml");
                $style = $skin->getStyle($_GET["style_id"]);
                $values["skin_id"] = $skin->getId();
                $values["skin_name"] = $skin->getName();
                $values["style_id"] = $style->getId();
                $values["style_name"] = $style->getName();
                $values["image_dir"] = $style->getImageDirectory();
                $values["font_dir"] = $style->getFontDirectory();
                $values["sound_dir"] = $style->getSoundDirectory();


                if($style->isSubstyle()){
                        $values["parent_style"] = $style->getSubstyleOf();
                }else{
                        $values["active"] = ilSystemStyleSettings::_lookupActivatedStyle($skin->getId(),$style->getId());
                        $is_personal_style = $DIC->user()->getPref("skin")==$skin->getId() && $DIC->user()->getPref("style") == $style->getId();
                        $values["personal"] =  $is_personal_style;
                        $is_default_style = ilSystemStyleSettings::getCurrentDefaultSkin()==$skin->getId()  && ilSystemStyleSettings::getCurrentDefaultStyle() == $style->getId();
                        $values["default"] = $is_default_style;
                }

                $form->setValuesByArray($values);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilSystemStyleSettingsGUI::save ( )

protected

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

References $_GET, $style, editSystemStyleForm(), saveStyle(), saveSubStyle(), ilUtil\sendFailure(), and ilSystemStyleMessage\TYPE_SUCCESS.

                                 {
                $form = $this->editSystemStyleForm();

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

                        try{
                                $system_style_conf = new ilSystemStyleConfig();
                                $skin = ilSkinXML::parseFromXML($system_style_conf->getCustomizingSkinPath().$_GET["skin_id"]."/template.xml");
                                $style = $skin->getStyle($_GET["style_id"]);

                                if($style->isSubstyle()){
                                        $this->saveSubStyle($message_stack);
                                }else{
                                        $this->saveStyle($message_stack);
                                }

                                $message_stack->prependMessage(new ilSystemStyleMessage($this->lng->txt("msg_sys_style_update"),ilSystemStyleMessage::TYPE_SUCCESS));
                                $message_stack->sendMessages(true);
                                $this->ctrl->redirectByClass("ilSystemStyleSettingsGUI");
                        }catch(ilSystemStyleException $e){
                                ilUtil::sendFailure($e->getMessage(), true);
                        }
                }else

                $message_stack->sendMessages();

                $form->setValuesByPost();
                $this->tpl->setContent($form->getHTML());
        }

Here is the call graph for this function:

saveStyle()

ilSystemStyleSettingsGUI::saveStyle ( ilSystemStyleMessageStack  $message_stack )

protected

Parameters

ilSystemStyleMessageStack

$message_stack

Exceptions

ilSystemStyleException

Definition at line 195 of file class.ilSystemStyleSettingsGUI.php.

References $_GET, $_POST, $DIC, ilSystemStyleSettings\_activateStyle(), ilSystemStyleSettings\_deactivateStyle(), ilSystemStyleMessageStack\addMessage(), ilSystemStyleSkinContainer\generateFromId(), ilSystemStyleSettings\getCurrentDefaultSkin(), ilSystemStyleSettings\getCurrentDefaultStyle(), ilSystemStyleSettings\getCurrentUserPrefSkin(), ilSystemStyleSettings\getCurrentUserPrefStyle(), ilSystemStyleSettings\setCurrentDefaultStyle(), ilSystemStyleSettings\setCurrentUserPrefStyle(), and ilSystemStyleMessage\TYPE_SUCCESS.

Referenced by save().

                                                                              {
                global $DIC;

                $container = ilSystemStyleSkinContainer::generateFromId($_GET['skin_id'],$message_stack);
                $old_skin = clone $container->getSkin();
                $old_style = clone $old_skin->getStyle($_GET["style_id"]);

                $new_skin = $container->getSkin();
                $new_skin->setId($_POST["skin_id"]);
                $new_skin->setName($_POST["skin_name"]);
                $new_skin->getVersionStep($_POST['skin_version']);

                $new_style = $new_skin->getStyle($_GET["style_id"]);
                $new_style->setId($_POST["style_id"]);
                $new_style->setName($_POST["style_name"]);
                $new_style->setCssFile($_POST["style_id"]);
                $new_style->setImageDirectory($_POST["image_dir"]);
                $new_style->setSoundDirectory($_POST["sound_dir"]);
                $new_style->setFontDirectory($_POST["font_dir"]);

                $container->updateSkin($old_skin);
                $container->updateStyle($new_style->getId(),$old_style);


                if($_POST["active"] == 1){
                        ilSystemStyleSettings::_activateStyle($new_skin->getId(),$new_style->getId());
                        if($_POST["personal"]==1){
                                ilSystemStyleSettings::setCurrentUserPrefStyle($new_skin->getId(),$new_style->getId());
                        }
                        if($_POST["default"]==1){
                                ilSystemStyleSettings::setCurrentDefaultStyle($new_skin->getId(),$new_style->getId());
                        }
                }else{
                        ilSystemStyleSettings::_deactivateStyle($new_skin->getId(),$new_style->getId());
                        $_POST["personal"] = 0;
                        $_POST["default"] = 0;
                }

                $system_style_conf = new ilSystemStyleConfig();

                //If style has been unset as personal style
                if(!$_POST["personal"] && $DIC->user()->getPref("skin") == $new_skin->getId()){
                        //Reset to default if possible, else change to delos
                        if(!$_POST["default"] ){
                                ilSystemStyleSettings::setCurrentUserPrefStyle(
                                        ilSystemStyleSettings::getCurrentDefaultSkin(),ilSystemStyleSettings::getCurrentDefaultStyle()
                                );
                        }else{
                                ilSystemStyleSettings::setCurrentUserPrefStyle(
                                        $system_style_conf->getDefaultSkinId(),$system_style_conf->getDefaultStyleId()
                                );
                        }
                        $message_stack->addMessage(new ilSystemStyleMessage(
                                $this->lng->txt("personal_style_set_to")." ".ilSystemStyleSettings::getCurrentUserPrefSkin().":".ilSystemStyleSettings::getCurrentUserPrefStyle(),
                                ilSystemStyleMessage::TYPE_SUCCESS)
                        );
                }
                if(!$_POST["default"] && ilSystemStyleSettings::getCurrentDefaultSkin() == $new_skin->getId()){
                        ilSystemStyleSettings::setCurrentDefaultStyle(
                                $system_style_conf->getDefaultSkinId(),$system_style_conf->getDefaultStyleId()
                        );
                        $message_stack->addMessage(new ilSystemStyleMessage(
                                        $this->lng->txt("default_style_set_to")." ".$system_style_conf->getDefaultSkinId().": ".$system_style_conf->getDefaultStyleId(),
                                        ilSystemStyleMessage::TYPE_SUCCESS)
                        );
                }
                $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI','skin_id',$new_skin->getId());
                $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI','style_id',$new_style->getId());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

saveSubStyle()

ilSystemStyleSettingsGUI::saveSubStyle ( ilSystemStyleMessageStack  $message_stack )

protected

Parameters

$message_stack

Exceptions

ilSystemStyleException

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

References $_GET, $_POST, and ilSystemStyleSkinContainer\generateFromId().

Referenced by save().

                                                                                 {
                $container = ilSystemStyleSkinContainer::generateFromId($_GET['skin_id'],$message_stack);
                $skin = $container->getSkin();
                $old_substyle = clone $skin->getStyle($_GET["style_id"]);

                $new_substyle = $skin->getStyle($_GET["style_id"]);
                $new_substyle->setId($_POST["style_id"]);
                $new_substyle->setName($_POST["style_name"]);
                $new_substyle->setCssFile($_POST["style_id"]);
                $new_substyle->setImageDirectory($_POST["image_dir"]);
                $new_substyle->setSoundDirectory($_POST["sound_dir"]);
                $new_substyle->setFontDirectory($_POST["font_dir"]);
                $new_substyle->setSubstyleOf($old_substyle->getSubstyleOf());

                $container->updateSkin($skin);
                $container->updateStyle($new_substyle->getId(),$old_substyle);

                $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI','skin_id',$skin->getId());
                $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI','style_id',$new_substyle->getId());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setSubStyleSubTabs()

ilSystemStyleSettingsGUI::setSubStyleSubTabs (   $active = "" )

protected

Parameters

string

$active

Definition at line 104 of file class.ilSystemStyleSettingsGUI.php.

Referenced by executeCommand().

                                                            {

                $this->tabs->addSubTab('edit', $this->lng->txt('settings'), $this->ctrl->getLinkTargetByClass('ilsystemstylesettingsgui'));
                $this->tabs->addSubTab('assignStyle', $this->lng->txt('assignment'), $this->ctrl->getLinkTargetByClass('ilsystemstylesettingsgui',"assignStyle"));

                $this->tabs->activateSubTab($active);
        }

Here is the caller graph for this function:

Field Documentation

$ctrl

ilSystemStyleSettingsGUI::$ctrl

protected

Definition at line 22 of file class.ilSystemStyleSettingsGUI.php.

$lng

ilSystemStyleSettingsGUI::$lng

protected

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

$tabs

ilSystemStyleSettingsGUI::$tabs

protected

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

$tpl

ilSystemStyleSettingsGUI::$tpl

protected

Definition at line 32 of file class.ilSystemStyleSettingsGUI.php.

---

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

• Services/Style/System/classes/Settings/class.ilSystemStyleSettingsGUI.php