Collaboration diagram for ilSkinStyle:

Public Member Functions
	__construct (string $id, string $name, string $css_file='', string $image_directory='', string $font_directory='', string $sound_directory='', string $parent_style='')

	getId ()

	setId (string $id)

	getName ()

	setName (string $name)

	getSoundDirectory ()

	setSoundDirectory (string $sound_directory)

	getImageDirectory ()

	setImageDirectory (string $image_directory)

	getCssFile ()

	setCssFile (string $css_file)

	getFontDirectory ()

	setFontDirectory (string $font_directory)

	getSubstyleOf ()
	Returns the parent style of this style if set. More...

	setSubstyleOf (string $substyle_of)
	Sets style as sub style of another. More...

	isSubstyle ()
	Return wheter this style is a substyle of another. More...

	referencesResource (string $resource)
	Checks if a resource (folder) relative to the style is referenced by this style. More...

Static Public Member Functions
static	parseFromXMLElement (SimpleXMLElement $xml_element)

Protected Attributes
string	$id = ''
	Id of the skin. More...

string	$name = ''
	Name of the style visible in all UI elements. More...

string	$sound_directory = ''
	Directory to store sound files into. More...

string	$image_directory = ''
	Directory to store image files into. More...

string	$font_directory = ''
	Directory to store fonts into. More...

string	$css_file = ''
	Css file name of the skin. More...

string	$substyle_of = ''
	Parent of the skin if set. More...

Detailed Description

Definition at line 21 of file class.ilSkinStyle.php.

Constructor & Destructor Documentation

◆ __construct()

ilSkinStyle::__construct	(	string	$id,
		string	$name,
		string	$css_file = `''`,
		string	$image_directory = `''`,
		string	$font_directory = `''`,
		string	$sound_directory = `''`,
		string	$parent_style = `''`
	)

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

      {
        $this->setId($id);
        $this->setName($name);
 
        if ($css_file == '') {
            $css_file = $this->getId();
        }
 
        if ($image_directory == '') {
            $image_directory = 'images';
        }
 
        if ($font_directory == '') {
            $font_directory = 'fonts';
        }
 
        if ($sound_directory == '') {
            $sound_directory = 'sound';
        }
 
        $this->setCssFile($css_file);
        $this->setImageDirectory($image_directory);
        $this->setFontDirectory($font_directory);
        $this->setSoundDirectory($sound_directory);
        $this->setSubstyleOf($parent_style);
    }

References $css_file, $font_directory, $image_directory, $sound_directory, getId(), setCssFile(), setFontDirectory(), setId(), setImageDirectory(), setName(), setSoundDirectory(), and setSubstyleOf().

Here is the call graph for this function:

Member Function Documentation

◆ getCssFile()

ilSkinStyle::getCssFile ( )

Definition at line 154 of file class.ilSkinStyle.php.

                                : string
    {
        return $this->css_file;
    }

References $css_file.

Referenced by ilSkin\addChildToXML(), referencesResource(), and ilSkinStyleContainer\updateStyle().

Here is the caller graph for this function:

◆ getFontDirectory()

ilSkinStyle::getFontDirectory ( )

Definition at line 164 of file class.ilSkinStyle.php.

                                      : string
    {
        return $this->font_directory;
    }

References $font_directory.

Referenced by ilSkin\addChildToXML(), ilSkinStyleContainer\deleteStyle(), referencesResource(), and ilSkinStyleContainer\updateStyle().

Here is the caller graph for this function:

◆ getId()

ilSkinStyle::getId ( )

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

                           : string
    {
        return $this->id;
    }

References $id.

Here is the caller graph for this function:

◆ getImageDirectory()

ilSkinStyle::getImageDirectory ( )

Definition at line 144 of file class.ilSkinStyle.php.

                                       : string
    {
        return $this->image_directory;
    }

References $image_directory.

Referenced by ilSkin\addChildToXML(), ilSkinStyleContainer\deleteStyle(), referencesResource(), ilSkinStyleContainer\resetImages(), and ilSkinStyleContainer\updateStyle().

Here is the caller graph for this function:

◆ getName()

ilSkinStyle::getName ( )

Definition at line 124 of file class.ilSkinStyle.php.

                             : string
    {
        return $this->name;
    }

References $name.

Referenced by ilSkin\addChildToXML(), ilSystemStyleDeleteGUI\addStyle(), and ilSkinStyleContainer\deleteStyle().

Here is the caller graph for this function:

◆ getSoundDirectory()

ilSkinStyle::getSoundDirectory ( )

Definition at line 134 of file class.ilSkinStyle.php.

                                       : string
    {
        return $this->sound_directory;
    }

References $sound_directory.

Referenced by ilSkin\addChildToXML(), ilSkinStyleContainer\deleteStyle(), referencesResource(), and ilSkinStyleContainer\updateStyle().

Here is the caller graph for this function:

◆ getSubstyleOf()

ilSkinStyle::getSubstyleOf ( )

Returns the parent style of this style if set.

Definition at line 177 of file class.ilSkinStyle.php.

                                   : string
    {
        return $this->substyle_of;
    }

References $substyle_of.

Referenced by ilSubStyleAssignmentGUI\assignStyle(), ilSubStyleAssignmentGUI\deleteAssignments(), ilSkinStyleContainer\deleteStyle(), isSubstyle(), and ilSubStyleAssignmentGUI\saveAssignment().

Here is the caller graph for this function:

◆ isSubstyle()

ilSkinStyle::isSubstyle ( )

Return wheter this style is a substyle of another.

Definition at line 193 of file class.ilSkinStyle.php.

                                : bool
    {
        return $this->getSubstyleOf() != '';
    }

References getSubstyleOf().

Referenced by ilSkin\addChildToXML(), and ilSkinStyleContainer\deleteStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseFromXMLElement()

static ilSkinStyle::parseFromXMLElement ( SimpleXMLElement $xml_element )

static

Exceptions

ilSystemStyleException

Definition at line 96 of file class.ilSkinStyle.php.

                                                                             : ilSkinStyle
    {
        return new self(
            (string) $xml_element->attributes()['id'],
            (string) $xml_element->attributes()['name'],
            (string) $xml_element->attributes()['css_file'],
            (string) $xml_element->attributes()['image_directory'],
            (string) $xml_element->attributes()['font_directory'],
            (string) $xml_element->attributes()['sound_directory']
        );
    }

◆ referencesResource()

ilSkinStyle::referencesResource ( string $resource )

Checks if a resource (folder) relative to the style is referenced by this style.

Used to decide if folder can be deleted.

Definition at line 201 of file class.ilSkinStyle.php.

                                                        : bool
    {
        return $this->getCssFile() == $resource
            || $this->getImageDirectory() == $resource
            || $this->getFontDirectory() == $resource
            || $this->getSoundDirectory() == $resource;
    }

References getCssFile(), getFontDirectory(), getImageDirectory(), and getSoundDirectory().

Here is the call graph for this function:

◆ setCssFile()

ilSkinStyle::setCssFile ( string $css_file )

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

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

References $css_file.

Referenced by __construct().

Here is the caller graph for this function:

◆ setFontDirectory()

ilSkinStyle::setFontDirectory ( string $font_directory )

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

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

References $font_directory.

Referenced by __construct().

Here is the caller graph for this function:

◆ setId()

ilSkinStyle::setId ( string $id )

Exceptions

ilSystemStyleException

Definition at line 116 of file class.ilSkinStyle.php.

                                     : void
    {
        if (strpos($id, ' ') !== false) {
            throw new ilSystemStyleException(ilSystemStyleException::INVALID_CHARACTERS_IN_ID, $id);
        }
        $this->id = str_replace(' ', '_', $id);
    }

References $id, and ilSystemStyleException\INVALID_CHARACTERS_IN_ID.

Referenced by __construct().

Here is the caller graph for this function:

◆ setImageDirectory()

ilSkinStyle::setImageDirectory ( string $image_directory )

Definition at line 149 of file class.ilSkinStyle.php.

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

References $image_directory.

Referenced by __construct().

Here is the caller graph for this function:

◆ setName()

ilSkinStyle::setName ( string $name )

Definition at line 129 of file class.ilSkinStyle.php.

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

References $name.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSoundDirectory()

ilSkinStyle::setSoundDirectory ( string $sound_directory )

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

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

References $sound_directory.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSubstyleOf()

ilSkinStyle::setSubstyleOf ( string $substyle_of )

Sets style as sub style of another.

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

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

References $substyle_of.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $css_file

string ilSkinStyle::$css_file = ''

protected

Css file name of the skin.

Definition at line 51 of file class.ilSkinStyle.php.

Referenced by __construct(), getCssFile(), and setCssFile().

◆ $font_directory

string ilSkinStyle::$font_directory = ''

protected

Directory to store fonts into.

Definition at line 46 of file class.ilSkinStyle.php.

Referenced by __construct(), getFontDirectory(), and setFontDirectory().

◆ $id

string ilSkinStyle::$id = ''

protected

Id of the skin.

Currently css and less files are named accordingely

Definition at line 26 of file class.ilSkinStyle.php.

Referenced by getId(), and setId().

◆ $image_directory

string ilSkinStyle::$image_directory = ''

protected

Directory to store image files into.

Definition at line 41 of file class.ilSkinStyle.php.

Referenced by __construct(), getImageDirectory(), and setImageDirectory().

◆ $name

string ilSkinStyle::$name = ''

protected

Name of the style visible in all UI elements.

Definition at line 31 of file class.ilSkinStyle.php.

Referenced by getName(), and setName().

◆ $sound_directory

string ilSkinStyle::$sound_directory = ''

protected

Directory to store sound files into.

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

Referenced by __construct(), getSoundDirectory(), and setSoundDirectory().

◆ $substyle_of

string ilSkinStyle::$substyle_of = ''

protected

Parent of the skin if set.

Definition at line 56 of file class.ilSkinStyle.php.

Referenced by getSubstyleOf(), and setSubstyleOf().

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

Services/Style/System/classes/Style/class.ilSkinStyle.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCssFile()

◆ getFontDirectory()

◆ getId()

◆ getImageDirectory()

◆ getName()

◆ getSoundDirectory()

◆ getSubstyleOf()

◆ isSubstyle()

◆ parseFromXMLElement()

◆ referencesResource()

◆ setCssFile()

◆ setFontDirectory()

◆ setId()

◆ setImageDirectory()

◆ setName()

◆ setSoundDirectory()

◆ setSubstyleOf()

Field Documentation

◆ $css_file

◆ $font_directory

◆ $id

◆ $image_directory

◆ $name

◆ $sound_directory

◆ $substyle_of