Manifest parser for ILIAS standard export files. More...

Inheritance diagram for ilManifestParser:

Collaboration diagram for ilManifestParser:

Public Member Functions
	__construct ($a_file)
	Constructor. More...

	setInstallId ($a_val)
	Set Installation ID. More...

	getInstallId ()
	Get Installation ID. More...

	setInstallUrl ($a_val)
	Set Installation Url. More...

	getInstallUrl ()
	Get Installation Url. More...

	setMainEntity ($a_val)
	Set main entity. More...

	getMainEntity ()
	Get main entity. More...

	setTitle ($a_val)
	Set title. More...

	getTitle ()
	Get title. More...

	setTargetRelease ($a_val)
	Set target release. More...

	getTargetRelease ()
	Get target release. More...

	getExportFiles ()
	Get xml files. More...

	getExportSets ()

	setHandlers ($a_xml_parser)
	Set event handlers. More...

	startParsing ()
	Start parser. More...

	handleBeginTag ($a_xml_parser, $a_name, $a_attribs)
	Begin Tag. More...

	handleEndTag ($a_xml_parser, $a_name)
	End Tag. More...

	handleCharacterData ($a_xml_parser, $a_data)
	End Tag. 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
	$expfiles = array()

	$expsets = array()

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

Manifest parser for ILIAS standard export files.

Author: Aleex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 13 of file class.ilManifestParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilManifestParser::__construct ( $a_file )

Constructor.

Parameters

return

Reimplemented from PEAR.

Definition at line 24 of file class.ilManifestParser.php.

    {
        parent::__construct($a_file, true);
        $this->startParsing();
    }

References ILIAS\GlobalScreen\Provider\__construct(), and startParsing().

Here is the call graph for this function:

Member Function Documentation

◆ getExportFiles()

ilManifestParser::getExportFiles ( )

Get xml files.

Returns: array of strings xml file pathes

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

    {
        return $this->expfiles;
    }

References $expfiles.

◆ getExportSets()

ilManifestParser::getExportSets ( )

Definition at line 140 of file class.ilManifestParser.php.

    {
        return $this->expsets;
    }

References $expsets.

◆ getInstallId()

ilManifestParser::getInstallId ( )

final

Get Installation ID.

Returns: string Installation ID

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

    {
        return $this->install_id;
    }

◆ getInstallUrl()

ilManifestParser::getInstallUrl ( )

final

Get Installation Url.

Returns: string Installation Url

Definition at line 65 of file class.ilManifestParser.php.

    {
        return $this->install_url;
    }

◆ getMainEntity()

ilManifestParser::getMainEntity ( )

Get main entity.

Returns: string main entity

Definition at line 85 of file class.ilManifestParser.php.

    {
        return $this->main_entity;
    }

◆ getTargetRelease()

ilManifestParser::getTargetRelease ( )

Get target release.

Returns: string target release

Definition at line 125 of file class.ilManifestParser.php.

    {
        return $this->target_release;
    }

◆ getTitle()

ilManifestParser::getTitle ( )

Get title.

Returns: string title

Definition at line 105 of file class.ilManifestParser.php.

    {
        return $this->title;
    }

◆ handleBeginTag()

ilManifestParser::handleBeginTag	(	$a_xml_parser,
		$a_name,
		$a_attribs
	)

Begin Tag.

Definition at line 170 of file class.ilManifestParser.php.

    {
        switch ($a_name) {
            case "Manifest":
                $this->setInstallId($a_attribs["InstallationId"]);
                $this->setInstallUrl($a_attribs["InstallationUrl"]);
                $this->setTitle($a_attribs["Title"]);
                $this->setTargetRelease($a_attribs["TargetRelease"]);
                $this->setMainEntity($a_attribs["MainEntity"]);
                break;
 
            case "ExportFile":
                $this->expfiles[] = array("component" => $a_attribs["Component"],
                    "path" => $a_attribs["Path"]);
                break;
                
            case "ExportSet":
                $this->expsets[] = array(
                    'path' => $a_attribs['Path'],
                    'type' => $a_attribs['Type']
                );
                break;
        }
    }

References setInstallId(), setInstallUrl(), setMainEntity(), setTargetRelease(), and setTitle().

Here is the call graph for this function:

◆ handleCharacterData()

ilManifestParser::handleCharacterData	(	$a_xml_parser,
		$a_data
	)

End Tag.

Definition at line 206 of file class.ilManifestParser.php.

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

◆ handleEndTag()

ilManifestParser::handleEndTag	(	$a_xml_parser,
		$a_name
	)

End Tag.

Definition at line 198 of file class.ilManifestParser.php.

    {
        $this->chr_data = "";
    }

◆ setHandlers()

ilManifestParser::setHandlers ( $a_xml_parser )

Set event handlers.

Parameters

resource reference to the xml parser @access private

Reimplemented from ilSaxParser.

Definition at line 151 of file class.ilManifestParser.php.

    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, 'handleBeginTag', 'handleEndTag');
        xml_set_character_data_handler($a_xml_parser, 'handleCharacterData');
    }

◆ setInstallId()

ilManifestParser::setInstallId ( $a_val )

final

Set Installation ID.

Parameters

string Installation ID

Definition at line 35 of file class.ilManifestParser.php.

    {
        $this->install_id = $a_val;
    }

Referenced by handleBeginTag().

Here is the caller graph for this function:

◆ setInstallUrl()

ilManifestParser::setInstallUrl ( $a_val )

final

Set Installation Url.

Parameters

string Installation Url

Definition at line 55 of file class.ilManifestParser.php.

    {
        $this->install_url = $a_val;
    }

Referenced by handleBeginTag().

Here is the caller graph for this function:

◆ setMainEntity()

ilManifestParser::setMainEntity ( $a_val )

Set main entity.

Parameters

string main entity

Definition at line 75 of file class.ilManifestParser.php.

    {
        $this->main_entity = $a_val;
    }

Referenced by handleBeginTag().

Here is the caller graph for this function:

◆ setTargetRelease()

ilManifestParser::setTargetRelease ( $a_val )

Set target release.

Parameters

string target release

Definition at line 115 of file class.ilManifestParser.php.

    {
        $this->target_release = $a_val;
    }

Referenced by handleBeginTag().

Here is the caller graph for this function:

◆ setTitle()

ilManifestParser::setTitle ( $a_val )

Set title.

Parameters

string title

Definition at line 95 of file class.ilManifestParser.php.

    {
        $this->title = $a_val;
    }

Referenced by handleBeginTag().

Here is the caller graph for this function:

◆ startParsing()

ilManifestParser::startParsing ( )

Start parser.

Reimplemented from ilSaxParser.

Definition at line 162 of file class.ilManifestParser.php.

    {
        parent::startParsing();
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $expfiles

ilManifestParser::$expfiles = array()

protected

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

Referenced by getExportFiles().

◆ $expsets

ilManifestParser::$expsets = array()

protected

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

Referenced by getExportSets().

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

Services/Export/classes/class.ilManifestParser.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getExportFiles()

◆ getExportSets()

◆ getInstallId()

◆ getInstallUrl()

◆ getMainEntity()

◆ getTargetRelease()

◆ getTitle()

◆ handleBeginTag()

◆ handleCharacterData()

◆ handleEndTag()

◆ setHandlers()

◆ setInstallId()

◆ setInstallUrl()

◆ setMainEntity()

◆ setTargetRelease()

◆ setTitle()

◆ startParsing()

Field Documentation

◆ $expfiles

◆ $expsets