ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions
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
 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

Static Public Member Functions

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

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 17192 2008-08-20 21:26:27Z smeyer

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

Member Function Documentation

static ilStyleDefinition::_getAllTemplates ( )
static

Definition at line 114 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 145 of file class.ilStyleDefinition.php.

References _getAllTemplates().

{
return self::_getAllTemplates();
}

+ Here is the call graph for this function:

ilStyleDefinition::getImageDirectory (   $a_id)

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

{
return $this->styles[$a_id]["image_directory"];
}
ilStyleDefinition::getSoundDirectory (   $a_id)

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

{
return $this->styles[$a_id]["sound_directory"];
}
ilStyleDefinition::getStyle (   $a_id)

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

{
return $this->styles[$a_id];
}
ilStyleDefinition::getStyleName (   $a_id)

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

{
return $this->styles[$a_id]["name"];
}
ilStyleDefinition::getStyles ( )

get translation type (sys, db or 0)s

Parameters
stringobject type public

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

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

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

{
return $this->template_name;
}
ilStyleDefinition::handlerBeginTag (   $a_xml_parser,
  $a_name,
  $a_attribs 
)

start tag handler

Parameters
ressouceinternal xml_parser_handler
stringelement tag name
arrayelement attributes private

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

{
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
ressouceinternal xml_parser_handler
stringdata private

Definition at line 265 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
ressouceinternal xml_parser_handler
stringelement tag name private

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

{
}
ilStyleDefinition::ilStyleDefinition (   $a_template_id = "")

Constructor.

parse

public

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

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

{
global $ilias;
if ($a_template_id == "")
{
$a_template_id = $ilias->account->skin;
}
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:

ilStyleDefinition::setHandlers (   $a_xml_parser)

set event handler

Parameters
ressouceinternal xml_parser_handler private

Reimplemented from ilSaxParser.

Definition at line 159 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$skinskin id
Returns
boolean

Definition at line 239 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$skinskin id
string$stylestyle id
Returns
boolean

Definition at line 209 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;
}
The documentation for this class was generated from the following file: