ilContentStyleSettingsGUI Class Reference

Settings UI class for system styles. More...

Collaboration diagram for ilContentStyleSettingsGUI:

Public Member Functions
	__construct (ilObjStyleSettingsGUI $a_parent_gui)
	Constructor. More...
	executeCommand ()
	Execute command. More...
	checkPermission ($a_perm, $a_throw_exc=true)
	Check permission. More...
	createStyle ()
	Create new style. More...
	edit ()
	Show styles. More...
	moveLMStyles ()
	move learning modules from one style to another More...
	moveIndividualStyles ()
	move all learning modules with individual styles to new style More...
	confirmDeleteIndividualStyles ()
	deleteStyle ()
	display deletion confirmation screen More...
	confirmedDelete ()
	delete selected style objects More...
	toggleGlobalDefault ()
	Toggle global default style. More...
	toggleGlobalFixed ()
	Toggle global fixed style. More...
	saveActiveStyles ()
	Save active styles. More...
	showActions ($with_subobjects=false)
	show possible action (form buttons) More...
	cancelDelete ()
	cancel deletion of object More...
	setScope ()
	Set scope. More...
	saveScope ()
	Save scope for style. More...

Protected Attributes
	$ctrl
	$rbacsystem
	$toolbar
	$lng
	$tpl
	$DIC
	$ref_id

Detailed Description

Settings UI class for system styles.

Author

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

Version

$Id$ ilContentStyleSettingsGUI: ilObjStyleSheetGUI

Definition at line 13 of file class.ilContentStyleSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilContentStyleSettingsGUI::__construct

(

ilObjStyleSettingsGUI

$a_parent_gui

)

Constructor.

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

References $_GET, $DIC, and settings().

        {
                global $DIC;

                $this->parent_gui = $a_parent_gui;
                $this->dic = $DIC;
                $this->ctrl = $DIC->ctrl();
                $this->rbacsystem = $DIC->rbac()->system();
                $this->toolbar = $DIC->toolbar();
                $this->lng = $DIC->language();
                $this->tpl = $DIC["tpl"];
                $this->ref_id = (int) $_GET["ref_id"];
                $this->obj_id = (int) $_GET["obj_id"];          // note that reference ID is the id of the style settings node and object ID may be a style sheet object ID

                
                include_once("./Services/Style/Content/classes/class.ilContentStyleSettings.php");
                $this->settings = new ilContentStyleSettings();
        }

Here is the call graph for this function:

Member Function Documentation

cancelDelete()

ilContentStyleSettingsGUI::cancelDelete

(

)

cancel deletion of object

public

Definition at line 449 of file class.ilContentStyleSettingsGUI.php.

References ilUtil\sendInfo().

        {
                ilUtil::sendInfo($this->lng->txt("msg_cancel"),true);
                $this->ctrl->redirect($this, "edit");

        }

Here is the call graph for this function:

checkPermission()

ilContentStyleSettingsGUI::checkPermission	(		$a_perm,
			$a_throw_exc = true
	)

Check permission.

Parameters

string

$a_perm

permission(s)

Returns

bool

Exceptions

ilObjectException

Definition at line 110 of file class.ilContentStyleSettingsGUI.php.

Referenced by confirmDeleteIndividualStyles(), confirmedDelete(), deleteStyle(), edit(), moveIndividualStyles(), moveLMStyles(), saveScope(), setScope(), toggleGlobalDefault(), and toggleGlobalFixed().

        {
                if (!$this->rbacsystem->checkAccess($a_perm, $this->ref_id))
                {
                        if ($a_throw_exc)
                        {
                                include_once "Services/Object/exceptions/class.ilObjectException.php";
                                throw new ilObjectException($this->lng->txt("permission_denied"));
                        }
                        return false;
                }
                return true;
        }

Here is the caller graph for this function:

confirmDeleteIndividualStyles()

ilContentStyleSettingsGUI::confirmDeleteIndividualStyles

(

)

Definition at line 244 of file class.ilContentStyleSettingsGUI.php.

References $_POST, ilObject\_lookupTitle(), and checkPermission().

Referenced by moveLMStyles().

        {
                $this->checkPermission("sty_write_content");

                include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");

                $this->ctrl->setParameter($this, "to_style", $_POST["to_style"]);

                $cgui = new ilConfirmationGUI();
                $cgui->setFormAction($this->ctrl->getFormAction($this));
                $cgui->setHeaderText($this->lng->txt("sty_confirm_del_ind_styles").": ".
                        sprintf($this->lng->txt("sty_confirm_del_ind_styles_desc"),
                                ilObject::_lookupTitle($_POST["to_style"])));
                $cgui->setCancel($this->lng->txt("cancel"), "edit");
                $cgui->setConfirm($this->lng->txt("ok"), "moveIndividualStyles");
                $this->tpl->setContent($cgui->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmedDelete()

ilContentStyleSettingsGUI::confirmedDelete

(

)

delete selected style objects

Definition at line 300 of file class.ilContentStyleSettingsGUI.php.

References $_POST, and checkPermission().

        {
                global $ilias;

                $this->checkPermission("sty_write_content");

                foreach($_POST["id"] as $id)
                {
                        include_once("./Services/Style/Content/classes/class.ilContentStyleSettings.php");
                        $set = new ilContentStyleSettings();
                        $set->removeStyle($id);
                        $set->update();
                        $style_obj = $ilias->obj_factory->getInstanceByObjId($id);
                        $style_obj->delete();
                }

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

Here is the call graph for this function:

createStyle()

ilContentStyleSettingsGUI::createStyle

(

)

Create new style.

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

References $ilCtrl.

        {
                global $ilCtrl;

        //      $ilCtrl->setParameterByClass("ilobjstylesheetgui", "new_type", "sty");
                $ilCtrl->redirectByClass("ilobjstylesheetgui", "create");
        }

deleteStyle()

ilContentStyleSettingsGUI::deleteStyle

(

)

display deletion confirmation screen

Definition at line 267 of file class.ilContentStyleSettingsGUI.php.

References $_POST, checkPermission(), ilUtil\getImageTagByType(), and ilUtil\sendFailure().

        {
                $this->checkPermission("sty_write_content");

                if (!isset($_POST["id"]))
                {
                        ilUtil::sendFailure($this->lng->txt("no_checkbox"), true);
                        $this->ctrl->redirect($this, "edit");
                }

                // display confirmation message
                include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                $cgui = new ilConfirmationGUI();
                $cgui->setFormAction($this->ctrl->getFormAction($this));
                $cgui->setHeaderText($this->lng->txt("info_delete_sure"));
                $cgui->setCancel($this->lng->txt("cancel"), "cancelDelete");
                $cgui->setConfirm($this->lng->txt("confirm"), "confirmedDelete");

                foreach ($_POST["id"] as $id)
                {
                        $caption =  ilUtil::getImageTagByType("sty", $this->tpl->tplPath).
                                " ".ilObject::_lookupTitle($id);

                        $cgui->addItem("id[]", $id, $caption);
                }

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

Here is the call graph for this function:

edit()

ilContentStyleSettingsGUI::edit

(

)

Show styles.

Definition at line 138 of file class.ilContentStyleSettingsGUI.php.

References $data, $si, $style, $styles, ilObjContentObject\_getNrLMsIndividualStyles(), ilObjContentObject\_getNrLMsNoStyle(), ilObjContentObject\_getNrOfAssignedLMs(), ilObjStyleSheet\_lookupActive(), array, checkPermission(), and settings().

        {
                $this->checkPermission("visible,read");

                // this may not be cool, if styles are organised as (independent) Service
                include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
                include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");

                $from_styles = $to_styles = $data = array();
                $styles = $this->settings->getStyles();
                foreach($styles as $style)
                {
                        $style["active"] = ilObjStyleSheet::_lookupActive($style["id"]);
                        $style["lm_nr"] = ilObjContentObject::_getNrOfAssignedLMs($style["id"]);
                        $data[$style["title"].":".$style["id"]]
                                = $style;
                        if ($style["lm_nr"] > 0)
                        {
                                $from_styles[$style["id"]] = $style["title"];
                        }
                        if ($style["active"] > 0)
                        {
                                $to_styles[$style["id"]] = $style["title"];
                        }
                }

                // number of individual styles
                if ($fixed_style <= 0)
                {
                        $data[-1] =
                                array("title" => $this->lng->txt("sty_individual_styles"),
                                        "id" => 0, "lm_nr" => ilObjContentObject::_getNrLMsIndividualStyles());
                        $from_styles[-1] = $this->lng->txt("sty_individual_styles");
                }

                // number of default style (fallback default style)
                if ($default_style <= 0 && $fixed_style <= 0)
                {
                        $data[0] =
                                array("title" => $this->lng->txt("sty_default_style"),
                                        "id" => 0, "lm_nr" => ilObjContentObject::_getNrLMsNoStyle());
                        $from_styles[0] = $this->lng->txt("sty_default_style");
                        $to_styles[0] = $this->lng->txt("sty_default_style");
                }

                if ($this->checkPermission("sty_write_content", false))
                {
                        $this->toolbar->addButton($this->lng->txt("sty_add_content_style"),
                                $this->ctrl->getLinkTarget($this, "createStyle"));
                        $this->toolbar->addSeparator();
                        include_once("./Services/Form/classes/class.ilSelectInputGUI.php");

                        // from styles selector
                        $si = new ilSelectInputGUI($this->lng->txt("sty_move_lm_styles").": ".$this->lng->txt("sty_from"), "from_style");
                        $si->setOptions($from_styles);
                        $this->toolbar->addInputItem($si, true);

                        // from styles selector
                        $si = new ilSelectInputGUI($this->lng->txt("sty_to"), "to_style");
                        $si->setOptions($to_styles);
                        $this->toolbar->addInputItem($si, true);
                        $this->toolbar->addFormButton($this->lng->txt("sty_move_style"), "moveLMStyles");

                        $this->toolbar->setFormAction($this->ctrl->getFormAction($this));
                }

                include_once("./Services/Style/Content/classes/class.ilContentStylesTableGUI.php");
                $table = new ilContentStylesTableGUI($this, "edit", $data, $this->settings);
                $this->tpl->setContent($table->getHTML());

        }

Here is the call graph for this function:

executeCommand()

ilContentStyleSettingsGUI::executeCommand

(

)

Execute command.

Definition at line 75 of file class.ilContentStyleSettingsGUI.php.

References $cmd, and array.

        {
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd("edit");

                switch ($next_class)
                {
                        case "ilobjstylesheetgui":
                                $this->ctrl->setReturn($this, "edit");
                                include_once("./Services/Style/Content/classes/class.ilObjStyleSheetGUI.php");
                                $style_gui = new ilObjStyleSheetGUI("", $this->obj_id, false, false);
                                $this->ctrl->forwardCommand($style_gui);
                                break;

                        default:
                                $this->parent_gui->prepareOutput();
                                if (in_array($cmd, array("edit", "delete", "toggleGlobalDefault", "toggleGlobalFixed", "setScope", "saveScope", "saveActiveStyles",
                                        "createStyle", "moveLMStyles", "moveIndividualStyles", "deleteStyle", "cancelDelete", "confirmedDelete")))
                                {
                                        $this->$cmd();
                                }
                                else
                                {
                                        die("Unknown command ".$cmd);
                                }
                }
        }

moveIndividualStyles()

ilContentStyleSettingsGUI::moveIndividualStyles

(

)

move all learning modules with individual styles to new style

Definition at line 232 of file class.ilContentStyleSettingsGUI.php.

References $_GET, ilObjContentObject\_moveLMStyles(), and checkPermission().

        {
                $this->checkPermission("sty_write_content");

                include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
                ilObjContentObject::_moveLMStyles(-1, $_GET["to_style"]);
                $this->ctrl->redirect($this, "edit");
        }

Here is the call graph for this function:

moveLMStyles()

ilContentStyleSettingsGUI::moveLMStyles

(

)

move learning modules from one style to another

Definition at line 213 of file class.ilContentStyleSettingsGUI.php.

References $_POST, ilObjContentObject\_moveLMStyles(), checkPermission(), and confirmDeleteIndividualStyles().

        {
                $this->checkPermission("sty_write_content");

                if ($_POST["from_style"] == -1)
                {
                        $this->confirmDeleteIndividualStyles();
                        return;
                }

                include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
                ilObjContentObject::_moveLMStyles($_POST["from_style"], $_POST["to_style"]);
                $this->ctrl->redirect($this, "edit");
        }

Here is the call graph for this function:

saveActiveStyles()

ilContentStyleSettingsGUI::saveActiveStyles

(

)

Save active styles.

Definition at line 377 of file class.ilContentStyleSettingsGUI.php.

References $_POST, $style, $styles, ilObjStyleSheet\_writeActive(), ilUtil\redirect(), and settings().

        {
                include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
                $styles = $this->settings->getStyles();
                foreach($styles as $style)
                {
                        if ($_POST["std_".$style["id"]] == 1)
                        {
                                ilObjStyleSheet::_writeActive((int) $style["id"], 1);
                        }
                        else
                        {
                                ilObjStyleSheet::_writeActive((int) $style["id"], 0);
                        }
                }
                ilUtil::redirect($this->ctrl->getLinkTarget($this, "edit", "", false, false));
        }

Here is the call graph for this function:

saveScope()

ilContentStyleSettingsGUI::saveScope

(

)

Save scope for style.

Definition at line 479 of file class.ilContentStyleSettingsGUI.php.

References $_GET, ilObjStyleSheet\_writeScope(), checkPermission(), ilUtil\redirect(), and ilUtil\sendSuccess().

        {
                global $tree;

                $this->checkPermission("sty_write_content");

                include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
                if ($_GET["cat"] == $tree->readRootId())
                {
                        $_GET["cat"] = "";
                }
                ilObjStyleSheet::_writeScope($_GET["id"], $_GET["cat"]);

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

                ilUtil::redirect($this->ctrl->getLinkTarget($this, "edit", "", false, false));
        }

Here is the call graph for this function:

setScope()

ilContentStyleSettingsGUI::setScope

(

)

Set scope.

Definition at line 459 of file class.ilContentStyleSettingsGUI.php.

References $ilCtrl, $tpl, array, and checkPermission().

        {
                global $tpl, $ilCtrl;

                $this->checkPermission("sty_write_content");

                $ilCtrl->saveParameter($this, "id");
                include_once("./Services/Repository/classes/class.ilRepositorySelectorExplorerGUI.php");
                $exp = new ilRepositorySelectorExplorerGUI($this, "setScope",
                        $this, "saveScope", "cat");
                $exp->setTypeWhiteList(array("root", "cat"));
                if (!$exp->handleCommand())
                {
                        $tpl->setContent($exp->getHTML());
                }
        }

Here is the call graph for this function:

showActions()

ilContentStyleSettingsGUI::showActions

(

$with_subobjects = false

)

show possible action (form buttons)

Parameters

boolean

public

Definition at line 401 of file class.ilContentStyleSettingsGUI.php.

References ilUtil\getImagePath().

        {

                // delete
                $this->tpl->setCurrentBlock("tbl_action_btn");
                $this->tpl->setVariable("BTN_NAME", "deleteStyle");
                $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("delete"));
                $this->tpl->parseCurrentBlock();

                // set global default
                $this->tpl->setCurrentBlock("tbl_action_btn");
                $this->tpl->setVariable("BTN_NAME", "toggleGlobalDefault");
                $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("toggleGlobalDefault"));
                $this->tpl->parseCurrentBlock();

                // set global default
                $this->tpl->setCurrentBlock("tbl_action_btn");
                $this->tpl->setVariable("BTN_NAME", "toggleGlobalFixed");
                $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("toggleGlobalFixed"));
                $this->tpl->parseCurrentBlock();

                // set global default
                $this->tpl->setCurrentBlock("tbl_action_btn");
                $this->tpl->setVariable("BTN_NAME", "setScope");
                $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("sty_set_scope"));
                $this->tpl->parseCurrentBlock();

                // save active styles
                $this->tpl->setCurrentBlock("tbl_action_btn");
                $this->tpl->setVariable("BTN_NAME", "saveActiveStyles");
                $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("sty_save_active_styles"));
                $this->tpl->parseCurrentBlock();

                if ($with_subobjects === true)
                {
                        $this->showPossibleSubObjects();
                }

                $this->tpl->setCurrentBlock("tbl_action_row");
                $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.svg"));
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

toggleGlobalDefault()

ilContentStyleSettingsGUI::toggleGlobalDefault

(

)

Toggle global default style.

Definition at line 323 of file class.ilContentStyleSettingsGUI.php.

References $_GET, $ilSetting, $lng, checkPermission(), ilUtil\redirect(), and ilUtil\sendSuccess().

        {
                global $ilSetting, $lng;

                $this->checkPermission("sty_write_content");

                if ($_GET["id"] > 0)
                {
                        $ilSetting->delete("fixed_content_style_id");
                        $def_style = $ilSetting->get("default_content_style_id");

                        if ($def_style != $_GET["id"])
                        {
                                $ilSetting->set("default_content_style_id", (int) $_GET["id"]);
                        }
                        else
                        {
                                $ilSetting->delete("default_content_style_id");
                        }
                        ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                }
                ilUtil::redirect($this->ctrl->getLinkTarget($this, "edit", "", false, false));
        }

Here is the call graph for this function:

toggleGlobalFixed()

ilContentStyleSettingsGUI::toggleGlobalFixed

(

)

Toggle global fixed style.

Definition at line 350 of file class.ilContentStyleSettingsGUI.php.

References $_GET, $ilSetting, $lng, checkPermission(), ilUtil\redirect(), and ilUtil\sendSuccess().

        {
                global $ilSetting, $lng;

                $this->checkPermission("sty_write_content");

                if ($_GET["id"] > 0)
                {
                        $ilSetting->delete("default_content_style_id");
                        $fixed_style = $ilSetting->get("fixed_content_style_id");
                        if ($fixed_style == (int) $_GET["id"])
                        {
                                $ilSetting->delete("fixed_content_style_id");
                        }
                        else
                        {
                                $ilSetting->set("fixed_content_style_id", (int) $_GET["id"]);
                        }
                        ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                }
                ilUtil::redirect($this->ctrl->getLinkTarget($this, "edit", "", false, false));
        }

Here is the call graph for this function:

Field Documentation

$ctrl

ilContentStyleSettingsGUI::$ctrl

protected

Definition at line 18 of file class.ilContentStyleSettingsGUI.php.

$DIC

ilContentStyleSettingsGUI::$DIC

protected

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

Referenced by __construct().

$lng

ilContentStyleSettingsGUI::$lng

protected

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

Referenced by toggleGlobalDefault(), and toggleGlobalFixed().

$rbacsystem

ilContentStyleSettingsGUI::$rbacsystem

protected

Definition at line 23 of file class.ilContentStyleSettingsGUI.php.

$ref_id

ilContentStyleSettingsGUI::$ref_id

protected

Definition at line 48 of file class.ilContentStyleSettingsGUI.php.

$toolbar

ilContentStyleSettingsGUI::$toolbar

protected

Definition at line 28 of file class.ilContentStyleSettingsGUI.php.

$tpl

ilContentStyleSettingsGUI::$tpl

protected

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

Referenced by setScope().

---

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

• Services/Style/Content/classes/class.ilContentStyleSettingsGUI.php