MDL-20534 lti: comments cleanup
[moodle.git] / mod / lti / typessettings.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 contains the script used to clone Moodle admin setting page.
37  * It is used to create a new form used to pre-configure lti activities
38  *
39  * @package    mod
40  * @subpackage lti
41  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
42  *  marc.alier@upc.edu
43  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
44  * @author     Marc Alier
45  * @author     Jordi Piguillem
46  * @author     Nikolas Galanis
47  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48  */
50 require_once('../../config.php');
51 require_once($CFG->libdir.'/adminlib.php');
52 require_once($CFG->dirroot.'/mod/lti/edit_form.php');
53 require_once($CFG->dirroot.'/mod/lti/locallib.php');
55 $section      = 'modsettinglti';
56 $return       = optional_param('return', '', PARAM_ALPHA);
57 $adminediting = optional_param('adminedit', -1, PARAM_BOOL);
58 $action       = optional_param('action', null, PARAM_ACTION);
59 $id           = optional_param('id', null, PARAM_INT);
60 $useexisting  = optional_param('useexisting', null, PARAM_INT);
61 $definenew    = optional_param('definenew', null, PARAM_INT);
63 // no guest autologin
64 require_login(0, false);
65 $url = new moodle_url('/mod/lti/typesettings.php');
66 $PAGE->set_url($url);
68 admin_externalpage_setup('managemodules'); // Hacky solution for printing the admin page
70 $tab = optional_param('tab', '', PARAM_ALPHAEXT);
71 $redirect = "$CFG->wwwroot/$CFG->admin/settings.php?section=modsettinglti&tab={$tab}";
73 // WRITING SUBMITTED DATA (IF ANY)
75 $statusmsg = '';
76 $errormsg  = '';
77 $focus = '';
79 $data = data_submitted();
81 // Any posted data & any action
82 if (!empty($data) || !empty($action)) {
83     require_sesskey();
84 }
86 if (isset($data->submitbutton)) {
87     $type = new stdClass();
89     if (isset($id)) {
90         $type->id = $id;
92         lti_update_type($type, $data);
94         redirect($redirect);
95     } else {
96         $type->state = LTI_TOOL_STATE_CONFIGURED;
98         lti_add_type($type, $data);
100         redirect($redirect);
101     }
103 } else if (isset($data->cancel)) {
104     redirect($redirect);
106 } else if ($action == 'accept') {
107     lti_set_state_for_type($id, LTI_TOOL_STATE_CONFIGURED);
108     redirect($redirect);
110 } else if ($action == 'reject') {
111     lti_set_state_for_type($id, LTI_TOOL_STATE_REJECTED);
112     redirect($redirect);
114 } else if ($action == 'delete') {
115     lti_delete_type($id);
116     redirect($redirect);
119 // print header stuff
120 $PAGE->set_focuscontrol($focus);
121 if (empty($SITE->fullname)) {
122     $PAGE->set_title($settingspage->visiblename);
123     $PAGE->set_heading($settingspage->visiblename);
125     $PAGE->navbar->add(get_string('lti_administration', 'lti'), $CFG->wwwroot.'/admin/settings.php?section=modsettinglti');
127     echo $OUTPUT->header();
129     echo $OUTPUT->box(get_string('configintrosite', 'admin'));
131     if ($errormsg !== '') {
132         echo $OUTPUT->notification($errormsg);
134     } else if ($statusmsg !== '') {
135         echo $OUTPUT->notification($statusmsg, 'notifysuccess');
136     }
138     echo '<form action="typesettings.php" method="post" id="'.$id.'" >';
139     echo '<div class="settingsform clearfix">';
140     echo html_writer::input_hidden_params($PAGE->url);
141     echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
142     echo '<input type="hidden" name="return" value="'.$return.'" />';
144     echo $settingspage->output_html();
146     echo '<div class="form-buttons"><input class="form-submit" type="submit" value="'.get_string('savechanges', 'admin').'" /></div>';
148     echo '</div>';
149     echo '</form>';
151 } else {
152     if ($PAGE->user_allowed_editing()) {
153         $url = clone($PAGE->url);
154         if ($PAGE->user_is_editing()) {
155             $caption = get_string('blockseditoff');
156             $url->param('adminedit', 'off');
157         } else {
158             $caption = get_string('blocksediton');
159             $url->param('adminedit', 'on');
160         }
161         $buttons = $OUTPUT->single_button($url, $caption, 'get');
162     }
164     $PAGE->set_title("$SITE->shortname: " . get_string('toolsetup', 'lti'));
166     $PAGE->navbar->add(get_string('lti_administration', 'lti'), $CFG->wwwroot.'/admin/settings.php?section=modsettinglti');
168     echo $OUTPUT->header();
170     if ($errormsg !== '') {
171         echo $OUTPUT->notification($errormsg);
173     } else if ($statusmsg !== '') {
174         echo $OUTPUT->notification($statusmsg, 'notifysuccess');
175     }
177     echo $OUTPUT->heading(get_string('toolsetup', 'lti'));
178     echo $OUTPUT->box_start('generalbox');
179     if ($action == 'add') {
180         $form = new mod_lti_edit_types_form(null, (object)array('isadmin' => true));
181         $form->display();
182     } else if ($action == 'update') {
183         $form = new mod_lti_edit_types_form('typessettings.php?id='.$id, (object)array('isadmin' => true));
184         $type = lti_get_type_type_config($id);
185         $form->set_data($type);
186         $form->display();
187     }
189     echo $OUTPUT->box_end();
192 echo $OUTPUT->footer();