XML writer class. More...

Inheritance diagram for ilExerciseXMLWriter:

Collaboration diagram for ilExerciseXMLWriter:

Public Member Functions
	__construct ()
	constructor More...

	setExercise ($exercise)
	set exercise object More...

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

	start ()

	getXML ()

	__buildHeader ()

	__buildFooter ()

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

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

	_ilXmlWriter ()
	destructor public More...

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

	xmlSetStSheet ($stSheet)
	Sets stylesheet. More...

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

	xmlEncodeData ($data)
	Encodes text from input encoding into output encoding. More...

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

	xmlFormatElement ($array)
	Callback function for xmlFormatData; do not invoke directly. More...

	xmlHeader ()
	Writes xml header public. More...

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

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

	xmlComment ($comment)
	Writes a comment. More...

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

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

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

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

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

	xmlClear ()
	clears xmlStr public More...

Data Fields
	$attachFileContents

	$attachMembers

	$exercise

Data Fields inherited from ilXmlWriter
	$xmlStr

	$version

	$outEnc

	$inEnc

	$dtdDef = ""

	$stSheet = ""

	$genCmt = "Generated by ILIAS XmlWriter"

Static Public Attributes
static	$CONTENT_ATTACH_NO = 0

static	$CONTENT_ATTACH_ENCODED = 1

static	$CONTENT_ATTACH_ZLIB_ENCODED = 2

static	$CONTENT_ATTACH_GZIP_ENCODED = 3

static	$STATUS_NOT_GRADED = "NOT_GRADED"

static	$STATUS_PASSED = "PASSED"

static	$STATUS_FAILED = "FAILED"

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

	handleAssignmentFiles ($ex_id, $as_id)

	handleAssignmentMembers ($ex_id, $assignment_id)
	create xml for files per assignment More...

Additional Inherited Members
Static Public Member Functions inherited from ilXmlWriter
static	_xmlEscapeData ($data)
	Escapes reserved characters. More...

Detailed Description

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 17 of file class.ilExerciseXMLWriter.php.

Constructor & Destructor Documentation

◆ __construct()

ilExerciseXMLWriter::__construct ( )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding public

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ __buildFooter()

ilExerciseXMLWriter::__buildFooter ( )

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

Referenced by start().

150 {

151 }

Here is the caller graph for this function:

◆ __buildHeader()

ilExerciseXMLWriter::__buildHeader ( )

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

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

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ attachMarking()

ilExerciseXMLWriter::attachMarking	(	$user_id,
		$assignment_id
	)

private

attach marking tag to member for given assignment

Parameters

int	$user_id
int	$assignment_id

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

References $STATUS_FAILED, $STATUS_NOT_GRADED, $STATUS_PASSED, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by handleAssignmentMembers().

     {
         $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");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXML()

ilExerciseXMLWriter::getXML ( )

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

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

◆ handleAssignmentFiles()

ilExerciseXMLWriter::handleAssignmentFiles	(	$ex_id,
		$as_id
	)

private

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

References $CONTENT_ATTACH_GZIP_ENCODED, $CONTENT_ATTACH_ZLIB_ENCODED, $filename, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

     {
         $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");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleAssignmentMembers()

ilExerciseXMLWriter::handleAssignmentMembers	(	$ex_id,
		$assignment_id
	)

private

create xml for files per assignment

Parameters

integer	$ex_id	exercise id
array	$assignments	assignment id

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

References $name, ilExerciseMembers\_getMembers(), ilObjUser\_lookupName(), attachMarking(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

     {
         $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");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAttachFileContents()

ilExerciseXMLWriter::setAttachFileContents ( $attachFileContents )

set attachment content mode

Parameters

int $attachFileContents

Exceptions

ilExerciseException if mode is not supported

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

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

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

◆ setAttachMembers()

ilExerciseXMLWriter::setAttachMembers ( $value )

write access to property attchMarkings

Parameters

boolean $value

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

     {
         $this->attachMembers = $value ? true : false;
     }

◆ setExercise()

ilExerciseXMLWriter::setExercise ( $exercise )

set exercise object

Parameters

ilObjExercise $exercise

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

References $exercise.

     {
         $this->exercise = $exercise;
     }

◆ start()

ilExerciseXMLWriter::start ( )

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

References __buildFooter(), __buildHeader(), ilExAssignment\getAssignmentDataOfExercise(), handleAssignmentFiles(), handleAssignmentMembers(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

     {
         $this->__buildHeader();
         
         $attribs = array("obj_id" => "il_" . IL_INST_ID . "_exc_" . $this->exercise->getId() );
         
         if ($this->exercise->getOwner()) {
             $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;
     }