XML parser for folder xml. More...

Inheritance diagram for ilFolderXmlParser:

Collaboration diagram for ilFolderXmlParser:

Public Member Functions
	__construct ($folder, $xml)
	Constructor.
	setFolder (ilObject $folder)
	set weblink
	getFolder ()
	Get folder object.
	start ()
	setHandlers ($a_xml_parser)
	set event handlers
	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	handler for begin of element
	handlerEndTag ($a_xml_parser, $a_name)
	handler for end of element
	handlerCharacterData ($a_xml_parser, $a_data)
	handler for character data
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.

Private Attributes
	$folder = null

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

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

ilFolderXmlParser::__construct	(	$folder,
		$xml
	)

Constructor.

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

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

        {
                parent::__construct();
                $this->setXMLContent($xml);
                $this->setFolder($folder);
                $this->setThrowException(true);
        }

Here is the call graph for this function:

Member Function Documentation

ilFolderXmlParser::getFolder ( )

Get folder object.

Returns: ilObject

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

References $folder.

Referenced by handlerBeginTag(), and handlerEndTag().

        {
                return $this->folder;
        }

Here is the caller graph for this function:

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 83 of file class.ilFolderXmlParser.php.

References $ilErr, getFolder(), ilContainer\SORT_MANUAL, and ilContainer\SORT_TITLE.

        {
                global $ilErr;
                switch($a_name)
                {
                        case 'Folder':
                                break;
                        case 'Sorting':
                                
                                include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
                                $sort = new ilContainerSortingSettings($this->getFolder()->getId());
                                $sort->delete();
                                
                                switch($a_attribs['type'])
                                {
                                        case 'Manual':
                                                $sort->setSortMode(ilContainer::SORT_MANUAL);
                                                break;
                                                                                                
                                        case 'Title':
                                        default:
                                                $sort->setSortMode(ilContainer::SORT_TITLE);            
                                }
                                $sort->save();
                                break;
                                
                        case 'Title':
                        case 'Description':
                                break;
                }
                
        }

Here is the call graph for this function:

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

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 128 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:

ilFolderXmlParser::setFolder ( ilObject $folder )

set weblink

Parameters

ilObject $webl

Returns

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

References $folder.

Referenced by __construct().

        {
                $this->folder = $folder;
        }

Here is the caller graph for this function:

ilFolderXmlParser::setHandlers ( $a_xml_parser )

set event handlers

Parameters

resource reference to the xml parser private

Reimplemented from ilSaxParser.

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

ilFolderXmlParser::start ( )

Returns

Exceptions

ilSaxParserException	if invalid xml structure is given
ilWebLinkXMLParserException	missing elements

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

References ilSaxParser\startParsing().

        {
                return $this->startParsing();
        }

Here is the call graph for this function:

Field Documentation

ilFolderXmlParser::$folder = null

private

Definition at line 17 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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation