ilFolderXmlParser Class Reference

XML parser for folder xml. More...

Inheritance diagram for ilFolderXmlParser:

Collaboration diagram for ilFolderXmlParser:

Public Member Functions
	__construct (ilObject $folder, string $xml)
	setFolder (ilObject $folder)
	getFolder ()
	start ()
	setHandlers ($a_xml_parser)
	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)
	handlerEndTag ($a_xml_parser, string $a_name)
	handlerCharacterData ($a_xml_parser, string $a_data)
Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)
	setXMLContent (string $a_xml_content)
	getXMLContent ()
	getInputType ()
	startParsing ()
	stores xml data in array More...
	createParser ()
	setHandlers ($a_xml_parser)
	parse ($a_xml_parser, $a_fp=null)

Protected Attributes
ilErrorHandling	$error
string	$cdata = ""
Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Attributes
ilObject	$folder

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file
bool	$throw_exception = false
Protected Member Functions inherited from ilContainerBaseXmlParser
	trimAndStripAttribs (array $attribs)
	trimAndStrip (string $input)
Protected Member Functions inherited from ilSaxParser
	openXMLFile ()
	handleError (string $message)
	setThrowException (bool $throw_exception)

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

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

Constructor & Destructor Documentation

__construct()

ilFolderXmlParser::__construct	(	ilObject	$folder,
		string	$xml
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), 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

(

)

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

References $folder.

Referenced by handlerBeginTag(), and handlerEndTag().

                               : ilObject
    {
        return $this->folder;
    }

Here is the caller graph for this function:

handlerBeginTag()

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

Parameters

XMLParser | resource	$a_xml_parser
string	$a_name
array	$a_attribs

Returns

void

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

References ilContainerSortingSettings\_importContainerSortingSettings(), getFolder(), and ILIAS\Survey\Mode\getId().

                                                                                    : void
    {
        switch ($a_name) {
            case 'Folder':
            case 'Title':
            case 'Description':
                break;

            case 'Sorting':
            case 'Sort':
                ilContainerSortingSettings::_importContainerSortingSettings($a_attribs, $this->getFolder()->getId());
                break;
        }
    }

Here is the call graph for this function:

handlerCharacterData()

ilFolderXmlParser::handlerCharacterData	(		$a_xml_parser,
		string	$a_data
	)

Parameters

XMLParser | resource	$a_xml_parser
string	$a_data

Returns

void

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

                                                                       : void
    {
        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,
		string	$a_name
	)

Parameters

XMLParser | resource	$a_xml_parser
string	$a_name

Returns

void

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

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

                                                                : void
    {
        $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 = '';
    }

Here is the call graph for this function:

setFolder()

ilFolderXmlParser::setFolder

(

ilObject

$folder

)

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

References $folder.

Referenced by __construct().

                                               : void
    {
        $this->folder = $folder;
    }

Here is the caller graph for this function:

setHandlers()

ilFolderXmlParser::setHandlers

(

$a_xml_parser

)

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

                                              : void
    {
        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

(

)

Exceptions

ilSaxParserException

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

References ilSaxParser\startParsing().

                           : void
    {
        $this->startParsing();
    }

Here is the call graph for this function:

Field Documentation

$cdata

string ilFolderXmlParser::$cdata = ""

protected

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

$error

ilErrorHandling ilFolderXmlParser::$error

protected

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

$folder

ilObject ilFolderXmlParser::$folder

private

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

Referenced by getFolder(), and setFolder().

---

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

• components/ILIAS/Folder/classes/class.ilFolderXmlParser.php