Merge branch 'MDL-47576-master' of git://github.com/jethac/moodle
[moodle.git] / mod / lti / mod_form.php
CommitLineData
996b0fd9 1<?php
61eb12d4
CS
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//
996b0fd9
CS
17// This file is part of BasicLTI4Moodle
18//
19// BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
20// consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
21// based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
22// specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
23// are already supporting or going to support BasicLTI. This project Implements the consumer
24// for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
25// BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
26// at the GESSI research group at UPC.
27// SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
28// by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
29// Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
30//
31// BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
32// of the Universitat Politecnica de Catalunya http://www.upc.edu
33// Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu
996b0fd9
CS
34
35/**
61eb12d4 36 * This file defines the main lti configuration form
996b0fd9 37 *
2b17ec3d 38 * @package mod_lti
61eb12d4 39 * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
996b0fd9 40 * marc.alier@upc.edu
61eb12d4
CS
41 * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
42 * @author Marc Alier
43 * @author Jordi Piguillem
44 * @author Nikolas Galanis
8f45215d 45 * @author Chris Scribner
61eb12d4 46 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
996b0fd9
CS
47 */
48
49defined('MOODLE_INTERNAL') || die;
50
51require_once($CFG->dirroot.'/course/moodleform_mod.php');
52require_once($CFG->dirroot.'/mod/lti/locallib.php');
53
b1e9a121 54class mod_lti_mod_form extends moodleform_mod {
996b0fd9 55
ea04a9f9 56 public function definition() {
996b0fd9
CS
57 global $DB, $PAGE, $OUTPUT, $USER, $COURSE;
58
976b5bca
CS
59 if ($type = optional_param('type', false, PARAM_ALPHA)) {
60 component_callback("ltisource_$type", 'add_instance_hook');
61 }
8cf7670e 62
996b0fd9 63 $this->typeid = 0;
e27cb316 64
996b0fd9 65 $mform =& $this->_form;
ea04a9f9
EL
66 //-------------------------------------------------------------------------------
67 // Adding the "general" fieldset, where all the common settings are shown
996b0fd9 68 $mform->addElement('header', 'general', get_string('general', 'form'));
ea04a9f9 69 // Adding the standard "name" field
996b0fd9
CS
70 $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size'=>'64'));
71 $mform->setType('name', PARAM_TEXT);
72 $mform->addRule('name', null, 'required', null, 'client');
a74cd331 73 $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
ea04a9f9 74 // Adding the optional "intro" and "introformat" pair of fields
996b0fd9
CS
75 $this->add_intro_editor(false, get_string('basicltiintro', 'lti'));
76 $mform->setAdvanced('introeditor');
194f2c60
EL
77
78 // Display the label to the right of the checkbox so it looks better & matches rest of the form
b07878ec
CS
79 $coursedesc = $mform->getElement('showdescription');
80 if(!empty($coursedesc)){
81 $coursedesc->setText(' ' . $coursedesc->getLabel());
82 $coursedesc->setLabel('&nbsp');
83 }
194f2c60 84
b07878ec 85 $mform->setAdvanced('showdescription');
996b0fd9 86
b07878ec
CS
87 $mform->addElement('checkbox', 'showtitlelaunch', '&nbsp;', ' ' . get_string('display_name', 'lti'));
88 $mform->setAdvanced('showtitlelaunch');
80fd0072 89 $mform->setDefault('showtitlelaunch', true);
b07878ec 90 $mform->addHelpButton('showtitlelaunch', 'display_name', 'lti');
e27cb316 91
b07878ec
CS
92 $mform->addElement('checkbox', 'showdescriptionlaunch', '&nbsp;', ' ' . get_string('display_description', 'lti'));
93 $mform->setAdvanced('showdescriptionlaunch');
94 $mform->addHelpButton('showdescriptionlaunch', 'display_description', 'lti');
e27cb316 95
ea04a9f9 96 // Tool settings
996b0fd9 97 $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'), array());
b26dc53c 98 $mform->addHelpButton('typeid', 'external_tool_type', 'lti');
e27cb316 99
ea04a9f9
EL
100 foreach (lti_get_types_for_add_instance() as $id => $type) {
101 if ($type->course == $COURSE->id) {
16e8f130 102 $attributes = array( 'editable' => 1, 'courseTool' => 1, 'domain' => $type->tooldomain );
ea04a9f9 103 } else if ($id != 0) {
16e8f130 104 $attributes = array( 'globalTool' => 1, 'domain' => $type->tooldomain);
996b0fd9
CS
105 } else {
106 $attributes = array();
107 }
e27cb316 108
996b0fd9
CS
109 $tooltypes->addOption($type->name, $id, $attributes);
110 }
e27cb316 111
996b0fd9
CS
112 $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size'=>'64'));
113 $mform->setType('toolurl', PARAM_TEXT);
b26dc53c 114 $mform->addHelpButton('toolurl', 'launch_url', 'lti');
e27cb316 115
d8d04121
CS
116 $mform->addElement('text', 'securetoolurl', get_string('secure_launch_url', 'lti'), array('size'=>'64'));
117 $mform->setType('securetoolurl', PARAM_TEXT);
118 $mform->setAdvanced('securetoolurl');
119 $mform->addHelpButton('securetoolurl', 'secure_launch_url', 'lti');
e27cb316 120
ea5d0515
AF
121 $mform->addElement('hidden', 'urlmatchedtypeid', '', array( 'id' => 'id_urlmatchedtypeid' ));
122 $mform->setType('urlmatchedtypeid', PARAM_INT);
123
996b0fd9
CS
124 $launchoptions=array();
125 $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
126 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
127 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
8fa50fdd 128 $launchoptions[LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW] = get_string('existing_window', 'lti');
996b0fd9
CS
129 $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
130
131 $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
132 $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
b26dc53c 133 $mform->addHelpButton('launchcontainer', 'launchinpopup', 'lti');
e27cb316 134
996b0fd9
CS
135 $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
136 $mform->setType('resourcekey', PARAM_TEXT);
137 $mform->setAdvanced('resourcekey');
b26dc53c 138 $mform->addHelpButton('resourcekey', 'resourcekey', 'lti');
e27cb316 139
996b0fd9
CS
140 $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
141 $mform->setType('password', PARAM_TEXT);
142 $mform->setAdvanced('password');
b26dc53c 143 $mform->addHelpButton('password', 'password', 'lti');
e27cb316 144
996b0fd9
CS
145 $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows'=>4, 'cols'=>60));
146 $mform->setType('instructorcustomparameters', PARAM_TEXT);
147 $mform->setAdvanced('instructorcustomparameters');
b26dc53c 148 $mform->addHelpButton('instructorcustomparameters', 'custom', 'lti');
e27cb316 149
6d462df8
CS
150 $mform->addElement('text', 'icon', get_string('icon_url', 'lti'), array('size'=>'64'));
151 $mform->setType('icon', PARAM_TEXT);
152 $mform->setAdvanced('icon');
d8d04121 153 $mform->addHelpButton('icon', 'icon_url', 'lti');
e27cb316 154
d8d04121
CS
155 $mform->addElement('text', 'secureicon', get_string('secure_icon_url', 'lti'), array('size'=>'64'));
156 $mform->setType('secureicon', PARAM_TEXT);
157 $mform->setAdvanced('secureicon');
158 $mform->addHelpButton('secureicon', 'secure_icon_url', 'lti');
e27cb316 159
ea04a9f9 160 //-------------------------------------------------------------------------------
996b0fd9
CS
161 // Add privacy preferences fieldset where users choose whether to send their data
162 $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
163
aa74cccb 164 $mform->addElement('advcheckbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));
996b0fd9 165 $mform->setDefault('instructorchoicesendname', '1');
b26dc53c 166 $mform->addHelpButton('instructorchoicesendname', 'share_name', 'lti');
e27cb316 167
aa74cccb 168 $mform->addElement('advcheckbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));
996b0fd9 169 $mform->setDefault('instructorchoicesendemailaddr', '1');
b26dc53c 170 $mform->addHelpButton('instructorchoicesendemailaddr', 'share_email', 'lti');
e27cb316 171
aa74cccb 172 $mform->addElement('advcheckbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));
996b0fd9 173 $mform->setDefault('instructorchoiceacceptgrades', '1');
b26dc53c 174 $mform->addHelpButton('instructorchoiceacceptgrades', 'accept_grades', 'lti');
e27cb316 175
59fc5c54
CS
176 //$mform->addElement('checkbox', 'instructorchoiceallowroster', '&nbsp;', ' ' . get_string('share_roster', 'lti'));
177 //$mform->setDefault('instructorchoiceallowroster', '1');
178 //$mform->addHelpButton('instructorchoiceallowroster', 'share_roster', 'lti');
e27cb316 179
ea04a9f9 180 //-------------------------------------------------------------------------------
996b0fd9 181
ea04a9f9
EL
182 /**
183 $debugoptions=array();
996b0fd9
CS
184 $debugoptions[0] = get_string('debuglaunchoff', 'lti');
185 $debugoptions[1] = get_string('debuglaunchon', 'lti');
186
187 $mform->addElement('select', 'debuglaunch', get_string('debuglaunch', 'lti'), $debugoptions);
188
189 if (isset($this->typeconfig['debuglaunch'])) {
190 if ($this->typeconfig['debuglaunch'] == 0) {
191 $mform->setDefault('debuglaunch', '0');
192 } else if ($this->typeconfig['debuglaunch'] == 1) {
193 $mform->setDefault('debuglaunch', '1');
194 }
195 }
ea04a9f9 196 */
996b0fd9 197
8fa50fdd
MN
198 // Add standard course module grading elements.
199 $this->standard_grading_coursemodule_elements();
200
ea04a9f9 201 //-------------------------------------------------------------------------------
996b0fd9
CS
202 // add standard elements, common to all modules
203 $this->standard_coursemodule_elements();
996b0fd9 204 $mform->setAdvanced('cmidnumber');
ea04a9f9 205 //-------------------------------------------------------------------------------
996b0fd9
CS
206 // add standard buttons, common to all modules
207 $this->add_action_buttons();
208
7302fbf6
TH
209 $editurl = new moodle_url('/mod/lti/instructor_edit_tool_type.php',
210 array('sesskey' => sesskey(), 'course' => $COURSE->id));
6831c7cd 211 $ajaxurl = new moodle_url('/mod/lti/ajax.php');
e27cb316 212
996b0fd9
CS
213 $jsinfo = (object)array(
214 'edit_icon_url' => (string)$OUTPUT->pix_url('t/edit'),
215 'add_icon_url' => (string)$OUTPUT->pix_url('t/add'),
216 'delete_icon_url' => (string)$OUTPUT->pix_url('t/delete'),
c3847443 217 'green_check_icon_url' => (string)$OUTPUT->pix_url('i/valid'),
16e8f130 218 'warning_icon_url' => (string)$OUTPUT->pix_url('warning', 'lti'),
6831c7cd
CS
219 'instructor_tool_type_edit_url' => $editurl->out(false),
220 'ajax_url' => $ajaxurl->out(true),
221 'courseId' => $COURSE->id
996b0fd9 222 );
e27cb316 223
996b0fd9
CS
224 $module = array(
225 'name' => 'mod_lti_edit',
226 'fullpath' => '/mod/lti/mod_form.js',
6831c7cd
CS
227 'requires' => array('base', 'io', 'querystring-stringify-simple', 'node', 'event', 'json-parse'),
228 'strings' => array(
229 array('addtype', 'lti'),
230 array('edittype', 'lti'),
231 array('deletetype', 'lti'),
232 array('delete_confirmation', 'lti'),
233 array('cannot_edit', 'lti'),
234 array('cannot_delete', 'lti'),
235 array('global_tool_types', 'lti'),
16e8f130
CS
236 array('course_tool_types', 'lti'),
237 array('using_tool_configuration', 'lti'),
238 array('domain_mismatch', 'lti'),
239 array('custom_config', 'lti'),
4c598b13
CS
240 array('tool_config_not_found', 'lti'),
241 array('forced_help', 'lti')
6831c7cd 242 ),
996b0fd9 243 );
e27cb316 244
996b0fd9
CS
245 $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
246 }
247
248 /**
249 * Make fields editable or non-editable depending on the administrator choices
250 * @see moodleform_mod::definition_after_data()
251 */
ea04a9f9 252 public function definition_after_data() {
996b0fd9 253 parent::definition_after_data();
e27cb316 254
d8d04121 255 //$mform =& $this->_form;
996b0fd9
CS
256 }
257
258 /**
259 * Function overwritten to change default values using
260 * global configuration
261 *
262 * @param array $default_values passed by reference
263 */
b1e9a121 264 public function data_preprocessing(&$default_values) {
996b0fd9
CS
265
266 }
267}
268