eb2a0d07fe5460036495cd7d8debef3035328160
[moodle.git] / lib / form / selectwithlink.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/>.
18 /**
19  * select type form element
20  *
21  * Contains HTML class for a select type element with options containing link
22  *
23  * @package   core_form
24  * @copyright 2008 Nicolas Connault <nicolasconnault@gmail.com>
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 require_once('HTML/QuickForm/select.php');
30 /**
31  * select type form element
32  *
33  * HTML class for a select type element with options containing link
34  *
35  * @deprecated since 3.2
36  * @package   core_form
37  * @category  form
38  * @copyright 2008 Nicolas Connault <nicolasconnault@gmail.com>
39  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class MoodleQuickForm_selectwithlink extends HTML_QuickForm_select{
42     /** @var string html for help button, if empty then no help */
43     var $_helpbutton='';
45     /** @var bool if true label will be hidden */
46     var $_hiddenLabel=false;
48     /** @var string url to which select option will be posted */
49     var $_link=null;
51     /** @var string data which will be posted to link */
52     var $_linklabel=null;
54     /** @var string url return link */
55     var $_linkreturn=null;
57     /**
58      * constructor
59      *
60      * @param string $elementName Select name attribute
61      * @param mixed $elementLabel Label(s) for the select
62      * @param array $options Data to be used to populate options
63      * @param mixed $attributes Either a typical HTML attribute string or an associative array
64      * @param bool $linkdata data to be posted
65      */
66     public function __construct($elementName=null, $elementLabel=null, $options=null, $attributes=null, $linkdata=null) {
67         debugging('Element type selectwithlink is deprecated. Use 2 elements.', DEBUG_DEVELOPER);
68         if (!empty($linkdata['link']) && !empty($linkdata['label'])) {
69             $this->_link = $linkdata['link'];
70             $this->_linklabel = $linkdata['label'];
71         }
73         if (!empty($linkdata['return'])) {
74             $this->_linkreturn = $linkdata['return'];
75         }
77         parent::__construct($elementName, $elementLabel, $options, $attributes);
78     }
80     /**
81      * Old syntax of class constructor. Deprecated in PHP7.
82      *
83      * @deprecated since Moodle 3.1
84      */
85     public function MoodleQuickForm_selectwithlink($elementName=null, $elementLabel=null, $options=null, $attributes=null, $linkdata=null) {
86         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
87         self::__construct($elementName, $elementLabel, $options, $attributes, $linkdata);
88     }
90     /**
91      * Sets label to be hidden
92      *
93      * @param bool $hiddenLabel sets if label should be hidden
94      */
95     function setHiddenLabel($hiddenLabel){
96         $this->_hiddenLabel = $hiddenLabel;
97     }
99     /**
100      * Returns the SELECT in HTML
101      *
102      * @return string
103      */
104     function toHtml(){
105         $retval = '';
106         if ($this->_hiddenLabel){
107             $this->_generateId();
108             $retval = '<label class="accesshide" for="'.$this->getAttribute('id').'" >'.
109                         $this->getLabel().'</label>'.parent::toHtml();
110         } else {
111              $retval = parent::toHtml();
112         }
114         if (!empty($this->_link)) {
115             if (!empty($this->_linkreturn) && is_array($this->_linkreturn)) {
116                 $appendchar = '?';
117                 if (strstr($this->_link, '?')) {
118                     $appendchar = '&amp;';
119                 }
121                 foreach ($this->_linkreturn as $key => $val) {
122                     $this->_link .= $appendchar."$key=$val";
123                     $appendchar = '&amp;';
124                 }
125             }
127             $retval .= '<a style="margin-left: 5px" href="'.$this->_link.'">'.$this->_linklabel.'</a>';
128         }
130         return $retval;
131     }
133     /**
134      * get html for help button
135      *
136      * @return string html for help button
137      */
138     function getHelpButton(){
139         return $this->_helpbutton;
140     }
142     /**
143      * Removes an OPTION from the SELECT
144      *
145      * @param string $value Value for the OPTION to remove
146      */
147     function removeOption($value)
148     {
149         $key=array_search($value, $this->_values);
150         if ($key!==FALSE and $key!==null) {
151             unset($this->_values[$key]);
152         }
153         foreach ($this->_options as $key=>$option){
154             if ($option['attr']['value']==$value){
155                 unset($this->_options[$key]);
156                 return;
157             }
158         }
159     }
161     /**
162      * Removes all OPTIONs from the SELECT
163      */
164     function removeOptions()
165     {
166         $this->_options = array();
167     }
169     /**
170      * Slightly different container template when frozen. Don't want to use a label tag
171      * with a for attribute in that case for the element label but instead use a div.
172      * Templates are defined in renderer constructor.
173      *
174      * @return string
175      */
176     function getElementTemplateType(){
177         if ($this->_flagFrozen){
178             return 'static';
179         } else {
180             return 'default';
181         }
182     }
184    /**
185     * We check the options and return only the values that _could_ have been
186     * selected. We also return a scalar value if select is not "multiple"
187     *
188     * @param array $submitValues submitted values
189     * @param bool $assoc if true the retured value is associated array
190     * @return mixed
191     */
192     function exportValue(&$submitValues, $assoc = false)
193     {
194         if (empty($this->_options)) {
195             return $this->_prepareValue(null, $assoc);
196         }
198         $value = $this->_findValue($submitValues);
199         if (is_null($value)) {
200             $value = $this->getValue();
201         }
202         $value = (array)$value;
204         $cleaned = array();
205         foreach ($value as $v) {
206             foreach ($this->_options as $option) {
207                 if ((string)$option['attr']['value'] === (string)$v) {
208                     $cleaned[] = (string)$option['attr']['value'];
209                     break;
210                 }
211             }
212         }
214         if (empty($cleaned)) {
215             return $this->_prepareValue(null, $assoc);
216         }
217         if ($this->getMultiple()) {
218             return $this->_prepareValue($cleaned, $assoc);
219         } else {
220             return $this->_prepareValue($cleaned[0], $assoc);
221         }
222     }