Moodle release 2.2beta
[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 *
61eb12d4
CS
38 * @package mod
39 * @subpackage lti
40 * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
996b0fd9 41 * marc.alier@upc.edu
61eb12d4
CS
42 * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
43 * @author Marc Alier
44 * @author Jordi Piguillem
45 * @author Nikolas Galanis
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
59 $this->typeid = 0;
e27cb316 60
996b0fd9 61 $mform =& $this->_form;
ea04a9f9
EL
62 //-------------------------------------------------------------------------------
63 // Adding the "general" fieldset, where all the common settings are shown
996b0fd9 64 $mform->addElement('header', 'general', get_string('general', 'form'));
ea04a9f9 65 // Adding the standard "name" field
996b0fd9
CS
66 $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size'=>'64'));
67 $mform->setType('name', PARAM_TEXT);
68 $mform->addRule('name', null, 'required', null, 'client');
ea04a9f9 69 // Adding the optional "intro" and "introformat" pair of fields
996b0fd9
CS
70 $this->add_intro_editor(false, get_string('basicltiintro', 'lti'));
71 $mform->setAdvanced('introeditor');
72
73 $mform->addElement('checkbox', 'showtitle', '&nbsp;', ' ' . get_string('display_name', 'lti'));
74 $mform->setAdvanced('showtitle');
b26dc53c 75 $mform->addHelpButton('showtitle', 'display_name', 'lti');
e27cb316 76
996b0fd9
CS
77 $mform->addElement('checkbox', 'showdescription', '&nbsp;', ' ' . get_string('display_description', 'lti'));
78 $mform->setAdvanced('showdescription');
b26dc53c 79 $mform->addHelpButton('showdescription', 'display_description', 'lti');
e27cb316 80
ea04a9f9 81 // Tool settings
996b0fd9 82 $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'), array());
b26dc53c 83 $mform->addHelpButton('typeid', 'external_tool_type', 'lti');
e27cb316 84
ea04a9f9
EL
85 foreach (lti_get_types_for_add_instance() as $id => $type) {
86 if ($type->course == $COURSE->id) {
16e8f130 87 $attributes = array( 'editable' => 1, 'courseTool' => 1, 'domain' => $type->tooldomain );
ea04a9f9 88 } else if ($id != 0) {
16e8f130 89 $attributes = array( 'globalTool' => 1, 'domain' => $type->tooldomain);
996b0fd9
CS
90 } else {
91 $attributes = array();
92 }
e27cb316 93
996b0fd9
CS
94 $tooltypes->addOption($type->name, $id, $attributes);
95 }
e27cb316 96
996b0fd9
CS
97 $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size'=>'64'));
98 $mform->setType('toolurl', PARAM_TEXT);
b26dc53c 99 $mform->addHelpButton('toolurl', 'launch_url', 'lti');
e27cb316 100
d8d04121
CS
101 $mform->addElement('text', 'securetoolurl', get_string('secure_launch_url', 'lti'), array('size'=>'64'));
102 $mform->setType('securetoolurl', PARAM_TEXT);
103 $mform->setAdvanced('securetoolurl');
104 $mform->addHelpButton('securetoolurl', 'secure_launch_url', 'lti');
e27cb316 105
996b0fd9
CS
106 $launchoptions=array();
107 $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
108 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
109 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
110 $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
111
112 $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
113 $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
b26dc53c 114 $mform->addHelpButton('launchcontainer', 'launchinpopup', 'lti');
e27cb316 115
996b0fd9
CS
116 $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
117 $mform->setType('resourcekey', PARAM_TEXT);
118 $mform->setAdvanced('resourcekey');
b26dc53c 119 $mform->addHelpButton('resourcekey', 'resourcekey', 'lti');
e27cb316 120
996b0fd9
CS
121 $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
122 $mform->setType('password', PARAM_TEXT);
123 $mform->setAdvanced('password');
b26dc53c 124 $mform->addHelpButton('password', 'password', 'lti');
e27cb316 125
996b0fd9
CS
126 $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows'=>4, 'cols'=>60));
127 $mform->setType('instructorcustomparameters', PARAM_TEXT);
128 $mform->setAdvanced('instructorcustomparameters');
b26dc53c 129 $mform->addHelpButton('instructorcustomparameters', 'custom', 'lti');
e27cb316 130
6d462df8
CS
131 $mform->addElement('text', 'icon', get_string('icon_url', 'lti'), array('size'=>'64'));
132 $mform->setType('icon', PARAM_TEXT);
133 $mform->setAdvanced('icon');
d8d04121 134 $mform->addHelpButton('icon', 'icon_url', 'lti');
e27cb316 135
d8d04121
CS
136 $mform->addElement('text', 'secureicon', get_string('secure_icon_url', 'lti'), array('size'=>'64'));
137 $mform->setType('secureicon', PARAM_TEXT);
138 $mform->setAdvanced('secureicon');
139 $mform->addHelpButton('secureicon', 'secure_icon_url', 'lti');
e27cb316 140
ea04a9f9 141 //-------------------------------------------------------------------------------
996b0fd9
CS
142 // Add privacy preferences fieldset where users choose whether to send their data
143 $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
144
145 $mform->addElement('checkbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));
146 $mform->setDefault('instructorchoicesendname', '1');
b26dc53c 147 $mform->addHelpButton('instructorchoicesendname', 'share_name', 'lti');
e27cb316 148
996b0fd9
CS
149 $mform->addElement('checkbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));
150 $mform->setDefault('instructorchoicesendemailaddr', '1');
b26dc53c 151 $mform->addHelpButton('instructorchoicesendemailaddr', 'share_email', 'lti');
e27cb316 152
996b0fd9
CS
153 $mform->addElement('checkbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));
154 $mform->setDefault('instructorchoiceacceptgrades', '1');
b26dc53c 155 $mform->addHelpButton('instructorchoiceacceptgrades', 'accept_grades', 'lti');
e27cb316 156
996b0fd9
CS
157 $mform->addElement('checkbox', 'instructorchoiceallowroster', '&nbsp;', ' ' . get_string('share_roster', 'lti'));
158 $mform->setDefault('instructorchoiceallowroster', '1');
b26dc53c 159 $mform->addHelpButton('instructorchoiceallowroster', 'share_roster', 'lti');
e27cb316 160
ea04a9f9 161 //-------------------------------------------------------------------------------
996b0fd9 162
ea04a9f9
EL
163 /**
164 $debugoptions=array();
996b0fd9
CS
165 $debugoptions[0] = get_string('debuglaunchoff', 'lti');
166 $debugoptions[1] = get_string('debuglaunchon', 'lti');
167
168 $mform->addElement('select', 'debuglaunch', get_string('debuglaunch', 'lti'), $debugoptions);
169
170 if (isset($this->typeconfig['debuglaunch'])) {
171 if ($this->typeconfig['debuglaunch'] == 0) {
172 $mform->setDefault('debuglaunch', '0');
173 } else if ($this->typeconfig['debuglaunch'] == 1) {
174 $mform->setDefault('debuglaunch', '1');
175 }
176 }
ea04a9f9 177 */
996b0fd9 178
ea04a9f9 179 //-------------------------------------------------------------------------------
996b0fd9
CS
180 // add standard elements, common to all modules
181 $this->standard_coursemodule_elements();
996b0fd9 182 $mform->setAdvanced('cmidnumber');
ea04a9f9 183 //-------------------------------------------------------------------------------
996b0fd9
CS
184 // add standard buttons, common to all modules
185 $this->add_action_buttons();
186
6831c7cd
CS
187 $editurl = new moodle_url("/mod/lti/instructor_edit_tool_type.php?sesskey={$USER->sesskey}&course={$COURSE->id}");
188 $ajaxurl = new moodle_url('/mod/lti/ajax.php');
e27cb316 189
996b0fd9
CS
190 $jsinfo = (object)array(
191 'edit_icon_url' => (string)$OUTPUT->pix_url('t/edit'),
192 'add_icon_url' => (string)$OUTPUT->pix_url('t/add'),
193 'delete_icon_url' => (string)$OUTPUT->pix_url('t/delete'),
6831c7cd 194 'green_check_icon_url' => (string)$OUTPUT->pix_url('i/tick_green_small'),
16e8f130 195 'warning_icon_url' => (string)$OUTPUT->pix_url('warning', 'lti'),
6831c7cd
CS
196 'instructor_tool_type_edit_url' => $editurl->out(false),
197 'ajax_url' => $ajaxurl->out(true),
198 'courseId' => $COURSE->id
996b0fd9 199 );
e27cb316 200
996b0fd9
CS
201 $module = array(
202 'name' => 'mod_lti_edit',
203 'fullpath' => '/mod/lti/mod_form.js',
6831c7cd
CS
204 'requires' => array('base', 'io', 'querystring-stringify-simple', 'node', 'event', 'json-parse'),
205 'strings' => array(
206 array('addtype', 'lti'),
207 array('edittype', 'lti'),
208 array('deletetype', 'lti'),
209 array('delete_confirmation', 'lti'),
210 array('cannot_edit', 'lti'),
211 array('cannot_delete', 'lti'),
212 array('global_tool_types', 'lti'),
16e8f130
CS
213 array('course_tool_types', 'lti'),
214 array('using_tool_configuration', 'lti'),
215 array('domain_mismatch', 'lti'),
216 array('custom_config', 'lti'),
217 array('tool_config_not_found', 'lti')
6831c7cd 218 ),
996b0fd9 219 );
e27cb316 220
996b0fd9
CS
221 $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
222 }
223
224 /**
225 * Make fields editable or non-editable depending on the administrator choices
226 * @see moodleform_mod::definition_after_data()
227 */
ea04a9f9 228 public function definition_after_data() {
996b0fd9 229 parent::definition_after_data();
e27cb316 230
d8d04121 231 //$mform =& $this->_form;
996b0fd9
CS
232 }
233
234 /**
235 * Function overwritten to change default values using
236 * global configuration
237 *
238 * @param array $default_values passed by reference
239 */
b1e9a121 240 public function data_preprocessing(&$default_values) {
996b0fd9
CS
241
242 }
243}
244