db93ef24f92285ff6dc4ac3b774f9e3bb84bef22
[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  * This is the form that is actually used while exporting.
34  * Plugins and callers don't get to define their own class
35  * as we have to handle form elements from both places
36  * See the docs here for more information:
37  * http://docs.moodle.org/dev/Writing_a_Portfolio_Plugin#has_export_config
38  * http://docs.moodle.org/dev/Adding_a_Portfolio_Button_to_a_page#has_export_config
39  *
40  * @package core_portfolio
41  * @category portfolio
42  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
43  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44  */
45 final class portfolio_export_form extends moodleform {
47     /**
48      * prepare form
49      */
50     public function definition() {
52         $mform =& $this->_form;
53         $mform->addElement('hidden', 'stage', PORTFOLIO_STAGE_CONFIG);
54         $mform->addElement('hidden', 'id', $this->_customdata['id']);
55         $mform->addElement('hidden', 'instance', $this->_customdata['instance']->get('id'));
56         $mform->setType('instance', PARAM_INT);
57         $mform->setType('stage', PARAM_INT);
58         $mform->setType('id', PARAM_INT);
60         if (array_key_exists('formats', $this->_customdata) && is_array($this->_customdata['formats'])) {
61             if (count($this->_customdata['formats']) > 1) {
62                 $options = array();
63                 foreach ($this->_customdata['formats'] as $key) {
64                     $options[$key] = get_string('format_' . $key, 'portfolio');
65                 }
66                 $mform->addElement('select', 'format', get_string('availableformats', 'portfolio'), $options);
67             } else {
68                 $f = array_shift($this->_customdata['formats']);
69                 $mform->addElement('hidden', 'format', $f);
70                 $mform->setType('format', PARAM_RAW);
71             }
72         }
74         // only display the option to wait or not if it's applicable
75         if (array_key_exists('expectedtime', $this->_customdata)
76             && $this->_customdata['expectedtime'] != PORTFOLIO_TIME_LOW
77             && $this->_customdata['expectedtime'] != PORTFOLIO_TIME_FORCEQUEUE) {
78             $radioarray = array();
79             $radioarray[] = &MoodleQuickForm::createElement('radio', 'wait', '', get_string('wait', 'portfolio'), 1);
80             $radioarray[] = &MoodleQuickForm::createElement('radio', 'wait', '', get_string('dontwait', 'portfolio'),  0);
81             $mform->addGroup($radioarray, 'radioar', get_string('wanttowait_' . $this->_customdata['expectedtime'], 'portfolio') , array(' '), false);
82             $mform->setDefault('wait', 0);
83         } else {
84             if ($this->_customdata['expectedtime'] == PORTFOLIO_TIME_LOW) {
85                 $mform->addElement('hidden', 'wait', 1);
86             } else {
87                 $mform->addElement('hidden', 'wait', 0);
88             }
89             $mform->setType('wait', PARAM_INT);
90         }
92         if (array_key_exists('plugin', $this->_customdata) && is_object($this->_customdata['plugin'])) {
93             $this->_customdata['plugin']->export_config_form($mform, $this->_customdata['userid']);
94         }
96         if (array_key_exists('caller', $this->_customdata) && is_object($this->_customdata['caller'])) {
97             $this->_customdata['caller']->export_config_form($mform, $this->_customdata['instance'], $this->_customdata['userid']);
98         }
100         $this->add_action_buttons(true, get_string('next'));
101     }
103     /**
104      * Validate portfolio export form
105      *
106      * @param stdClass $data portfolio information from form data
107      * @return array
108      */
109     public function validation($data) {
111         $errors = array();
113         if (array_key_exists('plugin', $this->_customdata) && is_object($this->_customdata['plugin'])) {
114             $pluginerrors = $this->_customdata['plugin']->export_config_validation($data);
115             if (is_array($pluginerrors)) {
116                 $errors = $pluginerrors;
117             }
118         }
119         if (array_key_exists('caller', $this->_customdata) && is_object($this->_customdata['caller'])) {
120             $callererrors = $this->_customdata['caller']->export_config_validation($data);
121             if (is_array($callererrors)) {
122                 $errors = array_merge($errors, $callererrors);
123             }
124         }
125         return $errors;
126     }
129 /**
130  * Admin config form.
131  * This form is extendable by plugins who want the admin to be able to configure more than just the name of the instance.
132  * This is NOT done by subclassing this class, see the docs for portfolio_plugin_base for more information:
133  * {@link http://docs.moodle.org/dev/Writing_a_Portfolio_Plugin#has_admin_config}
134  *
135  * @package core_portfolio
136  * @category portfolio
137  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
138  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
139  */
140 final class portfolio_admin_form extends moodleform {
142     /** @var object to hold porfolio instance configuration */
143     protected $instance;
145     /** @var string plugin name*/
146     protected $plugin;
148     /** @var string portfolio plugin name*/
149     protected $portfolio;
151     /** @var string plugin availability*/
152     protected $action;
154     /** @var int portfolio plugin visibility*/
155     protected $visible;
157     /**
158      * prepare form
159      */
160     public function definition() {
161         global $CFG;
162         $this->plugin = $this->_customdata['plugin'];
163         $this->instance = (isset($this->_customdata['instance'])
164                 && is_subclass_of($this->_customdata['instance'], 'portfolio_plugin_base'))
165             ? $this->_customdata['instance'] : null;
166         $this->portfolio = $this->_customdata['portfolio'];
167         $this->action = $this->_customdata['action'];
168         $this->visible = $this->_customdata['visible'];
170         $mform =& $this->_form;
171         $strrequired = get_string('required');
173         $mform->addElement('hidden', 'pf', $this->portfolio);
174         $mform->setType('pf', PARAM_ALPHA);
175         $mform->addElement('hidden', 'action', $this->action);
176         $mform->setType('action', PARAM_ALPHA);
177         $mform->addElement('hidden', 'visible', $this->visible);
178         $mform->setType('visible', PARAM_INT);
179         $mform->addElement('hidden', 'plugin', $this->plugin);
180         $mform->setType('plugin', PARAM_PLUGIN);
182         if (!$this->instance) {
183             $insane = portfolio_instance_sanity_check($this->instance);
184         } else {
185             $insane = portfolio_plugin_sanity_check($this->plugin);
186         }
188         if (isset($insane) && is_array($insane)) {
189             $insane = array_shift($insane);
190         }
191         if (isset($insane) && is_string($insane)) { // something went wrong, warn...
192             $mform->addElement('warning', 'insane', null, get_string($insane, 'portfolio_' . $this->plugin));
193         }
195         $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
196         $mform->addRule('name', $strrequired, 'required', null, 'client');
198         // let the plugin add the fields they want (either statically or not)
199         if (portfolio_static_function($this->plugin, 'has_admin_config')) {
200             if (!$this->instance) {
201                 require_once($CFG->libdir . '/portfolio/plugin.php');
202                 require_once($CFG->dirroot . '/portfolio/' . $this->plugin .  '/lib.php');
203                 call_user_func(array('portfolio_plugin_' . $this->plugin, 'admin_config_form'), $mform);
204             } else {
205                 $this->instance->admin_config_form($mform);
206             }
207         }
209         // and set the data if we have some.
210         if ($this->instance) {
211             $data = array('name' => $this->instance->get('name'));
212             foreach ($this->instance->get_allowed_config() as $config) {
213                 $data[$config] = $this->instance->get_config($config);
214             }
215             $this->set_data($data);
216         } else {
217             $this->set_data(array('name' => portfolio_static_function($this->plugin, 'get_name')));
218         }
220         $this->add_action_buttons(true, get_string('save', 'portfolio'));
221     }
223     /**
224      * Validate admin config form
225      *
226      * @param stdObject $data form data
227      * @return array
228      */
229     public function validation($data) {
230         global $DB;
232         $errors = array();
233         if ($DB->count_records('portfolio_instance', array('name' => $data['name'], 'plugin' => $data['plugin'])) > 1) {
234             $errors = array('name' => get_string('err_uniquename', 'portfolio'));
235         }
237         $pluginerrors = array();
238         if ($this->instance) {
239             $pluginerrors = $this->instance->admin_config_validation($data);
240         }
241         else {
242             $pluginerrors = portfolio_static_function($this->plugin, 'admin_config_validation', $data);
243         }
244         if (is_array($pluginerrors)) {
245             $errors = array_merge($errors, $pluginerrors);
246         }
247         return $errors;
248     }
251 /**
252  * User config form.
253  * This is the form for letting the user configure an instance of a plugin.
254  * In order to extend this, you don't subclass this in the plugin..
255  * see the docs in portfolio_plugin_base for more information:
256  * {@link http://docs.moodle.org/dev/Writing_a_Portfolio_Plugin#has_user_config}
257  *
258  * @package core_portfolio
259  * @category portfolio
260  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
261  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
262  */
263 final class portfolio_user_form extends moodleform {
265     /** @var object  user porfolio instance */
266     protected $instance;
268     /** @var int hold user id */
269     protected $userid;
271     /**
272      * prepare form
273      */
274     public function definition() {
275         $this->instance = $this->_customdata['instance'];
276         $this->userid = $this->_customdata['userid'];
278         $this->_form->addElement('hidden', 'config', $this->instance->get('id'));
279         $this->_form->setType('config', PARAM_INT);
281         $this->instance->user_config_form($this->_form, $this->userid);
283         $data = array();
284         foreach ($this->instance->get_allowed_user_config() as $config) {
285             $data[$config] = $this->instance->get_user_config($config, $this->userid);
286         }
287         $this->set_data($data);
288         $this->add_action_buttons(true, get_string('save', 'portfolio'));
289     }
291     /**
292      * User user config form.
293      *
294      * @param stdClass $data form data
295      */
296     public function validation($data) {
298         $errors = $this->instance->user_config_validation($data);
300     }
304 /**
305  * Form that just contains the dropdown menu of available instances.
306  * This is not used by portfolio_add_button, but on the first step of the export,
307  * if the plugin instance has not yet been selected.
308  *
309  * @package core_portfolio
310  * @category portfolio
311  * @copyright 2008 Penny Leach <penny@catalyst.net.nz>
312  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
313  */
314 class portfolio_instance_select extends moodleform {
316     /** @var portfolio_caller_base plugin instance */
317     private $caller;
319     /**
320      * The required basic elements to the form.
321      */
322     function definition() {
323         $this->caller = $this->_customdata['caller'];
324         $options = $this->_customdata['options'];
325         $mform =& $this->_form;
326         $mform->addElement('select', 'instance', get_string('selectplugin', 'portfolio'), $options);
327         $mform->addElement('hidden', 'id', $this->_customdata['id']);
328         $this->add_action_buttons(true, get_string('next'));
329     }