[Summary view]

Differences Between: [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403]

   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   * Strings for component 'profilefield_checkbox', language 'en', branch 'MOODLE_20_STABLE'
  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  
  25  /**
  26   * Class profile_field_checkbox
  27   *
  28   * @copyright  2008 onwards Shane Elliot {@link http://pukunui.com}
  29   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  30   */
  31  class profile_field_checkbox extends profile_field_base {
  32  
  33      /**
  34       * Add elements for editing the profile field value.
  35       * @param moodleform $mform
  36       */
  37      public function edit_field_add($mform) {
  38          // Create the form field.
  39          $checkbox = $mform->addElement('advcheckbox', $this->inputname, format_string($this->field->name));
  40          if ($this->data == '1') {
  41              $checkbox->setChecked(true);
  42          }
  43          $mform->setType($this->inputname, PARAM_BOOL);
  44          if ($this->is_required() and !has_capability('moodle/user:update', context_system::instance())) {
  45              $mform->addRule($this->inputname, get_string('required'), 'nonzero', null, 'client');
  46          }
  47      }
  48  
  49      /**
  50       * Display the data for this field
  51       *
  52       * @return string HTML.
  53       */
  54      public function display_data() {
  55          $options = new stdClass();
  56          $options->para = false;
  57          $checked = intval($this->data) === 1 ? 'checked="checked"' : '';
  58          return '<input disabled="disabled" type="checkbox" name="'.$this->inputname.'" '.$checked.' />';
  59      }
  60  
  61      /**
  62       * Return the field type and null properties.
  63       * This will be used for validating the data submitted by a user.
  64       *
  65       * @return array the param type and null property
  66       * @since Moodle 3.2
  67       */
  68      public function get_field_properties() {
  69          return array(PARAM_BOOL, NULL_NOT_ALLOWED);
  70      }
  71  }
  72  
  73