ilStyleDefinition Class Reference

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.
	getStyles ()
	get translation type (sys, db or 0)s
	getTemplateId ()
	getTemplateName ()
	getStyle ($a_id)
	getStyleName ($a_id)
	getImageDirectory ($a_id)
	getSoundDirectory ($a_id)
	getAllTemplates ()
	setHandlers ($a_xml_parser)
	set event handler
	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	start tag handler
	handlerCharacterData ($a_xml_parser, $a_data)
	end tag handler
	handlerEndTag ($a_xml_parser, $a_name)
	end tag handler
Public Member Functions inherited from ilSaxParser
	ilSaxParser ($a_xml_file= '', $throwException=false)
	Constructor setup ILIAS global object public.
	setXMLContent ($a_xml_content)
	getXMLContent ()
	getInputType ()
	startParsing ()
	stores xml data in array
	createParser ()
	create parser
	setOptions ($a_xml_parser)
	set parser options
	openXMLFile ()
	open xml file
	parse ($a_xml_parser, $a_fp=null)
	parse xml file
	freeParser ($a_xml_parser)
	free xml parser handle
	setThrowException ($throwException)
	set error handling
Public Member Functions inherited from PEAR
	PEAR ($error_class=null)
	Constructor.
	_PEAR ()
	Destructor (the emulated type of...).
&	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.
	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes.
	isError ($data, $code=null)
	Tell whether a value is a PEAR error.
	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled.
	expectError ($code= '*')
	This method is used to tell which errors you expect to get.
	popExpect ()
	This method pops one element off the expected error codes stack.
	_checkDelExpect ($error_code)
	This method checks unsets an error code if available.
	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack.
&	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.
&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options.
	staticPushErrorHandling ($mode, $options=null)
	staticPopErrorHandling ()
	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack.
	popErrorHandling ()
	Pop the last error handler used.
	loadExtension ($ext)
	OS independant PHP extension load.

Static Public Member Functions
static	_getAllTemplates ()
static	styleExists ($skin, $style)
	Check wheter a style exists.
static	skinExists ($skin)
	Check wheter a skin exists.
static	getCurrentSkin ()
	get the current skin
static	getCurrentStyle ()
	get the current style
static	setCurrentSkin ($a_skin)
	set a new current skin
static	setCurrentStyle ($a_style)
	set a new current style

Static Public Attributes
static	$current_skin
static	$current_style

Additional Inherited Members
Data Fields inherited from ilSaxParser
	$input_type = null
	$xml_content = ''
	$ilias
	$lng
	$xml_file
	$throwException = false
Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle

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:

class.ilStyleDefinition.php 31126 2011-10-13 16:40:55Z fneumann

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

Member Function Documentation

static ilStyleDefinition::_getAllTemplates ( )

static

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

References $file.

Referenced by getAllTemplates(), and 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:

ilStyleDefinition::getAllTemplates

(

)

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

References _getAllTemplates().

        {
                return self::_getAllTemplates();
        }

Here is the call graph for this function:

static ilStyleDefinition::getCurrentSkin ( )

static

get the current skin

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

Returns

string skin id

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

References ilSaxParser\$ilias.

Referenced by ilUtil\getImagePath(), ilUtil\getJSLocation(), ilUtil\getNewContentStyleSheetLocation(), ilUtil\getStyleSheetLocation(), ilTemplate\getTemplatePath(), and ilStyleDefinition().

        {
                global $ilias;

                return isset(self::$current_skin) ? self::$current_skin :
                                                                                        $ilias->account->skin;
        }

Here is the caller graph for this function:

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 style id

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

References ilSaxParser\$ilias.

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

        {
                global $ilias;  
                
                return isset(self::$current_style) ? self::$current_style :     
                                                                                        $ilias->account->prefs['style'];
        }

Here is the caller graph for this function:

ilStyleDefinition::getImageDirectory

(

$a_id

)

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

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

ilStyleDefinition::getSoundDirectory

(

$a_id

)

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

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

ilStyleDefinition::getStyle

(

$a_id

)

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

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

ilStyleDefinition::getStyleName

(

$a_id

)

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

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

ilStyleDefinition::getStyles

(

)

get translation type (sys, db or 0)s

Parameters

string

object type public

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

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

ilStyleDefinition::getTemplateId

(

)

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

        {
                return $this->template_id;
        }

ilStyleDefinition::getTemplateName

(

)

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

        {
                return $this->template_name;
        }

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 197 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"];
                                break;

                        case "style" :
                                $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;
                }
        }

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;
                        }
                }
        }

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.

        {
        }

ilStyleDefinition::ilStyleDefinition

(

$a_template_id = ""

)

Constructor.

parse

public

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

References ilSaxParser\$ilias, getCurrentSkin(), and ilSaxParser\ilSaxParser().

Referenced by 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 call graph for this function:

Here is the caller graph for this function:

static ilStyleDefinition::setCurrentSkin (   $a_skin )

static

set a new current skin

Parameters

string

skin id

Definition at line 363 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:

static ilStyleDefinition::setCurrentStyle (   $a_style )

static

set a new current style

Parameters

string

style id

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

        {
                self::$current_style = $a_style;
        }

ilStyleDefinition::setHandlers

(

$a_xml_parser

)

set event handler

Parameters

ressouce

internal xml_parser_handler private

Reimplemented from ilSaxParser.

Definition at line 182 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');
        }

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:

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.

        {
                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;
        }

Field Documentation

ilStyleDefinition::$current_skin

static

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

ilStyleDefinition::$current_style

static

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

---

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

• Services/Style/classes/class.ilStyleDefinition.php