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

Inheritance diagram for ilExerciseXMLParser:

Collaboration diagram for ilExerciseXMLParser:

Public Member Functions
	__construct (ilObjExercise $exercise, string $a_xml_data, int $obj_id=-1)

	setHandlers ($a_xml_parser)

	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)
	handler for begin of element More...

	handlerEndTag ($a_xml_parser, string $a_name)
	handler for end of element More...

	handlerCharacterData ($a_xml_parser, string $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 (?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
ilObjExercise	$exercise

int	$obj_id

bool	$result

int	$mode

ilExAssignment	$assignment

ilFSStorageExercise	$storage

Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Static Public Attributes
static int	$CONTENT_NOT_COMPRESSED = 0

static int	$CONTENT_GZ_COMPRESSED = 1

static int	$CONTENT_ZLIB_COMPRESSED = 2

Protected Member Functions
	trimAndStripAttribs (array $attribs)

	trimAndStrip (string $input)

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes
string	$cdata

string	$mark

string	$notice

string	$comment

string	$file_content

string	$file_name

string	$status

string	$file_action

int	$usr_id

string	$usr_action

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

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

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

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

      {
        // @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;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getAssignment()

ilExerciseXMLParser::getAssignment ( )

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

                                   : ilExAssignment
    {
        return $this->assignment;
    }

◆ handlerBeginTag()

ilExerciseXMLParser::handlerBeginTag	(		$a_xml_parser,
		string	$a_name,
		array	$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 91 of file class.ilExerciseXMLParser.php.

                                                                                    : void
    {
        $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 && $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 = (int) 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;
 
        }
    }

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, ILIAS\Repository\int(), and trimAndStripAttribs().

Here is the call graph for this function:

◆ handlerCharacterData()

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

handler for character data

Parameters

resource	$a_xml_parser	xml parser
string	$a_data	character data

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

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

◆ handlerEndTag()

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

handler for end of element

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name

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

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

References ILIAS\UI\examples\Symbol\Glyph\Comment\comment(), trimAndStrip(), updateFile(), updateMarking(), and updateMember().

Here is the call graph for this function:

◆ setHandlers()

ilExerciseXMLParser::setHandlers ( $a_xml_parser )

Parameters

XMLParser | resource $a_xml_parser

Returns: void

Reimplemented from ilSaxParser.

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

                                              : void
    {
        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 271 of file class.ilExerciseXMLParser.php.

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

◆ trimAndStrip()

ilExerciseXMLParser::trimAndStrip ( string $input )

protected

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

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

References ilUtil\stripSlashes().

Referenced by handlerEndTag().

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

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

Referenced by handlerBeginTag().

Here is the caller graph for this function:

◆ updateFile()

ilExerciseXMLParser::updateFile	(	string	$filename,
		string	$b64encodedContent,
		string	$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 238 of file class.ilExerciseXMLParser.php.

     : void {
        if (strlen($filename) == 0) {
            return;
        }
        $filename = $this->storage->getAbsolutePath() . "/" . $filename;
 
        if ($action == "Attach") {
            $content = base64_decode($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);
        }
    }

Referenced by handlerEndTag().

Here is the caller graph for this function:

◆ updateMarking()

ilExerciseXMLParser::updateMarking ( int $usr_id )

private

update marking of member

Parameters

int $usr_id

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

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

References ILIAS\UI\examples\Symbol\Glyph\Comment\comment(), and ilUtil\stripSlashes().

Referenced by handlerEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMember()

ilExerciseXMLParser::updateMember	(	int	$user_id,
		string	$action
	)

private

update member object according to given action

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

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