ilObjectXMLParser Class Reference

Object XML Parser. More...

Inheritance diagram for ilObjectXMLParser:

Collaboration diagram for ilObjectXMLParser:

Public Member Functions
	__construct ($a_xml_data='', $throwException=false)
	Constructor. More...
	getObjectData ()
	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...
	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...
	__addProperty ($a_name, $a_value)
	__addReference ($a_ref_id, $a_parent_id, $a_time_target)
Public Member Functions inherited from ilSaxParser
	__construct ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object 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 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...

Data Fields
	$object_data = array()
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()

Private Attributes
	$ref_id
	$parent_id

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...
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

Object XML Parser.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilObjectXMLParser::__construct	(		$a_xml_data = '',
			$throwException = false
	)

Constructor.

Parameters

object	$a_content_object	must be of type ilObjContentObject ilObjTest or ilObjQuestionPool
string	$a_xml_file	xml data
string	$a_subdir	subdirectory in import directory public

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

References ilSaxParser\$throwException, and ilSaxParser\setXMLContent().

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

Here is the call graph for this function:

Member Function Documentation

__addProperty()

ilObjectXMLParser::__addProperty	(		$a_name,
			$a_value
	)

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

Referenced by handlerBeginTag(), and handlerEndTag().

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

Here is the caller graph for this function:

__addReference()

ilObjectXMLParser::__addReference	(		$a_ref_id,
			$a_parent_id,
			$a_time_target
	)

Exceptions

ilObjectXMLException

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

Referenced by handlerEndTag().

    {
        $reference['ref_id'] = $a_ref_id;
        $reference['parent_id'] = $a_parent_id;
        $reference['time_target'] = $a_time_target;

        if (isset($reference['time_target']['changeable']) and $reference['time_target']['changeable']) {
            if (!isset($reference['time_target']['earliest_start']) or !isset($reference['time_target']['latest_end'])) {
                throw new ilObjectXMLException('Missing attributes: "earliest_start" and "latest_end" required for attribute "changeable"');
            }
            if (!isset($reference['time_target']['suggestion_start']) or !isset($reference['time_target']['suggestion_end'])) {
                throw new ilObjectXMLException('Missing attributes: "starting_time" and "ending_time" required for attribute "changeable"');
            }
            if (($reference['time_target']['earliest_start'] < $reference['time_target']['suggestion_start']) or
                ($reference['time_target']['earliest_start'] > $reference['time_target']['suggestion_end'])) {
                throw new ilObjectXMLException('Invalid attributes: "earliest_start" must be within "starting_time" and "ending_time"');
            }
            if (($reference['time_target']['latest_end'] < $reference['time_target']['suggestion_start']) or
                ($reference['time_target']['latest_end'] > $reference['time_target']['suggestion_end'])) {
                throw new ilObjectXMLException('Invalid attributes: "latest_end" must be within "starting_time" and "ending_time"');
            }
        }
        
        $this->object_data[$this->curr_obj]['references'][] = $reference;
    }

Here is the caller graph for this function:

getObjectData()

ilObjectXMLParser::getObjectData

(

)

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

References array.

    {
        return $this->object_data ? $this->object_data : array();
    }

handlerBeginTag()

ilObjectXMLParser::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 100 of file class.ilObjectXMLParser.php.

References __addProperty(), ilUtil\__extractId(), and array.

    {
        switch ($a_name) {
            case 'Objects':
                $this->curr_obj = -1;
                break;

            case 'Object':
                ++$this->curr_obj;
                
                $this->__addProperty('type', $a_attribs['type']);
                $this->__addProperty('obj_id', is_numeric($a_attribs['obj_id'])?(int) $a_attribs["obj_id"] :  ilUtil::__extractId($a_attribs["obj_id"], IL_INST_ID));
                break;

            case 'Title':
                break;

            case 'Description':
                break;

            case 'Owner':
                break;

            case 'CreateDate':
                break;

            case 'LastUpdate':
                break;
                
            case 'ImportId':
                break;

            case 'References':
                $this->time_target = array();
                $this->ref_id = $a_attribs["ref_id"];
                $this->parent_id = $a_attribs['parent_id'];
                break;
                
            case 'TimeTarget':
                $this->time_target['timing_type'] = $a_attribs['type'];
                break;
            
            case 'Timing':
                $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 ($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'];
                
                
                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'];
                }
                if (isset($a_attribs['earliest_start'])) {
                    $this->time_target['earliest_start'] = $a_attribs['earliest_start'];
                }
                if (isset($a_attribs['latest_end'])) {
                    $this->time_target['latest_end'] = $a_attribs['latest_end'];
                }

                if ($a_attribs['latest_end'] < $a_attribs['earliest_start']) {
                    throw new ilObjectXMLException('Earliest start time must be earlier than latest ending time.');
                }
                if ($a_attribs['ending_time'] < $a_attribs['starting_time']) {
                    throw new ilObjectXMLException('Starting time must be earlier than ending time.');
                }
                break;
                
        }
    }

Here is the call graph for this function:

handlerCharacterData()

ilObjectXMLParser::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 239 of file class.ilObjectXMLParser.php.

    {
        if ($a_data != "\n") {
            // Replace multiple tabs with one space
            $a_data = preg_replace("/\t+/", " ", $a_data);

            $this->cdata .= $a_data;
        }
    }

handlerEndTag()

ilObjectXMLParser::handlerEndTag	(		$a_xml_parser,
			$a_name
	)

handler for end of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name

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

References __addProperty(), and __addReference().

    {
        switch ($a_name) {
            case 'Objects':
                break;

            case 'Object':
                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':
                $this->__addReference($this->ref_id, $this->parent_id, $this->time_target);
                break;
        }

        $this->cdata = '';

        return;
    }

Here is the call graph for this function:

parse()

ilObjectXMLParser::parse	(		$a_xml_parser,
			$a_fp = null
	)

parse xml file

private

Exceptions

ilSaxParserException
ilObjectXMLException

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

    {
        parent::parse($a_xml_parser, $a_fp);
    }

setHandlers()

ilObjectXMLParser::setHandlers

(

$a_xml_parser

)

set event handlers

Parameters

resource

reference to the xml parser private

Definition at line 83 of file class.ilObjectXMLParser.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');
    }

Field Documentation

$object_data

ilObjectXMLParser::$object_data = array()

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

$parent_id

ilObjectXMLParser::$parent_id

private

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

$ref_id

ilObjectXMLParser::$ref_id

private

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

---

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

• webservice/soap/classes/class.ilObjectXMLParser.php