This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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 @access 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 @access 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 ilContainerBaseXmlParser
	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...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 28 of file class.ilFolderXmlParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilFolderXmlParser::__construct	(	$folder,
		$xml
	)

Constructor.

Reimplemented from ilSaxParser.

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

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

References $DIC, $folder, $xml, ILIAS\GlobalScreen\Provider\__construct(), error(), setFolder(), ilSaxParser\setThrowException(), and ilSaxParser\setXMLContent().

Here is the call graph for this function:

Member Function Documentation

◆ getFolder()

ilFolderXmlParser::getFolder ( )

Get folder object.

Returns: ilObject

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

    {
        return $this->folder;
    }

References $folder.

Referenced by handlerBeginTag(), and handlerEndTag().

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

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

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

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

    {
        $GLOBALS['ilLog']->write(__METHOD__ . ': Called ' . $a_name);
 
        switch ($a_name) {
                
            case 'Folder':
                $this->getFolder()->update();
                break;
                
            case 'Title':
                $this->getFolder()->setTitle($this->trimAndStrip((string) $this->cdata));
                break;
                
            case 'Description':
                $this->getFolder()->setDescription($this->trimAndStrip((string) $this->cdata));
                break;
                
        }
        
        // Reset cdata
        $this->cdata = '';
    }

References $GLOBALS, getFolder(), and ilContainerBaseXmlParser\trimAndStrip().

Here is the call graph for this function:

◆ setFolder()

ilFolderXmlParser::setFolder ( ilObject $folder )

set weblink

Parameters

ilObject $webl

Returns

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

    {
        $this->folder = $folder;
    }

References $folder.

Referenced by __construct().

Here is the caller graph for this function:

◆ setHandlers()

ilFolderXmlParser::setHandlers ( $a_xml_parser )

set event handlers

Parameters

resource reference to the xml parser @access private

Reimplemented from ilSaxParser.

Definition at line 90 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 79 of file class.ilFolderXmlParser.php.

    {
        return $this->startParsing();
    }

References ilSaxParser\startParsing().

Here is the call graph for this function:

Field Documentation

◆ $error

ilFolderXmlParser::$error

protected

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

Referenced by handlerBeginTag().

◆ $folder

ilFolderXmlParser::$folder = null

private

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

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFolder()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ setFolder()

◆ setHandlers()

◆ start()

Field Documentation

◆ $error

◆ $folder