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

Collaboration diagram for ilStyleDefinition:

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

	getStyles ()

	getTemplateName ()

	getStyle (string $a_id)

	getStyleName (string $a_id)

	getImageDirectory (string $style_id)

	getSoundDirectory (string $style_id)

	getSkin ()

	setSkin (ilSkin $skin)

	getSystemStylesConf ()

	setSystemStylesConf (ilSystemStyleConfig $system_style_config)

Static Public Member Functions
static	getCurrentSkin ()
	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() More...

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

static	getCurrentStyle ()
	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() 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 (string $a_skin)

static	styleExists (string $style_id)

static	styleExistsForSkinId (string $skin_id, string $style_id)

static	styleExistsForCurrentSkin (string $style_id)

static	setCurrentStyle (string $a_style)

static	getSkins ()

static	setSkins (array $skins)

Static Public Attributes
static string	$current_style
	currently selected style, used for caching More...

static array	$skins = null
	Skins available, used for caching. More...

Static Protected Member Functions
static	getCachedAllStylesInformation ()

static	setCachedAllStylesInformation (array $cached_all_styles_information)

Protected Attributes
ilSkin	$skin
	Sets the current skin. More...

ilSystemStyleConfig	$system_style_config
	Used to wire this component up with the correct paths into the customizing directory. More...

ilSkinFactory	$skin_factory

Static Protected Attributes
static array	$cached_all_styles_information
	Used for caching. More...

Detailed Description

ilStyleDefinition acts as a wrapper of style related actions.

See Readme for Details.

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

Constructor & Destructor Documentation

◆ __construct()

ilStyleDefinition::__construct	(	string	$skin_id = `''`,
		?ilSystemStyleConfig	$system_style_config = `null`
	)

ilStyleDefinition constructor.

Exceptions

ilSystemStyleException

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

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

     {
         global $DIC;
 
         if ($skin_id == '') {
             $skin_id = self::getCurrentSkin();
         }
 
         if (!$system_style_config) {
             $this->setSystemStylesConf(new ilSystemStyleConfig());
         } else {
             $this->setSystemStylesConf($system_style_config);
         }
 
         $this->skin_factory = new ilSkinFactory($DIC->language(), $this->getSystemStylesConf());
 
         if ($skin_id != $this->getSystemStylesConf()->getDefaultSkinId()) {
             $this->setSkin($this->skin_factory->skinFromXML($this->getSystemStylesConf()->getCustomizingSkinPath() . $skin_id . '/template.xml'));
         } else {
             $this->setSkin($this->skin_factory->skinFromXML($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.

Exceptions

ilSystemStyleException

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

References $DIC, $version, and ilObjUser\_getNumberOfUsersForStyle().

Referenced by ilSystemStyleOverviewGUI\checkStyleSettings(), ilSystemStyleOverviewGUI\getAssignmentCreationModal(), ilSystemStylesTableGUI\getStyles(), and ilSystemStyleOverviewGUI\saveStyleSettings().

                                              : ?array
     {
         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();
                     }
 
                     $version = $skin->getVersion();
                     if ($version == '$Id$') {
                         $version = '-';
                     }
                     // 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,
                         'version' => $version,
                     ];
                 }
             }
             self::setCachedAllStylesInformation($all_styles);
         }
 
         return self::getCachedAllStylesInformation();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCachedAllStylesInformation()

static ilStyleDefinition::getCachedAllStylesInformation ( )

staticprotected

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

References null.

                                                              : ?array
     {
         if (!isset(self::$cached_all_styles_information)) {
             return null;
         }
         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()

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

References $DIC, $messages, null, and ilSystemStyleMessage\TYPE_ERROR.

Referenced by ilTemplate\getCurrentSkin(), ilUtil\getImagePath(), ilUtil\getNewContentStyleSheetLocation(), ilUtil\getStyleSheetLocation(), ilTestHTMLGenerator\getTemplatePath(), and ilImagePathResolver\resolveImagePath().

                                            : ?string
     {
         global $DIC;
 
         if (!$DIC || is_array($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 ($skin_id && !self::skinExists($skin_id)) {
                     if($DIC->isDependencyAvailable('systemStyle')) {
                         $messages = new ilSystemStyleMessageStack($DIC->ui()->mainTemplate());
                         $message_text = $DIC->language()->txt('set_skin_does_not_exist') . ' ' . $skin_id;
                         $messages->addMessage(new ilSystemStyleMessage($message_text, ilSystemStyleMessage::TYPE_ERROR));
                         $messages->sendMessages();
                     }
                     $skin_id = $system_style_conf->getDefaultSkinId();
                 }
                 return $skin_id === '' ? $system_style_conf->getDefaultSkinId() : $skin_id;
             } else {
                 return null;
             }
         }
     }

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()

Exceptions

ilSystemStyleException

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

References Vendor\Package\$a, $DIC, $messages, $path, $ref_id, ilSystemStyleConfig\getDefaultSkinId(), ilSystemStyleConfig\getDefaultStyleId(), ilSystemStyleSettings\getSystemStyleCategoryAssignments(), null, and ilSystemStyleMessage\TYPE_ERROR.

Referenced by ilTemplate\getCurrentStyle(), ilUtil\getImagePath(), ilUtil\getNewContentStyleSheetLocation(), ilUtil\getStyleSheetLocation(), and ilImagePathResolver\resolveImagePath().

                                             : ?string
     {
         global $DIC;
 
         if (isset(self::$current_style)) {
             return self::$current_style;
         }
 
         if (!$DIC || is_array($DIC) || !$DIC->isDependencyAvailable('user')) {
             return null;
         }
 
         if (array_key_exists('style', $DIC->user()->prefs) && $DIC->user()->prefs['style']) {
             self::setCurrentStyle($DIC->user()->prefs['style']);
         } else {
             $system_style_config = new ilSystemStyleConfig();
             self::setCurrentStyle($system_style_config->getDefaultStyleId());
         }
 
         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 = '';
 
                     if ($DIC->http()->wrapper()->query()->has('ref_id')) {
                         $ref_id = $DIC->http()->wrapper()->query()->retrieve(
                             'ref_id',
                             $DIC->refinery()->kindlyTo()->string()
                         );
                     } elseif ($DIC->http()->wrapper()->query()->has('target')) {
                         $target = $DIC->http()->wrapper()->query()->retrieve(
                             'target',
                             $DIC->refinery()->kindlyTo()->string()
                         );
                         $target_arr = explode('_', $target);
                         $ref_id = $target_arr[1] ?? '';
                     }
 
                     // check whether any ref id assigns a new style
                     if ($DIC->isDependencyAvailable('repositoryTree') && $ref_id && $DIC->repositoryTree()->isInTree((int) $ref_id)) {
                         $path = $DIC->repositoryTree()->getPathId((int) $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 ($DIC->isDependencyAvailable('systemStyle') && !self::styleExistsForCurrentSkin(self::$current_style)) {
             $messages = new ilSystemStyleMessageStack($DIC->ui()->mainTemplate());
             $message_text = $DIC->language()->txt('set_style_does_not_exist') . ' ' . self::$current_style;
             $messages->addMessage(new ilSystemStyleMessage($message_text, ilSystemStyleMessage::TYPE_ERROR));
             $messages->sendMessages();
             $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 ( string $style_id )

Exceptions

ilSystemStyleException

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

References Vendor\Package\$e, getSkin(), ilSystemStyleException\NO_STYLE_ID, and ilSystemStyleException\NOT_EXISTING_STYLE.

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

Here is the call graph for this function:

◆ getSkin()

ilStyleDefinition::getSkin ( )

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

References $skin.

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

                              : ilSkin
     {
         return $this->skin;
     }

Here is the caller graph for this function:

◆ getSkins()

static ilStyleDefinition::getSkins ( )

static

Returns: ilSkin[]

Exceptions

ilSystemStyleException

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

Referenced by ilUtil\getStyleSheetLocation().

                                      : array
     {
         return self::getAllSkins();
     }

Here is the caller graph for this function:

◆ getSoundDirectory()

ilStyleDefinition::getSoundDirectory ( string $style_id )

Exceptions

ilSystemStyleException

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

References $DIC, $skin, $system_style_config, ilSystemStyleConfig\getCustomizingSkinPath(), ilSystemStyleConfig\getDefaultSkinId(), ilSystemStyleConfig\getDefaultTemplatePath(), ilSkin\getId(), getSkin(), and null.

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

Here is the call graph for this function:

◆ getStyle()

ilStyleDefinition::getStyle ( string $a_id )

Exceptions

ilSystemStyleException

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

References getSkin().

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

Here is the call graph for this function:

◆ getStyleName()

ilStyleDefinition::getStyleName ( string $a_id )

Exceptions

ilSystemStyleException

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

References getSkin().

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

Here is the call graph for this function:

◆ getStyles()

ilStyleDefinition::getStyles ( )

Returns: ilSkinStyle[]

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

References getSkin().

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

Here is the call graph for this function:

◆ getSystemStylesConf()

ilStyleDefinition::getSystemStylesConf ( )

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

References $system_style_config.

Referenced by __construct().

                                          : ilSystemStyleConfig
     {
         return $this->system_style_config;
     }

Here is the caller graph for this function:

◆ getTemplateName()

ilStyleDefinition::getTemplateName ( )

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

References getSkin().

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

Here is the call graph for this function:

◆ setCachedAllStylesInformation()

static ilStyleDefinition::setCachedAllStylesInformation ( array $cached_all_styles_information )

staticprotected

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

References $cached_all_styles_information.

                                                                                                  : void
     {
         self::$cached_all_styles_information = $cached_all_styles_information;
     }

◆ setCurrentSkin()

static ilStyleDefinition::setCurrentSkin ( string $a_skin )

static

Exceptions

ilSystemStyleException

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

References $DIC.

                                                          : void
     {
         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 ( string $a_style )

static

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

                                                            : void
     {
         self::$current_style = $a_style;
     }

◆ setSkin()

ilStyleDefinition::setSkin ( ilSkin $skin )

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

References $skin.

Referenced by __construct().

                                          : void
     {
         $this->skin = $skin;
     }

Here is the caller graph for this function:

◆ setSkins()

static ilStyleDefinition::setSkins ( array $skins )

static

Parameters

ilSkin[] $skins

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

References $skins.

                                                  : void
     {
         self::$skins = $skins;
     }

◆ setSystemStylesConf()

ilStyleDefinition::setSystemStylesConf ( ilSystemStyleConfig $system_style_config )

Definition at line 465 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	(	string	$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

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

References ilSystemStyleConfig\getCustomizingSkinPath(), ilSystemStyleConfig\getDefaultSkinId(), and ilSystemStyleConfig\getDefaultTemplatePath().

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

                                                                                                         : bool
     {
         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;
             }
         } elseif (is_file($system_style_config->getCustomizingSkinPath() . $skin_id . '/template.xml')) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ styleExists()

static ilStyleDefinition::styleExists ( string $style_id )

static

Exceptions

ilSystemStyleException

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

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

                                                         : bool
     {
         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 ( string $style_id )

static

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

References $DIC.

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

◆ styleExistsForSkinId()

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

static

Exceptions

ilSystemStyleException

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

References $DIC.

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

                                                                                   : bool
     {
         global $DIC;
 
         if (!self::skinExists($skin_id)) {
             return false;
         }
         $factory = new ilSkinFactory($DIC->language());
         $skin = $factory->skinStyleContainerFromId($skin_id, new ilSystemStyleMessageStack($DIC->ui()->mainTemplate()))->getSkin();
         return $skin->hasStyle($style_id);
     }

Here is the caller graph for this function:

Field Documentation

◆ $cached_all_styles_information

array ilStyleDefinition::$cached_all_styles_information

staticprotected

Used for caching.

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

Referenced by setCachedAllStylesInformation().

◆ $current_style

string ilStyleDefinition::$current_style

static

currently selected style, used for caching

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

◆ $skin

ilSkin ilStyleDefinition::$skin

protected

Sets the current skin.

This is used by the global instance of this class.

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

Referenced by getSkin(), getSoundDirectory(), and setSkin().

◆ $skin_factory

ilSkinFactory ilStyleDefinition::$skin_factory

protected

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

◆ $skins

array ilStyleDefinition::$skins = null

static

Skins available, used for caching.

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

Referenced by setSkins().

◆ $system_style_config

ilSystemStyleConfig ilStyleDefinition::$system_style_config

protected

Used to wire this component up with the correct paths into the customizing directory.

This is dynamic and not constant for this class to remain testable

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

Referenced by getSoundDirectory(), getSystemStylesConf(), and setSystemStylesConf().

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

components/ILIAS/Style/System/classes/class.ilStyleDefinition.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAllSkinStyles()

◆ getCachedAllStylesInformation()

◆ getCurrentSkin()

◆ getCurrentStyle()

◆ getImageDirectory()

◆ getSkin()

◆ getSkins()

◆ getSoundDirectory()

◆ getStyle()

◆ getStyleName()

◆ getStyles()

◆ getSystemStylesConf()

◆ getTemplateName()

◆ setCachedAllStylesInformation()

◆ setCurrentSkin()

◆ setCurrentStyle()

◆ setSkin()

◆ setSkins()

◆ setSystemStylesConf()

◆ skinExists()

◆ styleExists()

◆ styleExistsForCurrentSkin()

◆ styleExistsForSkinId()

Field Documentation

◆ $cached_all_styles_information

◆ $current_style

◆ $skin

◆ $skin_factory

◆ $skins

◆ $system_style_config