ilSystemStyleSettings Class Reference

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 ($a_skin, $a_style)
	lookup if a style is activated More...
static	_deactivateStyle ($a_skin, $a_style)
	deactivate system style More...
static	_activateStyle ($a_skin, $a_style)
	activate system style More...
static	getSystemStyleCategoryAssignments ($a_skin_id, $a_style_id)
	Get all system sub styles category assignments. More...
static	getSubStyleCategoryAssignments ($a_skin_id, $a_style_id, $a_sub_style_id)
	Get all system category assignments of exactly one substyle. More...
static	writeSystemStyleCategoryAssignment ( $a_skin_id, $a_style_id, $a_substyle, $a_ref_id)
	Sets a substyle category assignment. More...
static	deleteSystemStyleCategoryAssignment ( $a_skin_id, $a_style_id, $a_substyle, $a_ref_id)
	Deletes all sub style category assignment of a system style. More...
static	deleteSubStyleCategoryAssignments ($a_skin_id, $a_style_id, $a_substyle)
	Delets a sub styles category assignment. More...
static	setCurrentUserPrefStyle ($skin_id, $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 ($skin_id, $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

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 19 of file class.ilSystemStyleSettings.php.

Member Function Documentation

_activateStyle()

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

static

activate system style

Parameters

$a_skin
$a_style

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

References $DIC.

Referenced by _deactivateStyle(), ilSystemStyleSettingsGUI\saveStyle(), and ilSystemStyleOverviewGUI\saveStyleSettings().

    {
        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 (   $a_skin,   $a_style  )

static

deactivate system style

Parameters

$a_skin
$a_style

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

References $DIC, and _activateStyle().

Referenced by ilSystemStyleSettingsGUI\saveStyle(), and ilSystemStyleOverviewGUI\saveStyleSettings().

    {
        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 (   $a_skin,   $a_style  )

static

lookup if a style is activated

Parameters

$a_skin
$a_style

Returns

bool

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

References $DIC.

Referenced by ilSoapInstallationInfoXMLWriter\__buildClient(), ilUserImportParser\__construct(), ilSystemStyleOverviewGUI\checkDeletable(), ilSystemStylesTableGUI\fillRow(), ilSystemStyleSettingsGUI\getPropertiesValues(), ilObjUserGUI\getValues(), and ilPersonalSettingsGUI\initGeneralSettingsForm().

    {
        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 (   $a_skin_id,   $a_style_id,   $a_substyle  )

static

Delets a sub styles category assignment.

Parameters

$a_skin_id
$a_style_id
$a_substyle

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

References $DIC.

Referenced by ilSystemStyleSkinContainer\deleteStyle().

    {
        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"));
    }

Here is the caller graph for this function:

deleteSystemStyleCategoryAssignment()

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

static

Deletes all sub style category assignment of a system style.

This is used if a system style is deleted completely

Parameters

$a_skin_id
$a_style_id
$a_substyle
$a_ref_id

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

References $DIC.

Referenced by ilSubStyleAssignmentGUI\deleteAssignments().

      {
        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 280 of file class.ilSystemStyleSettings.php.

References $DIC, and ilStyleDefinition\skinExists().

Referenced by ilSystemStyleOverviewGUI\checkDeletable(), ilSystemStylesTableGUI\fillRow(), ilSystemStyleSettingsGUI\getPropertiesValues(), and ilSystemStyleSettingsGUI\saveStyle().

    {
        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.

Returns

mixed

Exceptions

ilSystemStyleException

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

References $DIC, and ilStyleDefinition\styleExistsForSkinId().

Referenced by ilSystemStylesTableGUI\fillRow(), ilSystemStyleSettingsGUI\getPropertiesValues(), and ilSystemStyleSettingsGUI\saveStyle().

    {
        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.

Returns

bool

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

References $DIC.

Referenced by ilSystemStyleSettingsGUI\saveStyle().

    {
        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.

Returns

bool

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

References $DIC.

Referenced by ilSystemStyleSettingsGUI\saveStyle().

    {
        global $DIC;

        return $DIC->user()->getPref("style");
    }

Here is the caller graph for this function:

getSubStyleCategoryAssignments()

static ilSystemStyleSettings::getSubStyleCategoryAssignments (   $a_skin_id,   $a_style_id,   $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.

Parameters

$a_skin_id
$a_style_id
$a_sub_style_id

Returns

array

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

References $DIC.

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

    {
        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 (   $a_skin_id,   $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.

Parameters

string	$a_skin_id	skin id
string	$a_style_id	style id

Returns

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

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

References $DIC.

Referenced by ilStyleDefinition\getCurrentStyle().

    {
        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 268 of file class.ilSystemStyleSettings.php.

    {
        $system_style_conf = new ilSystemStyleConfig();

        self::setCurrentDefaultStyle($system_style_conf->getDefaultSkinId(), $system_style_conf->getDefaultSkinId());
    }

setCurrentDefaultStyle()

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

static

Sets the default style of the system.

Parameters

$skin_id
$style_id

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

References $DIC.

Referenced by ilSystemStyleSettingsGUI\saveStyle(), and ilSystemStyleOverviewGUI\saveStyleSettings().

    {
        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 (   $skin_id,   $style_id  )

static

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

Parameters

$skin_id
$style_id

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

References $DIC.

Referenced by ilSystemStyleSettingsGUI\saveStyle().

    {
        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:

writeSystemStyleCategoryAssignment()

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

static

Sets a substyle category assignment.

Parameters

$a_skin_id
$a_style_id
$a_substyle
$a_ref_id

Exceptions

ilSystemStyleException

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

References $DIC, and ilSystemStyleException\SUBSTYLE_ASSIGNMENT_EXISTS.

Referenced by ilSubStyleAssignmentGUI\saveAssignment().

      {
        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:

• Services/Style/System/classes/class.ilSystemStyleSettings.php