ab963297a777582e87a5350fbbcb7586ad09f56c
[moodle.git] / lib / portfolio / forms.php
1 <?php
2 /**
3  * Moodle - Modular Object-Oriented Dynamic Learning Environment
4  *          http://moodle.org
5  * Copyright (C) 1999 onwards Martin Dougiamas  http://dougiamas.com
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19  *
20  * @package    moodle
21  * @subpackage portfolio
22  * @author     Penny Leach <penny@catalyst.net.nz>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24  * @copyright  (C) 1999 onwards Martin Dougiamas  http://dougiamas.com
25  *
26  * This file contains all the form definitions used by the portfolio code.
27  */
29 // make sure we include moodleform first!
30 require_once ($CFG->libdir.'/formslib.php');
32 /**
33 * During-export config form.
34 *
35 * This is the form that is actually used while exporting.
36 * Plugins and callers don't get to define their own class
37 * as we have to handle form elements from both places
38 * See the docs here for more information:
39 * http://docs.moodle.org/en/Development:Writing_a_Portfolio_Plugin#has_export_config
40 * http://docs.moodle.org/en/Development:Adding_a_Portfolio_Button_to_a_page#has_export_config
41 */
42 final class portfolio_export_form extends moodleform {
44     public function definition() {
46         $mform =& $this->_form;
47         $mform->addElement('hidden', 'stage', PORTFOLIO_STAGE_CONFIG);
48         $mform->addElement('hidden', 'instance', $this->_customdata['instance']->get('id'));
50         if (array_key_exists('formats', $this->_customdata) && is_array($this->_customdata['formats'])) {
51             if (count($this->_customdata['formats']) > 1) {
52                 $options = array();
53                 foreach ($this->_customdata['formats'] as $key) {
54                     $options[$key] = get_string('format_' . $key, 'portfolio');
55                 }
56                 $mform->addElement('select', 'format', get_string('availableformats', 'portfolio'), $options);
57             } else {
58                 $f = array_shift($this->_customdata['formats']);
59                 $mform->addElement('hidden', 'format', $f);
60             }
61         }
63         // only display the option to wait or not if it's applicable
64         if (array_key_exists('expectedtime', $this->_customdata)
65             && $this->_customdata['expectedtime'] != PORTFOLIO_TIME_LOW
66             && $this->_customdata['expectedtime'] != PORTFOLIO_TIME_FORCEQUEUE) {
67             $radioarray = array();
68             $radioarray[] = &MoodleQuickForm::createElement('radio', 'wait', '', get_string('wait', 'portfolio'), 1);
69             $radioarray[] = &MoodleQuickForm::createElement('radio', 'wait', '', get_string('dontwait', 'portfolio'),  0);
70             $mform->addGroup($radioarray, 'radioar', get_string('wanttowait_' . $this->_customdata['expectedtime'], 'portfolio') , array(' '), false);
71             $mform->setDefault('wait', 0);
72         } else {
73             if ($this->_customdata['expectedtime'] == PORTFOLIO_TIME_LOW) {
74                 $mform->addElement('hidden', 'wait', 1);
75             } else {
76                 $mform->addElement('hidden', 'wait', 0);
77             }
78         }
80         if (array_key_exists('plugin', $this->_customdata) && is_object($this->_customdata['plugin'])) {
81             $this->_customdata['plugin']->export_config_form($mform, $this->_customdata['userid']);
82         }
84         if (array_key_exists('caller', $this->_customdata) && is_object($this->_customdata['caller'])) {
85             $this->_customdata['caller']->export_config_form($mform, $this->_customdata['instance'], $this->_customdata['userid']);
86         }
88         $this->add_action_buttons(true, get_string('next'));
89     }
91     public function validation($data) {
93         $errors = array();
95         if (array_key_exists('plugin', $this->_customdata) && is_object($this->_customdata['plugin'])) {
96             $pluginerrors = $this->_customdata['plugin']->export_config_validation($data);
97             if (is_array($pluginerrors)) {
98                 $errors = $pluginerrors;
99             }
100         }
101         if (array_key_exists('caller', $this->_customdata) && is_object($this->_customdata['caller'])) {
102             $callererrors = $this->_customdata['caller']->export_config_validation($data);
103             if (is_array($callererrors)) {
104                 $errors = array_merge($errors, $callererrors);
105             }
106         }
107         return $errors;
108     }
111 /**
112 * Admin config form
114 * This form is extendable by plugins who want the admin to be able to configure more than just the name of the instance.
115 * This is NOT done by subclassing this class, see the docs for portfolio_plugin_base for more information:
116 * http://docs.moodle.org/en/Development:Writing_a_Portfolio_Plugin#has_admin_config
117 */
118 final class portfolio_admin_form extends moodleform {
120     protected $instance;
121     protected $plugin;
123     public function definition() {
124         global $CFG;
125         $this->plugin = $this->_customdata['plugin'];
126         $this->instance = (isset($this->_customdata['instance'])
127                 && is_subclass_of($this->_customdata['instance'], 'portfolio_plugin_base'))
128             ? $this->_customdata['instance'] : null;
130         $mform =& $this->_form;
131         $strrequired = get_string('required');
133         $mform->addElement('hidden', 'edit',  ($this->instance) ? $this->instance->get('id') : 0);
134         $mform->addElement('hidden', 'new',   $this->plugin);
135         $mform->addElement('hidden', 'plugin', $this->plugin);
137         if (!$this->instance) {
138             $insane = portfolio_instance_sanity_check($this->instance);
139         } else {
140             $insane = portfolio_plugin_sanity_check($this->plugin);
141         }
143         if (isset($insane) && is_array($insane)) {
144             $insane = array_shift($insane);
145         }
146         if (isset($insane) && is_string($insane)) { // something went wrong, warn...
147             $mform->addElement('warning', 'insane', null, get_string($insane, 'portfolio_' . $this->plugin));
148         }
150         $mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
151         $mform->addRule('name', $strrequired, 'required', null, 'client');
153         // let the plugin add the fields they want (either statically or not)
154         if (portfolio_static_function($this->plugin, 'has_admin_config')) {
155             if (!$this->instance) {
156                 portfolio_static_function($this->plugin, 'admin_config_form', $mform);
157             } else {
158                 $this->instance->admin_config_form($mform);
159             }
160         }
162         // and set the data if we have some.
163         if ($this->instance) {
164             $data = array('name' => $this->instance->get('name'));
165             foreach ($this->instance->get_allowed_config() as $config) {
166                 $data[$config] = $this->instance->get_config($config);
167             }
168             $this->set_data($data);
169         } else {
170             $this->set_data(array('name' => portfolio_static_function($this->plugin, 'get_name')));
171         }
173         $this->add_action_buttons(true, get_string('save', 'portfolio'));
174     }
176     public function validation($data) {
177         global $DB;
179         $errors = array();
180         if ($DB->count_records('portfolio_instance', array('name' => $data['name'], 'plugin' => $data['plugin'])) > 1) {
181             $errors = array('name' => get_string('err_uniquename', 'portfolio'));
182         }
184         $pluginerrors = array();
185         if ($this->instance) {
186             $pluginerrors = $this->instance->admin_config_validation($data);
187         }
188         else {
189             $pluginerrors = portfolio_static_function($this->plugin, 'admin_config_validation', $data);
190         }
191         if (is_array($pluginerrors)) {
192             $errors = array_merge($errors, $pluginerrors);
193         }
194         return $errors;
195     }
198 /**
199 * User config form.
201 * This is the form for letting the user configure an instance of a plugin.
202 * In order to extend this, you don't subclass this in the plugin..
203 * see the docs in portfolio_plugin_base for more information:
204 * http://docs.moodle.org/en/Development:Writing_a_Portfolio_Plugin#has_user_config
205 */
206 final class portfolio_user_form extends moodleform {
208     protected $instance;
209     protected $userid;
211     public function definition() {
212         $this->instance = $this->_customdata['instance'];
213         $this->userid = $this->_customdata['userid'];
215         $this->_form->addElement('hidden', 'config', $this->instance->get('id'));
217         $this->instance->user_config_form($this->_form, $this->userid);
219         $data = array();
220         foreach ($this->instance->get_allowed_user_config() as $config) {
221             $data[$config] = $this->instance->get_user_config($config, $this->userid);
222         }
223         $this->set_data($data);
224         $this->add_action_buttons(true, get_string('save', 'portfolio'));
225     }
227     public function validation($data) {
229         $errors = $this->instance->user_config_validation($data);
231     }
235 /**
236 * Form that just contains the dropdown menu of available instances
238 * This is not used by portfolio_add_button, but on the first step of the export
239 * if the plugin instance has not yet been selected.
240 */
241 class portfolio_instance_select extends moodleform {
243     private $caller;
245     function definition() {
246         $this->caller = $this->_customdata['caller'];
247         $options = portfolio_instance_select(
248             portfolio_instances(),
249             $this->caller->supported_formats($this->caller),
250             get_class($this->caller),
251             'instance',
252             true,
253             true
254         );
255         if (empty($options)) {
256             debugging('noavailableplugins', 'portfolio');
257             return false;
258         }
259         $mform =& $this->_form;
260         $mform->addElement('select', 'instance', get_string('selectplugin', 'portfolio'), $options);
261         $this->add_action_buttons(true, get_string('next'));
262     }
265 ?>