ilFolderXmlParser Class Reference

XML parser for folder xml. More...

Inheritance diagram for ilFolderXmlParser:

Collaboration diagram for ilFolderXmlParser:

Public Member Functions
	__construct ($folder, $xml)
	Constructor. More...
	setFolder (ilObject $folder)
	set weblink More...
	getFolder ()
	Get folder object. More...
	start ()
	setHandlers ($a_xml_parser)
	set event handlers 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 Attributes
	$error

Private Attributes
	$folder = null

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

XML parser for folder xml.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 15 of file class.ilFolderXmlParser.php.

Constructor & Destructor Documentation

__construct()

ilFolderXmlParser::__construct	(		$folder,
			$xml
	)

Constructor.

Definition at line 28 of file class.ilFolderXmlParser.php.

References $DIC, $folder, $xml, setFolder(), ilSaxParser\setThrowException(), and ilSaxParser\setXMLContent().

    {
        global $DIC;

        $this->error = $DIC["ilErr"];
        parent::__construct();
        $this->setXMLContent($xml);
        $this->setFolder($folder);
        $this->setThrowException(true);
    }

Here is the call graph for this function:

Member Function Documentation

getFolder()

ilFolderXmlParser::getFolder

(

)

Get folder object.

Returns

ilObject

Definition at line 53 of file class.ilFolderXmlParser.php.

References $folder.

Referenced by handlerBeginTag(), and handlerEndTag().

    {
        return $this->folder;
    }

Here is the caller graph for this function:

handlerBeginTag()

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

handler for begin of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name
array	$a_attribs	element attributes array

Definition at line 91 of file class.ilFolderXmlParser.php.

References $error, $ilErr, ilContainerSortingSettings\_importContainerSortingSettings(), and getFolder().

    {
        $ilErr = $this->error;

        switch ($a_name) {

            case 'Folder':
                break;


            case 'Sorting':
            case 'Sort':
                include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
                ilContainerSortingSettings::_importContainerSortingSettings($a_attribs, $this->getFolder()->getId());
                break;
                
            case 'Title':
            case 'Description':
                break;
        }
    }

Here is the call graph for this function:

handlerCharacterData()

ilFolderXmlParser::handlerCharacterData	(		$a_xml_parser,
			$a_data
	)

handler for character data

Parameters

resource	$a_xml_parser	xml parser
string	$a_data	character data

Definition at line 153 of file class.ilFolderXmlParser.php.

    {
        if ($a_data != "\n") {
            // Replace multiple tabs with one space
            $a_data = preg_replace("/\t+/", " ", $a_data);
            $this->cdata .= $a_data;
        }
    }

handlerEndTag()

ilFolderXmlParser::handlerEndTag	(		$a_xml_parser,
			$a_name
	)

handler for end of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name

Exceptions

ilSaxParserException	if invalid xml structure is given
ilWebLinkXMLParserException	missing elements

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

References $GLOBALS, and getFolder().

    {
        $GLOBALS['ilLog']->write(__METHOD__ . ': Called ' . $a_name);

        switch ($a_name) {
                
            case 'Folder':
                $this->getFolder()->update();
                break;
                
            case 'Title':
                $this->getFolder()->setTitle(trim($this->cdata));
                break;
                
            case 'Description':
                $this->getFolder()->setDescription(trim($this->cdata));
                break;
                
        }
        
        // Reset cdata
        $this->cdata = '';
    }

Here is the call graph for this function:

setFolder()

ilFolderXmlParser::setFolder

(

ilObject

$folder

)

set weblink

Parameters

ilObject

$webl

Returns

Definition at line 44 of file class.ilFolderXmlParser.php.

References $folder.

Referenced by __construct().

    {
        $this->folder = $folder;
    }

Here is the caller graph for this function:

setHandlers()

ilFolderXmlParser::setHandlers

(

$a_xml_parser

)

set event handlers

Parameters

resource

reference to the xml parser private

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

start()

ilFolderXmlParser::start

(

)

Returns

Exceptions

ilSaxParserException	if invalid xml structure is given
ilWebLinkXMLParserException	missing elements

Definition at line 66 of file class.ilFolderXmlParser.php.

References ilSaxParser\startParsing().

    {
        return $this->startParsing();
    }

Here is the call graph for this function:

Field Documentation

$error

ilFolderXmlParser::$error

protected

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

Referenced by handlerBeginTag().

$folder

ilFolderXmlParser::$folder = null

private

Definition at line 22 of file class.ilFolderXmlParser.php.

Referenced by __construct(), getFolder(), and setFolder().

---

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

• Modules/Folder/classes/class.ilFolderXmlParser.php