Skip to content

Commit

Permalink
MDL-78575 mod_lti: add course tool editing form as standalone page
Browse files Browse the repository at this point in the history
This handles create/edit of course tools. Deletion will be supported via
an action and modal confirm on the coursetools listing page.
  • Loading branch information
snake committed Jul 17, 2023
1 parent a8f496e commit 8d455f5
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 0 deletions.
90 changes: 90 additions & 0 deletions mod/lti/coursetooledit.php
@@ -0,0 +1,90 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* Page allowing instructors to configure course-level tools.
*
* @package mod_lti
* @copyright 2023 Jake Dallimore <jrhdallimore@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

use core\output\notification;

require_once('../../config.php');
require_once($CFG->dirroot.'/mod/lti/edit_form.php');
require_once($CFG->dirroot.'/mod/lti/lib.php');

$courseid = required_param('course', PARAM_INT);
$typeid = optional_param('typeid', null, PARAM_INT);

// Permissions etc.
require_login($courseid, false);
require_capability('mod/lti:addcoursetool', context_course::instance($courseid));
if (!empty($typeid)) {
$type = lti_get_type($typeid);
if ($type->course != $courseid || $type->course == get_site()->id) {
throw new moodle_exception('You do not have permissions to edit this tool type.');
}
}

// Page setup.
$url = new moodle_url('/mod/lti/coursetooledit.php', ['courseid' => $courseid]);
$PAGE->set_url($url);
$PAGE->set_pagelayout('incourse');
$PAGE->set_title(get_string('edittype', 'mod_lti')); // TODO confirm with UX about use of 'edit preconfigured tool' for the title.
$PAGE->set_secondary_active_tab('coursetools');
$PAGE->add_body_class('limitedwidth');

$type = !empty($typeid) ? lti_get_type_type_config($typeid) : (object) ['lti_clientid' => null];
$pageheading = !empty($typeid) ? get_string('courseexternaltooleditheading', 'mod_lti') :
get_string('courseexternaltooladdheading', 'mod_lti');
$form = new mod_lti_edit_types_form($url, (object)array('id' => $typeid, 'clientid' => $type->lti_clientid));

if ($form->is_cancelled()) {

redirect(new moodle_url('/mod/lti/coursetools.php', ['id' => $courseid]));
} else if ($data = $form->get_data()) {

require_sesskey();

if (!empty($data->typeid)) {
$type = (object) ['id' => $data->typeid];
lti_load_type_if_cartridge($data);
lti_update_type($type, $data);
$redirecturl = new moodle_url('/mod/lti/coursetools.php', ['id' => $courseid]);
$notice = get_string('courseexternaltooleditsuccess', 'mod_lti', $type->name);
} else {
$type = (object) ['state' => LTI_TOOL_STATE_CONFIGURED, 'course' => $data->course];
lti_load_type_if_cartridge($data);
lti_add_type($type, $data);
$redirecturl = new moodle_url('/mod/lti/coursetools.php', ['id' => $courseid]);
$notice = get_string('courseexternaltooladdsuccess', 'mod_lti', $type->name);
}

redirect($redirecturl, $notice, 0, notification::NOTIFY_SUCCESS);
}

// Display the form.
echo $OUTPUT->header();
echo $OUTPUT->heading($pageheading);

if (!empty($typeid)) {
$form->set_data($type);
}
$form->display();

echo $OUTPUT->footer();
4 changes: 4 additions & 0 deletions mod/lti/lang/en/lti.php
Expand Up @@ -117,6 +117,10 @@
$string['contentitem_multiple_graded'] = 'Graded activity (Maximum grade: {$a})';
$string['course_tool_types'] = 'Course tools';
$string['courseactivitiesorresources'] = 'Course activities or resources';
$string['courseexternaltooladdheading'] = 'Add new LTI External tool'; // TODO confirm wording with UX.
$string['courseexternaltooladdsuccess'] = 'Successfully added course tool \'{$a}\'.'; // TODO confirm wording with UX.
$string['courseexternaltooleditheading'] = 'Edit LTI External tool'; // TODO confirm wording with UX.
$string['courseexternaltooleditsuccess'] = 'The changes to the course tool \'{$a}\' were saved.'; // TODO confirm wording with UX.
$string['courseexternaltooliconalt'] = 'Icon for the \'{$a}\' LTI External tool'; // TODO: confirm wording with UX.
$string['courseexternaltools'] = 'LTI External tools'; // TODO: confirm wording with UX.
$string['courseexternaltoolsinfo'] = 'LTI External tools are add-on apps you can integrate into your course, such as interactive content or assessments. Your students can access and use them without leaving your course.'; // TODO: confirm wording with UX.
Expand Down

0 comments on commit 8d455f5

Please sign in to comment.