MDL-29794 Initial support for re-using a shared grading form
[moodle.git] / grade / grading / manage.php
CommitLineData
6832a102
DM
1<?php
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
9c9cee4e
DM
19 * A single gradable area management page
20 *
21 * This page alows the user to set the current active method in the given
22 * area, provides access to the plugin editor and allows user to save the
23 * current form as a template or re-use some existing form.
24 *
6832a102
DM
25 * @package core
26 * @subpackage grading
27 * @copyright 2011 David Mudrak <david@moodle.com>
28 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29 */
30
31require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
32require_once($CFG->dirroot.'/grade/grading/lib.php');
33
fde33804 34// identify gradable area by its id
71bd9d20 35$areaid = optional_param('areaid', null, PARAM_INT);
fde33804 36// alternatively the context, component and areaname must be provided
71bd9d20
DM
37$contextid = optional_param('contextid', null, PARAM_INT);
38$component = optional_param('component', null, PARAM_COMPONENT);
39$area = optional_param('area', null, PARAM_AREA);
fde33804 40// keep the caller's URL so that we know where to send the user finally
71bd9d20 41$returnurl = optional_param('returnurl', null, PARAM_LOCALURL);
fde33804 42// active method selector
71bd9d20 43$setmethod = optional_param('setmethod', null, PARAM_PLUGIN);
fde33804
DM
44// publish the given form definition as a new template in the forms bank
45$shareform = optional_param('shareform', null, PARAM_INT);
671ec8f5
DM
46// delete the given form definition
47$deleteform = optional_param('deleteform', null, PARAM_INT);
fde33804
DM
48// consider the required action as confirmed
49$confirmed = optional_param('confirmed', false, PARAM_BOOL);
50// a message to display, typically a previous action's result
51$message = optional_param('message', null, PARAM_NOTAGS);
6832a102
DM
52
53if (!is_null($areaid)) {
54 // get manager by id
55 $manager = get_grading_manager($areaid);
56} else {
57 // get manager by context and component
98a73bb7 58 if (is_null($contextid) or is_null($component) or is_null($area)) {
6832a102
DM
59 throw new coding_exception('The caller script must identify the gradable area.');
60 }
61 $context = get_context_instance_by_id($contextid, MUST_EXIST);
62 $manager = get_grading_manager($context, $component, $area);
63}
64
9c9cee4e
DM
65if ($manager->get_context()->contextlevel < CONTEXT_COURSE) {
66 throw new coding_exception('Unsupported gradable area context level');
67}
fde33804 68
9c9cee4e
DM
69// get the currently active method
70$method = $manager->get_active_method();
fde33804 71
9c9cee4e 72list($context, $course, $cm) = get_context_info_array($manager->get_context()->id);
fde33804 73
9c9cee4e
DM
74require_login($course, true, $cm);
75require_capability('moodle/grade:managegradingforms', $context);
6832a102 76
9c9cee4e
DM
77if (!empty($returnurl)) {
78 $returnurl = new moodle_url($returnurl);
6832a102 79} else {
9c9cee4e 80 $returnurl = null;
6832a102
DM
81}
82
98a73bb7 83$PAGE->set_url($manager->get_management_url($returnurl));
6832a102
DM
84navigation_node::override_active_url($manager->get_management_url());
85$PAGE->set_title(get_string('gradingmanagement', 'core_grading'));
86$PAGE->set_heading(get_string('gradingmanagement', 'core_grading'));
87$output = $PAGE->get_renderer('core_grading');
88
6832a102 89// process the eventual change of the active grading method
71bd9d20 90if (!empty($setmethod)) {
6832a102 91 require_sesskey();
71bd9d20 92 if ($setmethod == 'none') {
6832a102 93 // here we expect that noone would actually want to call their plugin as 'none'
71bd9d20 94 $setmethod = null;
6832a102 95 }
71bd9d20 96 $manager->set_active_method($setmethod);
6832a102
DM
97 redirect($PAGE->url);
98}
99
fde33804
DM
100// publish the form as a template
101if (!empty($shareform)) {
102 require_capability('moodle/grade:sharegradingforms', get_system_context());
103 $controller = $manager->get_controller($method);
104 $definition = $controller->get_definition();
105 if (!$confirmed) {
106 // let the user confirm they understand what they are doing (haha ;-)
107 echo $output->header();
108 echo $output->confirm(get_string('manageactionshareconfirm', 'core_grading', s($definition->name)),
109 new moodle_url($PAGE->url, array('shareform' => $shareform, 'confirmed' => 1)),
110 $PAGE->url);
111 echo $output->footer();
112 die();
113 } else {
114 require_sesskey();
115 $newareaid = $manager->create_shared_area($method);
116 $targetarea = get_grading_manager($newareaid);
117 $targetcontroller = $targetarea->get_controller($method);
118 $targetcontroller->update_definition($controller->get_definition_copy($targetcontroller));
119 redirect(new moodle_url($PAGE->url, array('message' => get_string('manageactionsharedone', 'core_grading'))));
120 }
121}
122
671ec8f5
DM
123// delete the form definition
124if (!empty($deleteform)) {
125 $controller = $manager->get_controller($method);
126 $definition = $controller->get_definition();
127 if (!$confirmed) {
128 // let the user confirm they understand the consequences (also known as WTF-effect)
129 echo $output->header();
130 echo $output->confirm(markdown_to_html(get_string('manageactiondeleteconfirm', 'core_grading', array(
131 'formname' => s($definition->name),
132 'component' => $manager->get_component_title(),
133 'area' => $manager->get_area_title()))),
134 new moodle_url($PAGE->url, array('deleteform' => $deleteform, 'confirmed' => 1)), $PAGE->url);
135 echo $output->footer();
136 die();
137 } else {
138 require_sesskey();
139 $controller->delete_definition();
140 redirect(new moodle_url($PAGE->url, array('message' => get_string('manageactiondeletedone', 'core_grading'))));
141 }
142}
143
6832a102 144echo $output->header();
fde33804
DM
145
146if (!empty($message)) {
147 echo $output->management_message($message);
148}
149
6832a102
DM
150echo $output->heading(get_string('gradingmanagementtitle', 'core_grading', array(
151 'component' => $manager->get_component_title(), 'area' => $manager->get_area_title())));
152
153// display the active grading method information and selector
154echo $output->management_method_selector($manager, $PAGE->url);
155
156// get the currently active method's controller
6832a102
DM
157if (!empty($method)) {
158 $controller = $manager->get_controller($method);
159 // display relevant actions
160 echo $output->container_start('actions');
161 if ($controller->is_form_defined()) {
fde33804 162 $definition = $controller->get_definition();
6832a102 163 echo $output->management_action_icon($controller->get_editor_url($returnurl),
fde33804 164 get_string('manageactionedit', 'core_grading'), 'b/document-edit');
671ec8f5 165 echo $output->management_action_icon(new moodle_url($PAGE->url, array('deleteform' => $definition->id)),
6832a102 166 get_string('manageactiondelete', 'core_grading'), 'b/edit-delete');
fde33804
DM
167 if (has_capability('moodle/grade:sharegradingforms', get_system_context())) {
168 echo $output->management_action_icon(new moodle_url($PAGE->url, array('shareform' => $definition->id)),
169 get_string('manageactionshare', 'core_grading'), 'b/bookmark-new');
170 }
6832a102
DM
171 } else {
172 echo $output->management_action_icon($controller->get_editor_url($returnurl),
173 get_string('manageactionnew', 'core_grading'), 'b/document-new');
20836db9 174 $pickurl = new moodle_url('/grade/grading/templates.php', array('targetid' => $controller->get_areaid()));
9c9cee4e
DM
175 if (!is_null($returnurl)) {
176 $pickurl->param('returnurl', $returnurl->out(false));
177 }
178 echo $output->management_action_icon($pickurl,
6832a102
DM
179 get_string('manageactionclone', 'core_grading'), 'b/edit-copy');
180 }
181 echo $output->container_end();
182
183 // display the grading form preview
184 if ($controller->is_form_defined()) {
185 echo $output->box($controller->render_preview($PAGE), 'preview');
186 }
187}
188
189
190echo $output->footer();