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

Inheritance diagram for ilManifestParser:

Collaboration diagram for ilManifestParser:

Public Member Functions
	__construct (string $a_file)

	setInstallId (string $a_val)

	getInstallId ()

	setInstallUrl (string $a_val)

	getInstallUrl ()

	setMainEntity (string $a_val)

	getMainEntity ()

	setTitle (string $a_val)

	getTitle ()

	getExportFiles ()

	getExportSets ()

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

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

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

	handleCharacterData ($a_xml_parser, string $a_data)
	End Tag. More...

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
string	$chr_data = ''

string	$target_release = ''

string	$title = ''

string	$main_entity = ''

string	$install_id = ''

string	$install_url = ''

array	$expfiles = array()

array	$expsets = array()

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

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

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

Constructor & Destructor Documentation

◆ __construct()

ilManifestParser::__construct ( string $a_file )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getExportFiles()

ilManifestParser::getExportFiles ( )

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

References $expfiles.

                                     : array
     {
         return $this->expfiles;
     }

◆ getExportSets()

ilManifestParser::getExportSets ( )

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

References $expsets.

                                    : array
     {
         return $this->expsets;
     }

◆ getInstallId()

ilManifestParser::getInstallId ( )

final

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

References $install_id.

                                         : string
     {
         return $this->install_id;
     }

◆ getInstallUrl()

ilManifestParser::getInstallUrl ( )

final

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

References $install_url.

                                          : string
     {
         return $this->install_url;
     }

◆ getMainEntity()

ilManifestParser::getMainEntity ( )

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

References $main_entity.

                                    : string
     {
         return $this->main_entity;
     }

◆ getTitle()

ilManifestParser::getTitle ( )

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

References $title.

                               : string
     {
         return $this->title;
     }

◆ handleBeginTag()

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

Begin Tag.

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

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

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

Here is the call graph for this function:

◆ handleCharacterData()

ilManifestParser::handleCharacterData	(		$a_xml_parser,
		string	$a_data
	)

End Tag.

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

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

End Tag.

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

                                                                : void
     {
         $this->chr_data = "";
     }

◆ setHandlers()

ilManifestParser::setHandlers ( $a_xml_parser )

Set event handlers.

Parameters

resource reference to the xml parser private

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

                                               : void
     {
         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 ( string $a_val )

final

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

Referenced by handleBeginTag().

                                                      : void
     {
         $this->install_id = $a_val;
     }

Here is the caller graph for this function:

◆ setInstallUrl()

ilManifestParser::setInstallUrl ( string $a_val )

final

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

Referenced by handleBeginTag().

                                                       : void
     {
         $this->install_url = $a_val;
     }

Here is the caller graph for this function:

◆ setMainEntity()

ilManifestParser::setMainEntity ( string $a_val )

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

Referenced by handleBeginTag().

                                                 : void
     {
         $this->main_entity = $a_val;
     }

Here is the caller graph for this function:

◆ setTitle()

ilManifestParser::setTitle ( string $a_val )

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

Referenced by handleBeginTag().

                                            : void
     {
         $this->title = $a_val;
     }

Here is the caller graph for this function:

Field Documentation

◆ $chr_data

string ilManifestParser::$chr_data = ''

protected

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

◆ $expfiles

array ilManifestParser::$expfiles = array()

protected

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

Referenced by getExportFiles().

◆ $expsets

array ilManifestParser::$expsets = array()

protected

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

Referenced by getExportSets().

◆ $install_id

string ilManifestParser::$install_id = ''

protected

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

Referenced by getInstallId().

◆ $install_url

string ilManifestParser::$install_url = ''

protected

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

Referenced by getInstallUrl().

◆ $main_entity

string ilManifestParser::$main_entity = ''

protected

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

Referenced by getMainEntity().

◆ $target_release

string ilManifestParser::$target_release = ''

protected

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

◆ $title

string ilManifestParser::$title = ''

protected

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

Referenced by getTitle().

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

◆ getTitle()

◆ handleBeginTag()

◆ handleCharacterData()

◆ handleEndTag()

◆ setHandlers()

◆ setInstallId()

◆ setInstallUrl()

◆ setMainEntity()

◆ setTitle()

Field Documentation

◆ $chr_data

◆ $expfiles

◆ $expsets

◆ $install_id

◆ $install_url

◆ $main_entity

◆ $target_release

◆ $title