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

Inheritance diagram for ilObjectXMLParser:

Collaboration diagram for ilObjectXMLParser:

Public Member Functions
	__construct (string $a_xml_data='', ?bool $throw_exception=false)

	getObjectData ()

	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)

Data Fields
array	$object_data = []

Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Private Member Functions
	addProperty (string $a_name, $a_value)

	addReference (int $a_ref_id, int $a_parent_id, array $a_time_target)

Private Attributes
int	$ref_id = 0

int	$parent_id = 0

int	$curr_obj = 0

array	$time_target = []

string	$cdata = ''

Additional Inherited Members
Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

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

Definition at line 19 of file class.ilObjectXMLParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectXMLParser::__construct	(	string	$a_xml_data = `''`,
		?bool	$throw_exception = `false`
	)

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

    {
        parent::__construct('', $throw_exception);
        $this->setXMLContent($a_xml_data);
    }

References ilSaxParser\$throw_exception, ILIAS\GlobalScreen\Provider\__construct(), and ilSaxParser\setXMLContent().

Here is the call graph for this function:

Member Function Documentation

◆ addProperty()

ilObjectXMLParser::addProperty	(	string	$a_name,
			$a_value
	)

private

Parameters

	string$a_name
string \| int	$a_value

Returns: void

Definition at line 196 of file class.ilObjectXMLParser.php.

                                                          : void
    {
        $this->object_data[$this->curr_obj][$a_name] = $a_value;
    }

References $curr_obj.

Referenced by handlerBeginTag(), and handlerEndTag().

Here is the caller graph for this function:

◆ addReference()

ilObjectXMLParser::addReference	(	int	$a_ref_id,
		int	$a_parent_id,
		array	$a_time_target
	)

private

Definition at line 201 of file class.ilObjectXMLParser.php.

                                                                                        : void
    {
        $reference['ref_id'] = $a_ref_id;
        $reference['parent_id'] = $a_parent_id;
        $reference['time_target'] = $a_time_target;
 
        if (isset($reference['time_target']['changeable']) && $reference['time_target']['changeable'] &&
            !isset($reference['time_target']['suggestion_start'], $reference['time_target']['suggestion_end'])) {
            throw new ilObjectXMLException(
                'Missing attributes: "starting_time" and "ending_time" required for attribute "changeable"'
            );
        }
 
        $this->object_data[$this->curr_obj]['references'][] = $reference;
    }

References $curr_obj.

Referenced by handlerEndTag().

Here is the caller graph for this function:

◆ getObjectData()

ilObjectXMLParser::getObjectData ( )

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

                                   : array
    {
        return $this->object_data;
    }

References $object_data.

◆ handlerBeginTag()

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

Parameters

XMLParser | resource $a_xml_parser

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

                                                                                    : void
    {
        switch ($a_name) {
            case 'Objects':
                $this->curr_obj = -1;
                break;
 
            case 'Object':
                ++$this->curr_obj;
 
                $this->addProperty('type', (string) $a_attribs['type']);
                if (array_key_exists('obj_id', $a_attribs)) {
                    $this->addProperty(
                        'obj_id',
                        is_numeric($a_attribs['obj_id']) ? (int) $a_attribs["obj_id"] : ilUtil::__extractId(
                            $a_attribs["obj_id"] ?? '',
                            IL_INST_ID
                        )
                    );
                }
                if (isset($a_attribs['offline'])) {
                    $this->addProperty('offline', $a_attribs['offline']);
                }
 
 
 
                break;
 
            case 'ImportId':
            case 'LastUpdate':
            case 'CreateDate':
            case 'Owner':
            case 'Description':
            case 'Title':
                break;
 
            case 'References':
                $this->time_target = [];
                $this->ref_id = $a_attribs["ref_id"] ?? 0;
                $this->parent_id = $a_attribs['parent_id'] ?? 0;
                break;
 
            case 'TimeTarget':
                $this->time_target['timing_type'] = $a_attribs['type'];
                break;
 
            case 'Timing':
                if (isset($a_attribs['visibility'])) {
                    $this->time_target['timing_visibility'] = $a_attribs['visibility'];
                }
                if (isset($a_attribs['starting_time'])) {
                    $this->time_target['starting_time'] = $a_attribs['starting_time'];
                }
                if (isset($a_attribs['ending_time'])) {
                    $this->time_target['ending_time'] = $a_attribs['ending_time'];
                }
                if (isset($a_attribs['ending_time']) && isset($a_attribs['starting_time'])) {
                    // Validate timing if both times are present
                    if ($a_attribs['ending_time'] < $a_attribs['starting_time']) {
                        throw new ilObjectXMLException('Starting time must be earlier than ending time.');
                    }
                }
                break;
 
            case 'Suggestion':
                $this->time_target['changeable'] = $a_attribs['changeable'] ?? false;
 
                if (isset($a_attribs['starting_time'])) {
                    $this->time_target['suggestion_start'] = $a_attribs['starting_time'];
                }
                if (isset($a_attribs['ending_time'])) {
                    $this->time_target['suggestion_end'] = $a_attribs['ending_time'];
                }
                break;
        }
    }

References $curr_obj, ilUtil\__extractId(), addProperty(), and IL_INST_ID.

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handlerCharacterData()

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

Parameters

XMLParser \| resource	$a_xml_parser
string	$a_data

Returns: void

Definition at line 181 of file class.ilObjectXMLParser.php.

                                                                       : void
    {
        if ($a_data !== "\n") {
            // Replace multiple tabs with one space
            $a_data = preg_replace("/\t+/", " ", $a_data);
 
            $this->cdata .= $a_data;
        }
    }

Referenced by setHandlers().

Here is the caller graph for this function:

◆ handlerEndTag()

ilObjectXMLParser::handlerEndTag	(		$a_xml_parser,
		string	$a_name
	)

Parameters

XMLParser \| resource	$a_xml_parser
string	$a_name

Returns: void

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

                                                                : void
    {
        switch ($a_name) {
            case 'Object':
            case 'Objects':
                break;
 
            case 'Title':
                $this->addProperty('title', trim($this->cdata));
                break;
 
            case 'Description':
                $this->addProperty('description', trim($this->cdata));
                break;
 
            case 'Owner':
                $this->addProperty('owner', trim($this->cdata));
                break;
 
            case 'CreateDate':
                $this->addProperty('create_date', trim($this->cdata));
                break;
 
            case 'LastUpdate':
                $this->addProperty('last_update', trim($this->cdata));
                break;
 
            case 'ImportId':
                $this->addProperty('import_id', trim($this->cdata));
                break;
 
            case 'References':
                if ($this->ref_id !== 0 && $this->parent_id !== 0) {
                    $this->addReference($this->ref_id, $this->parent_id, $this->time_target);
                }
                break;
        }
 
        $this->cdata = '';
    }

References addProperty(), and addReference().

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilObjectXMLParser::setHandlers ( $a_xml_parser )

Parameters

XMLParser | resource $a_xml_parser

Returns: void

Reimplemented from ilSaxParser.

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

                                              : void
    {
        xml_set_element_handler($a_xml_parser, $this->handlerBeginTag(...), $this->handlerEndTag(...));
        xml_set_character_data_handler($a_xml_parser, $this->handlerCharacterData(...));
    }