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

Inheritance diagram for ilSkinXML:

Collaboration diagram for ilSkinXML:

Public Member Functions
	__construct ($id, $name)
	ilSkinXML constructor. More...

	asXML ()
	Stores the skin and all it's styles as xml. More...

	writeToXMLFile ($path)

	addStyle (ilSkinStyleXML $style)

	removeStyle ($id)

	getStyle ($id)

	hasStyle ($id)

	getDefaultStyle ()

	valid ()
	Iterator implementations. More...

	key ()

	current ()

	next ()

	rewind ()

	count ()
	Countable implementations. More...

	getId ()

	setId ($id)

	getName ()

	setName ($name)

	getStyles ()

	setStyles ($styles)

	getVersion ()

	setVersion ($version)

	getVersionStep ($version)

	isVersionChangeable ()

	getSubstylesOfStyle ($style_id)

	hasStyleSubstyles ($style_id)
	Returns wheter a given style has substyles. More...

	hasStyles ()

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

Protected Attributes
	$id = ""

	$name = ""

	$styles = array()

	$version = "0.1"

Detailed Description

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

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 14 of file class.ilSkinXML.php.

Constructor & Destructor Documentation

◆ __construct()

ilSkinXML::__construct	(	$id,
		$name
	)

ilSkinXML constructor.

Parameters

string $name

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

References $id, $name, $path, $style, ilSystemStyleException\FILE_OPENING_FAILED, ilSystemStyleException\NO_PARENT_STYLE, ilSkinStyleXML\parseFromXMLElement(), setId(), setName(), and string.

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

Here is the call graph for this function:

Member Function Documentation

◆ addChildToXML()

ilSkinXML::addChildToXML	(	SimpleXMLElement	$xml,
		ilSkinStyleXML	$style
	)

protected

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

Parameters

SimpleXMLElement	$xml
ilSkinStyleXML	$style

Definition at line 132 of file class.ilSkinXML.php.

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

Referenced by asXML().

                                                                                      {
                 $xml_style = null;
                 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()

ilSkinXML::addStyle ( ilSkinStyleXML $style )

Parameters

ilSkinStyleXML $style

Definition at line 157 of file class.ilSkinXML.php.

References $style.

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

◆ asXML()

ilSkinXML::asXML ( )

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

Returns: string

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

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

Referenced by writeToXMLFile().

                                {
                 $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());
 
                 $last_style = null;
 
                 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()

ilSkinXML::count ( )

Countable implementations.

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

Referenced by getVersionStep(), and hasStyles().

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

Here is the caller graph for this function:

◆ current()

ilSkinXML::current ( )

Returns: mixed

Definition at line 228 of file class.ilSkinXML.php.

Referenced by valid().

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

Here is the caller graph for this function:

◆ getDefaultStyle()

ilSkinXML::getDefaultStyle ( )

Returns: ilSkinStyleXML

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

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

◆ getId()

ilSkinXML::getId ( )

Returns: string

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

References $id.

Referenced by ilSystemStyleDeleteGUI\addStyle(), ilSubStyleAssignmentGUI\assignStyle(), ilSubStyleAssignmentGUI\deleteAssignments(), ilSubStyleAssignmentGUI\saveAssignment(), and ilSystemStyleSkinContainer\updateSkin().

         {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getName()

ilSkinXML::getName ( )

Returns: string

Definition at line 270 of file class.ilSkinXML.php.

References $name.

Referenced by ilSystemStyleDeleteGUI\addStyle(), and asXML().

         {
                 return $this->name;
         }

Here is the caller graph for this function:

◆ getStyle()

ilSkinXML::getStyle ( $id )

Parameters

$id

Returns: ilSkinStyleXML

Exceptions

ilSystemStyleException

Definition at line 180 of file class.ilSkinXML.php.

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

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

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

ilSkinXML::getStyles ( )

Returns: ilSkinStyleXML[]

Definition at line 286 of file class.ilSkinXML.php.

References $styles.

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

         {
                 return $this->styles;
         }

Here is the caller graph for this function:

◆ getSubstylesOfStyle()

ilSkinXML::getSubstylesOfStyle ( $style_id )

Parameters

$style_id

Returns: array

Definition at line 339 of file class.ilSkinXML.php.

References $style, array, getStyle(), and getStyles().

Referenced by asXML().

                                                       {
                 $substyles = array();
 
                 if($this->getStyle($style_id)){
                         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()

ilSkinXML::getVersion ( )

Returns: string

Definition at line 302 of file class.ilSkinXML.php.

References $version.

Referenced by asXML().

     {
         return $this->version;
     }

Here is the caller graph for this function:

◆ getVersionStep()

ilSkinXML::getVersionStep ( $version )

Returns: string

Definition at line 320 of file class.ilSkinXML.php.

References $version, count(), and isVersionChangeable().

     {
         if($this->isVersionChangeable()) {
             $v = explode('.', ($version == "" ? '0.1' : $version));
             $v[count($v) - 1] = ($v[count($v) - 1] + 1);
             $this->version = implode('.', $v);
         }
         return $this->version;
     }

Here is the call graph for this function:

◆ hasStyle()

ilSkinXML::hasStyle ( $id )

Parameters

$id

Returns: bool

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

References $id, $style, and getStyles().

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

Here is the call graph for this function:

◆ hasStyles()

ilSkinXML::hasStyles ( )

Returns: bool

Definition at line 376 of file class.ilSkinXML.php.

References count(), and getStyles().

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

Here is the call graph for this function:

◆ hasStyleSubstyles()

ilSkinXML::hasStyleSubstyles ( $style_id )

Returns wheter a given style has substyles.

Parameters

$style_id

Returns: bool

Definition at line 359 of file class.ilSkinXML.php.

References $style, getStyle(), and getStyles().

                                                     {
                 if($this->getStyle($style_id)){
                         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:

◆ isVersionChangeable()

ilSkinXML::isVersionChangeable ( )

Definition at line 330 of file class.ilSkinXML.php.

Referenced by getVersionStep(), and setVersion().

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

Here is the caller graph for this function:

◆ key()

ilSkinXML::key ( )

Returns: mixed

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

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

◆ next()

ilSkinXML::next ( )

Definition at line 232 of file class.ilSkinXML.php.

                                {
                 next($this->styles);
         }

◆ removeStyle()

ilSkinXML::removeStyle ( $id )

Parameters

$id

Exceptions

ilSystemStyleException

Definition at line 165 of file class.ilSkinXML.php.

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

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

ilSkinXML::rewind ( )

Definition at line 235 of file class.ilSkinXML.php.

                                  {
                 reset($this->styles);
         }

◆ setId()

ilSkinXML::setId ( $id )

Parameters

$id

Exceptions

ilSystemStyleException

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

References $id, and ilSystemStyleException\INVALID_CHARACTERS_IN_ID.

Referenced by __construct().

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

ilSkinXML::setName ( $name )

Parameters

string $name

Definition at line 278 of file class.ilSkinXML.php.

References $name.

Referenced by __construct().

         {
                 $this->name = $name;
         }

Here is the caller graph for this function:

◆ setStyles()

ilSkinXML::setStyles ( $styles )

Parameters

ilSkinStyleXML[] $styles

Definition at line 294 of file class.ilSkinXML.php.

References $styles.

         {
                 $this->styles = $styles;
         }

◆ setVersion()

ilSkinXML::setVersion ( $version )

Parameters

string $version

Definition at line 310 of file class.ilSkinXML.php.

References $version, and isVersionChangeable().

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

Here is the call graph for this function:

◆ valid()

ilSkinXML::valid ( )

Iterator implementations.

Returns: bool

Definition at line 214 of file class.ilSkinXML.php.

References current().

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

Here is the call graph for this function:

◆ writeToXMLFile()

ilSkinXML::writeToXMLFile ( $path )

Parameters

$path

Definition at line 151 of file class.ilSkinXML.php.

References $path, and asXML().

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

Here is the call graph for this function:

Field Documentation

◆ $id

ilSkinXML::$id = ""

protected

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

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

◆ $name

ilSkinXML::$name = ""

protected

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

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

◆ $styles

ilSkinXML::$styles = array()

protected

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

Referenced by getStyles(), and setStyles().

◆ $version

ilSkinXML::$version = "0.1"

protected

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

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

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

Services/Style/System/classes/Utilities/class.ilSkinXML.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addChildToXML()

◆ addStyle()

◆ asXML()

◆ count()

◆ current()

◆ getDefaultStyle()

◆ getId()

◆ getName()

◆ getStyle()

◆ getStyles()

◆ getSubstylesOfStyle()

◆ getVersion()

◆ getVersionStep()

◆ hasStyle()

◆ hasStyles()

◆ hasStyleSubstyles()

◆ isVersionChangeable()

◆ key()

◆ next()

◆ removeStyle()

◆ rewind()

◆ setId()

◆ setName()

◆ setStyles()

◆ setVersion()

◆ valid()

◆ writeToXMLFile()

Field Documentation

◆ $id

◆ $name

◆ $styles

◆ $version