Exercise XML Parser which completes/updates a given exercise by an xml string. More...

Inheritance diagram for ilExerciseXMLParser:

Collaboration diagram for ilExerciseXMLParser:

Public Member Functions
	__construct ($exercise, $a_xml_data, $obj_id=-1)
	Constructor. 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...

	start ()
	starts parsing an changes object by side effect. More...

	getAssignment ()

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
	$exercise

	$obj_id

	$result

	$mode

	$assignment

	$storage

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

Static Public Attributes
static	$CONTENT_NOT_COMPRESSED = 0

static	$CONTENT_GZ_COMPRESSED = 1

static	$CONTENT_ZLIB_COMPRESSED = 2

Protected Member Functions
	trimAndStripAttribs (array $attribs)

	trimAndStrip (string $input)

Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Private Member Functions
	updateMember ($user_id, $action)
	update member object according to given action More...

	updateFile ($filename, $b64encodedContent, $action)
	update file according to filename More...

	updateMarking ($usr_id)
	update marking of member More...

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

Detailed Description

Exercise XML Parser which completes/updates a given exercise by an xml string.

Author: Roland Küstermann rolan.nosp@m.d@ku.nosp@m.ester.nosp@m.mann.nosp@m..com

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

Constructor & Destructor Documentation

◆ __construct()

ilExerciseXMLParser::__construct	(	$exercise,
		$a_xml_data,
		$obj_id = `-1`
	)

Constructor.

Parameters

ilExercise	$exercise	existing exercise object
string	$a_xml_file	xml data
int	$obj_id	obj id of exercise which is to be updated public

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

References $exercise, $obj_id, ILIAS\GlobalScreen\Provider\__construct(), ilFSStorageExercise\create(), ilExAssignment\getAssignmentDataOfExercise(), and ilSaxParser\setXMLContent().

     {
         // @todo: needs to be revised for multiple assignments per exercise
 
         parent::__construct();
         
         $this->exercise = $exercise;
         // get all assignments and choose first one if exists, otherwise create
         $assignments = ilExAssignment::getAssignmentDataOfExercise($exercise->getId());
         if (count($assignments) > 0) {
             $this->assignment = new ilExAssignment($assignments [0]["id"]);
         } else {
             $this->assignment = new ilExAssignment();
             $this->assignment->setExerciseId($exercise->getId());
             $this->assignment->save();
         }
         
         $this->storage = new ilFSStorageExercise($this->exercise->getId(), $this->assignment->getId());
         $this->storage->create();
         $this->storage->init();
         
         $this->setXMLContent($a_xml_data);
         $this->obj_id = $obj_id;
         $this->result = false;
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAssignment()

ilExerciseXMLParser::getAssignment ( )

Definition at line 335 of file class.ilExerciseXMLParser.php.

References $assignment.

     {
         return $this->assignment;
     }

◆ handlerBeginTag()

ilExerciseXMLParser::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

Exceptions

ilExerciseException when obj id != - 1 and if it it does not match the id in the xml

Definition at line 117 of file class.ilExerciseXMLParser.php.

References $CONTENT_GZ_COMPRESSED, $CONTENT_NOT_COMPRESSED, $CONTENT_ZLIB_COMPRESSED, ilExerciseException\$ID_DEFLATE_METHOD_MISMATCH, ilExerciseException\$ID_MISMATCH, ilExerciseXMLWriter\$STATUS_NOT_GRADED, ilExerciseXMLWriter\$STATUS_PASSED, ilUtil\__extractId(), IL_INST_ID, and trimAndStripAttribs().

     {
         $a_attribs = $this->trimAndStripAttribs($a_attribs);
         switch ($a_name) {
             case 'Exercise':
                 if (isset($a_attribs["obj_id"])) {
                     $read_obj_id = ilUtil::__extractId($a_attribs["obj_id"], IL_INST_ID);
                     if ($this->obj_id != -1 && (int) $read_obj_id != -1 && (int) $this->obj_id != (int) $read_obj_id) {
                         throw new ilExerciseException("Object IDs (xml $read_obj_id and argument " . $this->obj_id . ") do not match!", ilExerciseException::$ID_MISMATCH);
                     }
                 }
                 break;
             case 'Member':
                 $this->usr_action = $a_attribs["action"];
                 $this->usr_id = ilUtil::__extractId($a_attribs["usr_id"], IL_INST_ID);
                 break;
 
             case 'File':
                 $this->file_action = $a_attribs["action"];
                 break;
             case 'Content':
                 $this->mode = ilExerciseXMLParser::$CONTENT_NOT_COMPRESSED;
                 if ($a_attribs["mode"] == "GZIP") {
                     if (!function_exists("gzdecode")) {
                         throw new  ilExerciseException("Deflating with gzip is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH);
                     }
 
                     $this->mode = ilExerciseXMLParser::$CONTENT_GZ_COMPRESSED;
                 } elseif ($a_attribs["mode"] == "ZLIB") {
                     if (!function_exists("gzuncompress")) {
                         throw new ilExerciseException("Deflating with zlib (compress/uncompress) is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH);
                     }
 
                     $this->mode = ilExerciseXMLParser::$CONTENT_ZLIB_COMPRESSED;
                 }
                 break;
             case 'Marking':
                  $this->status = $a_attribs["status"];
                  if ($this->status == ilExerciseXMLWriter::$STATUS_NOT_GRADED) {
                      $this->status = "notgraded";
                  } elseif ($this->status == ilExerciseXMLWriter::$STATUS_PASSED) {
                      $this->status = "passed";
                  } else {
                      $this->status = "failed";
                  }
                  break;
 
         }
     }

Here is the call graph for this function:

◆ handlerCharacterData()

ilExerciseXMLParser::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 233 of file class.ilExerciseXMLParser.php.

     {
         if ($a_data != "\n") {
             $this->cdata .= $a_data;
         }
     }

◆ handlerEndTag()

ilExerciseXMLParser::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 175 of file class.ilExerciseXMLParser.php.

References comment(), trimAndStrip(), updateFile(), updateMarking(), and updateMember().

     {
         switch ($a_name) {
             case 'Exercise':
                 $this->result = true;
                 break;
             case 'Title':
                 $this->exercise->setTitle($this->trimAndStrip((string) $this->cdata));
                 $this->assignment->setTitle($this->trimAndStrip((string) $this->cdata));
                 break;
             case 'Description':
                 $this->exercise->setDescription($this->trimAndStrip((string) $this->cdata));
                 break;
             case 'Instruction':
                 $this->assignment->setInstruction($this->trimAndStrip((string) $this->cdata));
                 break;
             case 'DueDate':
                 $this->assignment->setDeadLine($this->trimAndStrip((string) $this->cdata));
                 break;
             case 'Member':
                 $this->updateMember($this->usr_id, $this->usr_action);
                 // update marking after update member.
                 $this->updateMarking($this->usr_id);
                 break;
             case 'Filename':
                 $this->file_name = $this->trimAndStrip((string) $this->cdata);
                 break;
             case 'Content':
                 $this->file_content = $this->trimAndStrip((string) $this->cdata);
                 break;
             case 'File':
                    $this->updateFile($this->file_name, $this->file_content, $this->file_action);
                 break;
             case 'Comment':
                  $this->comment = $this->trimAndStrip((string) $this->cdata);
                  break;
             case 'Notice':
                  $this->notice = $this->trimAndStrip((string) $this->cdata);
                  break;
             case 'Mark':
                  $this->mark = $this->trimAndStrip((string) $this->cdata);
                  break;
             case 'Marking':
                  // see Member end tag
                  break;
         }
 
         $this->cdata = '';
 
         return;
     }

Here is the call graph for this function:

◆ setHandlers()

ilExerciseXMLParser::setHandlers ( $a_xml_parser )

set event handlers

Parameters

resource reference to the xml parser private

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

◆ start()

ilExerciseXMLParser::start ( )

starts parsing an changes object by side effect.

Exceptions

ilExerciseException when obj id != - 1 and if it it does not match the id in the xml

Returns: boolean true, if no errors happend.

Definition at line 300 of file class.ilExerciseXMLParser.php.

References ilSaxParser\startParsing().

     {
         $this->startParsing();
         return $this->result > 0;
     }

Here is the call graph for this function:

◆ trimAndStrip()

ilExerciseXMLParser::trimAndStrip ( string $input )

protected

Definition at line 349 of file class.ilExerciseXMLParser.php.

References ilUtil\stripSlashes().

Referenced by handlerEndTag(), and trimAndStripAttribs().

                                                    : string
     {
         return ilUtil::stripSlashes(trim($input));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ trimAndStripAttribs()

ilExerciseXMLParser::trimAndStripAttribs ( array $attribs )

protected

Definition at line 340 of file class.ilExerciseXMLParser.php.

References $ret, and trimAndStrip().

Referenced by handlerBeginTag().

                                                            : array
     {
         $ret = [];
         foreach ($attribs as $k => $v) {
             $ret[$k] = $this->trimAndStrip((string) $v);
         }
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFile()

ilExerciseXMLParser::updateFile	(	$filename,
		$b64encodedContent,
		$action
	)

private

update file according to filename

Parameters

string	$filename
string	$content	base 64 encoded string
string	$action	can be Attach or Detach

Definition at line 270 of file class.ilExerciseXMLParser.php.

References $CONTENT_GZ_COMPRESSED, $CONTENT_ZLIB_COMPRESSED, and $filename.

Referenced by handlerEndTag().

     {
         if (strlen($filename) == 0) {
             return;
         }
         $filename = $this->storage->getAbsolutePath() . "/" . $filename;
         
         if ($action == "Attach") {
             $content = base64_decode((string) $b64encodedContent);
             if ($this->mode == ilExerciseXMLParser::$CONTENT_GZ_COMPRESSED) {
                 $content = gzdecode($content);
             } elseif ($this->mode == ilExerciseXMLParser::$CONTENT_ZLIB_COMPRESSED) {
                 $content = gzuncompress($content);
             }
           
             //echo $filename;
             $this->storage->writeToFile($content, $filename);
         }
         if ($action == "Detach") {
             $this->storage->deleteFile($filename);
         }
     }

Here is the caller graph for this function:

◆ updateMarking()

ilExerciseXMLParser::updateMarking ( $usr_id )

private

update marking of member

Parameters

int $usr_id

Definition at line 311 of file class.ilExerciseXMLParser.php.

References comment(), and ilUtil\stripSlashes().

Referenced by handlerEndTag().

     {
         $member_status = $this->assignment->getMemberStatus($usr_id);
         if (isset($this->mark)) {
             $member_status->setMark(ilUtil::stripSlashes($this->mark));
         }
         if (isset($this->comment)) {
             $member_status->setComment(ilUtil::stripSlashes($this->comment));
         }
         if (isset($this->status)) {
             $member_status->setStatus(ilUtil::stripSlashes($this->status));
         }
         if (isset($this->notice)) {
             $member_status->setNotice(ilUtil::stripSlashes($this->notice));
         }
         $member_status->update();
         
         // reset variables
         $this->mark = null;
         $this->status = null;
         $this->notice = null;
         $this->comment = null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMember()

ilExerciseXMLParser::updateMember	(	$user_id,
		$action
	)

private

update member object according to given action

Parameters

int	$user_id
string	$action	can be Attach or Detach

Definition at line 247 of file class.ilExerciseXMLParser.php.

Referenced by handlerEndTag().

     {
         if (!is_int($user_id) || $user_id <= 0) {
             return;
         }
         $memberObject = new ilExerciseMembers($this->exercise);
 
         if ($action == "Attach" && !$memberObject->isAssigned($user_id)) {
             $memberObject->assignMember($user_id);
         }
 
         if ($action == "Detach" && $memberObject->isAssigned($user_id)) {
             $memberObject->deassignMember($user_id);
         }
     }