ilSkin Class Reference

ilSkin holds an manages the basic data of a skin as provide by the template of the skin. More...

Inheritance diagram for ilSkin:

Collaboration diagram for ilSkin:

Public Member Functions
	__construct (string $id, string $name)
	asXML ()
	Stores the skin and all it's styles as xml. More...
	writeToXMLFile (string $path)
	addStyle (ilSkinStyle $style)
	removeStyle (string $id)
	getStyle (string $id)
	hasStyle (string $id)
	getDefaultStyle ()
	valid ()
	key ()
	current ()
	next ()
	rewind ()
	count ()
	getId ()
	setId (string $id)
	getName ()
	setName (string $name)
	getStyles ()
	setStyles (array $styles)
	getVersion ()
	setVersion (string $version)
	getVersionStep (string $version)
	isVersionChangeable ()
	updateParentStyleOfSubstyles (string $old_parent_style_id, string $new_parent_style_id)
	getSubstylesOfStyle (string $style_id)
	hasStyleSubstyles (string $style_id)
	Returns wheter a given style has substyles. More...
	hasStyles ()

Protected Member Functions
	addChildToXML (SimpleXMLElement $xml, ilSkinStyle $style)
	Used to generate the xml for styles contained by the skin. More...

Protected Attributes
string	$id = ''
	ID of the skin, equals the name of the folder this skin is stored in. More...
string	$name = ''
	Name of the skin, as provided in the template. More...
array	$styles = []
string	$version = '0.1'
	Version of skin, as provided by the template. More...

Detailed Description

ilSkin holds an manages the basic data of a skin as provide by the template of the skin.

This class is also responsible to read this data from the xml and, after manipulations transfer the data back to xml.

To read a skin from xml do not use this class, us ilSkinContainer instead.

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

Constructor & Destructor Documentation

__construct()

ilSkin::__construct	(	string	$id,
		string	$name
	)

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

References setId(), and setName().

    {
        $this->setId($id);
        $this->setName($name);
    }

Here is the call graph for this function:

Member Function Documentation

addChildToXML()

ilSkin::addChildToXML ( SimpleXMLElement  $xml, ilSkinStyle  $style  )

protected

Used to generate the xml for styles contained by the skin.

Definition at line 87 of file class.ilSkin.php.

References ilSkinStyle\getCssFile(), ilSkinStyle\getFontDirectory(), ilSkinStyle\getId(), ilSkinStyle\getImageDirectory(), ilSkinStyle\getName(), ilSkinStyle\getSoundDirectory(), and ilSkinStyle\isSubstyle().

Referenced by asXML().

                                                                               : void
    {
        if ($style->isSubstyle()) {
            $xml_style = $xml->addChild('substyle');
        } else {
            $xml_style = $xml->addChild('style');
        }
        $xml_style->addAttribute('id', $style->getId());
        $xml_style->addAttribute('name', $style->getName());
        $xml_style->addAttribute('image_directory', $style->getImageDirectory());
        $xml_style->addAttribute('css_file', $style->getCssFile());
        $xml_style->addAttribute('sound_directory', $style->getSoundDirectory());
        $xml_style->addAttribute('font_directory', $style->getFontDirectory());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addStyle()

ilSkin::addStyle

(

ilSkinStyle

$style

)

Definition at line 107 of file class.ilSkin.php.

                                                : void
    {
        $this->styles[] = $style;
    }

asXML()

ilSkin::asXML

(

)

Stores the skin and all it's styles as xml.

Definition at line 61 of file class.ilSkin.php.

References $xml, addChildToXML(), getName(), getStyles(), getSubstylesOfStyle(), and getVersion().

Referenced by ilSkinFactoryTest\testSkinFromXML(), and writeToXMLFile().

                           : string
    {
        $xml = new SimpleXMLElement("<?xml version='1.0' encoding='UTF-8'?><template/>");
        $xml->addAttribute('xmlns', 'http://www.w3.org');
        $xml->addAttribute('version', $this->getVersion());
        $xml->addAttribute('name', $this->getName());

        foreach ($this->getStyles() as $style) {
            if (!$style->isSubstyle()) {
                $this->addChildToXML($xml, $style);

                foreach ($this->getSubstylesOfStyle($style->getId()) as $substyle) {
                    $this->addChildToXML($xml, $substyle);
                }
            }
        }

        $dom = new DOMDocument('1.0', 'utf-8');
        $dom->formatOutput = true;
        $dom->loadXML($xml->asXML());
        return $dom->saveXML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

count()

ilSkin::count

(

)

Definition at line 179 of file class.ilSkin.php.

Referenced by getVersionStep(), and hasStyles().

                           : int
    {
        return count($this->styles);
    }

Here is the caller graph for this function:

current()

ilSkin::current

(

)

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

Referenced by valid().

                             : ilSkinStyle
    {
        return current($this->styles);
    }

Here is the caller graph for this function:

getDefaultStyle()

ilSkin::getDefaultStyle

(

)

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

                                     : ilSkinStyle
    {
        return array_values($this->styles)[0];
    }

getId()

ilSkin::getId

(

)

Definition at line 184 of file class.ilSkin.php.

References $id.

Referenced by ilSystemStyleDeleteGUI\addStyle(), ilSubStyleAssignmentGUI\assignStyle(), ilSubStyleAssignmentGUI\deleteAssignments(), ilStyleDefinition\getSoundDirectory(), ilSubStyleAssignmentGUI\saveAssignment(), ilSkinFactoryTest\testCopySkin(), ilSkinFactoryTest\testCopySkinWithInjectedName(), ilSkinStyleContainerTest\testDeleteSkin(), and ilSkinFactoryTest\testImportSkin().

                           : string
    {
        return $this->id;
    }

Here is the caller graph for this function:

getName()

ilSkin::getName

(

)

Definition at line 200 of file class.ilSkin.php.

References $name.

Referenced by ilSystemStyleDeleteGUI\addStyle(), asXML(), ilSkinFactoryTest\testCopySkin(), and ilSkinFactoryTest\testCopySkinWithInjectedName().

                             : string
    {
        return $this->name;
    }

Here is the caller graph for this function:

getStyle()

ilSkin::getStyle

(

string

$id

)

Exceptions

ilSystemStyleException

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

References $id, getStyles(), and ilSystemStyleException\INVALID_ID.

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

                                        : ilSkinStyle
    {
        foreach ($this->getStyles() as $style) {
            if ($style->getId() == $id) {
                return $style;
            }
        }
        throw new ilSystemStyleException(ilSystemStyleException::INVALID_ID, $id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStyles()

ilSkin::getStyles

(

)

Returns

ilSkinStyle[]

Definition at line 213 of file class.ilSkin.php.

References $styles.

Referenced by asXML(), getStyle(), getSubstylesOfStyle(), hasStyle(), hasStyles(), hasStyleSubstyles(), and removeStyle().

                               : array
    {
        return $this->styles;
    }

Here is the caller graph for this function:

getSubstylesOfStyle()

ilSkin::getSubstylesOfStyle

(

string

$style_id

)

Returns

ilSkinStyle[]

Definition at line 266 of file class.ilSkin.php.

References getStyles().

Referenced by asXML(), and updateParentStyleOfSubstyles().

                                                         : array
    {
        $substyles = [];

        foreach ($this->getStyles() as $style) {
            if ($style->getId() != $style_id && $style->isSubstyle()) {
                if ($style->getSubstyleOf() == $style_id) {
                    $substyles[$style->getId()] = $style;
                }
            }
        }

        return $substyles;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getVersion()

ilSkin::getVersion

(

)

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

References $version.

Referenced by asXML().

                                : string
    {
        return $this->version;
    }

Here is the caller graph for this function:

getVersionStep()

ilSkin::getVersionStep

(

string

$version

)

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

References $version, count(), ILIAS\Repository\int(), and isVersionChangeable().

                                                   : string
    {
        if ($this->isVersionChangeable()) {
            $v = explode('.', ($version == '' ? '0.1' : $version));
            $count = count($v) ;
            $v[$count - 1] = ((int) $v[$count - 1] + 1); //ToDo PHP8 Review: You are adding an int to a string in strict_types.
            $this->version = implode('.', $v);
        }
        return $this->version;
    }

Here is the call graph for this function:

hasStyle()

ilSkin::hasStyle

(

string

$id

)

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

References $id, and getStyles().

                                        : bool
    {
        foreach ($this->getStyles() as $style) {
            if ($style->getId() == $id) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

hasStyles()

ilSkin::hasStyles

(

)

Definition at line 296 of file class.ilSkin.php.

References count(), and getStyles().

                               : bool
    {
        return count($this->getStyles()) > 0;
    }

Here is the call graph for this function:

hasStyleSubstyles()

ilSkin::hasStyleSubstyles

(

string

$style_id

)

Returns wheter a given style has substyles.

Definition at line 284 of file class.ilSkin.php.

References getStyles().

Referenced by updateParentStyleOfSubstyles().

                                                       : bool
    {
        foreach ($this->getStyles() as $style) {
            if ($style->getId() != $style_id && $style->isSubstyle()) {
                if ($style->getSubstyleOf() == $style_id) {
                    return true;
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isVersionChangeable()

ilSkin::isVersionChangeable

(

)

Definition at line 249 of file class.ilSkin.php.

Referenced by getVersionStep(), and setVersion().

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

Here is the caller graph for this function:

key()

ilSkin::key

(

)

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

                         : int
    {
        return key($this->styles);
    }

next()

ilSkin::next

(

)

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

                          : void
    {
        next($this->styles);
    }

removeStyle()

ilSkin::removeStyle

(

string

$id

)

Exceptions

ilSystemStyleException

Definition at line 115 of file class.ilSkin.php.

References $id, $index, getStyles(), and ilSystemStyleException\INVALID_ID.

                                           : void
    {
        foreach ($this->getStyles() as $index => $style) {
            if ($style->getId() == $id) {
                unset($this->styles[$index]);
                return;
            }
        }
        throw new ilSystemStyleException(ilSystemStyleException::INVALID_ID, $id);
    }

Here is the call graph for this function:

rewind()

ilSkin::rewind

(

)

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

                            : void
    {
        reset($this->styles);
    }

setId()

ilSkin::setId

(

string

$id

)

Exceptions

ilSystemStyleException

Definition at line 192 of file class.ilSkin.php.

References ilSystemStyleException\INVALID_CHARACTERS_IN_ID.

Referenced by __construct().

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

Here is the caller graph for this function:

setName()

ilSkin::setName

(

string

$name

)

Definition at line 205 of file class.ilSkin.php.

References $name.

Referenced by __construct().

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

Here is the caller graph for this function:

setStyles()

ilSkin::setStyles

(

array

$styles

)

Parameters

ilSkinStyle[]

$styles

Definition at line 221 of file class.ilSkin.php.

References $styles.

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

setVersion()

ilSkin::setVersion

(

string

$version

)

Definition at line 231 of file class.ilSkin.php.

References $version, and isVersionChangeable().

Referenced by ilSkinFactory\__construct().

                                               : void
    {
        if ($version != '' && $this->isVersionChangeable()) {
            $this->version = $version;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateParentStyleOfSubstyles()

ilSkin::updateParentStyleOfSubstyles	(	string	$old_parent_style_id,
		string	$new_parent_style_id
	)

Definition at line 254 of file class.ilSkin.php.

References getSubstylesOfStyle(), and hasStyleSubstyles().

                                                                                                          : void
    {
        if ($this->hasStyleSubstyles($old_parent_style_id)) {
            foreach ($this->getSubstylesOfStyle($old_parent_style_id) as $substyle) {
                $substyle->setSubstyleOf($new_parent_style_id);
            }
        }
    }

Here is the call graph for this function:

valid()

ilSkin::valid

(

)

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

References current().

                           : bool
    {
        return current($this->styles) !== false;
    }

Here is the call graph for this function:

writeToXMLFile()

ilSkin::writeToXMLFile

(

string

$path

)

Definition at line 102 of file class.ilSkin.php.

References asXML().

                                                : void
    {
        file_put_contents($path, $this->asXML());
    }

Here is the call graph for this function:

Field Documentation

$id

string ilSkin::$id = ''

protected

ID of the skin, equals the name of the folder this skin is stored in.

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

Referenced by getId(), getStyle(), hasStyle(), and removeStyle().

$name

string ilSkin::$name = ''

protected

Name of the skin, as provided in the template.

Definition at line 38 of file class.ilSkin.php.

Referenced by getName(), and setName().

$styles

array ilSkin::$styles = []

protected

Definition at line 45 of file class.ilSkin.php.

Referenced by getStyles(), and setStyles().

$version

string ilSkin::$version = '0.1'

protected

Version of skin, as provided by the template.

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

Referenced by getVersion(), getVersionStep(), and setVersion().

---

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

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