ilStyleImportParser Class Reference

Style Import Parser. More...

Inheritance diagram for ilStyleImportParser:

Collaboration diagram for ilStyleImportParser:

Public Member Functions
	__construct ($a_xml_file, &$a_style_obj)
	Constructor. More...
	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private More...
	startParsing ()
	start the parser More...
	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	handler for begin of element More...
	handlerEndTag ($a_xml_parser, $a_name)
	handler for end of element More...
	handlerCharacterData ($a_xml_parser, $a_data)
	handler for character data More...
Public Member Functions inherited from ilSaxParser
	__construct ($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
	__construct ($error_class=null)
	Constructor. More...
	_PEAR ()
	Destructor (the emulated type of...). 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...
	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...

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

Protected Attributes
	$tree

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static &	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...
static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...
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()

Detailed Description

Style Import Parser.

Author

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

Version

$Id$

Definition at line 16 of file class.ilStyleImportParser.php.

Constructor & Destructor Documentation

__construct()

ilStyleImportParser::__construct	(		$a_xml_file,
		&	$a_style_obj
	)

Constructor.

Parameters

string	$a_xml_file	xml file
int	$a_mode	IL_EXTRACT_ROLES | IL_USER_IMPORT

public

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

References $DIC, ilSaxParser\$lng, $tree, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->tree = $DIC->repositoryTree();
        $lng = $DIC->language();
        $tree = $DIC->repositoryTree();

        $this->style_obj = $a_style_obj;

        parent::__construct($a_xml_file);
    }

Here is the call graph for this function:

Member Function Documentation

handlerBeginTag()

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

handler for begin of element

Definition at line 74 of file class.ilStyleImportParser.php.

References trimAndStripAttribs().

    {
        $a_attribs = $this->trimAndStripAttribs($a_attribs);
        switch ($a_name) {
            case "Style":
                $this->current_tag = $a_attribs["Tag"];
                $this->current_class = $a_attribs["Class"];
                $this->current_type = $a_attribs["Type"];
                if ($this->current_class == "PageTitle" && $this->current_type == "page_title" && $this->current_tag == "div") {
                    $this->current_tag = "h1";
                }
                if ($this->current_class == "Headline1" && $this->current_tag == "div") {
                    $this->current_tag = "h1";
                    $this->current_type = "heading1";
                }
                if ($this->current_class == "Headline2" && $this->current_tag == "div") {
                    $this->current_tag = "h2";
                    $this->current_type = "heading2";
                }
                if ($this->current_class == "Headline3" && $this->current_tag == "div") {
                    $this->current_tag = "h3";
                    $this->current_type = "heading3";
                }
                $this->current_tags = array();
                $this->chars[] = array("type" => $this->current_type,
                    "class" => $this->current_class);
                break;
                
            case "StyleParameter":
                $this->current_tags[] = array(
                    "tag" => $this->current_tag,
                    "class" => $this->current_class,
                    "parameter" => $a_attribs["Name"],
                    "type" => $this->current_type,
                    "value" => $a_attribs["Value"],
                    "custom" => $a_attribs["Custom"]);
                break;
                
            case "StyleColor":
                $this->style_obj->addColor($a_attribs["Name"], $a_attribs["Code"]);
                break;

            case "StyleTemplate":
                $this->cur_template = array("type" => $a_attribs["Type"],
                    "name" => $a_attribs["Name"]);
                $this->cur_template_classes = array();
                break;
                
            case "StyleTemplateClass":
                $this->cur_template_classes[$a_attribs["ClassType"]] =
                    $a_attribs["Class"];
                break;

        }
        $this->cdata = "";
    }

Here is the call graph for this function:

handlerCharacterData()

ilStyleImportParser::handlerCharacterData	(		$a_xml_parser,
			$a_data
	)

handler for character data

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

    {
        // i don't know why this is necessary, but
        // the parser seems to convert "&gt;" to ">" and "&lt;" to "<"
        // in character data, but we don't want that, because it's the
        // way we mask user html in our content, so we convert back...
        $a_data = str_replace("<", "&lt;", $a_data);
        $a_data = str_replace(">", "&gt;", $a_data);

        // 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)) {
            $this->cdata .= $a_data;
        }
    }

handlerEndTag()

ilStyleImportParser::handlerEndTag	(		$a_xml_parser,
			$a_name
	)

handler for end of element

Definition at line 135 of file class.ilStyleImportParser.php.

References trimAndStrip().

    {
        $this->cdata = $this->trimAndStrip($this->cdata);
        switch ($a_name) {
            case "Title":
                $this->style_obj->setTitle($this->cdata);
                break;
                
            case "Description":
                $this->style_obj->setDescription($this->cdata);
                break;
                
            case "Style":
                $this->styles[] = $this->current_tags;
                break;
                
            case "StyleTemplate":
                $this->style_obj->addTemplate(
                    $this->cur_template["type"],
                    $this->cur_template["name"],
                    $this->cur_template_classes
                );
                break;

        }
    }

Here is the call graph for this function:

setHandlers()

ilStyleImportParser::setHandlers

(

$a_xml_parser

)

set event handler should be overwritten by inherited class private

Definition at line 52 of file class.ilStyleImportParser.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');
    }

startParsing()

ilStyleImportParser::startParsing

(

)

start the parser

Definition at line 62 of file class.ilStyleImportParser.php.

    {
        $this->styles = array();
        parent::startParsing();
        $this->style_obj->setStyle($this->styles);
        $this->style_obj->setCharacteristics($this->chars);
    }

trimAndStrip()

ilStyleImportParser::trimAndStrip ( string  $input )

protected

Definition at line 191 of file class.ilStyleImportParser.php.

References ilUtil\stripSlashes().

Referenced by handlerEndTag(), and trimAndStripAttribs().

                                                   : string
    {
        return ilUtil::stripSlashes(trim($input));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

trimAndStripAttribs()

ilStyleImportParser::trimAndStripAttribs ( array  $attribs )

protected

Definition at line 182 of file class.ilStyleImportParser.php.

References $ret, and trimAndStrip().

Referenced by handlerBeginTag().

                                                           : array
    {
        $ret = [];
        foreach ($attribs as $k => $v) {
            $ret[$k] = $this->trimAndStrip((string) $v);
        }
        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$tree

ilStyleImportParser::$tree

protected

Definition at line 21 of file class.ilStyleImportParser.php.

Referenced by __construct().

---

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

• Services/Style/Content/classes/class.ilStyleImportParser.php