Skip to content
Browse files

MDL-29244 users: Fixed comments for checkbox.php

  • Loading branch information...
1 parent 228d24f commit 542cde99770225a3b9426ce3002202f23682dc66 Rajesh Taneja committed
Showing with 10 additions and 6 deletions.
  1. +10 −6 user/filters/checkbox.php
View
16 user/filters/checkbox.php
@@ -15,12 +15,10 @@
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
- * moodlelib.php - Moodle main library
+ * Generic checkbox filter.
*
- * Main library file of miscellaneous general-purpose Moodle functions.
- * Other main libraries:
- * - weblib.php - functions that produce web output
- * - datalib.php - functions that access the database
+ * This will create generic filter with checkbox option and can be used for
+ * disabling other elements for specific condition.
*
* @package user
* @copyright 2011 Rajesh Taneja
@@ -48,7 +46,9 @@ class user_filter_checkbox extends user_filter_type {
protected $field;
/**
- * Constructor
+ * Constructor, initalize user_filter_type and sets $disableelements array
+ * with list of elements to be diabled by checkbox.
+ *
* @param string $name the name of the filter instance
* @param string $label the label of the filter instance
* @param boolean $advanced advanced form element flag
@@ -69,6 +69,7 @@ public function __construct($name, $label, $advanced, $field, $disableelements=n
/**
* Adds controls specific to this filter in the form.
+ *
* @param moodleform $mform a MoodleQuickForm object in which element will be added
*/
public function setupForm(MoodleQuickForm &$mform) {
@@ -90,6 +91,7 @@ public function setupForm(MoodleQuickForm &$mform) {
/**
* Retrieves data from the form data
+ *
* @param object $formdata data submited with the form
* @return mixed array filter data or false when filter not set
*/
@@ -111,6 +113,7 @@ public function check_data($formdata) {
/**
* Returns the condition to be used with SQL where
+ *
* @param array $data filter settings
* @return array sql string and $params
*/
@@ -126,6 +129,7 @@ public function get_sql_filter($data) {
/**
* Returns a human friendly description of the filter used as label.
+ *
* @param array $data filter settings
* @return string active filter label
*/

0 comments on commit 542cde9

Please sign in to comment.
Something went wrong with that request. Please try again.