This class acts as Model for all system styles settings related settings such as activated or default system styles etc, be it in database or inifile. More...

Collaboration diagram for ilSystemStyleSettings:

Static Public Member Functions
static	_lookupActivatedStyle (string $a_skin, string $a_style)
	lookup if a style is activated More...

static	_deactivateStyle (string $a_skin, string $a_style)
	deactivate system style More...

static	_activateStyle (string $a_skin, string $a_style)
	activate system style More...

static	getSystemStyleCategoryAssignments (string $a_skin_id, string $a_style_id)
	Get all system sub styles category assignments. More...

static	getSubStyleCategoryAssignments (string $a_skin_id, string $a_style_id, string $a_sub_style_id)
	Get all system category assignments of exactly one substyle. More...

static	writeSystemStyleCategoryAssignment (string $a_skin_id, string $a_style_id, string $a_substyle, string $a_ref_id)
	Sets a substyle category assignment. More...

static	deleteSystemStyleCategoryAssignment (string $a_skin_id, string $a_style_id, string $a_substyle, string $a_ref_id)
	Deletes all sub style category assignment of a system style. More...

static	deleteSubStyleCategoryAssignments (string $a_skin_id, string $a_style_id, string $a_substyle)
	Delets a sub styles category assignment. More...

static	updateSkinIdAndStyleIDOfSubStyleCategoryAssignments (string $old_skin_id, string $old_style_id, string $new_skin_id, string $new_style_id)
	Updates an assignment, e.g. More...

static	updateSubStyleIdfSubStyleCategoryAssignments (string $old_substyle_id, string $new_substyle_id)
	Updates an assignment, e.g. More...

static	setCurrentUserPrefStyle (string $skin_id, string $style_id)
	Sets a users preferred system skin/style by using the user object. More...

static	getCurrentUserPrefSkin ()
	Gets a users preferred skin by using the user object. More...

static	getCurrentUserPrefStyle ()
	Gets a users preferred style by using the user object. More...

static	setCurrentDefaultStyle (string $skin_id, string $style_id)
	Sets the default style of the system. More...

static	resetDefaultToDelos ()

static	getCurrentDefaultSkin ()
	Gets default Skin of the System. More...

static	getCurrentDefaultStyle ()
	Gets default style of the system. More...

Detailed Description

This class acts as Model for all system styles settings related settings such as activated or default system styles etc, be it in database or inifile.

Do not use this class to get the current system style, use ilStyleDefinition insteaed. Semantics of terms style, sub style, skin, template –> see ilStyleDefinition

Definition at line 27 of file class.ilSystemStyleSettings.php.

Member Function Documentation

◆ _activateStyle()

static ilSystemStyleSettings::_activateStyle	(	string	$a_skin,
		string	$a_style
	)

static

activate system style

Definition at line 69 of file class.ilSystemStyleSettings.php.

References $DIC, and $q.

Referenced by _deactivateStyle(), ilSystemStyleConfigGUI\handleStyleActivation(), and ilSystemStyleOverviewGUI\saveStyleSettings().

                                                                           : void
     {
         global $DIC;
 
         $q = 'DELETE FROM settings_deactivated_s' .
             ' WHERE skin = ' . $DIC->database()->quote($a_skin, 'text') .
             ' AND style = ' . $DIC->database()->quote($a_style, 'text');
 
         $DIC->database()->manipulate($q);
     }

Here is the caller graph for this function:

◆ _deactivateStyle()

static ilSystemStyleSettings::_deactivateStyle	(	string	$a_skin,
		string	$a_style
	)

static

deactivate system style

Definition at line 53 of file class.ilSystemStyleSettings.php.

References $DIC, $q, and _activateStyle().

Referenced by ilSystemStyleConfigGUI\handleStyleActivation(), and ilSystemStyleOverviewGUI\saveStyleSettings().

                                                                             : void
     {
         global $DIC;
 
         ilSystemStyleSettings::_activateStyle($a_skin, $a_style);
         $q = 'INSERT into settings_deactivated_s' .
             ' (skin, style) VALUES ' .
             ' (' . $DIC->database()->quote($a_skin, 'text') . ',' .
             ' ' . $DIC->database()->quote($a_style, 'text') . ')';
 
         $DIC->database()->manipulate($q);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupActivatedStyle()

static ilSystemStyleSettings::_lookupActivatedStyle	(	string	$a_skin,
		string	$a_style
	)

static

lookup if a style is activated

Definition at line 32 of file class.ilSystemStyleSettings.php.

References $DIC, and $q.

Referenced by ilSystemStyleConfigGUI\editSystemStyleForm(), ilSystemStylesTableGUI\fillRow(), ilObjUserGUI\initForm(), and ilPersonalSettingsGUI\initGeneralSettingsForm().

                                                                                  : bool
     {
         global $DIC;
 
         $q = 'SELECT count(*) cnt FROM settings_deactivated_s' .
             ' WHERE skin = ' . $DIC->database()->quote($a_skin, 'text') .
             ' AND style = ' . $DIC->database()->quote($a_style, 'text') . ' ';
 
         $cnt_set = $DIC->database()->query($q);
         $cnt_rec = $DIC->database()->fetchAssoc($cnt_set);
 
         if ($cnt_rec['cnt'] > 0) {
             return false;
         } else {
             return true;
         }
     }

Here is the caller graph for this function:

◆ deleteSubStyleCategoryAssignments()

static ilSystemStyleSettings::deleteSubStyleCategoryAssignments	(	string	$a_skin_id,
		string	$a_style_id,
		string	$a_substyle
	)

static

Delets a sub styles category assignment.

Definition at line 185 of file class.ilSystemStyleSettings.php.

References $DIC.

                                                                                                                        : void
     {
         global $DIC;
 
         $DIC->database()->manipulate('DELETE FROM syst_style_cat WHERE ' .
             ' skin_id = ' . $DIC->database()->quote($a_skin_id, 'text') .
             ' AND style_id = ' . $DIC->database()->quote($a_style_id, 'text') .
             ' AND substyle = ' . $DIC->database()->quote($a_substyle, 'text'));
     }

◆ deleteSystemStyleCategoryAssignment()

static ilSystemStyleSettings::deleteSystemStyleCategoryAssignment	(	string	$a_skin_id,
		string	$a_style_id,
		string	$a_substyle,
		string	$a_ref_id
	)

static

Deletes all sub style category assignment of a system style.

This is used if a system style is deleted completely

Definition at line 167 of file class.ilSystemStyleSettings.php.

References $DIC.

Referenced by ilSubStyleAssignmentGUI\deleteAssignments().

      : void {
         global $DIC;
 
         $DIC->database()->manipulate('DELETE FROM syst_style_cat WHERE ' .
             ' skin_id = ' . $DIC->database()->quote($a_skin_id, 'text') .
             ' AND style_id = ' . $DIC->database()->quote($a_style_id, 'text') .
             ' AND substyle = ' . $DIC->database()->quote($a_substyle, 'text') .
             ' AND category_ref_id = ' . $DIC->database()->quote($a_ref_id, 'integer'));
     }

Here is the caller graph for this function:

◆ getCurrentDefaultSkin()

static ilSystemStyleSettings::getCurrentDefaultSkin ( )

static

Gets default Skin of the System.

Returns: string

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

References $DIC, and ilStyleDefinition\skinExists().

Referenced by ilSystemStyleConfigGUI\editSystemStyleForm(), ilSystemStylesTableGUI\fillRow(), and ilSystemStyleConfigGUI\handleStyleActivation().

                                                   : string
     {
         global $DIC;
 
         $skin_id = $DIC->clientIni()->readVariable('layout', 'skin');
 
         if (!ilStyleDefinition::skinExists($skin_id)) {
             self::resetDefaultToDelos();
             $skin_id = $DIC->clientIni()->readVariable('layout', 'skin');
         }
         return $skin_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentDefaultStyle()

static ilSystemStyleSettings::getCurrentDefaultStyle ( )

static

Gets default style of the system.

Exceptions

ilSystemStyleException

Definition at line 300 of file class.ilSystemStyleSettings.php.

References $DIC, and ilStyleDefinition\styleExistsForSkinId().

Referenced by ilSystemStyleConfigGUI\editSystemStyleForm(), ilSystemStylesTableGUI\fillRow(), and ilSystemStyleConfigGUI\handleStyleActivation().

                                                    : string
     {
         global $DIC;
         $skin_id = $DIC->clientIni()->readVariable('layout', 'skin');
         $style_id = $DIC->clientIni()->readVariable('layout', 'style');
 
         if (!ilStyleDefinition::styleExistsForSkinId($skin_id, $style_id)) {
             self::resetDefaultToDelos();
             $style_id = $DIC->clientIni()->readVariable('layout', 'style');
         }
         return $style_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentUserPrefSkin()

static ilSystemStyleSettings::getCurrentUserPrefSkin ( )

static

Gets a users preferred skin by using the user object.

Definition at line 242 of file class.ilSystemStyleSettings.php.

References $DIC.

Referenced by ilSystemStyleConfigGUI\handleStyleActivation().

                                                    : string
     {
         global $DIC;
 
         return $DIC->user()->getPref('skin');
     }

Here is the caller graph for this function:

◆ getCurrentUserPrefStyle()

static ilSystemStyleSettings::getCurrentUserPrefStyle ( )

static

Gets a users preferred style by using the user object.

Definition at line 252 of file class.ilSystemStyleSettings.php.

References $DIC.

Referenced by ilSystemStyleConfigGUI\handleStyleActivation().

                                                     : string
     {
         global $DIC;
 
         return $DIC->user()->getPref('style');
     }

Here is the caller graph for this function:

◆ getSubStyleCategoryAssignments()

static ilSystemStyleSettings::getSubStyleCategoryAssignments	(	string	$a_skin_id,
		string	$a_style_id,
		string	$a_sub_style_id
	)

static

Get all system category assignments of exactly one substyle.

This is used to check wheter a system sub style is to be used in a particular category.

Definition at line 108 of file class.ilSystemStyleSettings.php.

References $DIC.

Referenced by ilSystemStylesTableGUI\fillRow(), and ilSysStyleCatAssignmentTableGUI\getStyleCatAssignments().

      : array {
         global $DIC;
 
         $assignmnts = [];
 
         $set = $DIC->database()->query(
             'SELECT substyle, category_ref_id FROM syst_style_cat ' .
             ' WHERE skin_id = ' . $DIC->database()->quote($a_skin_id, 'text') .
             ' AND substyle = ' . $DIC->database()->quote($a_sub_style_id, 'text') .
             ' AND style_id = ' . $DIC->database()->quote($a_style_id, 'text')
         );
         while (($rec = $DIC->database()->fetchAssoc($set))) {
             $assignmnts[] = [
                 'substyle' => $rec['substyle'],
                 'ref_id' => $rec['category_ref_id']
             ];
         }
         return $assignmnts;
     }

Here is the caller graph for this function:

◆ getSystemStyleCategoryAssignments()

static ilSystemStyleSettings::getSystemStyleCategoryAssignments	(	string	$a_skin_id,
		string	$a_style_id
	)

static

Get all system sub styles category assignments.

This is used to check wheter a system sub style is to be used in a particular category.

Returns: array ('substyle' => substyle_id, 'ref id' => cat_ref_id)

Definition at line 85 of file class.ilSystemStyleSettings.php.

References $DIC.

Referenced by ilStyleDefinition\getCurrentStyle().

                                                                                                    : array
     {
         global $DIC;
 
         $assignments = [];
         $set = $DIC->database()->query(
             'SELECT substyle, category_ref_id FROM syst_style_cat ' .
             ' WHERE skin_id = ' . $DIC->database()->quote($a_skin_id, 'text') .
             ' AND style_id = ' . $DIC->database()->quote($a_style_id, 'text')
         );
         while (($rec = $DIC->database()->fetchAssoc($set))) {
             $assignments[] = [
                 'substyle' => $rec['substyle'],
                 'ref_id' => $rec['category_ref_id']
             ];
         }
         return $assignments;
     }

Here is the caller graph for this function:

◆ resetDefaultToDelos()

static ilSystemStyleSettings::resetDefaultToDelos ( )

static

Definition at line 272 of file class.ilSystemStyleSettings.php.

                                                 : void
     {
         $system_style_conf = new ilSystemStyleConfig();
 
         self::setCurrentDefaultStyle($system_style_conf->getDefaultSkinId(), $system_style_conf->getDefaultSkinId());
     }

◆ setCurrentDefaultStyle()

static ilSystemStyleSettings::setCurrentDefaultStyle	(	string	$skin_id,
		string	$style_id
	)

static

Sets the default style of the system.

Definition at line 262 of file class.ilSystemStyleSettings.php.

References $DIC.

Referenced by ilSystemStyleConfigGUI\handleStyleActivation(), and ilSystemStyleOverviewGUI\saveStyleSettings().

                                                                                     : void
     {
         global $DIC;
 
         $DIC->clientIni()->setVariable('layout', 'skin', $skin_id);
         $DIC->clientIni()->setVariable('layout', 'style', $style_id);
         $DIC->clientIni()->write();
         self::_activateStyle($skin_id, $style_id);
     }

Here is the caller graph for this function:

◆ setCurrentUserPrefStyle()

static ilSystemStyleSettings::setCurrentUserPrefStyle	(	string	$skin_id,
		string	$style_id
	)

static

Sets a users preferred system skin/style by using the user object.

Definition at line 230 of file class.ilSystemStyleSettings.php.

References $DIC.

Referenced by ilSystemStyleConfigGUI\handleStyleActivation().

                                                                                      : void
     {
         global $DIC;
 
         $DIC->user()->setPref('skin', $skin_id);
         $DIC->user()->setPref('style', $style_id);
         $DIC->user()->update();
     }

Here is the caller graph for this function:

◆ updateSkinIdAndStyleIDOfSubStyleCategoryAssignments()

static ilSystemStyleSettings::updateSkinIdAndStyleIDOfSubStyleCategoryAssignments	(	string	$old_skin_id,
		string	$old_style_id,
		string	$new_skin_id,
		string	$new_style_id
	)

static

Updates an assignment, e.g.

in case of ID Change through GUI.

Definition at line 198 of file class.ilSystemStyleSettings.php.

References $DIC.

Referenced by ilSystemStyleConfigGUI\save().

      : void {
         global $DIC;
 
         $DIC->database()->manipulate('UPDATE syst_style_cat ' .
             ' SET skin_id = ' . $DIC->database()->quote($new_skin_id, 'text')
             . ', style_id = ' . $DIC->database()->quote($new_style_id, 'text') .
             ' WHERE skin_id = ' . $DIC->database()->quote($old_skin_id, 'text') .
             ' AND style_id = ' . $DIC->database()->quote($old_style_id, 'text'));
     }

Here is the caller graph for this function:

◆ updateSubStyleIdfSubStyleCategoryAssignments()

static ilSystemStyleSettings::updateSubStyleIdfSubStyleCategoryAssignments	(	string	$old_substyle_id,
		string	$new_substyle_id
	)

static

Updates an assignment, e.g.

in case of ID Change through GUI.

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

References $DIC.

Referenced by ilSystemStyleConfigGUI\save().

      : void {
         global $DIC;
 
         $DIC->database()->manipulate('UPDATE syst_style_cat ' .
             ' SET substyle = ' . $DIC->database()->quote($new_substyle_id, 'text') .
             ' WHERE substyle = ' . $DIC->database()->quote($old_substyle_id, 'text'));
     }

Here is the caller graph for this function:

◆ writeSystemStyleCategoryAssignment()

static ilSystemStyleSettings::writeSystemStyleCategoryAssignment	(	string	$a_skin_id,
		string	$a_style_id,
		string	$a_substyle,
		string	$a_ref_id
	)

static

Sets a substyle category assignment.

Exceptions

ilSystemStyleException

Definition at line 136 of file class.ilSystemStyleSettings.php.

References $DIC, and ilSystemStyleException\SUBSTYLE_ASSIGNMENT_EXISTS.

Referenced by ilSubStyleAssignmentGUI\saveAssignment().

      : void {
         global $DIC;
 
         $assignments = self::getSubStyleCategoryAssignments($a_skin_id, $a_style_id, $a_substyle);
 
         foreach ($assignments as $assignment) {
             if ($assignment['ref_id'] == $a_ref_id) {
                 throw new ilSystemStyleException(
                     ilSystemStyleException::SUBSTYLE_ASSIGNMENT_EXISTS,
                     $a_substyle . ': ' . $a_ref_id
                 );
             }
         }
         $DIC->database()->manipulate('INSERT INTO syst_style_cat ' .
             '(skin_id, style_id, substyle, category_ref_id) VALUES (' .
             $DIC->database()->quote($a_skin_id, 'text') . ',' .
             $DIC->database()->quote($a_style_id, 'text') . ',' .
             $DIC->database()->quote($a_substyle, 'text') . ',' .
             $DIC->database()->quote($a_ref_id, 'integer') .
             ')');
     }

Here is the caller graph for this function:

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

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ _activateStyle()

◆ _deactivateStyle()

◆ _lookupActivatedStyle()

◆ deleteSubStyleCategoryAssignments()

◆ deleteSystemStyleCategoryAssignment()

◆ getCurrentDefaultSkin()

◆ getCurrentDefaultStyle()

◆ getCurrentUserPrefSkin()

◆ getCurrentUserPrefStyle()

◆ getSubStyleCategoryAssignments()

◆ getSystemStyleCategoryAssignments()

◆ resetDefaultToDelos()

◆ setCurrentDefaultStyle()

◆ setCurrentUserPrefStyle()

◆ updateSkinIdAndStyleIDOfSubStyleCategoryAssignments()

◆ updateSubStyleIdfSubStyleCategoryAssignments()

◆ writeSystemStyleCategoryAssignment()