06ee3d1da01ff4591cbbba11f4c48157ee8cfd73
[moodle.git] / grade / grading / manage.php
1 <?php
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/>.
18 /**
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  *
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  */
31 require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
32 require_once($CFG->dirroot.'/grade/grading/lib.php');
34 // identify gradable area by its id
35 $areaid     = optional_param('areaid', null, PARAM_INT);
36 // alternatively the context, component and areaname must be provided
37 $contextid  = optional_param('contextid', null, PARAM_INT);
38 $component  = optional_param('component', null, PARAM_COMPONENT);
39 $area       = optional_param('area', null, PARAM_AREA);
40 // keep the caller's URL so that we know where to send the user finally
41 $returnurl  = optional_param('returnurl', null, PARAM_LOCALURL);
42 // active method selector
43 $setmethod  = optional_param('setmethod', null, PARAM_PLUGIN);
44 // publish the given form definition as a new template in the forms bank
45 $shareform  = optional_param('shareform', null, PARAM_INT);
46 // delete the given form definition
47 $deleteform = optional_param('deleteform', null, PARAM_INT);
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);
53 if (!is_null($areaid)) {
54     // get manager by id
55     $manager = get_grading_manager($areaid);
56 } else {
57     // get manager by context and component
58     if (is_null($contextid) or is_null($component) or is_null($area)) {
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 }
65 if ($manager->get_context()->contextlevel < CONTEXT_COURSE) {
66     throw new coding_exception('Unsupported gradable area context level');
67 }
69 // get the currently active method
70 $method = $manager->get_active_method();
72 list($context, $course, $cm) = get_context_info_array($manager->get_context()->id);
74 require_login($course, true, $cm);
75 require_capability('moodle/grade:managegradingforms', $context);
77 if (!empty($returnurl)) {
78     $returnurl = new moodle_url($returnurl);
79 } else {
80     $returnurl = null;
81 }
83 $PAGE->set_url($manager->get_management_url($returnurl));
84 navigation_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');
89 // process the eventual change of the active grading method
90 if (!empty($setmethod)) {
91     require_sesskey();
92     if ($setmethod == 'none') {
93         // here we expect that noone would actually want to call their plugin as 'none'
94         $setmethod = null;
95     }
96     $manager->set_active_method($setmethod);
97     redirect($PAGE->url);
98 }
100 // publish the form as a template
101 if (!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     }
123 // delete the form definition
124 if (!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     }
144 echo $output->header();
146 if (!empty($message)) {
147     echo $output->management_message($message);
150 echo $output->heading(get_string('gradingmanagementtitle', 'core_grading', array(
151     'component' => $manager->get_component_title(), 'area' => $manager->get_area_title())));
153 // display the active grading method information and selector
154 echo $output->management_method_selector($manager, $PAGE->url);
156 // get the currently active method's controller
157 if (!empty($method)) {
158     $controller = $manager->get_controller($method);
159     // display relevant actions
160     echo $output->container_start('actions');
161     if ($controller->is_form_defined()) {
162         $definition = $controller->get_definition();
163         echo $output->management_action_icon($controller->get_editor_url($returnurl),
164             get_string('manageactionedit', 'core_grading'), 'b/document-edit');
165         echo $output->management_action_icon(new moodle_url($PAGE->url, array('deleteform' => $definition->id)),
166             get_string('manageactiondelete', 'core_grading'), 'b/edit-delete');
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         }
171     } else {
172         echo $output->management_action_icon($controller->get_editor_url($returnurl),
173             get_string('manageactionnew', 'core_grading'), 'b/document-new');
174         $pickurl = new moodle_url('/grade/grading/pick.php', array('targetid' => $controller->get_areaid()));
175         if (!is_null($returnurl)) {
176             $pickurl->param('returnurl', $returnurl->out(false));
177         }
178         echo $output->management_action_icon($pickurl,
179             get_string('manageactionclone', 'core_grading'), 'b/edit-copy');
180     }
181     echo $output->container_end();
183     // display the grading form preview
184     if ($controller->is_form_defined()) {
185         echo $output->box($controller->render_preview($PAGE), 'preview');
186     }
190 echo $output->footer();