lib/form/selectyesno.php

   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 /**
  19  * Yes/No drop down type form element
  20  *
  21  * Contains HTML class for a simple yes/ no drop down element
  22  *
  23  * @package   core_form
  24  * @copyright 2006 Jamie Pratt <me@jamiep.org>
  25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26  */
  27
  28 global $CFG;
  29 require_once "$CFG->libdir/form/select.php";
  30
  31 /**
  32  * Yes/No drop down type form element
  33  *
  34  * HTML class for a simple yes/ no drop down element
  35  *
  36  * @package   core_form
  37  * @category  form
  38  * @copyright 2006 Jamie Pratt <me@jamiep.org>
  39  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40  */
  41 class MoodleQuickForm_selectyesno extends MoodleQuickForm_select{
  42     /**
  43      * Class constructor
  44      *
  45      * @param string $elementName Select name attribute
  46      * @param mixed $elementLabel Label(s) for the select
  47      * @param mixed $attributes Either a typical HTML attribute string or an associative array
  48      * @param mixed $options ignored, not used.
  49      */
  50     public function __construct($elementName=null, $elementLabel=null, $attributes=null, $options=null) {
  51         // TODO MDL-52313 Replace with the call to parent::__construct().
  52         HTML_QuickForm_element::__construct($elementName, $elementLabel, $attributes, null);
  53         $this->_type = 'selectyesno';
  54         $this->_persistantFreeze = true;
  55     }
  56
  57     /**
  58      * Old syntax of class constructor for backward compatibility.
  59      */
  60     public function MoodleQuickForm_selectyesno($elementName=null, $elementLabel=null, $attributes=null, $options=null) {
  61         self::__construct($elementName, $elementLabel, $attributes, $options);
  62     }
  63
  64     /**
  65      * Called by HTML_QuickForm whenever form event is made on this element
  66      *
  67      * @param string $event Name of event
  68      * @param mixed $arg event arguments
  69      * @param object $caller calling object
  70      * @return mixed
  71      */
  72     function onQuickFormEvent($event, $arg, &$caller)
  73     {
  74         switch ($event) {
  75             case 'createElement':
  76                 $choices=array();
  77                 $choices[0] = get_string('no');
  78                 $choices[1] = get_string('yes');
  79                 $this->load($choices);
  80                 break;
  81         }
  82         return parent::onQuickFormEvent($event, $arg, $caller);
  83     }
  84
  85 }