Merge branch 'MDL-29320-master' of git://github.com/junpataleta/moodle
[moodle.git] / completion / classes / bulkedit_form.php
CommitLineData
06cdda46
MG
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/**
7f53e8aa 18 * Bulk edit activity completion form
06cdda46
MG
19 *
20 * @package core_completion
21 * @copyright 2017 Marina Glancy
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25defined('MOODLE_INTERNAL') || die;
26
06cdda46 27/**
7f53e8aa 28 * Bulk edit activity completion form
06cdda46
MG
29 *
30 * @package core_completion
31 * @copyright 2017 Marina Glancy
32 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33 */
7f53e8aa 34class core_completion_bulkedit_form extends core_completion_edit_base_form {
06cdda46
MG
35 /** @var cm_info[] list of selected course modules */
36 protected $cms = [];
37 /** @var array Do not use directly, call $this->get_module_names() */
38 protected $_modnames = null;
06cdda46
MG
39
40 /**
41 * Returns list of types of selected modules
42 *
43 * @return array modname=>modfullname
44 */
45 protected function get_module_names() {
46 if ($this->_modnames !== null) {
47 return $this->_modnames;
48 }
49 $this->_modnames = [];
50 foreach ($this->cms as $cm) {
51 $this->_modnames[$cm->modname] = $cm->modfullname;
52 }
53 return $this->_modnames;
54 }
55
a64a9f9c
MG
56 /**
57 * Returns an instance of component-specific module form for the first selected module
58 *
59 * @return moodleform_mod|null
60 */
61 protected function get_module_form() {
62 global $CFG, $PAGE;
63
64 if ($this->_moduleform) {
65 return $this->_moduleform;
66 }
67
68 $cm = reset($this->cms);
69 $course = $this->course;
70 $modname = $cm->modname;
71
72 $modmoodleform = "$CFG->dirroot/mod/$modname/mod_form.php";
73 if (file_exists($modmoodleform)) {
74 require_once($modmoodleform);
75 } else {
76 print_error('noformdesc');
77 }
78
79 list($cmrec, $context, $module, $data, $cw) = get_moduleinfo_data($cm, $course);
80 $data->return = 0;
81 $data->sr = 0;
82 $data->update = $modname;
83
84 // Initialise the form but discard all JS requirements it adds, our form has already added them.
85 $mformclassname = 'mod_'.$modname.'_mod_form';
273d3106 86 $PAGE->start_collecting_javascript_requirements();
a64a9f9c 87 $this->_moduleform = new $mformclassname($data, 0, $cmrec, $course);
273d3106 88 $PAGE->end_collecting_javascript_requirements();
a64a9f9c
MG
89
90 return $this->_moduleform;
91 }
92
06cdda46
MG
93 /**
94 * Form definition
95 */
96 public function definition() {
97 $this->cms = $this->_customdata['cms'];
98 $cm = reset($this->cms); // First selected course module.
7f53e8aa 99 $this->course = $cm->get_course();
06cdda46
MG
100
101 $mform = $this->_form;
102
6c481358 103 $idx = 0;
06cdda46 104 foreach ($this->cms as $cm) {
6c481358
MG
105 $mform->addElement('hidden', 'cmid['.$idx.']', $cm->id);
106 $mform->setType('cmid['.$idx.']', PARAM_INT);
107 $idx++;
06cdda46
MG
108 }
109
7f53e8aa 110 parent::definition();
06cdda46
MG
111
112 $modform = $this->get_module_form();
113 if ($modform) {
114 // Pre-fill the form with the current completion rules of the first selected module.
7f53e8aa 115 list($cmrec, $context, $module, $data, $cw) = get_moduleinfo_data($cm->get_course_module_record(), $this->course);
06cdda46
MG
116 $data = (array)$data;
117 $modform->data_preprocessing($data);
118 // Unset fields that will conflict with this form and set data to this form.
119 unset($data['cmid']);
120 unset($data['id']);
121 $this->set_data($data);
122 }
123 }
6445f17b
MG
124
125 /**
126 * Form validation
127 *
128 * @param array $data array of ("fieldname"=>value) of submitted data
129 * @param array $files array of uploaded files "element_name"=>tmp_file_path
130 * @return array of "element_name"=>"error_description" if there are errors,
131 * or an empty array if everything is OK (true allowed for backwards compatibility too).
132 */
133 public function validation($data, $files) {
134 global $CFG;
135 $errors = parent::validation($data, $files);
136
137 // Completion: Don't let them choose automatic completion without turning
138 // on some conditions.
139 if (array_key_exists('completion', $data) &&
140 $data['completion'] == COMPLETION_TRACKING_AUTOMATIC && !empty($data['completionusegrade'])) {
141 require_once($CFG->libdir.'/gradelib.php');
142 $moduleswithoutgradeitem = [];
143 foreach ($this->cms as $cm) {
144 $item = grade_item::fetch(array('courseid' => $cm->course, 'itemtype' => 'mod',
145 'itemmodule' => $cm->modname, 'iteminstance' => $cm->instance,
146 'itemnumber' => 0));
147 if (!$item) {
148 $moduleswithoutgradeitem[] = $cm->get_formatted_name();
149 }
150 }
151 if ($moduleswithoutgradeitem) {
152 $errors['completionusegrade'] = get_string('nogradeitem', 'completion', join(', ', $moduleswithoutgradeitem));
153 }
154 }
155
156 return $errors;
157 }
06cdda46 158}