ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilExerciseXMLParser Class Reference

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

 ilExerciseXMLParser (& $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
 ilSaxParser ($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
 PEAR ($error_class=null)
 Constructor. More...
 
 _PEAR ()
 Destructor (the emulated type of...). More...
 
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...
 
 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...
 
 setErrorHandling ($mode=null, $options=null)
 Sets how errors generated by this object should be handled. 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
 

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

- 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

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
Version
Id
class.ilObjectXMLParser.php 12811 2006-12-08 18:37:44Z akill

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

Member Function Documentation

◆ getAssignment()

ilExerciseXMLParser::getAssignment ( )

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

References $assignment.

353  {
354  return $this->assignment;
355  }

◆ handlerBeginTag()

ilExerciseXMLParser::handlerBeginTag (   $a_xml_parser,
  $a_name,
  $a_attribs 
)

handler for begin of element

Parameters
resource$a_xml_parserxml parser
string$a_nameelement name
array$a_attribselement attributes array
Exceptions
ilExerciseExceptionwhen obj id != - 1 and if it it does not match the id in the xml

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

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

124  {
125  global $ilErr;
126 
127  switch($a_name)
128  {
129  case 'Exercise':
130  if (isset($a_attribs["obj_id"]))
131  {
132  $read_obj_id = ilUtil::__extractId($a_attribs["obj_id"], IL_INST_ID);
133  if ($this->obj_id != -1 && (int) $read_obj_id != -1 && (int) $this->obj_id != (int) $read_obj_id)
134  {
135  throw new ilExerciseException ("Object IDs (xml $read_obj_id and argument ".$this->obj_id.") do not match!", ilExerciseException::$ID_MISMATCH);
136  }
137  }
138  break;
139  case 'Member':
140  $this->usr_action = $a_attribs["action"];
141  $this->usr_id = ilUtil::__extractId($a_attribs["usr_id"], IL_INST_ID);
142  break;
143 
144  case 'File':
145  $this->file_action = $a_attribs["action"];
146  break;
147  case 'Content':
149  if ($a_attribs["mode"] == "GZIP")
150  {
151  if (!function_exists("gzdecode"))
152  throw new ilExerciseException ("Deflating with gzip is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH);
153 
155  } elseif ($a_attribs["mode"] == "ZLIB")
156  {
157  if (!function_exists("gzuncompress"))
158  throw new ilExerciseException ("Deflating with zlib (compress/uncompress) is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH);
159 
161  }
162  break;
163  case 'Marking':
164  $this->status = $a_attribs["status"];
165  if ($this->status == ilExerciseXMLWriter::$STATUS_NOT_GRADED)
166  $this->status = "notgraded";
167  elseif ($this->status == ilExerciseXMLWriter::$STATUS_PASSED)
168  $this->status = "passed";
169  else
170  $this->status = "failed";
171  break;
172 
173  }
174  }
static __extractId($ilias_id, $inst_id)
extract ref id from role title, e.g.
Class to report exception.
+ Here is the call graph for this function:

◆ handlerCharacterData()

ilExerciseXMLParser::handlerCharacterData (   $a_xml_parser,
  $a_data 
)

handler for character data

Parameters
resource$a_xml_parserxml parser
string$a_datacharacter data

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

244  {
245  if($a_data != "\n")
246  {
247  $this->cdata .= $a_data;
248  }
249  }

◆ handlerEndTag()

ilExerciseXMLParser::handlerEndTag (   $a_xml_parser,
  $a_name 
)

handler for end of element

Parameters
resource$a_xml_parserxml parser
string$a_nameelement name

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

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

185  {
186  switch($a_name)
187  {
188  case 'Exercise':
189  $this->result = true;
190  break;
191  case 'Title':
192  $this->exercise->setTitle(trim($this->cdata));
193  $this->assignment->setTitle(trim($this->cdata));
194  break;
195  case 'Description':
196  $this->exercise->setDescription(trim($this->cdata));
197  break;
198  case 'Instruction':
199  $this->assignment->setInstruction(trim($this->cdata));
200  break;
201  case 'DueDate':
202  $this->assignment->setDeadLine(trim($this->cdata));
203  break;
204  case 'Member':
205  $this->updateMember($this->usr_id, $this->usr_action);
206  // update marking after update member.
207  $this->updateMarking($this->usr_id);
208  break;
209  case 'Filename':
210  $this->file_name = trim($this->cdata);
211  break;
212  case 'Content':
213  $this->file_content = trim($this->cdata);
214  break;
215  case 'File':
216  $this->updateFile($this->file_name, $this->file_content, $this->file_action);
217  break;
218  case 'Comment':
219  $this->comment = trim($this->cdata);
220  break;
221  case 'Notice':
222  $this->notice = trim($this->cdata);
223  break;
224  case 'Mark':
225  $this->mark = trim($this->cdata);
226  break;
227  case 'Marking':
228  // see Member end tag
229  break;
230  }
231 
232  $this->cdata = '';
233 
234  return;
235  }
updateMarking($usr_id)
update marking of member
updateFile($filename, $b64encodedContent, $action)
update file according to filename
updateMember($user_id, $action)
update member object according to given action
+ Here is the call graph for this function:

◆ ilExerciseXMLParser()

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

Constructor.

Parameters
ilExercise$exerciseexisting exercise object
string$a_xml_filexml data
int$obj_idobj id of exercise which is to be updated public

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

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

76  {
77 // @todo: needs to be revised for multiple assignments per exercise
78 
79  parent::ilSaxParser();
80  $this->exercise = $exercise;
81  // get all assignments and choose first one if exists, otherwise create
83  if (count ($assignments) > 0) {
84  $this->assignment = new ilExAssignment($assignments [0]["id"]);
85  } else {
86  $this->assignment = new ilExAssignment();
87  $this->assignment->setExerciseId($exercise->getId());
88  $this->assignment->save();
89  }
90 
91  include_once ("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
92  $this->storage = new ilFSStorageExercise ( $this->exercise->getId(), $this->assignment->getId());
93  $this->storage->create();
94  $this->storage->init();
95 
96  $this->setXMLContent($a_xml_data);
97  $this->obj_id = $obj_id;
98  $this->result = false;
99  }
static getAssignmentDataOfExercise($a_exc_id)
Get assignments data of an exercise in an array.
Exercise assignment.
setXMLContent($a_xml_content)
+ Here is the call graph for this function:

◆ setHandlers()

ilExerciseXMLParser::setHandlers (   $a_xml_parser)

set event handlers

Parameters
resourcereference to the xml parser private

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

109  {
110  xml_set_object($a_xml_parser,$this);
111  xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
112  xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
113  }

◆ start()

ilExerciseXMLParser::start ( )

starts parsing an changes object by side effect.

Exceptions
ilExerciseExceptionwhen 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 315 of file class.ilExerciseXMLParser.php.

References ilSaxParser\startParsing().

315  {
316  $this->startParsing();
317  return $this->result > 0;
318  }
startParsing()
stores xml data in array
+ Here is the call graph for this function:

◆ updateFile()

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

update file according to filename

Parameters
string$filename
string$contentbase 64 encoded string
string$actioncan be Attach or Detach

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

References $CONTENT_GZ_COMPRESSED, $CONTENT_ZLIB_COMPRESSED, and $filename.

Referenced by handlerEndTag().

283  {
284  if (strlen($filename) == 0) {
285  return;
286  }
287  $filename= $this->storage->getAbsolutePath()."/".$filename;
288 
289  if ($action == "Attach")
290  {
291  $content = base64_decode((string) $b64encodedContent);
292  if ($this->mode == ilExerciseXMLParser::$CONTENT_GZ_COMPRESSED) {
293  $content = gzdecode($content);
294  }elseif ($this->mode ==ilExerciseXMLParser::$CONTENT_ZLIB_COMPRESSED) {
295  $content = gzuncompress($content);
296  }
297 
298  //echo $filename;
299  $this->storage->writeToFile($content, $filename);
300 
301  }
302  if ($action == "Detach")
303  {
304  $this->storage->deleteFile($filename);
305  }
306  }
$filename
Definition: buildRTE.php:89
+ 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 325 of file class.ilExerciseXMLParser.php.

References ilUtil\stripSlashes().

Referenced by handlerEndTag().

325  {
326 
327  $member_status = $this->assignment->getMemberStatus($usr_id);
328  if (isset($this->mark))
329  {
330  $member_status->setMark(ilUtil::stripSlashes($this->mark));
331  }
332  if (isset($this->comment))
333  {
334  $member_status->setComment(ilUtil::stripSlashes($this->comment));
335  }
336  if (isset($this->status))
337  {
338  $member_status->setStatus(ilUtil::stripSlashes($this->status));
339  }
340  if (isset($this->notice))
341  {
342  $member_status->setNotice(ilUtil::stripSlashes($this->notice));
343  }
344  $member_status->update();
345 
346  // reset variables
347  $this->mark = null;
348  $this->status = null;
349  $this->notice = null;
350  $this->comment = null;
351  }
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
+ 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$actioncan be Attach or Detach

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

Referenced by handlerEndTag().

258  {
259  if (!is_int($user_id) || $user_id <= 0) {
260  return;
261  }
262  $memberObject = new ilExerciseMembers($this->exercise);
263 
264  if ($action == "Attach" && !$memberObject->isAssigned($user_id))
265  {
266  $memberObject->assignMember ($user_id);
267  }
268 
269  if ($action == "Detach" && $memberObject->isAssigned($user_id))
270  {
271  $memberObject->deassignMember ($user_id);
272  }
273  }
Class ilExerciseMembers.
+ Here is the caller graph for this function:

Field Documentation

◆ $assignment

ilExerciseXMLParser::$assignment

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

Referenced by getAssignment().

◆ $CONTENT_GZ_COMPRESSED

ilExerciseXMLParser::$CONTENT_GZ_COMPRESSED = 1
static

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

Referenced by handlerBeginTag(), and updateFile().

◆ $CONTENT_NOT_COMPRESSED

ilExerciseXMLParser::$CONTENT_NOT_COMPRESSED = 0
static

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

Referenced by handlerBeginTag().

◆ $CONTENT_ZLIB_COMPRESSED

ilExerciseXMLParser::$CONTENT_ZLIB_COMPRESSED = 2
static

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

Referenced by handlerBeginTag(), and updateFile().

◆ $exercise

ilExerciseXMLParser::$exercise

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

Referenced by ilExerciseXMLParser().

◆ $mode

ilExerciseXMLParser::$mode

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

◆ $obj_id

ilExerciseXMLParser::$obj_id

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

Referenced by ilExerciseXMLParser().

◆ $result

ilExerciseXMLParser::$result

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

◆ $storage

ilExerciseXMLParser::$storage

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


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