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

Inheritance diagram for ilExerciseXMLWriter:

Collaboration diagram for ilExerciseXMLWriter:

Public Member Functions
	__construct ()

	setExercise (ilObjExercise $exercise)

	setAttachFileContents (int $attachFileContents)
	set attachment content mode More...

	start ()

	getXML ()

	__buildHeader ()

	__buildFooter ()

	setAttachMembers (bool $value)
	write access to property attchMarkings More...

Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")

	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...

	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...

	xmlFormatData (string $data)
	Indents text for better reading. More...

	xmlHeader ()
	Writes xml header. More...

	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...

	xmlEndTag (string $tag)
	Writes an endtag. More...

	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...

	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...

	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...

	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...

	appendXML (string $a_str)
	append xml string to document More...

	xmlClear ()
	clears xmlStr More...

Data Fields
bool	$attachFileContents

bool	$attachMembers

ilObjExercise	$exercise

Static Public Attributes
static int	$CONTENT_ATTACH_NO = 0

static int	$CONTENT_ATTACH_ENCODED = 1

static int	$CONTENT_ATTACH_ZLIB_ENCODED = 2

static int	$CONTENT_ATTACH_GZIP_ENCODED = 3

static string	$STATUS_NOT_GRADED = "NOT_GRADED"

static string	$STATUS_PASSED = "PASSED"

static string	$STATUS_FAILED = "FAILED"

Private Member Functions
	attachMarking (int $user_id, int $assignment_id)
	attach marking tag to member for given assignment More...

	handleAssignmentFiles (int $ex_id, int $as_id)

	handleAssignmentMembers (int $ex_id, int $assignment_id)
	create xml for files per assignment 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 XML writer class Class to simplify manual writing of xml documents. It only supports writing xml sequentially, because the xml document is saved in a string with no additional structure information. The author is responsible for well-formedness and validity of the xml document.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilExerciseXMLWriter::__construct ( )

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

    {
        // @todo: needs to be revised for multiple assignments per exercise
        //die ("Needs revision for ILIAS 4.1");
        parent::__construct();
        $this->attachFileContents = ilExerciseXMLWriter::$CONTENT_ATTACH_NO;
    }

References $CONTENT_ATTACH_NO, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ __buildFooter()

ilExerciseXMLWriter::__buildFooter ( )

Definition at line 128 of file class.ilExerciseXMLWriter.php.

                                   : void
    {
    }

Referenced by start().

Here is the caller graph for this function:

◆ __buildHeader()

ilExerciseXMLWriter::__buildHeader ( )

Definition at line 119 of file class.ilExerciseXMLWriter.php.

                                   : bool
    {
        $this->xmlSetDtdDef("<!DOCTYPE Exercise PUBLIC \"-//ILIAS//DTD ExerciseAdministration//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_exercise_4_4.dtd\">");
        $this->xmlSetGenCmt("Exercise Object");
        $this->xmlHeader();
 
        return true;
    }

References ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ attachMarking()

ilExerciseXMLWriter::attachMarking	(	int	$user_id,
		int	$assignment_id
	)

private

attach marking tag to member for given assignment

Definition at line 143 of file class.ilExerciseXMLWriter.php.

     : void {
        $ass = new ilExAssignment($assignment_id);
 
        $amark = $ass->getMemberStatus($user_id)->getMark();
        $astatus = $ass->getMemberStatus($user_id)->getStatus();
        $acomment = $ass->getMemberStatus($user_id)->getComment();
        $anotice = $ass->getMemberStatus($user_id)->getNotice();
 
 
        if ($astatus == "notgraded") {
            $status = ilExerciseXMLWriter::$STATUS_NOT_GRADED;
        } elseif ($astatus == "failed") {
            $status = ilExerciseXMLWriter::$STATUS_FAILED;
        } else {
            $status = ilExerciseXMLWriter::$STATUS_PASSED;
        }
 
        $this->xmlStartTag("Marking", array("status" => $status ));
        $this->xmlElement("Mark", null, $amark);
        $this->xmlElement("Notice", null, $anotice);
        $this->xmlElement("Comment", null, $acomment);
        $this->xmlEndTag("Marking");
    }

References $STATUS_NOT_GRADED.

◆ getXML()

ilExerciseXMLWriter::getXML ( )

Definition at line 114 of file class.ilExerciseXMLWriter.php.

                            : string
    {
        return $this->xmlDumpMem(false);
    }

References ilXmlWriter\xmlDumpMem().

Here is the call graph for this function:

◆ handleAssignmentFiles()

ilExerciseXMLWriter::handleAssignmentFiles	(	int	$ex_id,
		int	$as_id
	)

private

Definition at line 170 of file class.ilExerciseXMLWriter.php.

     : void {
        $this->xmlStartTag("Files");
        $storage = new ilFSStorageExercise($ex_id, $as_id);
        $files = $storage->getFiles();
 
        if (count($files)) {
            foreach ($files as $file) {
                $this->xmlStartTag("File", array("size" => $file ["size"] ));
                $this->xmlElement("Filename", null, $file ["name"]);
                if ($this->attachFileContents) {
                    $filename = $file ["fullpath"];
                    if (is_file($filename)) {
                        $content = file_get_contents($filename);
                        $attribs = array("mode" => "PLAIN" );
                        if ($this->attachFileContents == ilExerciseXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED) {
                            $attribs = array("mode" => "ZLIB" );
                            $content = gzcompress($content, 9);
                        } elseif ($this->attachFileContents == ilExerciseXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED) {
                            $attribs = array("mode" => "GZIP" );
                            $content = gzencode($content, 9);
                        }
                        $content = base64_encode($content);
                        $this->xmlElement("Content", $attribs, $content);
                    }
                }
                $this->xmlEndTag("File");
            }
        }
        $this->xmlEndTag("Files");
    }

Referenced by start().

Here is the caller graph for this function:

◆ handleAssignmentMembers()

ilExerciseXMLWriter::handleAssignmentMembers	(	int	$ex_id,
		int	$assignment_id
	)

private

create xml for files per assignment

Definition at line 207 of file class.ilExerciseXMLWriter.php.

     : void {
        $this->xmlStartTag("Members");
        $members = ilExerciseMembers::_getMembers($ex_id);
        if (count($members)) {
            foreach ($members as $member_id) {
                $this->xmlStartTag("Member", array("usr_id" => "il_" . IL_INST_ID . "_usr_" . $member_id  ));
 
                $name = ilObjUser::_lookupName($member_id);
 
                $this->xmlElement("Firstname", array(), $name['firstname']);
                $this->xmlElement("Lastname", array(), $name['lastname']);
                $this->xmlElement("Login", array(), $name['login']);
                $this->attachMarking($member_id, $assignment_id);
                $this->xmlEndTag("Member");
            }
        }
        $this->xmlEndTag("Members");
    }

Referenced by start().

Here is the caller graph for this function:

◆ setAttachFileContents()

ilExerciseXMLWriter::setAttachFileContents ( int $attachFileContents )

set attachment content mode

Exceptions

ilExerciseException if mode is not supported

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

                                                                  : void
    {
        if ($attachFileContents == ilExerciseXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED && !function_exists("gzencode")) {
            throw new ilExerciseException("Inflating with gzip is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH);
        }
        if ($attachFileContents == ilExerciseXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED && !function_exists("gzcompress")) {
            throw new ilExerciseException("Inflating with zlib (compress/uncompress) is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH);
        }
 
        $this->attachFileContents = $attachFileContents;
    }

References $attachFileContents, $CONTENT_ATTACH_GZIP_ENCODED, $CONTENT_ATTACH_ZLIB_ENCODED, and ilExerciseException\$ID_DEFLATE_METHOD_MISMATCH.

◆ setAttachMembers()

ilExerciseXMLWriter::setAttachMembers ( bool $value )

write access to property attchMarkings

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

                                                 : void
    {
        $this->attachMembers = $value;
    }

◆ setExercise()

ilExerciseXMLWriter::setExercise ( ilObjExercise $exercise )

Definition at line 50 of file class.ilExerciseXMLWriter.php.

                                                        : void
    {
        $this->exercise = $exercise;
    }

References $exercise.

◆ start()

ilExerciseXMLWriter::start ( )

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

                           : bool
    {
        $this->__buildHeader();
 
        $attribs = array("obj_id" => "il_" . IL_INST_ID . "_exc_" . $this->exercise->getId() );
 
        if ($this->exercise->getOwner() !== 0) {
            $attribs ["owner"] = "il_" . IL_INST_ID . "_usr_" . $this->exercise->getOwner();
        }
 
        $this->xmlStartTag("Exercise", $attribs);
 
        //todo: create new dtd for new assignment structure
        $this->xmlElement("Title", null, $this->exercise->getTitle());
        $this->xmlElement("Description", null, $this->exercise->getDescription());
        //$this->xmlElement("Instruction",  null,$this->exercise->getInstruction());
        //$this->xmlElement("DueDate",  null,$this->exercise->getTimestamp());
 
 
        //todo: as a workaround use first assignment for compatibility with old exercise dtd
        $assignments = ilExAssignment::getAssignmentDataOfExercise($this->exercise->getId());
 
        if (count($assignments) > 0) {
            foreach ($assignments as $assignment) {
                $this->xmlStartTag("Assignment");
                $this->xmlElement("Instruction", null, $assignment ["instruction"]);
                $this->xmlElement("DueDate", null, $assignment ["deadline"]);
 
                $this->handleAssignmentFiles($this->exercise->getId(), $assignment ["id"]);
                if ($this->attachMembers) {
                    $this->handleAssignmentMembers($this->exercise->getId(), $assignment ["id"]);
                }
                $this->xmlEndTag("Assignment");
            }
        }
 
 
        $this->xmlEndTag("Exercise");
        $this->__buildFooter();
 
        return true;
    }