Merge branch 'MDL-30290' of git://github.com/scriby/moodle
[moodle.git] / mod / lti / mod_form.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/>.
16 //
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
35 /**
36  * This file defines the main lti configuration form
37  *
38  * @package    mod
39  * @subpackage lti
40  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
41  *  marc.alier@upc.edu
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
47  */
49 defined('MOODLE_INTERNAL') || die;
51 require_once($CFG->dirroot.'/course/moodleform_mod.php');
52 require_once($CFG->dirroot.'/mod/lti/locallib.php');
54 class mod_lti_mod_form extends moodleform_mod {
56     public function definition() {
57         global $DB, $PAGE, $OUTPUT, $USER, $COURSE;
59         $this->typeid = 0;
61         $mform =& $this->_form;
62         //-------------------------------------------------------------------------------
63         // Adding the "general" fieldset, where all the common settings are shown
64         $mform->addElement('header', 'general', get_string('general', 'form'));
65         // Adding the standard "name" field
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');
69         // Adding the optional "intro" and "introformat" pair of fields
70         $this->add_intro_editor(false, get_string('basicltiintro', 'lti'));
71         $mform->setAdvanced('introeditor');
72         
73         //Display the label to the right of the checkbox so it looks better & matches rest of the form
74         $coursedesc = $mform->getElement('showdescription');
75         if(!empty($coursedesc)){
76             $coursedesc->setText(' ' . $coursedesc->getLabel());
77             $coursedesc->setLabel('&nbsp');
78         }
79         
80         $mform->setAdvanced('showdescription');
82         $mform->addElement('checkbox', 'showtitlelaunch', '&nbsp;', ' ' . get_string('display_name', 'lti'));
83         $mform->setAdvanced('showtitlelaunch');
84         $mform->addHelpButton('showtitlelaunch', 'display_name', 'lti');
86         $mform->addElement('checkbox', 'showdescriptionlaunch', '&nbsp;', ' ' . get_string('display_description', 'lti'));
87         $mform->setAdvanced('showdescriptionlaunch');
88         $mform->addHelpButton('showdescriptionlaunch', 'display_description', 'lti');
90         // Tool settings
91         $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'), array());
92         $mform->addHelpButton('typeid', 'external_tool_type', 'lti');
94         foreach (lti_get_types_for_add_instance() as $id => $type) {
95             if ($type->course == $COURSE->id) {
96                 $attributes = array( 'editable' => 1, 'courseTool' => 1, 'domain' => $type->tooldomain );
97             } else if ($id != 0) {
98                 $attributes = array( 'globalTool' => 1, 'domain' => $type->tooldomain);
99             } else {
100                 $attributes = array();
101             }
103             $tooltypes->addOption($type->name, $id, $attributes);
104         }
106         $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size'=>'64'));
107         $mform->setType('toolurl', PARAM_TEXT);
108         $mform->addHelpButton('toolurl', 'launch_url', 'lti');
110         $mform->addElement('text', 'securetoolurl', get_string('secure_launch_url', 'lti'), array('size'=>'64'));
111         $mform->setType('securetoolurl', PARAM_TEXT);
112         $mform->setAdvanced('securetoolurl');
113         $mform->addHelpButton('securetoolurl', 'secure_launch_url', 'lti');
115         $launchoptions=array();
116         $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
117         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
118         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
119         $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
121         $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
122         $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
123         $mform->addHelpButton('launchcontainer', 'launchinpopup', 'lti');
125         $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
126         $mform->setType('resourcekey', PARAM_TEXT);
127         $mform->setAdvanced('resourcekey');
128         $mform->addHelpButton('resourcekey', 'resourcekey', 'lti');
130         $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
131         $mform->setType('password', PARAM_TEXT);
132         $mform->setAdvanced('password');
133         $mform->addHelpButton('password', 'password', 'lti');
135         $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows'=>4, 'cols'=>60));
136         $mform->setType('instructorcustomparameters', PARAM_TEXT);
137         $mform->setAdvanced('instructorcustomparameters');
138         $mform->addHelpButton('instructorcustomparameters', 'custom', 'lti');
140         $mform->addElement('text', 'icon', get_string('icon_url', 'lti'), array('size'=>'64'));
141         $mform->setType('icon', PARAM_TEXT);
142         $mform->setAdvanced('icon');
143         $mform->addHelpButton('icon', 'icon_url', 'lti');
145         $mform->addElement('text', 'secureicon', get_string('secure_icon_url', 'lti'), array('size'=>'64'));
146         $mform->setType('secureicon', PARAM_TEXT);
147         $mform->setAdvanced('secureicon');
148         $mform->addHelpButton('secureicon', 'secure_icon_url', 'lti');
150         //-------------------------------------------------------------------------------
151         // Add privacy preferences fieldset where users choose whether to send their data
152         $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
154         $mform->addElement('checkbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));
155         $mform->setDefault('instructorchoicesendname', '1');
156         $mform->addHelpButton('instructorchoicesendname', 'share_name', 'lti');
158         $mform->addElement('checkbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));
159         $mform->setDefault('instructorchoicesendemailaddr', '1');
160         $mform->addHelpButton('instructorchoicesendemailaddr', 'share_email', 'lti');
162         $mform->addElement('checkbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));
163         $mform->setDefault('instructorchoiceacceptgrades', '1');
164         $mform->addHelpButton('instructorchoiceacceptgrades', 'accept_grades', 'lti');
166         $mform->addElement('checkbox', 'instructorchoiceallowroster', '&nbsp;', ' ' . get_string('share_roster', 'lti'));
167         $mform->setDefault('instructorchoiceallowroster', '1');
168         $mform->addHelpButton('instructorchoiceallowroster', 'share_roster', 'lti');
170         //-------------------------------------------------------------------------------
172         /**
173         $debugoptions=array();
174         $debugoptions[0] = get_string('debuglaunchoff', 'lti');
175         $debugoptions[1] = get_string('debuglaunchon', 'lti');
177         $mform->addElement('select', 'debuglaunch', get_string('debuglaunch', 'lti'), $debugoptions);
179         if (isset($this->typeconfig['debuglaunch'])) {
180             if ($this->typeconfig['debuglaunch'] == 0) {
181                 $mform->setDefault('debuglaunch', '0');
182             } else if ($this->typeconfig['debuglaunch'] == 1) {
183                 $mform->setDefault('debuglaunch', '1');
184             }
185         }
186         */
188         //-------------------------------------------------------------------------------
189         // add standard elements, common to all modules
190         $this->standard_coursemodule_elements();
191         $mform->setAdvanced('cmidnumber');
192         //-------------------------------------------------------------------------------
193         // add standard buttons, common to all modules
194         $this->add_action_buttons();
196         $editurl = new moodle_url("/mod/lti/instructor_edit_tool_type.php?sesskey={$USER->sesskey}&course={$COURSE->id}");
197         $ajaxurl = new moodle_url('/mod/lti/ajax.php');
199         $jsinfo = (object)array(
200                         'edit_icon_url' => (string)$OUTPUT->pix_url('t/edit'),
201                         'add_icon_url' => (string)$OUTPUT->pix_url('t/add'),
202                         'delete_icon_url' => (string)$OUTPUT->pix_url('t/delete'),
203                         'green_check_icon_url' => (string)$OUTPUT->pix_url('i/tick_green_small'),
204                         'warning_icon_url' => (string)$OUTPUT->pix_url('warning', 'lti'),
205                         'instructor_tool_type_edit_url' => $editurl->out(false),
206                         'ajax_url' => $ajaxurl->out(true),
207                         'courseId' => $COURSE->id
208                   );
210         $module = array(
211             'name'      => 'mod_lti_edit',
212             'fullpath'  => '/mod/lti/mod_form.js',
213             'requires'  => array('base', 'io', 'querystring-stringify-simple', 'node', 'event', 'json-parse'),
214             'strings'   => array(
215                 array('addtype', 'lti'),
216                 array('edittype', 'lti'),
217                 array('deletetype', 'lti'),
218                 array('delete_confirmation', 'lti'),
219                 array('cannot_edit', 'lti'),
220                 array('cannot_delete', 'lti'),
221                 array('global_tool_types', 'lti'),
222                 array('course_tool_types', 'lti'),
223                 array('using_tool_configuration', 'lti'),
224                 array('domain_mismatch', 'lti'),
225                 array('custom_config', 'lti'),
226                 array('tool_config_not_found', 'lti')
227             ),
228         );
230         $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
231     }
233     /**
234      * Make fields editable or non-editable depending on the administrator choices
235      * @see moodleform_mod::definition_after_data()
236      */
237     public function definition_after_data() {
238         parent::definition_after_data();
240         //$mform =& $this->_form;
241     }
243     /**
244      * Function overwritten to change default values using
245      * global configuration
246      *
247      * @param array $default_values passed by reference
248      */
249     public function data_preprocessing(&$default_values) {
251     }