parses the template.xml that defines all styles of the current template More...

Inheritance diagram for ilStyleDefinition:

Collaboration diagram for ilStyleDefinition:

Public Member Functions
	ilStyleDefinition ($a_template_id="")
	Constructor. More...

	getStyles ()
	get translation type (sys, db or 0)s More...

	getTemplateId ()

	getTemplateName ()

	getTemplateVersion ()

	getStyle ($a_id)

	getStyleName ($a_id)

	getImageDirectory ($a_master_style, $a_substyle="")

	getSoundDirectory ($a_id)

	getAllTemplates ()

	setHandlers ($a_xml_parser)
	set event handler More...

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	start tag handler More...

	handlerCharacterData ($a_xml_parser, $a_data)
	end tag handler More...

	handlerEndTag ($a_xml_parser, $a_name)
	end tag handler More...

	writeSystemStyleCategoryAssignment ($a_skin_id, $a_style_id, $a_substyle, $a_ref_id)
	Write category assignment. More...

	deleteSystemStyleCategoryAssignment ($a_skin_id, $a_style_id, $a_substyle, $a_ref_id)
	Delete category style assignment. More...

Public Member Functions inherited from ilSaxParser
	ilSaxParser ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object public. More...

	setXMLContent ($a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()
	create parser More...

	setOptions ($a_xml_parser)
	set parser options More...

	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private More...

	openXMLFile ()
	open xml file More...

	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...

	freeParser ($a_xml_parser)
	free xml parser handle More...

	setThrowException ($throwException)
	set error handling More...

Public Member Functions inherited from PEAR
	PEAR ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

&	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

Static Public Member Functions
static	_getAllTemplates ()

static	styleExists ($skin, $style)
	Check wheter a style exists. More...

static	skinExists ($skin)
	Check wheter a skin exists. More...

static	getCurrentStyle ()
	get the current style More...

static	getCurrentMasterStyle ()
	get the current style More...

static	setCurrentSkin ($a_skin)
	set a new current skin More...

static	setCurrentStyle ($a_style)
	set a new current style More...

static	getAllSkinStyles ()
	Get all skins/styles. More...

static	getSystemStyleCategoryAssignments ($a_skin_id, $a_style_id)
	Get all system style category assignments. More...

Static Public Attributes
static	$current_skin

static	$current_style

static	$current_master_style

Additional Inherited Members
Data Fields inherited from ilSaxParser
	$input_type = null

	$xml_content = ''

	$ilias

	$lng

	$xml_file

	$throwException = false

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Detailed Description

parses the template.xml that defines all styles of the current template

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 14 of file class.ilStyleDefinition.php.

Member Function Documentation

◆ _getAllTemplates()

static ilStyleDefinition::_getAllTemplates ( )

static

Definition at line 125 of file class.ilStyleDefinition.php.

References $file.

Referenced by ilUserImportParser\ilUserImportParser().

         {
                 $skins = array();
 
                 $skins[] = array("id" => "default");
                 if ($dp = @opendir("./Customizing/global/skin"))
                 {
                         while (($file = readdir($dp)) != false)
                         {
                                 //is the file a directory?
                                 if (is_dir("./Customizing/global/skin/".$file) && $file != "." && $file != ".." && $file != "CVS"
                                         && $file != ".svn")
                                 {
                                         if (is_file("./Customizing/global/skin/".$file."/template.xml"))
                                         {
                                                 $skins[] = array(
                                                         "id" => $file
                                                 );
                                         }
                                 }
                         } // while
                 }
                 else
                 {
                         return $skins;
                 }
 
                 return $skins;
                 
         }

Here is the caller graph for this function:

◆ deleteSystemStyleCategoryAssignment()

ilStyleDefinition::deleteSystemStyleCategoryAssignment	(	$a_skin_id,
		$a_style_id,
		$a_substyle,
		$a_ref_id
	)

Delete category style assignment.

Parameters

Definition at line 592 of file class.ilStyleDefinition.php.

References $ilDB.

Referenced by ilObjStyleSettingsGUI\deleteSysStyleCatAssignmentsObject().

         {
                 global $ilDB;
                 
                 $ilDB->manipulate("DELETE FROM syst_style_cat WHERE ".
                         " skin_id = ".$ilDB->quote($a_skin_id, "text").
                         " AND style_id = ".$ilDB->quote($a_style_id, "text").
                         " AND substyle = ".$ilDB->quote($a_substyle, "text").
                         " AND category_ref_id = ".$ilDB->quote($a_ref_id, "integer"));
         }

Here is the caller graph for this function:

◆ getAllSkinStyles()

static ilStyleDefinition::getAllSkinStyles ( )

static

Get all skins/styles.

Parameters

Definition at line 505 of file class.ilStyleDefinition.php.

References $style, ilObjUser\_getNumberOfUsersForStyle(), and ilStyleDefinition().

Referenced by ilObjStyleSettingsGUI\assignStylesToCatsObject(), ilObjStyleSettingsGUI\editSystemStylesObject(), ilSystemStylesTableGUI\getStyles(), and ilObjStyleSettingsGUI\saveStyleSettingsObject().

         {
                 global $styleDefinition;
                 
                 $all_styles = array();
                 
                 $templates = $styleDefinition->getAllTemplates();
                 
                 foreach ($templates as $template)
                 {
                         // get styles definition for template
                         $styleDef = new ilStyleDefinition($template["id"]);
                         $styleDef->startParsing();
                         $styles = $styleDef->getStyles();
 
                         foreach ($styles as $style)
                         {
                                 $num_users = ilObjUser::_getNumberOfUsersForStyle($template["id"], $style["id"]);
                                 
                                 // default selection list
                                 $all_styles[$template["id"].":".$style["id"]] =
                                         array (
                                                 "title" => $styleDef->getTemplateName()." / ".$style["name"],
                                                 "id" => $template["id"].":".$style["id"],
                                                 "template_id" => $template["id"],
                                                 "style_id" => $style["id"],
                                                 "template_name" => $styleDef->getTemplateName(),
                                                 "substyle" => $style["substyle"],
                                                 "style_name" => $style["name"],
                                                 "users" => $num_users
                                                 );
                         }
                 }
 
                 return $all_styles;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllTemplates()

ilStyleDefinition::getAllTemplates ( )

Definition at line 156 of file class.ilStyleDefinition.php.

         {
                 return self::_getAllTemplates();
         }

◆ getCurrentMasterStyle()

static ilStyleDefinition::getCurrentMasterStyle ( )

static

get the current style

use always this function instead of getting the account's style the current style may be changed on the fly by setCurrentStyle()

Returns: string style id

Definition at line 428 of file class.ilStyleDefinition.php.

References ilSaxParser\$ilias.

Referenced by ilUtil\getImagePath().

         {
                 global $ilias;  
                 
                 if (isset(self::$current_master_style))
                 {
                         return self::$current_master_style;
                 }
 
                 $cs = $ilias->account->prefs['style'];
 
                 self::$current_master_style = $cs;
                 
                 return $cs;
         }

Here is the caller graph for this function:

◆ getCurrentStyle()

static ilStyleDefinition::getCurrentStyle ( )

static

get the current style

use always this function instead of getting the account's style the current style may be changed on the fly by setCurrentStyle()

Returns: string|null style id

Definition at line 362 of file class.ilStyleDefinition.php.

References $_GET, ilSaxParser\$ilias, and $path.

Referenced by ilUtil\getImagePath(), and ilUtil\getStyleSheetLocation().

         {
                 global $ilias, $tree, $styleDefinition, $tree;  
                 
                 if (isset(self::$current_style))
                 {
                         return self::$current_style;
                 }
 
                 if(!is_object($ilias))
                 {
                         return null;
                 }
 
                 $cs = $ilias->account->prefs['style'];
                 
                 if (is_object($styleDefinition))
                 {
                         // are there any substyles?
                         $styles = $styleDefinition->getStyles();
                         if (is_array($styles[$cs]["substyle"]))
                         {
                                 // read assignments, if given
                                 $assignmnts = self::getSystemStyleCategoryAssignments(self::getCurrentSkin(), $cs);
                                 if (count($assignmnts) > 0)
                                 {
                                         $ref_ass = array();
                                         foreach ($assignmnts as $a)
                                         {
                                                 $ref_ass[$a["ref_id"]] = $a["substyle"];
                                         }
 
                                         // check whether any ref id assigns a new style
                                         if (is_object($tree) && $_GET["ref_id"] > 0 &&
                                                 $tree->isInTree($_GET["ref_id"]))
                                         {
                                                 $path = $tree->getPathId((int) $_GET["ref_id"]);
                                                 for ($i = count($path) - 1; $i >= 0; $i--)
                                                 {
                                                         if (isset($ref_ass[$path[$i]]))
                                                         {
                                                                 self::$current_style = $ref_ass[$path[$i]];
                                                                 return self::$current_style;
                                                         }
                                                 }
                                         }
                                 }
                         }
                 }
                 
                 if ($_GET["ref_id"] != "")
                 {
                         self::$current_style = $cs;
                 }
                 
                 return $cs;
         }

Here is the caller graph for this function:

◆ getImageDirectory()

ilStyleDefinition::getImageDirectory	(	$a_master_style,
		$a_substyle = `""`
	)

Definition at line 111 of file class.ilStyleDefinition.php.

         {
                 if ($a_substyle != $a_master_style && $a_substyle != "")
                 {
                         return $this->styles[$a_master_style]["substyle"][$a_substyle]["image_directory"];
                 }
                 return $this->styles[$a_master_style]["image_directory"];
         }

◆ getSoundDirectory()

ilStyleDefinition::getSoundDirectory ( $a_id )

Definition at line 120 of file class.ilStyleDefinition.php.

         {
                 return $this->styles[$a_id]["sound_directory"];
         }

◆ getStyle()

ilStyleDefinition::getStyle ( $a_id )

Definition at line 100 of file class.ilStyleDefinition.php.

         {
                 return $this->styles[$a_id];
         }

◆ getStyleName()

ilStyleDefinition::getStyleName ( $a_id )

Definition at line 106 of file class.ilStyleDefinition.php.

         {
                 return $this->styles[$a_id]["name"];
         }

◆ getStyles()

ilStyleDefinition::getStyles ( )

get translation type (sys, db or 0)s

Parameters

string object type public

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

         {
 //echo ":".count($this->styles).":";
                 if (is_array($this->styles))
                 {
                         return $this->styles;
                 }
                 else
                 {
                         return array();
                 }
         }

◆ getSystemStyleCategoryAssignments()

static ilStyleDefinition::getSystemStyleCategoryAssignments	(	$a_skin_id,
		$a_style_id
	)

static

Get all system style category assignments.

Parameters

string	$a_skin_id	skin id
string	$a_style_id	style id

Returns: array ref ids

Definition at line 549 of file class.ilStyleDefinition.php.

References $ilDB.

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

         {
                 global $ilDB;
                 
                 $assignmnts = array();
                 $set = $ilDB->query("SELECT substyle, category_ref_id FROM syst_style_cat ".
                         " WHERE skin_id = ".$ilDB->quote($a_skin_id, "text").
                         " AND style_id = ".$ilDB->quote($a_style_id, "text")
                         );
                 while ($rec = $ilDB->fetchAssoc($set))
                 {
                         $assignmnts[] = array("substyle" => $rec["substyle"],
                                 "ref_id" => $rec["category_ref_id"]);
                 }
                 return $assignmnts;
         }

Here is the caller graph for this function:

◆ getTemplateId()

ilStyleDefinition::getTemplateId ( )

Definition at line 84 of file class.ilStyleDefinition.php.

References $template_id.

         {
                 return $this->template_id;
         }

◆ getTemplateName()

ilStyleDefinition::getTemplateName ( )

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

         {
                 return $this->template_name;
         }

◆ getTemplateVersion()

ilStyleDefinition::getTemplateVersion ( )

Definition at line 95 of file class.ilStyleDefinition.php.

         {
                 return $this->template_version;
         }

◆ handlerBeginTag()

ilStyleDefinition::handlerBeginTag	(	$a_xml_parser,
		$a_name,
		$a_attribs
	)

start tag handler

Parameters

ressouce	internal xml_parser_handler
string	element tag name
array	element attributes private

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

         {
                 if (!isset($a_attribs["sound_directory"]))
                 {
                         $a_attribs["sound_directory"] = "";
                 }
                 
                 if (!isset($a_attribs["browsers"]))
                 {
                         $a_attribs["browsers"] = "";
                 }
                 
                 switch($a_name)
                 {
                         case "template" :
                                 $this->template_name = $a_attribs["name"];
                                 $this->template_version = $a_attribs["version"];
                                 break;
 
                         case "style" :
                                 $this->last_style_id = $a_attribs["id"];
                                 $this->styles[$a_attribs["id"]] =
                                         array(  "id" => $a_attribs["id"],
                                                         "name" => $a_attribs["name"],
                                                         "css_file" => $a_attribs["id"].".css",
                                                         "image_directory" => $a_attribs["image_directory"],
                                                         "sound_directory" => $a_attribs["sound_directory"]
                                         );
                                 $browsers =
                                         explode(",", $a_attribs["browsers"]);
                                 foreach ($browsers as $val)
                                 {
                                         $this->styles[$a_attribs["id"]]["browsers"][] = trim($val);
                                 }
                                 break;
                                 
                         case "substyle":
                                 $this->styles[$this->last_style_id]["substyle"][$a_attribs["id"]] =
                                         array(  "id" => $a_attribs["id"],
                                                         "name" => $a_attribs["name"],
                                                         "css_file" => $a_attribs["id"].".css",
                                                         "image_directory" => $a_attribs["image_directory"],
                                                         "sound_directory" => $a_attribs["sound_directory"]
                                         );
                                 break;
                 }
         }

◆ handlerCharacterData()

ilStyleDefinition::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

end tag handler

Parameters

ressouce	internal xml_parser_handler
string	data private

Definition at line 298 of file class.ilStyleDefinition.php.

         {
                 // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
                 $a_data = preg_replace("/\n/","",$a_data);
                 $a_data = preg_replace("/\t+/","",$a_data);
 
                 if(!empty($a_data))
                 {
                         switch($this->current_tag)
                         {
                                 default:
                                         break;
                         }
                 }
         }

◆ handlerEndTag()

ilStyleDefinition::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

end tag handler

Parameters

ressouce	internal xml_parser_handler
string	element tag name private

Definition at line 321 of file class.ilStyleDefinition.php.

References ilSaxParser\$ilias.

322 {

323 }

◆ ilStyleDefinition()

ilStyleDefinition::ilStyleDefinition ( $a_template_id = "" )

Constructor.

parse

public

Definition at line 39 of file class.ilStyleDefinition.php.

References ilSaxParser\$ilias.

Referenced by getAllSkinStyles(), and setCurrentSkin().

         {
                 global $ilias;
 
                 if ($a_template_id == "")
                 {
                         // use function to get the current skin
                         $a_template_id = self::getCurrentSkin();
                 }
 
                 // remember the template id
                 $this->template_id = $a_template_id;
 
                 if ($a_template_id == "default")
                 {
                         parent::ilSaxParser("./templates/".$a_template_id."/template.xml");
                 }
                 else
                 {
                         parent::ilSaxParser("./Customizing/global/skin/".$a_template_id."/template.xml");
                 }
         }

Here is the caller graph for this function:

◆ setCurrentSkin()

static ilStyleDefinition::setCurrentSkin ( $a_skin )

static

set a new current skin

Parameters

string skin id

Definition at line 474 of file class.ilStyleDefinition.php.

References ilStyleDefinition().

         {
                 global $styleDefinition;
 
                 if (is_object($styleDefinition)
                 and $styleDefinition->getTemplateId() != $a_skin)
                 {
                         $styleDefinition = new ilStyleDefinition($a_skin);
                         $styleDefinition->startParsing();
                 }
                 
                 self::$current_skin = $a_skin;
         }

Here is the call graph for this function:

◆ setCurrentStyle()

static ilStyleDefinition::setCurrentStyle ( $a_style )

static

set a new current style

Parameters

string style id

Definition at line 494 of file class.ilStyleDefinition.php.

         {
                 self::$current_style = $a_style;
         }

◆ setHandlers()

ilStyleDefinition::setHandlers ( $a_xml_parser )

set event handler

Parameters

ressouce internal xml_parser_handler private

Definition at line 170 of file class.ilStyleDefinition.php.

         {
                 xml_set_object($a_xml_parser,$this);
                 xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
                 xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
         }

◆ skinExists()

static ilStyleDefinition::skinExists ( $skin )

static

Check wheter a skin exists.

Parameters

string $skin skin id

Returns: boolean

Definition at line 272 of file class.ilStyleDefinition.php.

Referenced by ilObjUser\read().

         {
                 if ($skin == "default")
                 {               
                         if (is_file("./templates/".$skin."/template.xml"))
                         {
                                 return true;
                         }
                 }
                 else
                 {
                         if (is_file("./Customizing/global/skin/".$skin."/template.xml"))
                         {
                                 return true;
                         }
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ styleExists()

static ilStyleDefinition::styleExists	(	$skin,
		$style
	)

static

Check wheter a style exists.

Parameters

string	$skin	skin id
string	$style	style id

Returns: boolean

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

References $style.

         {
                 if ($skin == "default")
                 {               
                         if (is_file("./templates/".$skin."/template.xml") &&
                                 is_file("./templates/".$skin."/".$style.".css")
                                 )
                         {
                                 return true;
                         }
                 }
                 else
                 {
                         if (is_file("./Customizing/global/skin/".$skin."/template.xml") &&
                                 is_file("./Customizing/global/skin/".$skin."/".$style.".css")
                                 )
                         {
                                 return true;
                         }
                 }
                 return false;
         }

◆ writeSystemStyleCategoryAssignment()

ilStyleDefinition::writeSystemStyleCategoryAssignment	(	$a_skin_id,
		$a_style_id,
		$a_substyle,
		$a_ref_id
	)

Write category assignment.

Parameters

Definition at line 572 of file class.ilStyleDefinition.php.

References $ilDB.

Referenced by ilObjStyleSettingsGUI\saveStyleCatAssignmentObject().

         {
                 global $ilDB;
                 
                 $ilDB->manipulate("INSERT INTO syst_style_cat ".
                         "(skin_id, style_id, substyle, category_ref_id) VALUES (".
                         $ilDB->quote($a_skin_id, "text").",".
                         $ilDB->quote($a_style_id, "text").",".
                         $ilDB->quote($a_substyle, "text").",".
                         $ilDB->quote($a_ref_id, "integer").
                         ")");
         }

Here is the caller graph for this function:

Field Documentation

◆ $current_master_style

ilStyleDefinition::$current_master_style

static

Definition at line 29 of file class.ilStyleDefinition.php.

◆ $current_skin

ilStyleDefinition::$current_skin

static

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

◆ $current_style

ilStyleDefinition::$current_style

static

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

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

Services/Style/classes/class.ilStyleDefinition.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getAllTemplates()

◆ deleteSystemStyleCategoryAssignment()

◆ getAllSkinStyles()

◆ getAllTemplates()

◆ getCurrentMasterStyle()

◆ getCurrentStyle()

◆ getImageDirectory()

◆ getSoundDirectory()

◆ getStyle()

◆ getStyleName()

◆ getStyles()

◆ getSystemStyleCategoryAssignments()

◆ getTemplateId()

◆ getTemplateName()

◆ getTemplateVersion()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ ilStyleDefinition()

◆ setCurrentSkin()

◆ setCurrentStyle()

◆ setHandlers()

◆ skinExists()

◆ styleExists()

◆ writeSystemStyleCategoryAssignment()

Field Documentation

◆ $current_master_style

◆ $current_skin

◆ $current_style