Settings UI class for system styles. More...

Collaboration diagram for ilSystemStyleMainGUI:

Public Member Functions
	executeCommand ()
	Main routing of the system styles. More...

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

Protected Member Functions
	executeDefaultCommand (ilSkinFactory $skin_factory, string $skin_id, string $style_id)

	setUnderworldTabs (string $sking_id, string $active='', bool $read_only=false)
	Sets the tab correctly if one system style is open (navigational underworld opened) More...

	setUnderworldTitle (string $skin_id, string $style_id, bool $read_only=false)
	Sets title correctly if one system style is opened. More...

Protected Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs

ilRbacSystem	$rbacsystem

string	$ref_id

ilGlobalTemplateInterface	$tpl

ilHelpGUI	$help

Factory	$ui_factory

Renderer	$renderer

ilIniFile	$ilIniFile

ilLocatorGUI	$locator

Services	$global_screen

WrapperFactory	$request_wrapper

RefineryFactory	$refinery

ServerRequestInterface	$request

ilToolbarGUI	$toolbar

ilSkinFactory	$skin_factory

FileUpload	$upload

ilTree	$tree

ilObjUser	$user

ilSystemStyleMessageStack	$message_stack

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. ilSystemStyleMainGUI: ilSystemStyleOverviewGUI,ilSystemStyleConfigGUI ilSystemStyleMainGUI: ilSystemStyleScssGUI,ilSystemStyleIconsGUI,ilSystemStyleDocumentationGUI

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

Member Function Documentation

◆ checkPermission()

ilSystemStyleMainGUI::checkPermission	(	string	$a_perm,
		bool	$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

Exceptions

ilObjectException

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

References ILIAS\Repository\lng(), ilIniFile\readVariable(), and ilSystemStyleMessage\TYPE_ERROR.

Referenced by executeCommand(), and executeDefaultCommand().

                                                                              : bool
     {
         $has_perm = true;
 
         $config = new ilSystemStyleConfig();
         if ($a_perm == 'sty_management') {
             $has_perm = $this->ilIniFile->readVariable('tools', 'enable_system_styles_management') == '1';
             $a_perm = 'sty_write_system';
             if ($has_perm && !is_writable($config->getCustomizingSkinPath())) {
                 $this->message_stack->addMessage(new ilSystemStyleMessage(
                     $this->lng->txt('enable_system_styles_management_no_write_perm'),
                     ilSystemStyleMessage::TYPE_ERROR
                 ));
                 $this->message_stack->sendMessages();
                 $has_perm = false;
             }
         }
 
         if ($has_perm) {
             $has_perm = $this->rbacsystem->checkAccess($a_perm, (int) $this->ref_id);
         }
 
         if (!$has_perm) {
             if ($a_throw_exc) {
                 throw new ilObjectException($this->lng->txt('sty_permission_denied'));
             }
             return false;
         }
         return true;
     }

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

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

References Vendor\Package\$e, checkPermission(), ILIAS\Repository\ctrl(), ilSystemStyleDocumentationGUI\DATA_PATH, executeDefaultCommand(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), setUnderworldTabs(), setUnderworldTitle(), ilSystemStyleDocumentationGUI\SHOW_TREE, ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), ilSystemStyleMessage\TYPE_ERROR, ILIAS\Repository\upload(), and ILIAS\Repository\user().

                                     : void
     {
         $next_class = $this->ctrl->getNextClass($this);
 
         $this->help->setScreenIdComponent('sty');
         $this->help->setScreenId('system_styles');
 
         $config = new ilSystemStyleConfig();
         $skin_factory = new ilSkinFactory($this->lng);
 
         if ($this->request_wrapper->query()->has('skin_id') && $this->request_wrapper->query()->has('style_id')) {
             $skin_id = $this->request_wrapper->query()->retrieve('skin_id', $this->refinery->kindlyTo()->string());
             $style_id = $this->request_wrapper->query()->retrieve('style_id', $this->refinery->kindlyTo()->string());
         } else {
             $skin_id = $config->getDefaultSkinId();
             $style_id = $config->getDefaultStyleId();
         }
 
         $this->ctrl->setParameterByClass(ilSystemStyleConfigGUI::class, 'skin_id', $skin_id);
         $this->ctrl->setParameterByClass(ilSystemStyleConfigGUI::class, 'style_id', $style_id);
         $this->ctrl->setParameterByClass(ilSystemStyleScssGUI::class, 'skin_id', $skin_id);
         $this->ctrl->setParameterByClass(ilSystemStyleScssGUI::class, 'style_id', $style_id);
         $this->ctrl->setParameterByClass(ilSystemStyleIconsGUI::class, 'skin_id', $skin_id);
         $this->ctrl->setParameterByClass(ilSystemStyleIconsGUI::class, 'style_id', $style_id);
         $this->ctrl->setParameterByClass(ilSystemStyleDocumentationGUI::class, 'skin_id', $skin_id);
         $this->ctrl->setParameterByClass(ilSystemStyleDocumentationGUI::class, 'style_id', $style_id);
 
         try {
             switch ($next_class) {
                 case strtolower(ilSystemStyleConfigGUI::class):
                     $this->help->setSubScreenId('settings');
                     $this->checkPermission('sty_management');
                     $this->setUnderworldTabs($skin_id, 'settings');
                     $this->setUnderworldTitle($skin_id, $style_id);
                     $system_styles_settings = new ilSystemStyleConfigGUI(
                         $this->ctrl,
                         $this->lng,
                         $this->tpl,
                         $this->tabs,
                         $this->ui_factory,
                         $this->renderer,
                         $skin_factory,
                         $this->request_wrapper,
                         $this->refinery,
                         $this->toolbar,
                         $this->user,
                         $this->request,
                         $this->tree,
                         $skin_id,
                         $style_id
                     );
                     $this->ctrl->forwardCommand($system_styles_settings);
                     break;
                 case strtolower(ilSystemStyleScssGUI::class):
                     $this->help->setSubScreenId('scss');
                     $this->checkPermission('sty_management');
                     $this->setUnderworldTabs($skin_id, 'scss');
                     $this->setUnderworldTitle($skin_id, $style_id);
                     $system_styles_scss = new ilSystemStyleScssGUI(
                         $this->ctrl,
                         $this->lng,
                         $this->tpl,
                         $this->ui_factory,
                         $this->renderer,
                         $this->request,
                         $this->toolbar,
                         $this->refinery,
                         $skin_factory,
                         $skin_id,
                         $style_id
                     );
                     $this->ctrl->forwardCommand($system_styles_scss);
                     break;
                 case strtolower(ilSystemStyleIconsGUI::class):
                     $this->help->setSubScreenId('icons');
                     $this->checkPermission('sty_management');
                     $this->setUnderworldTabs($skin_id, 'icons');
                     $this->setUnderworldTitle($skin_id, $style_id);
                     $system_styles_icons = new ilSystemStyleIconsGUI(
                         $this->ctrl,
                         $this->lng,
                         $this->tpl,
                         $this->ui_factory,
                         $this->renderer,
                         $this->request_wrapper,
                         $this->toolbar,
                         $this->refinery,
                         $skin_factory,
                         $this->tabs,
                         $this->upload,
                         $skin_id,
                         $style_id
                     );
                     $this->ctrl->forwardCommand($system_styles_icons);
                     break;
                 case strtolower(ilSystemStyleDocumentationGUI::class):
                     $this->help->setSubScreenId('documentation');
                     $read_only = !$this->checkPermission('sty_management', false);
                     $this->setUnderworldTabs($skin_id, 'documentation', $read_only);
                     $this->setUnderworldTitle($skin_id, $style_id, $read_only);
                     $node_id = '';
                     if ($this->request_wrapper->query()->has('node_id')) {
                         $node_id = $this->request_wrapper->query()->retrieve(
                             'node_id',
                             $this->refinery->kindlyTo()->string()
                         );
                     }
                     $goto_link = (new ilKSDocumentationGotoLink())->generateGotoLink($node_id, $skin_id, $style_id);
                     $this->global_screen->tool()->context()->current()->addAdditionalData(
                         ilSystemStyleDocumentationGUI::SHOW_TREE,
                         true
                     );
                     $this->tpl->setPermanentLink('stys', (int) $this->ref_id, $goto_link);
                     $entries = new Entries();
                     $entries->addEntriesFromArray(include ilSystemStyleDocumentationGUI::DATA_PATH);
                     $documentation_gui = new ilSystemStyleDocumentationGUI(
                         $this->tpl,
                         $this->ctrl,
                         $this->ui_factory,
                         $this->renderer
                     );
                     $documentation_gui->show($entries, $node_id);
                     break;
                 case strtolower(ilSystemStyleOverviewGUI::class):
                 default:
                     $this->executeDefaultCommand($skin_factory, $skin_id, $style_id);
                     break;
             }
         } catch (ilObjectException $e) {
             $this->message_stack->addMessage(new ilSystemStyleMessage(
                 $e->getMessage(),
                 ilSystemStyleMessage::TYPE_ERROR
             ));
             $this->message_stack->sendMessages();
             $this->executeDefaultCommand($skin_factory, $skin_id, $style_id);
         }
     }

Here is the call graph for this function:

◆ executeDefaultCommand()

ilSystemStyleMainGUI::executeDefaultCommand	(	ilSkinFactory	$skin_factory,
		string	$skin_id,
		string	$style_id
	)

protected

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

References checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\upload().

Referenced by executeCommand().

                                                                                                             : void
     {
         $this->help->setSubScreenId('overview');
         $this->checkPermission('visible,read');
         $read_only = !$this->checkPermission('sty_write_system', false);
         $management_enabled = $this->checkPermission('sty_management', false);
         $system_styles_overview = new ilSystemStyleOverviewGUI(
             $this->ctrl,
             $this->lng,
             $this->tpl,
             $this->ui_factory,
             $this->renderer,
             $this->request_wrapper,
             $this->toolbar,
             $this->refinery,
             $skin_factory,
             $this->upload,
             $this->tabs,
             $this->help,
             $skin_id,
             $style_id,
             $this->ref_id,
             $read_only,
             $management_enabled
         );
 
         $this->ctrl->forwardCommand($system_styles_overview);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUnderworldTabs()

ilSystemStyleMainGUI::setUnderworldTabs	(	string	$sking_id,
		string	$active = `''`,
		bool	$read_only = `false`
	)

protected

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

Exceptions

ilCtrlException

Since clearTargets also clears the help screen ids

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

                                                                                                         : void
     {
         $this->tabs->clearTargets();
 
         if ($read_only) {
             $this->locator->clearItems();
             $this->tpl->setLocator();
             return;
         }
 
         $this->help->setScreenIdComponent('sty');
         $this->help->setScreenId('system_styles');
         $this->tabs->setBackTarget($this->lng->txt('back'), $this->ctrl->getLinkTarget($this));
         $config = new ilSystemStyleConfig();
         if ($sking_id != $config->getDefaultSkinId()) {
             $this->tabs->addTab(
                 'settings',
                 $this->lng->txt('settings'),
                 $this->ctrl->getLinkTargetByClass('ilsystemstyleconfiggui')
             );
             $this->tabs->addTab(
                 'scss',
                 $this->lng->txt('scss'),
                 $this->ctrl->getLinkTargetByClass('ilsystemstylescssgui')
             );
             $this->tabs->addTab(
                 'icons',
                 $this->lng->txt('icons'),
                 $this->ctrl->getLinkTargetByClass('ilsystemstyleiconsgui')
             );
         }
 
         $this->tabs->addTab(
             'documentation',
             $this->lng->txt('documentation'),
             $this->ctrl->getLinkTargetByClass(ilSystemStyleDocumentationGUI::class)
         );
 
         $this->tabs->activateTab($active);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUnderworldTitle()

ilSystemStyleMainGUI::setUnderworldTitle	(	string	$skin_id,
		string	$style_id,
		bool	$read_only = `false`
	)

protected

Sets title correctly if one system style is opened.

Exceptions

ilSystemStyleException

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

References ILIAS\Repository\lng().

Referenced by executeCommand().

                                                                                                      : void
     {
         $skin = $this->skin_factory->skinStyleContainerFromId($skin_id, $this->message_stack)->getSkin();
         $style = $skin->getStyle($style_id);
 
         if ($read_only) {
             $this->tpl->setTitle($this->lng->txt('documentation'));
 
             if ($style->isSubstyle()) {
                 $this->tpl->setDescription(
                     $this->lng->txt('ks_documentation_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('ks_documentation_of_style') . " '" . $style->getName() . "' " .
                     $this->lng->txt('from_skin') . " '" . $skin->getName() . "'"
                 );
             }
         } else {
             $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() . "'"
                 );
             }
         }
     }