[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Class profile_field_checkbox
  19   *
  20   * @package    profilefield_checkbox
  21   * @copyright  2008 onwards Shane Elliot {@link http://pukunui.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  class profile_field_checkbox extends profile_field_base {
  25  
  26      /**
  27       * Add elements for editing the profile field value.
  28       * @param moodleform $mform
  29       */
  30      public function edit_field_add($mform) {
  31          // Create the form field.
  32          $checkbox = $mform->addElement('advcheckbox', $this->inputname, format_string($this->field->name));
  33          if ($this->data == '1') {
  34              $checkbox->setChecked(true);
  35          }
  36          $mform->setType($this->inputname, PARAM_BOOL);
  37          if ($this->is_required() and !has_capability('moodle/user:update', context_system::instance())) {
  38              $mform->addRule($this->inputname, get_string('required'), 'nonzero', null, 'client');
  39          }
  40      }
  41  
  42      /**
  43       * Display the data for this field
  44       *
  45       * @return string HTML.
  46       */
  47      public function display_data() {
  48          return $this->data ? get_string('yes') : get_string('no');
  49      }
  50  
  51      /**
  52       * Return the field type and null properties.
  53       * This will be used for validating the data submitted by a user.
  54       *
  55       * @return array the param type and null property
  56       * @since Moodle 3.2
  57       */
  58      public function get_field_properties() {
  59          return array(PARAM_BOOL, NULL_NOT_ALLOWED);
  60      }
  61  }
  62  
  63