Settings UI class for system styles. More...

Collaboration diagram for ilSystemStyleMainGUI:

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

Static Public Member Functions
static	_goto ($ref_id, $params)

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.

Member Function Documentation

◆ _goto()

static ilSystemStyleMainGUI::_goto	(	$ref_id,
		$params
	)

static

Parameters

$ref_id
$params

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

References $_GET, $DIC, PHPMailer\PHPMailer\$params, and $ref_id.

     {
         global $DIC;
 
         $node_id = $params[2];
         $skin_id = $params[3];
         $style_id = $params[4];
 
         $DIC->ctrl()->setParameterByClass('ilSystemStyleDocumentationGUI', 'skin_id', $skin_id);
         $DIC->ctrl()->setParameterByClass(
             'ilSystemStyleDocumentationGUI',
             'style_id',
             $style_id
         );
         $DIC->ctrl()->setParameterByClass('ilSystemStyleDocumentationGUI', 'node_id', $node_id);
         $DIC->ctrl()->setParameterByClass('ilSystemStyleDocumentationGUI', 'ref_id', $ref_id);
 
         $_GET['baseClass'] = 'ilAdministrationGUI';
 
         $cmd = "entries";
         $cmd_classes = [
                 "ilAdministrationGUI",
                 "ilObjStyleSettingsGUI",
                 "ilSystemStyleMainGUI",
                 'ilSystemStyleDocumentationGUI'
         ];
 
         $DIC->ctrl()->setTargetScript("ilias.php");
         $DIC->ctrl()->redirectByClass($cmd_classes, $cmd);
     }

◆ 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 216 of file class.ilSystemStyleMainGUI.php.

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

     {
         global $DIC;
 
         $has_perm = true;
 
         $config = new ilSystemStyleConfig();
         if ($a_perm == "sty_management") {
             $has_perm = $DIC->iliasIni()->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:

◆ setUnderworldTabs()

ilSystemStyleMainGUI::setUnderworldTabs ( $active = "" )

protected

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

Parameters

string $active

Since clearTargets also clears the help screen ids

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

References $_GET, $config, and $DIC.

     {
         global $DIC;
         $this->tabs->clearTargets();
 
         $DIC->help()->setScreenIdComponent("sty");
         $DIC->help()->setScreenId("system_styles");
         $this->tabs->setBackTarget($this->lng->txt("back"), $this->ctrl->getLinkTarget($this));
         $config = new ilSystemStyleConfig();
         if ($_GET["skin_id"] != $config->getDefaultSkinId()) {
             $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);
     }

◆ setUnderworldTitle()

ilSystemStyleMainGUI::setUnderworldTitle ( )

protected

Sets title correctly if one system style is opened.

Exceptions

ilSystemStyleException

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

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

     {
         $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() . "'"
             );
         }
     }