MDL-33552 - portfolio api E_STRICT fixes
[moodle.git] / lib / portfolio / forms.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/>.
17 /**
18  * This file contains all the form definitions used by the portfolio code.
19  *
20  * @package core_portfolio
21  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>,
22  *            Martin Dougiamas (http://dougiamas.com)
23  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 // make sure we include moodleform first!
29 require_once ($CFG->libdir.'/formslib.php');
31 /**
32  * During-export config form.
33  *
34  * This is the form that is actually used while exporting.
35  * Plugins and callers don't get to define their own class
36  * as we have to handle form elements from both places
37  * See the docs here for more information:
38  * http://docs.moodle.org/dev/Writing_a_Portfolio_Plugin#has_export_config
39  * http://docs.moodle.org/dev/Adding_a_Portfolio_Button_to_a_page#has_export_config
40  *
41  * @package core_portfolio
42  * @category portfolio
43  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
44  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
45  */
46 final class portfolio_export_form extends moodleform {
48     /**
49      * prepare form
50      */
51     public function definition() {
53         $mform =& $this->_form;
54         $mform->addElement('hidden', 'stage', PORTFOLIO_STAGE_CONFIG);
55         $mform->addElement('hidden', 'id', $this->_customdata['id']);
56         $mform->addElement('hidden', 'instance', $this->_customdata['instance']->get('id'));
57         $mform->setType('instance', PARAM_INT);
58         $mform->setType('stage', PARAM_INT);
59         $mform->setType('id', PARAM_INT);
61         if (array_key_exists('formats', $this->_customdata) && is_array($this->_customdata['formats'])) {
62             if (count($this->_customdata['formats']) > 1) {
63                 $options = array();
64                 foreach ($this->_customdata['formats'] as $key) {
65                     $options[$key] = get_string('format_' . $key, 'portfolio');
66                 }
67                 $mform->addElement('select', 'format', get_string('availableformats', 'portfolio'), $options);
68             } else {
69                 $f = array_shift($this->_customdata['formats']);
70                 $mform->addElement('hidden', 'format', $f);
71                 $mform->setType('format', PARAM_RAW);
72             }
73         }
75         // only display the option to wait or not if it's applicable
76         if (array_key_exists('expectedtime', $this->_customdata)
77             && $this->_customdata['expectedtime'] != PORTFOLIO_TIME_LOW
78             && $this->_customdata['expectedtime'] != PORTFOLIO_TIME_FORCEQUEUE) {
79             $radioarray = array();
80             $radioarray[] = $mform->createElement('radio', 'wait', '', get_string('wait', 'portfolio'), 1);
81             $radioarray[] = $mform->createElement('radio', 'wait', '', get_string('dontwait', 'portfolio'),  0);
82             $mform->addGroup($radioarray, 'radioar', get_string('wanttowait_' . $this->_customdata['expectedtime'], 'portfolio') , array(' '), false);
83             $mform->setDefault('wait', 0);
84         } else {
85             if ($this->_customdata['expectedtime'] == PORTFOLIO_TIME_LOW) {
86                 $mform->addElement('hidden', 'wait', 1);
87             } else {
88                 $mform->addElement('hidden', 'wait', 0);
89             }
90             $mform->setType('wait', PARAM_INT);
91         }
93         if (array_key_exists('plugin', $this->_customdata) && is_object($this->_customdata['plugin'])) {
94             $this->_customdata['plugin']->export_config_form($mform, $this->_customdata['userid']);
95         }
97         if (array_key_exists('caller', $this->_customdata) && is_object($this->_customdata['caller'])) {
98             $this->_customdata['caller']->export_config_form($mform, $this->_customdata['instance'], $this->_customdata['userid']);
99         }
101         $this->add_action_buttons(true, get_string('next'));
102     }
104     /**
105      * Validate portfolio export form
106      *
107      * @param stdClass $data portfolio information from form data
108      * @return array
109      */
110     public function validation($data, $files) {
112         $errors = array();
114         if (array_key_exists('plugin', $this->_customdata) && is_object($this->_customdata['plugin'])) {
115             $pluginerrors = $this->_customdata['plugin']->export_config_validation($data);
116             if (is_array($pluginerrors)) {
117                 $errors = $pluginerrors;
118             }
119         }
120         if (array_key_exists('caller', $this->_customdata) && is_object($this->_customdata['caller'])) {
121             $callererrors = $this->_customdata['caller']->export_config_validation($data);
122             if (is_array($callererrors)) {
123                 $errors = array_merge($errors, $callererrors);
124             }
125         }
126         return $errors;
127     }
130 /**
131  * Admin config form.
132  *
133  * This form is extendable by plugins who want the admin to be able to configure more than just the name of the instance.
134  * This is NOT done by subclassing this class, see the docs for portfolio_plugin_base for more information:
135  * {@link http://docs.moodle.org/dev/Writing_a_Portfolio_Plugin#has_admin_config}
136  *
137  * @package core_portfolio
138  * @category portfolio
139  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
140  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
141  */
142 final class portfolio_admin_form extends moodleform {
144     /** @var object to hold porfolio instance configuration */
145     protected $instance;
147     /** @var string plugin name*/
148     protected $plugin;
150     /** @var string portfolio plugin name*/
151     protected $portfolio;
153     /** @var string plugin availability*/
154     protected $action;
156     /** @var int portfolio plugin visibility*/
157     protected $visible;
159     /**
160      * prepare form
161      */
162     public function definition() {
163         global $CFG;
164         $this->plugin = $this->_customdata['plugin'];
165         $this->instance = (isset($this->_customdata['instance'])
166                 && is_subclass_of($this->_customdata['instance'], 'portfolio_plugin_base'))
167             ? $this->_customdata['instance'] : null;
168         $this->portfolio = $this->_customdata['portfolio'];
169         $this->action = $this->_customdata['action'];
170         $this->visible = $this->_customdata['visible'];
172         $mform =& $this->_form;
173         $strrequired = get_string('required');
175         $mform->addElement('hidden', 'pf', $this->portfolio);
176         $mform->setType('pf', PARAM_ALPHA);
177         $mform->addElement('hidden', 'action', $this->action);
178         $mform->setType('action', PARAM_ALPHA);
179         $mform->addElement('hidden', 'visible', $this->visible);
180         $mform->setType('visible', PARAM_INT);
181         $mform->addElement('hidden', 'plugin', $this->plugin);
182         $mform->setType('plugin', PARAM_PLUGIN);
184         if (!$this->instance) {
185             $insane = portfolio_instance_sanity_check($this->instance);
186         } else {
187             $insane = portfolio_plugin_sanity_check($this->plugin);
188         }
190         if (isset($insane) && is_array($insane)) {
191             $insane = array_shift($insane);
192         }
193         if (isset($insane) && is_string($insane)) { // something went wrong, warn...
194             $mform->addElement('warning', 'insane', null, get_string($insane, 'portfolio_' . $this->plugin));
195         }
197         $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
198         $mform->addRule('name', $strrequired, 'required', null, 'client');
200         // let the plugin add the fields they want (either statically or not)
201         if (portfolio_static_function($this->plugin, 'has_admin_config')) {
202             require_once($CFG->libdir . '/portfolio/plugin.php');
203             require_once($CFG->dirroot . '/portfolio/' . $this->plugin .  '/lib.php');
204             call_user_func(array('portfolio_plugin_' . $this->plugin, 'admin_config_form'), $mform);
205         }
207         // and set the data if we have some.
208         if ($this->instance) {
209             $data = array('name' => $this->instance->get('name'));
210             foreach ($this->instance->get_allowed_config() as $config) {
211                 $data[$config] = $this->instance->get_config($config);
212             }
213             $this->set_data($data);
214         } else {
215             $this->set_data(array('name' => portfolio_static_function($this->plugin, 'get_name')));
216         }
218         $this->add_action_buttons(true, get_string('save', 'portfolio'));
219     }
221     /**
222      * Validate admin config form
223      *
224      * @param stdObject $data form data
225      * @return array
226      */
227     public function validation($data, $files) {
228         global $DB;
230         $errors = array();
231         if ($DB->count_records('portfolio_instance', array('name' => $data['name'], 'plugin' => $data['plugin'])) > 1) {
232             $errors = array('name' => get_string('err_uniquename', 'portfolio'));
233         }
235         $pluginerrors = array();
236         $pluginerrors = portfolio_static_function($this->plugin, 'admin_config_validation', $data);
237         if (is_array($pluginerrors)) {
238             $errors = array_merge($errors, $pluginerrors);
239         }
240         return $errors;
241     }
244 /**
245  * User config form.
246  *
247  * This is the form for letting the user configure an instance of a plugin.
248  * In order to extend this, you don't subclass this in the plugin..
249  * see the docs in portfolio_plugin_base for more information:
250  * {@link http://docs.moodle.org/dev/Writing_a_Portfolio_Plugin#has_user_config}
251  *
252  * @package core_portfolio
253  * @category portfolio
254  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
255  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
256  */
257 final class portfolio_user_form extends moodleform {
259     /** @var object  user porfolio instance */
260     protected $instance;
262     /** @var int hold user id */
263     protected $userid;
265     /**
266      * prepare form
267      */
268     public function definition() {
269         $this->instance = $this->_customdata['instance'];
270         $this->userid = $this->_customdata['userid'];
272         $this->_form->addElement('hidden', 'config', $this->instance->get('id'));
273         $this->_form->setType('config', PARAM_INT);
275         $this->instance->user_config_form($this->_form, $this->userid);
277         $data = array();
278         foreach ($this->instance->get_allowed_user_config() as $config) {
279             $data[$config] = $this->instance->get_user_config($config, $this->userid);
280         }
281         $this->set_data($data);
282         $this->add_action_buttons(true, get_string('save', 'portfolio'));
283     }
285     /**
286      * User user config form.
287      *
288      * @param stdClass $data form data
289      */
290     public function validation($data, $files) {
292         $errors = $this->instance->user_config_validation($data);
294     }
298 /**
299  * Form that just contains the dropdown menu of available instances.
300  *
301  * This is not used by portfolio_add_button, but on the first step of the export,
302  * if the plugin instance has not yet been selected.
303  *
304  * @package core_portfolio
305  * @category portfolio
306  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
307  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
308  */
309 class portfolio_instance_select extends moodleform {
311     /** @var portfolio_caller_base plugin instance */
312     private $caller;
314     /**
315      * The required basic elements to the form.
316      */
317     function definition() {
318         $this->caller = $this->_customdata['caller'];
319         $options = $this->_customdata['options'];
320         $mform =& $this->_form;
321         $mform->addElement('select', 'instance', get_string('selectplugin', 'portfolio'), $options);
322         $mform->addElement('hidden', 'id', $this->_customdata['id']);
323         $this->add_action_buttons(true, get_string('next'));
324     }