ilSystemStyleOverviewGUI Class Reference

Collaboration diagram for ilSystemStyleOverviewGUI:

Public Member Functions
	__construct ($read_only, $management_enabled)
	Constructor. More...
	executeCommand ()
	Execute command. More...
	edit ()
	Edit. More...
	moveUserStyles ()
	Move user styles. More...
	saveStyleSettings ()
	Save skin and style settings. More...
	isReadOnly ()
	setReadOnly ($read_only)
	isManagementEnabled ()
	setManagementEnabled ($management_enabled)

Protected Member Functions
	view ()
	cancel ()
	checkStyleSettings (ilSystemStyleMessageStack $message_stack)
	addSystemStyle ()
	create More...
	saveNewSystemStyle ()
	addSystemStyleForms ()
	create More...
	createSystemStyleForm ()
	importSystemStyleForm ()
	cloneSystemStyleForm ()
	copyStyle ()
	deleteStyle ()
	deleteStyles ()
	checkDeletable ($skin_id, $style_id, ilSystemStyleMessageStack $message_stack)
	confirmDelete ()
	importStyle ()
	export ()
	addSubStyle ()
	addSubStyleForms ()
	saveNewSubStyle ()

Protected Attributes
	$ctrl
	$toolbar
	$lng
	$tpl
	$DIC
	$ref_id
	$read_only = true
	$management_enabled = false

Detailed Description

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

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

Version

$Id$*

Definition at line 20 of file class.ilSystemStyleOverviewGUI.php.

Constructor & Destructor Documentation

__construct()

ilSystemStyleOverviewGUI::__construct	(		$read_only,
			$management_enabled
	)

Constructor.

Definition at line 66 of file class.ilSystemStyleOverviewGUI.php.

References $_GET, $DIC, $management_enabled, $read_only, setManagementEnabled(), and setReadOnly().

    {
        global $DIC;

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

        $this->ref_id = (int) $_GET["ref_id"];

        $this->setReadOnly($read_only);
        $this->setManagementEnabled($management_enabled);
    }

Here is the call graph for this function:

Member Function Documentation

addSubStyle()

ilSystemStyleOverviewGUI::addSubStyle ( )

protected

Since clearTargets also clears the help screen ids

Definition at line 643 of file class.ilSystemStyleOverviewGUI.php.

References $DIC, $form, and addSubStyleForms().

    {
        global $DIC;

        $DIC->tabs()->clearTargets();
        $DIC->help()->setScreenIdComponent("sty");
        $DIC->help()->setScreenId("system_styles");
        $DIC->help()->setSubScreenId("create_sub");

        $form = $this->addSubStyleForms();

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

Here is the call graph for this function:

addSubStyleForms()

ilSystemStyleOverviewGUI::addSubStyleForms ( )

protected

Returns

ilPropertyFormGUI

Definition at line 663 of file class.ilSystemStyleOverviewGUI.php.

References $form, $id, PHPMailer\PHPMailer\$options, $style, ilStyleDefinition\getAllSkinStyles(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by addSubStyle(), and saveNewSubStyle().

    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("sty_create_new_system_sub_style"));


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

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

        // source
        $ti = new ilSelectInputGUI($this->lng->txt("parent"), "parent_style");
        $ti->setRequired(true);
        $ti->setInfo($this->lng->txt("sub_style_parent_style_description"));
        $styles = ilStyleDefinition::getAllSkinStyles();
        $options = array();
        foreach ($styles as $id => $style) {
            $system_style_conf = new ilSystemStyleConfig();
            if ($style["skin_id"] != $system_style_conf->getDefaultSkinId() && !$style["substyle_of"]) {
                $options[$id] = $style['title'];
            }
        }
        $ti->setOptions($options);

        $form->addItem($ti);
        $form->addCommandButton("saveNewSubStyle", $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:

addSystemStyle()

ilSystemStyleOverviewGUI::addSystemStyle ( )

protected

create

Definition at line 283 of file class.ilSystemStyleOverviewGUI.php.

References addSystemStyleForms().

    {
        $this->addSystemStyleForms();
    }

Here is the call graph for this function:

addSystemStyleForms()

ilSystemStyleOverviewGUI::addSystemStyleForms ( )

protected

create

Since clearTargets also clears the help screen ids

Definition at line 327 of file class.ilSystemStyleOverviewGUI.php.

References $DIC, cloneSystemStyleForm(), createSystemStyleForm(), and importSystemStyleForm().

Referenced by addSystemStyle().

    {
        global $DIC;

        $DIC->tabs()->clearTargets();
        $DIC->help()->setScreenIdComponent("sty");
        $DIC->help()->setScreenId("system_styles");
        $DIC->help()->setSubScreenId("create");

        $forms = array();

        $forms[] = $this->createSystemStyleForm();
        $forms[] = $this->importSystemStyleForm();
        $forms[] = $this->cloneSystemStyleForm();

        $this->tpl->setContent($this->getCreationFormsHTML($forms));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

ilSystemStyleOverviewGUI::cancel ( )

protected

Definition at line 133 of file class.ilSystemStyleOverviewGUI.php.

References edit().

    {
        $this->edit();
    }

Here is the call graph for this function:

checkDeletable()

ilSystemStyleOverviewGUI::checkDeletable (   $skin_id,   $style_id, ilSystemStyleMessageStack  $message_stack  )

protected

Parameters

	$skin_id
	$style_id
ilSystemStyleMessageStack	$message_stack

Returns

bool

Exceptions

ilSystemStyleException

Definition at line 560 of file class.ilSystemStyleOverviewGUI.php.

References ilObjUser\_getNumberOfUsersForStyle(), ilSystemStyleSettings\_lookupActivatedStyle(), ilSystemStyleMessageStack\addMessage(), ilSystemStyleSkinContainer\generateFromId(), ilSystemStyleSettings\getCurrentDefaultSkin(), and ilSystemStyleMessage\TYPE_ERROR.

Referenced by deleteStyle(), and deleteStyles().

    {
        $passed = true;
        if (ilObjUser::_getNumberOfUsersForStyle($skin_id, $style_id) > 0) {
            $message_stack->addMessage(new ilSystemStyleMessage($style_id . ": " . $this->lng->txt("cant_delete_if_users_assigned"), ilSystemStyleMessage::TYPE_ERROR));
            $passed = false;
        }
        if (ilSystemStyleSettings::_lookupActivatedStyle($skin_id, $style_id) > 0) {
            $message_stack->addMessage(new ilSystemStyleMessage($style_id . ": " . $this->lng->txt("cant_delete_activated_style"), ilSystemStyleMessage::TYPE_ERROR));
            $passed = false;
        }
        if (ilSystemStyleSettings::getCurrentDefaultSkin() == $skin_id && ilSystemStyleSettings::getCurrentDefaultSkin() == $style_id) {
            $message_stack->addMessage(new ilSystemStyleMessage($style_id . ": " . $this->lng->txt("cant_delete_default_style"), ilSystemStyleMessage::TYPE_ERROR));
            $passed = false;
        }

        if (ilSystemStyleSkinContainer::generateFromId($skin_id)->getSkin()->getSubstylesOfStyle($style_id)) {
            $message_stack->addMessage(new ilSystemStyleMessage($style_id . ": " . $this->lng->txt("cant_delete_style_with_substyles"), ilSystemStyleMessage::TYPE_ERROR));
            $passed = false;
        }
        return $passed;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkStyleSettings()

ilSystemStyleOverviewGUI::checkStyleSettings ( ilSystemStyleMessageStack  $message_stack )

protected

Parameters

ilSystemStyleMessageStack

$message_stack

Returns

bool

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

References $_POST, ilObjUser\_getNumberOfUsersForStyle(), ilSystemStyleMessageStack\addMessage(), ilStyleDefinition\getAllSkinStyles(), and ilSystemStyleMessage\TYPE_ERROR.

Referenced by saveStyleSettings().

    {
        $passed = true;

        if (count($_POST["st_act"]) < 1) {
            $passed = false;
            $message_stack->addMessage(new ilSystemStyleMessage($this->lng->txt("at_least_one_style"), ilSystemStyleMessage::TYPE_ERROR));
        }

        if (!isset($_POST["st_act"][$_POST["default_skin_style"]])) {
            $passed = false;
            $message_stack->addMessage(new ilSystemStyleMessage($this->lng->txt("cant_deactivate_default_style"), ilSystemStyleMessage::TYPE_ERROR));
        }

        // check if a style should be deactivated, that still has
        // a user assigned to
        $all_styles = ilStyleDefinition::getAllSkinStyles();

        foreach ($all_styles as $st) {
            if (!isset($_POST["st_act"][$st["id"]])) {
                if (ilObjUser::_getNumberOfUsersForStyle($st["template_id"], $st["style_id"]) > 0) {
                    $passed = false;
                    $message_stack->addMessage(new ilSystemStyleMessage($st["style_name"] . ": " . $this->lng->txt("cant_deactivate_if_users_assigned"), ilSystemStyleMessage::TYPE_ERROR));
                }
            }
        }
        return $passed;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneSystemStyleForm()

ilSystemStyleOverviewGUI::cloneSystemStyleForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 415 of file class.ilSystemStyleOverviewGUI.php.

References $form, $id, PHPMailer\PHPMailer\$options, $style, ilAccordionGUI\FIRST_OPEN, ilStyleDefinition\getAllSkinStyles(), and ilFormPropertyGUI\setRequired().

Referenced by addSystemStyleForms().

    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("sty_copy_other_system_style"));

        // source
        $ti = new ilSelectInputGUI($this->lng->txt("sty_source"), "source_style");
        $ti->setRequired(true);
        $styles = ilStyleDefinition::getAllSkinStyles();
        $options = array();
        foreach ($styles as $id => $style) {
            $system_style_conf = new ilSystemStyleConfig();
            if ($style["skin_id"] != $system_style_conf->getDefaultSkinId()) {
                $options[$id] = $style['title'];
            }
        }
        $ti->setOptions($options);

        $form->addItem($ti);

        $form->addCommandButton("copyStyle", $this->lng->txt("copy"));
        $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:

confirmDelete()

ilSystemStyleOverviewGUI::confirmDelete ( )

protected

Definition at line 583 of file class.ilSystemStyleOverviewGUI.php.

References $_POST, $container, $key, ilSystemStyleSkinContainer\generateFromId(), and ilSystemStyleMessage\TYPE_ERROR.

    {
        $message_stack = new ilSystemStyleMessageStack();

        foreach ($_POST as $key => $skin_style_id) {
            if (is_string($skin_style_id) && strpos($key, 'style') !== false) {
                try {
                    $imploded_skin_style_id = explode(":", $skin_style_id);
                    $container = ilSystemStyleSkinContainer::generateFromId($imploded_skin_style_id[0], $message_stack);
                    $syle = $container->getSkin()->getStyle($imploded_skin_style_id[1]);
                    $container->deleteStyle($syle);
                    if (!$container->getSkin()->hasStyles()) {
                        $container->delete();
                    }
                } catch (Exception $e) {
                    $message_stack->addMessage(new ilSystemStyleMessage($e->getMessage(), ilSystemStyleMessage::TYPE_ERROR));
                }
            }
        }
        $message_stack->sendMessages(true);
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

copyStyle()

ilSystemStyleOverviewGUI::copyStyle ( )

protected

Definition at line 483 of file class.ilSystemStyleOverviewGUI.php.

References $_POST, $container, ilSystemStyleSkinContainer\generateFromId(), ilSystemStyleMessage\TYPE_ERROR, and ilSystemStyleMessage\TYPE_SUCCESS.

    {
        $message_stack = new ilSystemStyleMessageStack();

        $imploded_skin_style_id = explode(":", $_POST['source_style']);
        $skin_id = $imploded_skin_style_id[0];
        $style_id = $imploded_skin_style_id[1];

        try {
            $container = ilSystemStyleSkinContainer::generateFromId($skin_id, $message_stack);
            $new_container = $container->copy();
            $message_stack->prependMessage(new ilSystemStyleMessage($this->lng->txt("style_copied"), ilSystemStyleMessage::TYPE_SUCCESS));
            $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI', 'skin_id', $new_container->getSkin()->getId());
            $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI', 'style_id', $new_container->getSkin()->getStyle($style_id)->getId());
        } catch (Exception $e) {
            $message_stack->addMessage(new ilSystemStyleMessage($e->getMessage(), ilSystemStyleMessage::TYPE_ERROR));
        }


        $message_stack->sendMessages(true);
        $this->ctrl->redirectByClass("ilSystemStyleSettingsGUI");
    }

Here is the call graph for this function:

createSystemStyleForm()

ilSystemStyleOverviewGUI::createSystemStyleForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 351 of file class.ilSystemStyleOverviewGUI.php.

References $form, and ilFormPropertyGUI\setInfo().

Referenced by addSystemStyleForms(), and saveNewSystemStyle().

    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("sty_create_new_system_style"));

        $ti = new ilTextInputGUI($this->lng->txt("skin_id"), "skin_id");
        $ti->setInfo($this->lng->txt("skin_id_description"));
        $ti->setMaxLength(128);
        $ti->setSize(40);
        $ti->setRequired(true);
        $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);

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

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

        $form->addCommandButton("saveNewSystemStyle", $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:

deleteStyle()

ilSystemStyleOverviewGUI::deleteStyle ( )

protected

Definition at line 506 of file class.ilSystemStyleOverviewGUI.php.

References $_GET, $container, checkDeletable(), edit(), ilSystemStyleSkinContainer\generateFromId(), and ilSystemStyleMessage\TYPE_ERROR.

    {
        $skin_id = $_GET["skin_id"];
        $style_id = $_GET["style_id"];
        $message_stack = new ilSystemStyleMessageStack();

        if ($this->checkDeletable($skin_id, $style_id, $message_stack)) {
            $delete_form_table = new ilSystemStyleDeleteGUI();
            $container = ilSystemStyleSkinContainer::generateFromId($skin_id);
            $delete_form_table->addStyle($container->getSkin(), $container->getSkin()->getStyle($style_id));
            $this->tpl->setContent($delete_form_table->getDeleteStyleFormHTML());
        } else {
            $message_stack->prependMessage(new ilSystemStyleMessage($this->lng->txt("style_not_deleted"), ilSystemStyleMessage::TYPE_ERROR));
            $message_stack->sendMessages(true);
            $this->edit();
        }
    }

Here is the call graph for this function:

deleteStyles()

ilSystemStyleOverviewGUI::deleteStyles ( )

protected

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

References $_POST, $container, checkDeletable(), edit(), ilSystemStyleSkinContainer\generateFromId(), and ilSystemStyleMessage\TYPE_ERROR.

    {
        $delete_form_table = new ilSystemStyleDeleteGUI();
        $message_stack = new ilSystemStyleMessageStack();

        $all_deletable = true;
        foreach ($_POST['id'] as $skin_style_id) {
            $imploded_skin_style_id = explode(":", $skin_style_id);
            $skin_id = $imploded_skin_style_id[0];
            $style_id = $imploded_skin_style_id[1];
            if (!$this->checkDeletable($skin_id, $style_id, $message_stack)) {
                $all_deletable = false;
            }
        }
        if ($all_deletable) {
            foreach ($_POST['id'] as $skin_style_id) {
                $imploded_skin_style_id = explode(":", $skin_style_id);
                $skin_id = $imploded_skin_style_id[0];
                $style_id = $imploded_skin_style_id[1];
                $container = ilSystemStyleSkinContainer::generateFromId($skin_id);
                $delete_form_table->addStyle($container->getSkin(), $container->getSkin()->getStyle($style_id));
            }
            $this->tpl->setContent($delete_form_table->getDeleteStyleFormHTML());
        } else {
            $message_stack->prependMessage(new ilSystemStyleMessage($this->lng->txt("styles_not_deleted"), ilSystemStyleMessage::TYPE_ERROR));
            $message_stack->sendMessages(true);
            $this->edit();
        }
    }

Here is the call graph for this function:

edit()

ilSystemStyleOverviewGUI::edit

(

)

Edit.

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

References $id, PHPMailer\PHPMailer\$options, $si, $table, ilStyleDefinition\getAllSkinStyles(), ilSubmitButton\getInstance(), ilLinkButton\getInstance(), and isManagementEnabled().

Referenced by cancel(), deleteStyle(), and deleteStyles().

    {
        if ($this->isManagementEnabled()) {
            // Add Button for adding skins
            $add_skin_btn = ilLinkButton::getInstance();
            $add_skin_btn->setCaption($this->lng->txt("add_system_style"), false);
            $add_skin_btn->setUrl($this->ctrl->getLinkTarget($this, 'addSystemStyle'));
            $this->toolbar->addButtonInstance($add_skin_btn);

            // Add Button for adding skins
            $add_substyle_btn = ilLinkButton::getInstance();
            $add_substyle_btn->setCaption($this->lng->txt("add_substyle"), false);
            $add_substyle_btn->setUrl($this->ctrl->getLinkTarget($this, 'addSubStyle'));
            if (count(ilStyleDefinition::getAllSkins()) == 1) {
                $add_substyle_btn->setDisabled(true);
            }
            $this->toolbar->addButtonInstance($add_substyle_btn);

            $this->toolbar->addSeparator();
        }

        // from styles selector
        $si = new ilSelectInputGUI($this->lng->txt("sty_move_user_styles") . ": " . $this->lng->txt("sty_from"), "from_style");

        $options = array();
        foreach (ilStyleDefinition::getAllSkinStyles() as $id => $skin_style) {
            if (!$skin_style['substyle_of']) {
                $options[$id] = $skin_style['title'];
            }
        }
        $si->setOptions($options + array("other" => $this->lng->txt("other")));

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

        // from styles selector
        $si = new ilSelectInputGUI($this->lng->txt("sty_to"), "to_style");
        $si->setOptions($options);
        $this->toolbar->addInputItem($si, true);
        // Add Button for adding skins
        $move_skin_btn = ilSubmitButton::getInstance();
        $move_skin_btn->setCaption($this->lng->txt("sty_move_style"), false);
        $this->toolbar->addButtonInstance($move_skin_btn);
        $this->toolbar->setFormAction($this->ctrl->getLinkTarget($this, 'moveUserStyles'));

        $table = new ilSystemStylesTableGUI($this, "edit");
        $table->addActions($this->isManagementEnabled());
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilSystemStyleOverviewGUI::executeCommand

(

)

Execute command.

Definition at line 86 of file class.ilSystemStyleOverviewGUI.php.

References isManagementEnabled(), and isReadOnly().

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

        if ($cmd == "") {
            $cmd = $this->isReadOnly()?"view":"edit";
        }


        switch ($cmd) {
            case "addSystemStyle":
            case "addSubStyle":
            case "saveNewSystemStyle":
            case "saveNewSubStyle":
            case "copyStyle":
            case "importStyle":
            case "deleteStyles":
            case "deleteStyle":
            case "confirmDelete":
                if (!$this->isManagementEnabled()) {
                    throw new ilObjectException($this->lng->txt("permission_denied"));
                }
                $this->$cmd();
                return;
            case "cancel":
            case "edit":
            case "export":
            case "moveUserStyles":
            case "saveStyleSettings":
                if ($this->isReadOnly()) {
                    throw new ilObjectException($this->lng->txt("permission_denied"));
                }
                $this->$cmd();
                return;
            case "view":
                $this->$cmd();
                return;

        }
    }

Here is the call graph for this function:

export()

ilSystemStyleOverviewGUI::export ( )

protected

Definition at line 628 of file class.ilSystemStyleOverviewGUI.php.

References $_GET, $container, ilSystemStyleSkinContainer\generateFromId(), and ilUtil\sendFailure().

    {
        $skin_id = $_GET["skin_id"];
        $container = ilSystemStyleSkinContainer::generateFromId($skin_id);
        try {
            $container->export();
        } catch (Exception $e) {
            ilUtil::sendFailure($this->lng->txt("zip_export_failed") . " " . $e->getMessage());
        }
    }

Here is the call graph for this function:

importStyle()

ilSystemStyleOverviewGUI::importStyle ( )

protected

Definition at line 609 of file class.ilSystemStyleOverviewGUI.php.

References $_POST, $form, ilSystemStyleSkinContainer\import(), importSystemStyleForm(), and ilSystemStyleMessage\TYPE_SUCCESS.

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

        if ($form->checkInput()) {
            $message_stack = new ilSystemStyleMessageStack();
            $imported_container = ilSystemStyleSkinContainer::import($_POST['importfile']['tmp_name'], $_POST['importfile']['name'], $message_stack);
            $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI', 'skin_id', $imported_container->getSkin()->getId());
            $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI', 'style_id', $imported_container->getSkin()->getDefaultStyle()->getId());
            $message_stack->addMessage(new ilSystemStyleMessage($this->lng->txt("style_imported") . " " . $imported_container->getSkinDirectory(), ilSystemStyleMessage::TYPE_SUCCESS));

            $message_stack->sendMessages(true);
            $this->ctrl->redirectByClass("ilSystemStyleSettingsGUI");
        }

        // display only this form to correct input
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

importSystemStyleForm()

ilSystemStyleOverviewGUI::importSystemStyleForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 394 of file class.ilSystemStyleOverviewGUI.php.

References $form, and ilFormPropertyGUI\setRequired().

Referenced by addSystemStyleForms(), and importStyle().

    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("sty_import_system_style"));

        // title
        $file_input = new ilFileInputGUI($this->lng->txt("import_file"), "importfile");
        $file_input->setRequired(true);
        $file_input->setSuffixes(array("zip"));
        $form->addItem($file_input);

        $form->addCommandButton("importStyle", $this->lng->txt("import"));
        $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:

isManagementEnabled()

ilSystemStyleOverviewGUI::isManagementEnabled

(

)

Returns

boolean

Definition at line 760 of file class.ilSystemStyleOverviewGUI.php.

References $management_enabled.

Referenced by edit(), and executeCommand().

    {
        return $this->management_enabled;
    }

Here is the caller graph for this function:

isReadOnly()

ilSystemStyleOverviewGUI::isReadOnly

(

)

Returns

boolean

Definition at line 744 of file class.ilSystemStyleOverviewGUI.php.

References $read_only.

Referenced by executeCommand().

    {
        return $this->read_only;
    }

Here is the caller graph for this function:

moveUserStyles()

ilSystemStyleOverviewGUI::moveUserStyles

(

)

Move user styles.

Definition at line 192 of file class.ilSystemStyleOverviewGUI.php.

References $_POST, $from, $style, ilObjUser\_getAllUserAssignedStyles(), ilObjUser\_moveUsersToStyle(), and ilStyleDefinition\styleExists().

    {
        $to = explode(":", $_POST["to_style"]);

        if ($_POST["from_style"] == "other") {
            // get all user assigned styles
            $all_user_styles = ilObjUser::_getAllUserAssignedStyles();

            // move users that are not assigned to
            // currently existing style
            foreach ($all_user_styles as $style) {
                if (!ilStyleDefinition::styleExists($style)) {
                    $style_arr = explode(":", $style);
                    ilObjUser::_moveUsersToStyle($style_arr[0], $style_arr[1], $to[0], $to[1]);
                }
            }
        } else {
            $from = explode(":", $_POST["from_style"]);
            ilObjUser::_moveUsersToStyle($from[0], $from[1], $to[0], $to[1]);
        }

        ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "edit");
    }

Here is the call graph for this function:

saveNewSubStyle()

ilSystemStyleOverviewGUI::saveNewSubStyle ( )

protected

Definition at line 705 of file class.ilSystemStyleOverviewGUI.php.

References $_POST, $container, $form, $style, addSubStyleForms(), ilSystemStyleSkinContainer\generateFromId(), ilUtil\sendFailure(), and ilSystemStyleException\SUBSTYLE_ASSIGNMENT_EXISTS.

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

        if ($form->checkInput()) {
            try {
                $imploded_parent_skin_style_id = explode(":", $_POST['parent_style']);
                $parent_skin_id = $imploded_parent_skin_style_id[0];
                $parent_style_id = $imploded_parent_skin_style_id[1];

                $container = ilSystemStyleSkinContainer::generateFromId($parent_skin_id);

                if (array_key_exists($_POST['sub_style_id'], $container->getSkin()->getSubstylesOfStyle($parent_style_id))) {
                    throw new ilSystemStyleException(ilSystemStyleException::SUBSTYLE_ASSIGNMENT_EXISTS, $_POST['sub_style_id']);
                }

                $sub_style_id = $_POST['sub_style_id'];

                $style = new ilSkinStyleXML($_POST['sub_style_id'], $_POST['sub_style_name']);
                $style->setSubstyleOf($parent_style_id);
                $container->addStyle($style);

                $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI', 'skin_id', $parent_skin_id);
                $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI', 'style_id', $sub_style_id);
                ilUtil::sendSuccess($this->lng->txt("msg_sub_style_created"), true);
                $this->ctrl->redirectByClass("ilSystemStyleSettingsGUI");
            } catch (ilSystemStyleException $e) {
                ilUtil::sendFailure($e->getMessage(), true);
            }
        }

        // display only this form to correct input
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

saveNewSystemStyle()

ilSystemStyleOverviewGUI::saveNewSystemStyle ( )

protected

Definition at line 289 of file class.ilSystemStyleOverviewGUI.php.

References $_POST, $container, $form, $style, createSystemStyleForm(), ilUtil\sendFailure(), ilStyleDefinition\skinExists(), and ilSystemStyleMessage\TYPE_ERROR.

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

        if ($form->checkInput()) {
            $message_stack = new ilSystemStyleMessageStack();
            if (ilStyleDefinition::skinExists($_POST["skin_id"])) {
                ilUtil::sendFailure($this->lng->txt("skin_id_exists"));
            } else {
                try {
                    $skin = new ilSkinXML($_POST["skin_id"], $_POST["skin_name"]);
                    $style = new ilSkinStyleXML($_POST["style_id"], $_POST["style_name"]);
                    $skin->addStyle($style);
                    $container = new ilSystemStyleSkinContainer($skin);
                    $container->create($message_stack);
                    $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI', 'skin_id', $skin->getId());
                    $this->ctrl->setParameterByClass('ilSystemStyleSettingsGUI', 'style_id', $style->getId());
                    if ($message_stack->hasMessages()) {
                        $message_stack->sendMessages(true);
                    } else {
                        ilUtil::sendSuccess($this->lng->txt("msg_sys_style_created"), true);
                    }
                    $this->ctrl->redirectByClass("ilSystemStyleSettingsGUI");
                } catch (ilSystemStyleException $e) {
                    $message_stack->addMessage(new ilSystemStyleMessage($e->getMessage(), ilSystemStyleMessage::TYPE_ERROR));
                }
            }
            $message_stack->sendMessages();
        }

        // display only this form to correct input
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

saveStyleSettings()

ilSystemStyleOverviewGUI::saveStyleSettings

(

)

Save skin and style settings.

Definition at line 221 of file class.ilSystemStyleOverviewGUI.php.

References $_POST, ilSystemStyleSettings\_activateStyle(), ilSystemStyleSettings\_deactivateStyle(), checkStyleSettings(), ilStyleDefinition\getAllSkinStyles(), ilSystemStyleSettings\setCurrentDefaultStyle(), and ilSystemStyleMessage\TYPE_SUCCESS.

    {
        $message_stack = new ilSystemStyleMessageStack();

        if ($this->checkStyleSettings($message_stack)) {
            $all_styles = ilStyleDefinition::getAllSkinStyles();
            foreach ($all_styles as $st) {
                if (!isset($_POST["st_act"][$st["id"]])) {
                    ilSystemStyleSettings::_deactivateStyle($st["template_id"], $st["style_id"]);
                } else {
                    ilSystemStyleSettings::_activateStyle($st["template_id"], $st["style_id"]);
                }
            }

            //set default skin and style
            if ($_POST["default_skin_style"] != "") {
                $sknst = explode(":", $_POST["default_skin_style"]);
                ilSystemStyleSettings::setCurrentDefaultStyle($sknst[0], $sknst[1]);
            }
            $message_stack->addMessage(new ilSystemStyleMessage($this->lng->txt("msg_obj_modified"), ilSystemStyleMessage::TYPE_SUCCESS));
        }
        $message_stack->sendMessages(true);
        $this->ctrl->redirect($this, "edit");
    }

Here is the call graph for this function:

setManagementEnabled()

ilSystemStyleOverviewGUI::setManagementEnabled

(

$management_enabled

)

Parameters

boolean

$management_enabled

Definition at line 768 of file class.ilSystemStyleOverviewGUI.php.

References $management_enabled.

Referenced by __construct().

    {
        $this->management_enabled = $management_enabled;
    }

Here is the caller graph for this function:

setReadOnly()

ilSystemStyleOverviewGUI::setReadOnly

(

$read_only

)

Parameters

boolean

$read_only

Definition at line 752 of file class.ilSystemStyleOverviewGUI.php.

References $read_only.

Referenced by __construct().

    {
        $this->read_only = $read_only;
    }

Here is the caller graph for this function:

view()

ilSystemStyleOverviewGUI::view ( )

protected

Definition at line 127 of file class.ilSystemStyleOverviewGUI.php.

References $table.

    {
        $table = new ilSystemStylesTableGUI($this, "edit", true);
        $this->tpl->setContent($table->getHTML());
    }

Field Documentation

$ctrl

ilSystemStyleOverviewGUI::$ctrl

protected

Definition at line 25 of file class.ilSystemStyleOverviewGUI.php.

$DIC

ilSystemStyleOverviewGUI::$DIC

protected

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

Referenced by __construct(), addSubStyle(), and addSystemStyleForms().

$lng

ilSystemStyleOverviewGUI::$lng

protected

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

$management_enabled

ilSystemStyleOverviewGUI::$management_enabled = false

protected

Definition at line 60 of file class.ilSystemStyleOverviewGUI.php.

Referenced by __construct(), isManagementEnabled(), and setManagementEnabled().

$read_only

ilSystemStyleOverviewGUI::$read_only = true

protected

Definition at line 55 of file class.ilSystemStyleOverviewGUI.php.

Referenced by __construct(), isReadOnly(), and setReadOnly().

$ref_id

ilSystemStyleOverviewGUI::$ref_id

protected

Definition at line 50 of file class.ilSystemStyleOverviewGUI.php.

$toolbar

ilSystemStyleOverviewGUI::$toolbar

protected

Definition at line 30 of file class.ilSystemStyleOverviewGUI.php.

$tpl

ilSystemStyleOverviewGUI::$tpl

protected

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

---

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

• Services/Style/System/classes/Overview/class.ilSystemStyleOverviewGUI.php