ilStyleDefinition acts as a wrapper of style related actions. More...

Collaboration diagram for ilStyleDefinition:

Public Member Functions
	__construct ($skin_id="", ilSystemStyleConfig $system_style_config=null)
	ilStyleDefinition constructor. More...

	getStyles ()

	getTemplateName ()

	getStyle ($a_id)

	getStyleName ($a_id)

	getImageDirectory ($style_id)

	getSoundDirectory ($style_id)

	getSkin ()

	setSkin ($skin)

	getSystemStylesConf ()

	setSystemStylesConf ($system_style_config)

Static Public Member Functions
static	getCurrentSkin ()
	get the current skin More...

static	getAllTemplates ()

static	skinExists ($skin_id, ilSystemStyleConfig $system_style_config=null)
	Check whether a skin exists. More...

static	getCurrentStyle ()
	get the current style or sub style More...

static	getAllSkinStyles ()
	Get all skins/styles as array (convenient for tables) Attention: tempalte_name/template_id in this array is only used for legacy reasons an might be removed in future. More...

static	setCurrentSkin ($a_skin)

static	styleExists ($style_id)

static	styleExistsForSkinId ($skin_id, $style_id)

static	styleExistsForCurrentSkin ($style_id)

static	setCurrentStyle ($a_style)

static	getSkins ()

static	setSkins ($skins)

Static Public Attributes
static	$current_style = false

static	$skins = []

Static Protected Member Functions
static	getCachedAllStylesInformation ()

static	setCachedAllStylesInformation ($cached_all_styles_information)

Protected Attributes
	$skin

	$system_style_config

Static Protected Attributes
static	$cached_all_styles_information = null

Detailed Description

ilStyleDefinition acts as a wrapper of style related actions.

Use this class to get the systems current style. Currently some of the logic is not clearly separated from ilSystemStyleSettings. This is due to legacy reasons. In a future refactoring, this class might be completely merged with ilSystemStyleSettings.

The following terminology is used:

(system) style: A style that can be set as system style for the complete ILIAS installations. This includes, less css, fonts, icons and sounds as well as possible html tpl files to overide ILIAS templates. (stystem) sub style: A sub style can be assigned to exactly one system style to be displayed for a set of categories. skin: A skin can hold multiple style. A skin is defined by it's folder carrying the name of the skin and the template.xml in this exact folder, listing the skins styles and substyles. Mostly a skin caries exactly one style. Through the GUI in the administration it is not possible to define multiple style per skin. It is however possible to define multiple sub styles for one style stored in one skin. template: The template is the xml file of the skin storing the skin styles and sub styles information.

Skins, styles ans stub styles are always used globally (not client specific).

This class is currently also used as global $styleDefinition.

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 42 of file class.ilStyleDefinition.php.

Constructor & Destructor Documentation

◆ __construct()

ilStyleDefinition::__construct	(		$skin_id = `""`,
		ilSystemStyleConfig	$system_style_config = `null`
	)

ilStyleDefinition constructor.

Parameters

string	$skin_id
ilSystemStyleConfig \| null	$system_style_config

Exceptions

ilSystemStyleException

Definition at line 84 of file class.ilStyleDefinition.php.

References $system_style_config, getSystemStylesConf(), setSkin(), and setSystemStylesConf().

     {
         if ($skin_id == "") {
             $skin_id = self::getCurrentSkin();
         }
 
         if (!$system_style_config) {
             $this->setSystemStylesConf(new ilSystemStyleConfig());
         } else {
             $this->setSystemStylesConf($system_style_config);
         }
 
         if ($skin_id != $this->getSystemStylesConf()->getDefaultSkinId()) {
             $this->setSkin(ilSkinXML::parseFromXML($this->getSystemStylesConf()->getCustomizingSkinPath() . $skin_id . "/template.xml"));
         } else {
             $this->setSkin(ilSkinXML::parseFromXML($this->getSystemStylesConf()->getDefaultTemplatePath()));
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAllSkinStyles()

static ilStyleDefinition::getAllSkinStyles ( )

static

Get all skins/styles as array (convenient for tables) Attention: tempalte_name/template_id in this array is only used for legacy reasons an might be removed in future.

Returns: array|null

Exceptions

ilSystemStyleException

Definition at line 348 of file class.ilStyleDefinition.php.

References $DIC, $skin, $skins, $style, and ilObjUser\_getNumberOfUsersForStyle().

Referenced by ilSystemStyleOverviewGUI\addSubStyleForms(), ilSystemStyleOverviewGUI\checkStyleSettings(), ilSystemStyleOverviewGUI\cloneSystemStyleForm(), ilSystemStyleOverviewGUI\edit(), ilSystemStylesTableGUI\getStyles(), and ilSystemStyleOverviewGUI\saveStyleSettings().

     {
         global $DIC;
 
         if (!self::getCachedAllStylesInformation()) {
             $all_styles = [];
 
             $skins = $DIC->systemStyle()->getSkins();
 
             foreach ($skins as $skin) {
                 foreach ($skin->getStyles() as $style) {
                     $num_users = ilObjUser::_getNumberOfUsersForStyle($skin->getId(), $style->getId());
 
                     $parent_name = "";
                     if ($style->getSubstyleOf()) {
                         $parent_name = $skin->getStyle($style->getSubstyleOf())->getName();
                     }
 
                     // default selection list
                     $all_styles[$skin->getId() . ":" . $style->getId()] = [
                                     "title" => $skin->getName() . " / " . $style->getName(),
                                     "id" => $skin->getId() . ":" . $style->getId(),
                                     "skin_id" => $skin->getId(),
                                     "skin_name" => $skin->getName(),
                                     "template_id" => $skin->getId(),
                                     "template_name" => $skin->getName(),
                                     "style_id" => $style->getId(),
                                     "style_name" => $style->getName(),
                                     "substyle_of" => $style->getSubstyleOf(),
                                     "substyle_of_name" => $parent_name,
                                     "users" => $num_users
                             ];
                 }
             }
             self::setCachedAllStylesInformation($all_styles);
         }
 
         return self::getCachedAllStylesInformation();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllTemplates()

static ilStyleDefinition::getAllTemplates ( )

static

Deprecated:: due to bad naming.

Returns: ilSkinXML[]

Exceptions

ilSystemStyleException

Definition at line 245 of file class.ilStyleDefinition.php.

     {
         return self::getAllSkins();
     }

◆ getCachedAllStylesInformation()

static ilStyleDefinition::getCachedAllStylesInformation ( )

staticprotected

Returns: array|null

Definition at line 491 of file class.ilStyleDefinition.php.

     {
         return self::$cached_all_styles_information;
     }

◆ getCurrentSkin()

static ilStyleDefinition::getCurrentSkin ( )

static

get the current skin

use always this function instead of getting the account's skin the current skin may be changed on the fly by setCurrentSkin()

Returns: string|null skin id

Definition at line 111 of file class.ilStyleDefinition.php.

References $DIC, and ilUtil\sendFailure().

Referenced by ilUtil\getImagePath(), ilUtil\getJSLocation(), ilUtil\getNewContentStyleSheetLocation(), ilUtil\getStyleSheetLocation(), ilTestPDFGenerator\getTemplatePath(), and ilTemplate\getTemplatePath().

     {
         global $DIC;
 
         if (!$DIC) {
             return null;
         }
         if ($DIC->isDependencyAvailable("systemStyle") && is_object($DIC->systemStyle()->getSkin())) {
             return $DIC->systemStyle()->getSkin()->getId();
         } else {
             $system_style_conf = new ilSystemStyleConfig();
 
             if ($DIC->isDependencyAvailable("user") && is_object($DIC->user()) && property_exists($DIC->user(), "skin")) {
                 $skin_id = $DIC->user()->skin;
                 if (!self::skinExists($skin_id)) {
                     ilUtil::sendFailure($DIC->language()->txt("set_skin_does_not_exist") . " " . $skin_id);
                     $skin_id = $system_style_conf->getDefaultSkinId();
                 }
                 return $skin_id;
             } else {
                 return null;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentStyle()

static ilStyleDefinition::getCurrentStyle ( )

static

get the current style or sub style

use always this function instead of getting the account's style the current style may be changed on the fly by setCurrentStyle()

Returns: bool|null

Exceptions

ilSystemStyleException

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

References $_GET, $DIC, $i, $path, $system_style_config, $target_arr, ilSystemStyleSettings\getSystemStyleCategoryAssignments(), and ilUtil\sendFailure().

Referenced by ilUtil\getImagePath(), ilUtil\getNewContentStyleSheetLocation(), ilUtil\getStyleSheetLocation(), and ilTemplate\getTemplatePath().

     {
         global $DIC;
         
         if (self::$current_style) {
             return self::$current_style;
         }
 
         if (!$DIC || !$DIC->isDependencyAvailable("user")) {
             return null;
         }
 
         self::setCurrentStyle($DIC->user()->prefs['style']);
 
         if ($DIC->isDependencyAvailable("systemStyle") && self::styleExistsForCurrentSkin(self::$current_style)) {
             if ($DIC->systemStyle()->getSkin()->hasStyleSubstyles(self::$current_style)) {
                 // read assignments, if given
                 $assignments = ilSystemStyleSettings::getSystemStyleCategoryAssignments(self::getCurrentSkin(), self::$current_style);
                 if (count($assignments) > 0) {
                     $ref_ass = [];
                     foreach ($assignments as $a) {
                         if ($DIC->systemStyle()->getSkin()->hasStyle($a["substyle"])) {
                             $ref_ass[$a["ref_id"]] = $a["substyle"];
                         }
                     }
 
                     $ref_id = false;
                     if ($_GET["ref_id"]) {
                         $ref_id = $_GET["ref_id"];
                     } elseif ($_GET["target"]) {
                         $target_arr = explode("_", $_GET["target"]);
                         $ref_id = $target_arr[1];
                     }
 
                     // check whether any ref id assigns a new style
                     if ($DIC->isDependencyAvailable("repositoryTree") && $ref_id && $DIC->repositoryTree()->isInTree($ref_id)) {
                         $path = $DIC->repositoryTree()->getPathId($ref_id);
                         for ($i = count($path) - 1; $i >= 0; $i--) {
                             if (isset($ref_ass[$path[$i]])) {
                                 self::$current_style = $ref_ass[$path[$i]];
                                 return self::$current_style;
                             }
                         }
                     }
                 }
             }
         }
 
         if (!self::styleExistsForCurrentSkin(self::$current_style)) {
             ilUtil::sendFailure($DIC->language()->txt("set_style_does_not_exist") . " " . self::$current_style);
             $system_style_config = new ilSystemStyleConfig();
             self::setCurrentSkin($system_style_config->getDefaultSkinId());
             self::setCurrentStyle($system_style_config->getDefaultStyleId());
         }
 
         return self::$current_style;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImageDirectory()

ilStyleDefinition::getImageDirectory ( $style_id )

Parameters

$style_id

Returns: string

Exceptions

ilSystemStyleException

Definition at line 179 of file class.ilStyleDefinition.php.

References getSkin(), getStyle(), ilSystemStyleException\NO_STYLE_ID, and ilSystemStyleException\NOT_EXISTING_STYLE.

     {
         if (!$style_id) {
             throw new ilSystemStyleException(ilSystemStyleException::NO_STYLE_ID, $style_id);
         }
         if (!$this->getSkin()->getStyle($style_id)) {
             throw new ilSystemStyleException(ilSystemStyleException::NOT_EXISTING_STYLE, $style_id);
         }
         return $this->getSkin()->getStyle($style_id)->getImageDirectory();
     }

Here is the call graph for this function:

◆ getSkin()

ilStyleDefinition::getSkin ( )

Returns: ilSkinXML

Definition at line 475 of file class.ilStyleDefinition.php.

References $skin.

Referenced by getImageDirectory(), getSoundDirectory(), getStyle(), getStyleName(), getStyles(), and getTemplateName().

     {
         return $this->skin;
     }

Here is the caller graph for this function:

◆ getSkins()

static ilStyleDefinition::getSkins ( )

static

Returns: ilSkinXML[]

Exceptions

ilSystemStyleException

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

Referenced by ilUtil\getStyleSheetLocation().

     {
         return self::getAllSkins();
     }

Here is the caller graph for this function:

◆ getSoundDirectory()

ilStyleDefinition::getSoundDirectory ( $style_id )

Parameters

$style_id

Returns: string

Exceptions

ilSystemStyleException

Definition at line 195 of file class.ilStyleDefinition.php.

References $skin, $skins, $system_style_config, and getSkin().

     {
         return $this->getSkin()->getStyle($style_id)->getSoundDirectory();
     }

Here is the call graph for this function:

◆ getStyle()

ilStyleDefinition::getStyle ( $a_id )

Parameters

$a_id

Returns: ilSkinStyleXML

Exceptions

ilSystemStyleException

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

References getSkin().

Referenced by getImageDirectory().

     {
         return $this->getSkin()->getStyle($a_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStyleName()

ilStyleDefinition::getStyleName ( $a_id )

Parameters

$a_id

Returns: string

Exceptions

ilSystemStyleException

Definition at line 169 of file class.ilStyleDefinition.php.

References getSkin().

     {
         return $this->getSkin()->getStyle($a_id)->getName();
     }

Here is the call graph for this function:

◆ getStyles()

ilStyleDefinition::getStyles ( )

Returns: ilSkinStyleXML[]

Definition at line 139 of file class.ilStyleDefinition.php.

References getSkin().

     {
         return $this->getSkin()->getStyles();
     }

Here is the call graph for this function:

◆ getSystemStylesConf()

ilStyleDefinition::getSystemStylesConf ( )

Returns: ilSystemStyleConfig

Definition at line 507 of file class.ilStyleDefinition.php.

References $system_style_config.

Referenced by __construct().

     {
         return $this->system_style_config;
     }

Here is the caller graph for this function:

◆ getTemplateName()

ilStyleDefinition::getTemplateName ( )

Returns: string

Definition at line 148 of file class.ilStyleDefinition.php.

References getSkin().

     {
         return $this->getSkin()->getName();
     }

Here is the call graph for this function:

◆ setCachedAllStylesInformation()

static ilStyleDefinition::setCachedAllStylesInformation ( $cached_all_styles_information )

staticprotected

Parameters

array | null $cached_all_styles_information

Definition at line 499 of file class.ilStyleDefinition.php.

References $cached_all_styles_information.

     {
         self::$cached_all_styles_information = $cached_all_styles_information;
     }

◆ setCurrentSkin()

static ilStyleDefinition::setCurrentSkin ( $a_skin )

static

Parameters

$a_skin

Exceptions

ilSystemStyleException

Definition at line 393 of file class.ilStyleDefinition.php.

References $DIC.

     {
         global $DIC;
 
         if ($DIC->isDependencyAvailable("systemStyle") && $DIC->systemStyle()->getSkin()->getName() != $a_skin) {
             $styleDefinition = new ilStyleDefinition($a_skin);
             if (!self::styleExistsForCurrentSkin(self::$current_style)) {
                 $styleDefinition->setCurrentStyle($DIC->systemStyle()->getSkin()->getDefaultStyle()->getId());
             }
         }
     }

◆ setCurrentStyle()

static ilStyleDefinition::setCurrentStyle ( $a_style )

static

Parameters

$a_style

Definition at line 450 of file class.ilStyleDefinition.php.

     {
         self::$current_style = $a_style;
     }

◆ setSkin()

ilStyleDefinition::setSkin ( $skin )

Parameters

ilSkinXML $skin

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

References $skin.

Referenced by __construct().

     {
         $this->skin = $skin;
     }

Here is the caller graph for this function:

◆ setSkins()

static ilStyleDefinition::setSkins ( $skins )

static

Parameters

ilSkinXML[] $skins

Definition at line 467 of file class.ilStyleDefinition.php.

References $skins.

     {
         self::$skins = $skins;
     }

◆ setSystemStylesConf()

ilStyleDefinition::setSystemStylesConf ( $system_style_config )

Parameters

$system_style_config

Definition at line 515 of file class.ilStyleDefinition.php.

References $system_style_config.

Referenced by __construct().

     {
         $this->system_style_config = $system_style_config;
     }

Here is the caller graph for this function:

◆ skinExists()

static ilStyleDefinition::skinExists	(		$skin_id,
		ilSystemStyleConfig	$system_style_config = `null`
	)

static

Check whether a skin exists.

Not using array_key_exists($skin_id,self::getAllSkins()); for performance reasons

Parameters

string	$skin_id
ilSystemStyleConfig \| null	$system_style_config

Returns: bool

Definition at line 256 of file class.ilStyleDefinition.php.

References $system_style_config.

Referenced by ilSystemStyleSkinContainer\copy(), ilSystemStyleSettings\getCurrentDefaultSkin(), ilSystemStyleSkinContainer\import(), ilObjUser\read(), and ilSystemStyleOverviewGUI\saveNewSystemStyle().

     {
         if (!$system_style_config) {
             $system_style_config = new ilSystemStyleConfig();
         }
 
         if ($skin_id == $system_style_config->getDefaultSkinId()) {
             if (is_file($system_style_config->getDefaultTemplatePath())) {
                 return true;
             }
         } else {
             if (is_file($system_style_config->getCustomizingSkinPath() . $skin_id . "/template.xml")) {
                 return true;
             }
         }
         return false;
     }

Here is the caller graph for this function:

◆ styleExists()

static ilStyleDefinition::styleExists ( $style_id )

static

Parameters

$style_id

Returns: bool

Exceptions

ilSystemStyleException

Definition at line 411 of file class.ilStyleDefinition.php.

References $skin.

Referenced by ilSystemStylesTableGUI\getStyles(), and ilSystemStyleOverviewGUI\moveUserStyles().

     {
         foreach (self::getSkins() as $skin) {
             if ($skin->hasStyle($style_id)) {
                 return true;
             }
         }
         return false;
     }

Here is the caller graph for this function:

◆ styleExistsForCurrentSkin()

static ilStyleDefinition::styleExistsForCurrentSkin ( $style_id )

static

Parameters

$style_id

Returns: bool

Definition at line 440 of file class.ilStyleDefinition.php.

References $DIC.

     {
         global $DIC;
 
         return $DIC->systemStyle()->getSkin()->hasStyle($style_id);
     }

◆ styleExistsForSkinId()

static ilStyleDefinition::styleExistsForSkinId	(	$skin_id,
		$style_id
	)

static

Parameters

$skin_id
$style_id

Returns: bool

Exceptions

ilSystemStyleException

Definition at line 427 of file class.ilStyleDefinition.php.

References $skin, and ilSystemStyleSkinContainer\generateFromId().

Referenced by ilSystemStyleSettings\getCurrentDefaultStyle(), and ilObjUser\read().

     {
         if (!self::skinExists($skin_id)) {
             return false;
         }
         $skin = ilSystemStyleSkinContainer::generateFromId($skin_id)->getSkin();
         return $skin->hasStyle($style_id);
     }