Settings UI class for system styles. More...

Collaboration diagram for ilSystemStyleMainGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	executeCommand ()
	Main routing of the system styles. More...

	checkPermission ($a_perm, $a_throw_exc=true)
	Checks permission for system styles. More...

Protected Member Functions
	setUnderworldTabs ($active="")
	Sets the tab correctly if one system style is open (navigational underworld opened) More...

	setUnderworldTitle ()
	Sets title correctly if one system style is opened. More...

Protected Attributes
	$ctrl

	$lng

	$DIC

	$tabs

	$rbacsystem

	$ref_id

	$tpl

Detailed Description

Settings UI class for system styles.

Acts as main router for the systems styles and handles permissions checks, sets tabs and title as well as description of the content section.

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$

ilSystemStyleMainGUI: ilSystemStyleOverviewGUI,ilSystemStyleSettingsGUI ilSystemStyleMainGUI: ilSystemStyleLessGUI,ilSystemStyleIconsGUI,ilSystemStyleDocumentationGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleMainGUI::__construct ( )

Constructor.

Definition at line 62 of file class.ilSystemStyleMainGUI.php.

References $_GET, and $DIC.

         {
                 global $DIC;
 
                 $this->ctrl = $DIC->ctrl();
                 $this->lng = $DIC->language();
                 $this->tabs = $DIC->tabs();
                 $this->rbacsystem = $DIC->rbac()->system();
                 $this->tpl = $DIC["tpl"];
 
                 $this->ref_id = (int) $_GET["ref_id"];
         }

Member Function Documentation

◆ checkPermission()

ilSystemStyleMainGUI::checkPermission	(	$a_perm,
		$a_throw_exc = `true`
	)

Checks permission for system styles.

Permissions work on two levels, ordinary rbac and the 'enable_system_styles_management' setting in the tools section of the ilias.ini.php

Parameters

	$a_perm
bool \| true	$a_throw_exc

Returns: bool

Exceptions

ilObjectException

Definition at line 159 of file class.ilSystemStyleMainGUI.php.

References $config, $ilIliasIniFile, and ilUtil\sendFailure().

Referenced by executeCommand().

         {
                 global $ilIliasIniFile;
 
                 $has_perm = true;
 
                 $config = new ilSystemStyleConfig();
                 if($a_perm == "sty_management"){
                         $has_perm = $ilIliasIniFile->readVariable("tools","enable_system_styles_management")== "1" ? true:false;
                         $a_perm = "sty_write_system";
                         if($has_perm && ! is_writable($config->getCustomizingSkinPath())){
                                 ilUtil::sendFailure($this->lng->txt("enable_system_styles_management_no_write_perm"));
                                 $has_perm = false;
                         }
                 }
 
                 if($has_perm){
                         $has_perm = $this->rbacsystem->checkAccess($a_perm, $this->ref_id);
                 }
 
                 if (!$has_perm)
                 {
                         if ($a_throw_exc)
                         {
                                 include_once "Services/Object/exceptions/class.ilObjectException.php";
                                 throw new ilObjectException($this->lng->txt("sty_permission_denied"));
                         }
                         return false;
                 }
                 return $has_perm;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilSystemStyleMainGUI::executeCommand ( )

Main routing of the system styles.

Resets ilCtrl Parameter for all subsequent generation of links.

Exceptions

ilCtrlException
ilObjectException

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

References $_GET, checkPermission(), ilUtil\sendFailure(), setUnderworldTabs(), and setUnderworldTitle().

         {
                 $next_class = $this->ctrl->getNextClass($this);
 
                 $this->ctrl->setParameterByClass('ilsystemstylesettingsgui','skin_id',$_GET["skin_id"]);
                 $this->ctrl->setParameterByClass('ilsystemstylesettingsgui','style_id',$_GET["style_id"]);
                 $this->ctrl->setParameterByClass('ilsystemstylelessgui','skin_id',$_GET["skin_id"]);
                 $this->ctrl->setParameterByClass('ilsystemstylelessgui','style_id',$_GET["style_id"]);
                 $this->ctrl->setParameterByClass('ilsystemstyleiconsgui','skin_id',$_GET["skin_id"]);
                 $this->ctrl->setParameterByClass('ilsystemstyleiconsgui','style_id',$_GET["style_id"]);
                 $this->ctrl->setParameterByClass('ilsystemstyledocumentationgui','skin_id',$_GET["skin_id"]);
                 $this->ctrl->setParameterByClass('ilsystemstyledocumentationgui','style_id',$_GET["style_id"]);
 
                 try{
                         switch ($next_class)
                         {
 
                                 case "ilsystemstylesettingsgui":
                                         $this->checkPermission("sty_management");
                                         $this->setUnderworldTabs('settings');
                                         $this->setUnderworldTitle();
                                         include_once("Settings/class.ilSystemStyleSettingsGUI.php");
                                         $system_styles_settings = new ilSystemStyleSettingsGUI();
                                         $this->ctrl->forwardCommand($system_styles_settings);
                                         break;
                                 case "ilsystemstylelessgui":
                                         $this->checkPermission("sty_management");
                                         $this->setUnderworldTabs('less');
                                         $this->setUnderworldTitle();
                                         include_once("Less/class.ilSystemStyleLessGUI.php");
                                         $system_styles_less = new ilSystemStyleLessGUI();
                                         $this->ctrl->forwardCommand($system_styles_less);
                                         break;
                                 case "ilsystemstyleiconsgui":
                                         $this->checkPermission("sty_management");
                                         $this->setUnderworldTabs('icons');
                                         $this->setUnderworldTitle();
                                         include_once("Icons/class.ilSystemStyleIconsGUI.php");
                                         $system_styles_icons = new ilSystemStyleIconsGUI();
                                         $this->ctrl->forwardCommand($system_styles_icons);
                                         break;
                                 case "ilsystemstyledocumentationgui":
                                         $this->checkPermission("sty_management");
                                         $this->setUnderworldTabs('documentation');
                                         $this->setUnderworldTitle();
                                         include_once("Documentation/class.ilSystemStyleDocumentationGUI.php");
                                         $system_styles_documentation = new ilSystemStyleDocumentationGUI();
                                         $this->ctrl->forwardCommand($system_styles_documentation);
                                         break;
                                 case "ilsystemstyleoverviewgui":
                                 default:
                                         $this->checkPermission("visible,read");
                                         include_once("Overview/class.ilSystemStyleOverviewGUI.php");
                                         $system_styles_overview = new ilSystemStyleOverviewGUI(!$this->checkPermission("sty_write_system",false)
                                                         ,$this->checkPermission("sty_management",false));
                                         $this->ctrl->forwardCommand($system_styles_overview);
                                         break;
                         }
                 }catch(ilObjectException $e){
                         ilUtil::sendFailure($e->getMessage());
                         $this->checkPermission("visible,read");
                         include_once("Overview/class.ilSystemStyleOverviewGUI.php");
                         $this->ctrl->setCmd("");
                         $system_styles_overview = new ilSystemStyleOverviewGUI(!$this->checkPermission("sty_write_system",false),$this->checkPermission("sty_management",false));
                         $this->ctrl->forwardCommand($system_styles_overview);
                 }
         }

Here is the call graph for this function:

◆ setUnderworldTabs()

ilSystemStyleMainGUI::setUnderworldTabs ( $active = "" )

protected

Sets the tab correctly if one system style is open (navigational underworld opened)

Parameters

string $active

Definition at line 196 of file class.ilSystemStyleMainGUI.php.

Referenced by executeCommand().

                                                            {
                 $this->tabs->clearTargets();
 
                 $this->tabs->setBackTarget($this->lng->txt("back"),$this->ctrl->getLinkTarget($this));
                 $this->tabs->addTab('settings', $this->lng->txt('settings'), $this->ctrl->getLinkTargetByClass('ilsystemstylesettingsgui'));
                 $this->tabs->addTab('less', $this->lng->txt('less'), $this->ctrl->getLinkTargetByClass('ilsystemstylelessgui'));
                 $this->tabs->addTab('icons', $this->lng->txt('icons'), $this->ctrl->getLinkTargetByClass('ilsystemstyleiconsgui'));
                 $this->tabs->addTab('documentation', $this->lng->txt('documentation'), $this->ctrl->getLinkTargetByClass('ilsystemstyledocumentationgui'));
 
                 $this->tabs->activateTab($active);
         }

Here is the caller graph for this function:

◆ setUnderworldTitle()

ilSystemStyleMainGUI::setUnderworldTitle ( )

protected

Sets title correctly if one system style is opened.

Exceptions

ilSystemStyleException

Definition at line 214 of file class.ilSystemStyleMainGUI.php.

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

Referenced by executeCommand().

                                                 {
                 $skin_id = $_GET["skin_id"];
                 $style_id = $_GET["style_id"];
 
                 $skin = ilSystemStyleSkinContainer::generateFromId($skin_id)->getSkin();
                 $style = $skin->getStyle($style_id);
 
                 $this->tpl->setTitle($style->getName());
                 if($style->isSubstyle()){
                         $this->tpl->setDescription($this->lng->txt("settings_of_substyle")." '".$style->getName()."' ".
                                         $this->lng->txt("of_parent")." '".$skin->getStyle($style->getSubstyleOf())->getName()."' ".
                                         $this->lng->txt("from_skin")." ".$skin->getName()
                         );
                 }else{
                         $this->tpl->setDescription($this->lng->txt("settings_of_style")." '".$style->getName()."' ".
                                         $this->lng->txt("from_skin")." '".$skin->getName()."'"
                         );
                 }
         }