Fixing a couple issues with grade receipt
[moodle.git] / mod / lti / mod_form.php
CommitLineData
996b0fd9
CS
1<?php
2// This file is part of BasicLTI4Moodle
3//
4// BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
5// consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
6// based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
7// specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
8// are already supporting or going to support BasicLTI. This project Implements the consumer
9// for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
10// BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
11// at the GESSI research group at UPC.
12// SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
13// by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
14// Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
15//
16// BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
17// of the Universitat Politecnica de Catalunya http://www.upc.edu
18// Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu
19//
20// Moodle is free software: you can redistribute it and/or modify
21// it under the terms of the GNU General Public License as published by
22// the Free Software Foundation, either version 3 of the License, or
23// (at your option) any later version.
24//
25// Moodle is distributed in the hope that it will be useful,
26// but WITHOUT ANY WARRANTY; without even the implied warranty of
27// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28// GNU General Public License for more details.
29//
30// You should have received a copy of the GNU General Public License
31// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
32
33/**
34 * This file defines the main basiclti configuration form
35 *
36 * @package lti
37 * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
38 * marc.alier@upc.edu
39 * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
40 *
41 * @author Marc Alier
42 * @author Jordi Piguillem
43 * @author Nikolas Galanis
44 *
45 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
46 */
47
48defined('MOODLE_INTERNAL') || die;
49
50require_once($CFG->dirroot.'/course/moodleform_mod.php');
51require_once($CFG->dirroot.'/mod/lti/locallib.php');
52
53class mod_lti_mod_form extends moodleform_mod {
54
55 function definition() {
56 global $DB, $PAGE, $OUTPUT, $USER, $COURSE;
57
58 $this->typeid = 0;
59
60 $mform =& $this->_form;
61//-------------------------------------------------------------------------------
62 /// Adding the "general" fieldset, where all the common settings are shown
63 $mform->addElement('header', 'general', get_string('general', 'form'));
64 /// Adding the standard "name" field
65 $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size'=>'64'));
66 $mform->setType('name', PARAM_TEXT);
67 $mform->addRule('name', null, 'required', null, 'client');
68 /// Adding the optional "intro" and "introformat" pair of fields
69 $this->add_intro_editor(false, get_string('basicltiintro', 'lti'));
70 $mform->setAdvanced('introeditor');
71
72 $mform->addElement('checkbox', 'showtitle', '&nbsp;', ' ' . get_string('display_name', 'lti'));
73 $mform->setAdvanced('showtitle');
74
75 $mform->addElement('checkbox', 'showdescription', '&nbsp;', ' ' . get_string('display_description', 'lti'));
76 $mform->setAdvanced('showdescription');
77
78 //Tool settings
79 $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'), array());
80
81 foreach(lti_get_types_for_add_instance() as $id => $type){
82 if($type->course == $COURSE->id) {
83 $attributes = array( 'editable' => 1 );
84 } else {
85 $attributes = array();
86 }
87
88 $tooltypes->addOption($type->name, $id, $attributes);
89 }
90
91 $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size'=>'64'));
92 $mform->setType('toolurl', PARAM_TEXT);
93
94 $launchoptions=array();
95 $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
96 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
97 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
98 $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
99
100 $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
101 $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
102
103 $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
104 $mform->setType('resourcekey', PARAM_TEXT);
105 $mform->setAdvanced('resourcekey');
106
107 $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
108 $mform->setType('password', PARAM_TEXT);
109 $mform->setAdvanced('password');
110
111 $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows'=>4, 'cols'=>60));
112 $mform->setType('instructorcustomparameters', PARAM_TEXT);
113 $mform->setAdvanced('instructorcustomparameters');
114
115//-------------------------------------------------------------------------------
116 //$mform->addElement('hidden', 'typeid', $this->typeid);
117 //$mform->addElement('hidden', 'toolurl', $this->typeconfig['toolurl']);
118 //$mform->addElement('hidden', 'type', $typename);
119
120//-------------------------------------------------------------------------------
121 // Add privacy preferences fieldset where users choose whether to send their data
122 $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
123
124 $mform->addElement('checkbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));
125 $mform->setDefault('instructorchoicesendname', '1');
126
127 $mform->addElement('checkbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));
128 $mform->setDefault('instructorchoicesendemailaddr', '1');
129
130 $mform->addElement('checkbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));
131 $mform->setDefault('instructorchoiceacceptgrades', '1');
132
133 $mform->addElement('checkbox', 'instructorchoiceallowroster', '&nbsp;', ' ' . get_string('share_roster', 'lti'));
134 $mform->setDefault('instructorchoiceallowroster', '1');
135
136//-------------------------------------------------------------------------------
137
138/* $debugoptions=array();
139 $debugoptions[0] = get_string('debuglaunchoff', 'lti');
140 $debugoptions[1] = get_string('debuglaunchon', 'lti');
141
142 $mform->addElement('select', 'debuglaunch', get_string('debuglaunch', 'lti'), $debugoptions);
143
144 if (isset($this->typeconfig['debuglaunch'])) {
145 if ($this->typeconfig['debuglaunch'] == 0) {
146 $mform->setDefault('debuglaunch', '0');
147 } else if ($this->typeconfig['debuglaunch'] == 1) {
148 $mform->setDefault('debuglaunch', '1');
149 }
150 }
151*/
152
153//-------------------------------------------------------------------------------
154 // add standard elements, common to all modules
155 $this->standard_coursemodule_elements();
156
157 $mform->setAdvanced('cmidnumber');
158//-------------------------------------------------------------------------------
159 // add standard buttons, common to all modules
160 $this->add_action_buttons();
161
162 $url = new moodle_url("/mod/lti/instructor_edit_tool_type.php?sesskey={$USER->sesskey}&course={$COURSE->id}");
163 $jsinfo = (object)array(
164 'edit_icon_url' => (string)$OUTPUT->pix_url('t/edit'),
165 'add_icon_url' => (string)$OUTPUT->pix_url('t/add'),
166 'delete_icon_url' => (string)$OUTPUT->pix_url('t/delete'),
167 'instructor_tool_type_edit_url' => $url->out(false)
168 );
169
170 $module = array(
171 'name' => 'mod_lti_edit',
172 'fullpath' => '/mod/lti/mod_form.js',
173 'requires' => array('base', 'io', 'node', 'event', 'json-parse'),
174 'strings' => array(),
175 );
176
177 $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
178 }
179
180 /**
181 * Make fields editable or non-editable depending on the administrator choices
182 * @see moodleform_mod::definition_after_data()
183 */
184 function definition_after_data() {
185 parent::definition_after_data();
186
187 }
188
189 /**
190 * Function overwritten to change default values using
191 * global configuration
192 *
193 * @param array $default_values passed by reference
194 */
195 function data_preprocessing(&$default_values) {
196
197 }
198}
199