MDL-20534 lti: fix some errors introduced by myself in the cleanup
[moodle.git] / mod / lti / edit_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 de main basiclti 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  * @author     Charles Severance
47  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48  */
50 defined('MOODLE_INTERNAL') || die;
52 require_once($CFG->libdir.'/formslib.php');
53 require_once($CFG->dirroot.'/mod/lti/locallib.php');
55 class mod_lti_edit_types_form extends moodleform{
56     public function definition() {
57         $mform    =& $this->_form;
59         //-------------------------------------------------------------------------------
60         // Add basiclti elements
61         $mform->addElement('header', 'setup', get_string('tool_settings', 'lti'));
63         $mform->addElement('text', 'lti_typename', get_string('typename', 'lti'));
64         $mform->setType('lti_typename', PARAM_INT);
65         $mform->addHelpButton('lti_typename', 'typename', 'lti');
66         $mform->addRule('lti_typename', null, 'required', null, 'client');
68         $mform->addElement('text', 'lti_toolurl', get_string('toolurl', 'lti'), array('size'=>'64'));
69         $mform->setType('lti_toolurl', PARAM_TEXT);
70         $mform->addHelpButton('lti_toolurl', 'toolurl', 'lti');
71         $mform->addRule('lti_toolurl', null, 'required', null, 'client');
73         $mform->addElement('text', 'lti_resourcekey', get_string('resourcekey_admin', 'lti'));
74         $mform->setType('lti_resourcekey', PARAM_TEXT);
75         $mform->addHelpButton('lti_resourcekey', 'resourcekey_admin', 'lti');
77         $mform->addElement('passwordunmask', 'lti_password', get_string('password_admin', 'lti'));
78         $mform->setType('lti_password', PARAM_TEXT);
79         $mform->addHelpButton('lti_password', 'password_admin', 'lti');
81         $mform->addElement('textarea', 'lti_customparameters', get_string('custom', 'lti'), array('rows'=>4, 'cols'=>60));
82         $mform->setType('lti_customparameters', PARAM_TEXT);
83         $mform->addHelpButton('lti_customparameters', 'custom', 'lti');
85         if (!empty($this->_customdata->isadmin)) {
86             $mform->addElement('checkbox', 'lti_coursevisible', '&nbsp;', ' ' . get_string('show_in_course', 'lti'));
87             $mform->addHelpButton('lti_coursevisible', 'show_in_course', 'lti');
88         } else {
89             $mform->addElement('hidden', 'lti_coursevisible', '1');
90         }
92         $mform->addElement('hidden', 'typeid');
94         $launchoptions=array();
95         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
96         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
97         $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
99         $mform->addElement('select', 'lti_launchcontainer', get_string('default_launch_container', 'lti'), $launchoptions);
100         $mform->setDefault('lti_launchcontainer', LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS);
101         $mform->addHelpButton('lti_launchcontainer', 'default_launch_container', 'lti');
103         // Add privacy preferences fieldset where users choose whether to send their data
104         $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
106         $options=array();
107         $options[0] = get_string('never', 'lti');
108         $options[1] = get_string('always', 'lti');
109         $options[2] = get_string('delegate', 'lti');
111         $mform->addElement('select', 'lti_sendname', get_string('share_name_admin', 'lti'), $options);
112         $mform->setDefault('lti_sendname', '2');
113         $mform->addHelpButton('lti_sendname', 'share_name_admin', 'lti');
115         $mform->addElement('select', 'lti_sendemailaddr', get_string('share_email_admin', 'lti'), $options);
116         $mform->setDefault('lti_sendemailaddr', '2');
117         $mform->addHelpButton('lti_sendemailaddr', 'share_email_admin', 'lti');
119         //-------------------------------------------------------------------------------
120         // LTI Extensions
122         // Add grading preferences fieldset where the tool is allowed to return grades
123         $mform->addElement('select', 'lti_acceptgrades', get_string('accept_grades_admin', 'lti'), $options);
124         $mform->setDefault('lti_acceptgrades', '2');
125         $mform->addHelpButton('lti_acceptgrades', 'accept_grades_admin', 'lti');
127         // Add grading preferences fieldset where the tool is allowed to retrieve rosters
128         $mform->addElement('select', 'lti_allowroster', get_string('share_roster_admin', 'lti'), $options);
129         $mform->setDefault('lti_allowroster', '2');
130         $mform->addHelpButton('lti_allowroster', 'share_roster_admin', 'lti');
132         $mform->addElement('checkbox', 'lti_forcessl', '&nbsp;', ' ' . get_string('force_ssl', 'lti'), $options);
133         $mform->setDefault('lti_forcessl', '0');
134         $mform->addHelpButton('lti_forcessl', 'force_ssl', 'lti');
136         if (!empty($this->_customdata->isadmin)) {
137             //-------------------------------------------------------------------------------
138             // Add setup parameters fieldset
139             $mform->addElement('header', 'setupoptions', get_string('miscellaneous', 'lti'));
141             // Adding option to change id that is placed in context_id
142             $idoptions = array();
143             $idoptions[0] = get_string('id', 'lti');
144             $idoptions[1] = get_string('courseid', 'lti');
146             $mform->addElement('text', 'lti_organizationid', get_string('organizationid', 'lti'));
147             $mform->setType('lti_organizationid', PARAM_TEXT);
148             $mform->addHelpButton('lti_organizationid', 'organizationid', 'lti');
150             $mform->addElement('text', 'lti_organizationurl', get_string('organizationurl', 'lti'));
151             $mform->setType('lti_organizationurl', PARAM_TEXT);
152             $mform->addHelpButton('lti_organizationurl', 'organizationurl', 'lti');
153         }
155         /* Suppress this for now - Chuck
156         $mform->addElement('text', 'lti_organizationdescr', get_string('organizationdescr', 'lti'));
157         $mform->setType('lti_organizationdescr', PARAM_TEXT);
158         $mform->addHelpButton('lti_organizationdescr', 'organizationdescr', 'lti');
159         */
161         //-------------------------------------------------------------------------------
162         // Add a hidden element to signal a tool fixing operation after a problematic backup - restore process
163         //$mform->addElement('hidden', 'lti_fix');
165         $tab = optional_param('tab', '', PARAM_ALPHAEXT);
166         $mform->addElement('hidden', 'tab', $tab);
168         $courseid = optional_param('course', 1, PARAM_INT);
169         $mform->addElement('hidden', 'course', $courseid);
171         //-------------------------------------------------------------------------------
172         // Add standard buttons, common to all modules
173         $this->add_action_buttons();
175     }