MDL-27675 mod_feedback: Tidy up of phpdocs and scope within feedback mod

moodle · May 28, 2012 · 064cac7 · 064cac7
1 parent a09a9be
commit 064cac7
Show file tree

Hide file tree

Showing 10 changed files with 53 additions and 16 deletions.
diff --git a/mod/feedback/item/captcha/lib.php b/mod/feedback/item/captcha/lib.php
@@ -327,7 +327,12 @@ public function can_switch_require() {
         return false;
     }
 
-    function clean_input_value($value) {
+    /**
+     * Cleans the value coming from the user for a field of this type.
+     * @param mixed $value
+     * @return mixed
+     */
+    public function clean_input_value($value) {
         return clean_param($value, PARAM_RAW);
     }
 }
diff --git a/mod/feedback/item/feedback_item_class.php b/mod/feedback/item/feedback_item_class.php
@@ -128,13 +128,13 @@ abstract public function print_item_complete($item, $value = '', $highlightrequi
      */
     abstract public function print_item_show_value($item, $value = '');
 
-    /**     
+    /**
      * cleans the userinput while submitting the form
      *
      * @param mixed $value
      * @return mixed
      */
-    abstract function clean_input_value($value);
+    abstract public function clean_input_value($value);
 
 }
 
@@ -186,4 +186,4 @@ public function can_switch_require() {
     public function clean_input_value($value) {
     }
 
-}
+}
diff --git a/mod/feedback/item/info/lib.php b/mod/feedback/item/info/lib.php
@@ -389,7 +389,12 @@ public function can_switch_require() {
         return false;
     }
 
-    function clean_input_value($value) {
+    /**
+     * Cleans the value coming from the user for a field of this type.
+     * @param mixed $value
+     * @return mixed
+     */
+    public function clean_input_value($value) {
         return clean_param($value, PARAM_INT);
     }
 }
diff --git a/mod/feedback/item/label/lib.php b/mod/feedback/item/label/lib.php
@@ -270,6 +270,11 @@ public function get_printval($item, $value) {
     }
     public function get_analysed($item, $groupid = false, $courseid = false) {
     }
+    /**
+     * Cleans the value coming from the user for a field of this type.
+     * @param mixed $value
+     * @return mixed
+     */
     public function clean_input_value($value) {
         return '';
     }

diff --git a/mod/feedback/item/multichoice/lib.php b/mod/feedback/item/multichoice/lib.php
@@ -827,11 +827,12 @@ public function value_is_array() {
         return true;
     }
 
-    function can_switch_require() {
-        return true;
-    }
-
-    function clean_input_value($value) {
+    /**
+     * Cleans the value coming from the user for a field of this type.
+     * @param mixed $value
+     * @return mixed
+     */
+    public function clean_input_value($value) {
         return clean_param_array($value, PARAM_INT);
     }
 }
diff --git a/mod/feedback/item/multichoicerated/lib.php b/mod/feedback/item/multichoicerated/lib.php
@@ -678,7 +678,12 @@ public function can_switch_require() {
         return true;
     }
 
-    function clean_input_value($value) {
+    /**
+     * Cleans the value coming from the user for a field of this type.
+     * @param mixed $value
+     * @return mixed
+     */
+    public function clean_input_value($value) {
         return clean_param($value, PARAM_INT);
     }
 }
diff --git a/mod/feedback/item/numeric/lib.php b/mod/feedback/item/numeric/lib.php
@@ -534,8 +534,13 @@ public function get_hasvalue() {
     public function can_switch_require() {
         return true;
     }
-
-    function clean_input_value($value) {
+
+    /**
+     * Cleans the value coming from the user for a field of this type.
+     * @param mixed $value
+     * @return mixed
+     */
+    public function clean_input_value($value) {
         return clean_param($value, PARAM_FLOAT);
     }
 }
diff --git a/mod/feedback/item/textarea/lib.php b/mod/feedback/item/textarea/lib.php
@@ -334,7 +334,12 @@ public function can_switch_require() {
         return true;
     }
 
-    function clean_input_value($value) {
+    /**
+     * Cleans the value coming from the user for a field of this type.
+     * @param mixed $value
+     * @return mixed
+     */
+    public function clean_input_value($value) {
         return clean_param($value, PARAM_CLEANHTML);
     }
 }
diff --git a/mod/feedback/item/textfield/lib.php b/mod/feedback/item/textfield/lib.php
@@ -321,7 +321,12 @@ public function can_switch_require() {
         return true;
     }
 
-    function clean_input_value($value) {
+    /**
+     * Cleans the value coming from the user for a field of this type.
+     * @param mixed $value
+     * @return mixed
+     */
+    public function clean_input_value($value) {
         return clean_param($value, PARAM_CLEANHTML);
     }
 }
diff --git a/mod/feedback/lib.php b/mod/feedback/lib.php
@@ -2058,9 +2058,10 @@ function feedback_get_page_to_continue($feedbackid, $courseid = false, $guestid
 //functions to handle the values
 ////////////////////////////////////////////////
 
-/**     
+/**
  * cleans the userinput while submitting the form.
  *
+ * @param stdClass $item The feedback item record from the database that the value needs to be cleaned against.
  * @param mixed $value
  * @return mixed
  */