lib/form/select.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  * select type form element
  20  *
  21  * Contains HTML class for a select type 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 require_once('HTML/QuickForm/select.php');
  29
  30 /**
  31  * select type form element
  32  *
  33  * HTML class for a select type element
  34  *
  35  * @package   core_form
  36  * @category  form
  37  * @copyright 2006 Jamie Pratt <me@jamiep.org>
  38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39  */
  40 class MoodleQuickForm_select extends HTML_QuickForm_select{
  41     /** @var string html for help button, if empty then no help */
  42     var $_helpbutton='';
  43
  44     /** @var bool if true label will be hidden */
  45     var $_hiddenLabel=false;
  46
  47     /**
  48      * constructor
  49      *
  50      * @param string $elementName Select name attribute
  51      * @param mixed $elementLabel Label(s) for the select
  52      * @param mixed $options Data to be used to populate options
  53      * @param mixed $attributes Either a typical HTML attribute string or an associative array
  54      */
  55     function MoodleQuickForm_select($elementName=null, $elementLabel=null, $options=null, $attributes=null) {
  56         parent::HTML_QuickForm_select($elementName, $elementLabel, $options, $attributes);
  57     }
  58
  59     /**
  60      * Sets label to be hidden
  61      *
  62      * @param bool $hiddenLabel sets if label should be hidden
  63      */
  64     function setHiddenLabel($hiddenLabel){
  65         $this->_hiddenLabel = $hiddenLabel;
  66     }
  67
  68     /**
  69      * Returns HTML for select form element.
  70      *
  71      * @return string
  72      */
  73     function toHtml(){
  74         $html = '';
  75         if ($this->getMultiple()) {
  76             // Adding an hidden field forces the browser to send an empty data even though the user did not
  77             // select any element. This value will be cleaned up in self::exportValue() as it will not be part
  78             // of the select options.
  79             $html .= '<input type="hidden" name="'.$this->getName().'" value="_qf__force_multiselect_submission">';
  80         }
  81         if ($this->_hiddenLabel){
  82             $this->_generateId();
  83             $html .= '<label class="accesshide" for="'.$this->getAttribute('id').'" >'.$this->getLabel().'</label>';
  84         }
  85         $html .= parent::toHtml();
  86         return $html;
  87     }
  88
  89     /**
  90      * get html for help button
  91      *
  92      * @return string html for help button
  93      */
  94     function getHelpButton(){
  95         return $this->_helpbutton;
  96     }
  97
  98     /**
  99      * Removes an OPTION from the SELECT
 100      *
 101      * @param string $value Value for the OPTION to remove
 102      * @return void
 103      */
 104     function removeOption($value)
 105     {
 106         $key=array_search($value, $this->_values);
 107         if ($key!==FALSE and $key!==null) {
 108             unset($this->_values[$key]);
 109         }
 110         foreach ($this->_options as $key=>$option){
 111             if ($option['attr']['value']==$value){
 112                 unset($this->_options[$key]);
 113                 // we must reindex the options because the ugly code in quickforms' select.php expects that keys are 0,1,2,3... !?!?
 114                 $this->_options = array_merge($this->_options);
 115                 return;
 116             }
 117         }
 118     }
 119
 120     /**
 121      * Removes all OPTIONs from the SELECT
 122      */
 123     function removeOptions()
 124     {
 125         $this->_options = array();
 126     }
 127
 128     /**
 129      * Slightly different container template when frozen. Don't want to use a label tag
 130      * with a for attribute in that case for the element label but instead use a div.
 131      * Templates are defined in renderer constructor.
 132      *
 133      * @return string
 134      */
 135     function getElementTemplateType(){
 136         if ($this->_flagFrozen){
 137             return 'static';
 138         } else {
 139             return 'default';
 140         }
 141     }
 142
 143    /**
 144     * We check the options and return only the values that _could_ have been
 145     * selected. We also return a scalar value if select is not "multiple"
 146     *
 147     * @param array $submitValues submitted values
 148     * @param bool $assoc if true the retured value is associated array
 149     * @return mixed
 150     */
 151     function exportValue(&$submitValues, $assoc = false)
 152     {
 153         if (empty($this->_options)) {
 154             return $this->_prepareValue(null, $assoc);
 155         }
 156
 157         $value = $this->_findValue($submitValues);
 158         if (is_null($value)) {
 159             $value = $this->getValue();
 160         }
 161         $value = (array)$value;
 162
 163         $cleaned = array();
 164         foreach ($value as $v) {
 165             foreach ($this->_options as $option) {
 166                 if ((string)$option['attr']['value'] === (string)$v) {
 167                     $cleaned[] = (string)$option['attr']['value'];
 168                     break;
 169                 }
 170             }
 171         }
 172
 173         if (empty($cleaned)) {
 174             return $this->_prepareValue(null, $assoc);
 175         }
 176         if ($this->getMultiple()) {
 177             return $this->_prepareValue($cleaned, $assoc);
 178         } else {
 179             return $this->_prepareValue($cleaned[0], $assoc);
 180         }
 181     }
 182 }