MDL-34483 qformat_examview: clean the code to make codechecker happy
authorJean-Michel Vedrine <vedrine@vedrine.org>
Mon, 23 Jul 2012 10:31:32 +0000 (11:31 +0100)
committerTim Hunt <T.J.Hunt@open.ac.uk>
Fri, 27 Jul 2012 11:20:11 +0000 (12:20 +0100)
question/format/examview/format.php

index 3bd0539..f9e1975 100644 (file)
@@ -26,7 +26,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-require_once ($CFG->libdir . '/xmlize.php');
+require_once($CFG->libdir . '/xmlize.php');
 
 
 /**
@@ -54,7 +54,7 @@ class qformat_examview extends qformat_default {
 
     public $matching_questions = array();
 
-    function provide_import() {
+    public function provide_import() {
         return true;
     }
 
@@ -68,23 +68,22 @@ class qformat_examview extends qformat_default {
      * @param array $xml section of the xml data structure
      * @return string data with evrything else removed
      */
-    function unxmlise( $xml ) {
-        // if it's not an array then it's probably just data
+    protected function unxmlise( $xml ) {
+        // If it's not an array then it's probably just data.
         if (!is_array($xml)) {
             $text = s($xml);
-        }
-        else {
-            // otherwise parse the array
+        } else {
+            // Otherwise parse the array.
             $text = '';
-            foreach ($xml as $tag=>$data) {
-                // if tag is '@' then it's attributes and we don't care
+            foreach ($xml as $tag => $data) {
+                // If tag is '@' then it's attributes and we don't care.
                 if ($tag!=='@') {
                     $text = $text . $this->unxmlise( $data );
                 }
             }
         }
 
-        // currently we throw the tags we found
+        // Currently we throw the tags we found.
         $text = strip_tags($text);
         return $text;
     }
@@ -109,13 +108,12 @@ class qformat_examview extends qformat_default {
         return $question;
     }
 
-    function parse_matching_groups($matching_groups)
-    {
+    protected function parse_matching_groups($matching_groups) {
         if (empty($matching_groups)) {
             return;
         }
-        foreach($matching_groups as $match_group) {
-            $newgroup = NULL;
+        foreach ($matching_groups as $match_group) {
+            $newgroup = null;
             $groupname = trim($match_group['@']['name']);
             $questiontext = $this->unxmlise($match_group['#']['text'][0]['#']);
             $newgroup->questiontext = trim($questiontext);
@@ -123,8 +121,8 @@ class qformat_examview extends qformat_default {
             $newgroup->subquestions = array();
             $newgroup->subanswers = array();
             $choices = $match_group['#']['choices']['0']['#'];
-            foreach($choices as $key => $value) {
-                if (strpos(trim($key),'choice-') !== FALSE) {
+            foreach ($choices as $key => $value) {
+                if (strpos(trim($key), 'choice-') !== false) {
                     $key = strtoupper(trim(str_replace('choice-', '', $key)));
                     $newgroup->subchoices[$key] = trim($value['0']['#']);
                 }
@@ -133,8 +131,7 @@ class qformat_examview extends qformat_default {
         }
     }
 
-    function parse_ma($qrec, $groupname)
-    {
+    protected function parse_ma($qrec, $groupname) {
         $match_group = $this->matching_questions[$groupname];
         $phrase = trim($this->unxmlise($qrec['text']['0']['#']));
         $answer = trim($this->unxmlise($qrec['answer']['0']['#']));
@@ -142,15 +139,14 @@ class qformat_examview extends qformat_default {
         $match_group->subquestions[] = $this->text_field($phrase);
         $match_group->subanswers[] = $match_group->subchoices[$answer];
         $this->matching_questions[$groupname] = $match_group;
-        return NULL;
+        return null;
     }
 
-    function process_matches(&$questions)
-    {
+    protected function process_matches(&$questions) {
         if (empty($this->matching_questions)) {
             return;
         }
-        foreach($this->matching_questions as $match_group) {
+        foreach ($this->matching_questions as $match_group) {
             $question = $this->defaultquestion();
             $htmltext = s($match_group->questiontext);
             $question->questiontext = $htmltext;
@@ -161,7 +157,7 @@ class qformat_examview extends qformat_default {
             $question = $this->add_blank_combined_feedback($question);
             $question->subquestions = array();
             $question->subanswers = array();
-            foreach($match_group->subquestions as $key => $value) {
+            foreach ($match_group->subquestions as $key => $value) {
                 $htmltext = s($value);
                 $question->subquestions[] = $htmltext;
 
@@ -172,28 +168,28 @@ class qformat_examview extends qformat_default {
         }
     }
 
-    function cleanUnicode($text) {
+    protected function cleanunicode($text) {
         return str_replace('&#x2019;', "'", $text);
     }
 
     protected function readquestions($lines) {
-        /// Parses an array of lines into an array of questions,
-        /// where each item is a question object as defined by
-        /// readquestion().
+        // Parses an array of lines into an array of questions,
+        // where each item is a question object as defined by
+        // readquestion().
 
         $questions = array();
         $currentquestion = array();
 
         $text = implode($lines, ' ');
-        $text = $this->cleanUnicode($text);
+        $text = $this->cleanunicode($text);
 
         $xml = xmlize($text, 0);
         if (!empty($xml['examview']['#']['matching-group'])) {
             $this->parse_matching_groups($xml['examview']['#']['matching-group']);
         }
 
-        $questionNode = $xml['examview']['#']['question'];
-        foreach($questionNode as $currentquestion) {
+        $questionnode = $xml['examview']['#']['question'];
+        foreach ($questionnode as $currentquestion) {
             if ($question = $this->readquestion($currentquestion)) {
                 $questions[] = $question;
             }
@@ -202,21 +198,18 @@ class qformat_examview extends qformat_default {
         $this->process_matches($questions);
         return $questions;
     }
-    // end readquestions
 
-    function readquestion($qrec)
-    {
+    public function readquestion($qrec) {
 
         $type = trim($qrec['@']['type']);
         $question = $this->defaultquestion();
         if (array_key_exists($type, $this->qtypes)) {
             $question->qtype = $this->qtypes[$type];
-        }
-        else {
+        } else {
             $question->qtype = null;
         }
         $question->single = 1;
-        // Only one answer is allowed
+        // Only one answer is allowed.
         $htmltext = $this->unxmlise($qrec['#']['text'][0]['#']);
         $question->questiontext = $htmltext;
         $question->questiontextformat = FORMAT_HTML;
@@ -224,38 +217,35 @@ class qformat_examview extends qformat_default {
         $question->name = shorten_text( $question->questiontext, 250 );
 
         switch ($question->qtype) {
-        case MULTICHOICE:
-            $question = $this->parse_mc($qrec['#'], $question);
-            break;
-        case MATCH:
-            $groupname = trim($qrec['@']['group']);
-            $question = $this->parse_ma($qrec['#'], $groupname);
-            break;
-        case TRUEFALSE:
-            $question = $this->parse_tf_yn($qrec['#'], $question);
-            break;
-        case SHORTANSWER:
-            $question = $this->parse_co($qrec['#'], $question);
-            break;
-        case ESSAY:
-            $question = $this->parse_sa($qrec['#'], $question);
-            break;
-        case NUMERICAL:
-            $question = $this->parse_nr($qrec['#'], $question);
-            break;
-            break;
+            case MULTICHOICE:
+                $question = $this->parse_mc($qrec['#'], $question);
+                break;
+            case MATCH:
+                $groupname = trim($qrec['@']['group']);
+                $question = $this->parse_ma($qrec['#'], $groupname);
+                break;
+            case TRUEFALSE:
+                $question = $this->parse_tf_yn($qrec['#'], $question);
+                break;
+            case SHORTANSWER:
+                $question = $this->parse_co($qrec['#'], $question);
+                break;
+            case ESSAY:
+                $question = $this->parse_sa($qrec['#'], $question);
+                break;
+            case NUMERICAL:
+                $question = $this->parse_nr($qrec['#'], $question);
+                break;
+                break;
             default:
-            print("<p>Question type ".$type." import not supported for ".$question->questiontext."<p>");
-            $question = NULL;
+                print("<p>Question type ".$type." import not supported for ".$question->questiontext."<p>");
+                $question = null;
         }
-        // end switch ($question->qtype)
 
         return $question;
     }
-    // end readquestion
 
-    function parse_tf_yn($qrec, $question)
-    {
+    protected function parse_tf_yn($qrec, $question) {
         $choices = array('T' => 1, 'Y' => 1, 'F' => 0, 'N' => 0 );
         $answer = trim($qrec['answer'][0]['#']);
         $question->answer = $choices[$answer];
@@ -270,14 +260,13 @@ class qformat_examview extends qformat_default {
         return $question;
     }
 
-    function parse_mc($qrec, $question)
-    {
+    protected function parse_mc($qrec, $question) {
         $question = $this->add_blank_combined_feedback($question);
         $answer = 'choice-'.strtolower(trim($qrec['answer'][0]['#']));
 
         $choices = $qrec['choices'][0]['#'];
-        foreach($choices as $key => $value) {
-            if (strpos(trim($key),'choice-') !== FALSE) {
+        foreach ($choices as $key => $value) {
+            if (strpos(trim($key), 'choice-') !== false) {
 
                 $question->answer[$key] = $this->text_field(s($this->unxmlise($value[0]['#'])));
                 if (strcmp($key, $answer) == 0) {
@@ -292,14 +281,13 @@ class qformat_examview extends qformat_default {
         return $question;
     }
 
-    function parse_co($qrec, $question)
-    {
+    protected function parse_co($qrec, $question) {
         $question->usecase = 0;
         $answer = trim($this->unxmlise($qrec['answer'][0]['#']));
         $answer = strip_tags( $answer );
-        $answers = explode("\n",$answer);
+        $answers = explode("\n", $answer);
 
-        foreach($answers as $key => $value) {
+        foreach ($answers as $key => $value) {
             $value = trim($value);
             if (strlen($value) > 0) {
                 $question->answer[$key] = $value;
@@ -310,20 +298,19 @@ class qformat_examview extends qformat_default {
         return $question;
     }
 
-    function parse_sa($qrec, $question) {
+    protected function parse_sa($qrec, $question) {
         $feedback = trim($this->unxmlise($qrec['answer'][0]['#']));
         $question->feedback = $feedback;
         $question->fraction = 0;
         return $question;
     }
 
-    function parse_nr($qrec, $question)
-    {
+    protected function parse_nr($qrec, $question) {
         $answer = trim($this->unxmlise($qrec['answer'][0]['#']));
         $answer = strip_tags( $answer );
-        $answers = explode("\n",$answer);
+        $answers = explode("\n", $answer);
 
-        foreach($answers as $key => $value) {
+        foreach ($answers as $key => $value) {
             $value = trim($value);
             if (is_numeric($value)) {
                 $errormargin = 0;
@@ -338,6 +325,6 @@ class qformat_examview extends qformat_default {
     }
 
 }
-// end class
+// End class.