Collaboration diagram for ilSkinStyleXML:

Public Member Functions
	__construct ($id, $name, $css_file="", $image_directory="", $font_directory="", $sound_directory="", $parent_style="")
	ilSkinStyleXML constructor. More...

	getId ()

	setId ($id)

	getName ()

	setName ($name)

	getSoundDirectory ()

	setSoundDirectory ($sound_directory)

	getImageDirectory ()

	setImageDirectory ($image_directory)

	getCssFile ()

	setCssFile ($css_file)

	getFontDirectory ()

	setFontDirectory ($font_directory)

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

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

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

	referencesResource ($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
	$id = ""

	$name = ""

	$sound_directory = ""

	$image_directory = ""

	$font_directory = ""

	$css_file = ""

	$substyle_of = ""

Detailed Description

Author: Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: $Id$*

Definition at line 7 of file class.ilSkinStyleXML.php.

Constructor & Destructor Documentation

◆ __construct()

ilSkinStyleXML::__construct	(	$id,
		$name,
		$css_file = `""`,
		$image_directory = `""`,
		$font_directory = `""`,
		$sound_directory = `""`,
		$parent_style = `""`
	)

ilSkinStyleXML constructor.

Parameters

	$id
	$name
string	$css_file
string	$image_directory
string	$font_directory
string	$sound_directory
string	$parent_style

Definition at line 67 of file class.ilSkinStyleXML.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, $id, $image_directory, $name, $sound_directory, getId(), setCssFile(), setFontDirectory(), setId(), setImageDirectory(), setName(), setSoundDirectory(), and setSubstyleOf().

Here is the call graph for this function:

Member Function Documentation

◆ getCssFile()

ilSkinStyleXML::getCssFile ( )

Returns: string

Definition at line 182 of file class.ilSkinStyleXML.php.

        {
                return $this->css_file;
        }

References $css_file.

Referenced by referencesResource(), and ilSystemStyleSkinContainer\updateStyle().

Here is the caller graph for this function:

◆ getFontDirectory()

ilSkinStyleXML::getFontDirectory ( )

Returns: string

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

        {
                return $this->font_directory;
        }

References $font_directory.

Referenced by ilSystemStyleSkinContainer\deleteStyle(), referencesResource(), and ilSystemStyleSkinContainer\updateStyle().

Here is the caller graph for this function:

◆ getId()

ilSkinStyleXML::getId ( )

Returns: string

Definition at line 114 of file class.ilSkinStyleXML.php.

        {
                return $this->id;
        }

References $id.

Referenced by __construct(), ilSystemStyleSkinContainer\addStyle(), ilSubStyleAssignmentGUI\assignStyle(), ilSystemStyleSkinContainer\copyCSSFromDefault(), ilSystemStyleSkinContainer\copyVariablesFromDefault(), ilSystemStyleSkinContainer\createLessStructure(), ilSystemStyleSkinContainer\createMainLessFile(), ilSubStyleAssignmentGUI\deleteAssignments(), ilSystemStyleSkinContainer\deleteStyle(), and ilSubStyleAssignmentGUI\saveAssignment().

Here is the caller graph for this function:

◆ getImageDirectory()

ilSkinStyleXML::getImageDirectory ( )

Returns: string

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

        {
                return $this->image_directory;
        }

References $image_directory.

Referenced by ilSystemStyleSkinContainer\deleteStyle(), referencesResource(), ilSystemStyleSkinContainer\resetImages(), and ilSystemStyleSkinContainer\updateStyle().

Here is the caller graph for this function:

◆ getName()

ilSkinStyleXML::getName ( )

Returns: string

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

        {
                return $this->name;
        }

References $name.

◆ getSoundDirectory()

ilSkinStyleXML::getSoundDirectory ( )

Returns: string

Definition at line 150 of file class.ilSkinStyleXML.php.

        {
                return $this->sound_directory;
        }

References $sound_directory.

Referenced by ilSystemStyleSkinContainer\deleteStyle(), referencesResource(), and ilSystemStyleSkinContainer\updateStyle().

Here is the caller graph for this function:

◆ getSubstyleOf()

ilSkinStyleXML::getSubstyleOf ( )

Returns the parent style of this style if set.

Returns: string

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

        {
                return $this->substyle_of;
        }

References $substyle_of.

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

Here is the caller graph for this function:

◆ isSubstyle()

ilSkinStyleXML::isSubstyle ( )

Return wheter this style is a substyle of another.

Returns: bool

Definition at line 236 of file class.ilSkinStyleXML.php.

                                    {
                return $this->getSubstyleOf() != "";
        }

References getSubstyleOf().

Here is the call graph for this function:

◆ parseFromXMLElement()

static ilSkinStyleXML::parseFromXMLElement ( SimpleXMLElement $xml_element )

static

Parameters

SimpleXMLElement $xml_element

Returns: ilSkinStyleXML

Definition at line 99 of file class.ilSkinStyleXML.php.

                                                                          {
                $style = 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"]
 
                );
                return $style;
        }

References $style.

◆ referencesResource()

ilSkinStyleXML::referencesResource ( $resource )

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

Used to decide if folder can be deleted.

Parameters

$resource

Returns: bool

Definition at line 246 of file class.ilSkinStyleXML.php.

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

ilSkinStyleXML::setCssFile ( $css_file )

Parameters

string $css_file

Definition at line 190 of file class.ilSkinStyleXML.php.

        {
                $this->css_file = $css_file;
        }

References $css_file.

Referenced by __construct().

Here is the caller graph for this function:

◆ setFontDirectory()

ilSkinStyleXML::setFontDirectory ( $font_directory )

Parameters

string $font_directory

Definition at line 206 of file class.ilSkinStyleXML.php.

        {
                $this->font_directory = $font_directory;
        }

References $font_directory.

Referenced by __construct().

Here is the caller graph for this function:

◆ setId()

ilSkinStyleXML::setId ( $id )

Parameters

$id

Exceptions

ilSystemStyleException

Definition at line 123 of file class.ilSkinStyleXML.php.

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

ilSkinStyleXML::setImageDirectory ( $image_directory )

Parameters

string $image_directory

Definition at line 174 of file class.ilSkinStyleXML.php.

        {
                $this->image_directory = $image_directory;
        }

References $image_directory.

Referenced by __construct().

Here is the caller graph for this function:

◆ setName()

ilSkinStyleXML::setName ( $name )

Parameters

string $name

Definition at line 142 of file class.ilSkinStyleXML.php.

        {
                $this->name = $name;
        }

References $name.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSoundDirectory()

ilSkinStyleXML::setSoundDirectory ( $sound_directory )

Parameters

string $sound_directory

Definition at line 158 of file class.ilSkinStyleXML.php.

        {
                $this->sound_directory = $sound_directory;
        }

References $sound_directory.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSubstyleOf()

ilSkinStyleXML::setSubstyleOf ( $substyle_of )

Sets style as sub style of another.

Parameters

string $substyle_of

Definition at line 226 of file class.ilSkinStyleXML.php.

        {
                $this->substyle_of = $substyle_of;
        }

References $substyle_of.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $css_file

ilSkinStyleXML::$css_file = ""

protected

Definition at line 48 of file class.ilSkinStyleXML.php.

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

◆ $font_directory

ilSkinStyleXML::$font_directory = ""

protected

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

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

◆ $id

ilSkinStyleXML::$id = ""

protected

Definition at line 13 of file class.ilSkinStyleXML.php.

Referenced by __construct(), getId(), and setId().

◆ $image_directory

ilSkinStyleXML::$image_directory = ""

protected

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

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

◆ $name

ilSkinStyleXML::$name = ""

protected

Definition at line 20 of file class.ilSkinStyleXML.php.

Referenced by __construct(), getName(), and setName().

◆ $sound_directory

ilSkinStyleXML::$sound_directory = ""

protected

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

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

◆ $substyle_of

ilSkinStyleXML::$substyle_of = ""

protected

Definition at line 55 of file class.ilSkinStyleXML.php.

Referenced by getSubstyleOf(), and setSubstyleOf().

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

Services/Style/System/classes/Utilities/class.ilSkinStyleXML.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