MDL-62748 course: maxsections is a limit
[moodle.git] / course / changenumsections.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  * This script allows the number of sections in a course to be increased
20  * or decreased, redirecting to the course page.
21  *
22  * @package core_course
23  * @copyright 2012 Dan Poltawski
24  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  * @since Moodle 2.3
26  */
28 require_once(__DIR__.'/../config.php');
29 require_once($CFG->dirroot.'/course/lib.php');
31 $courseid = required_param('courseid', PARAM_INT);
32 $increase = optional_param('increase', null, PARAM_BOOL);
33 $insertsection = optional_param('insertsection', null, PARAM_INT); // Insert section at position; 0 means at the end.
34 $numsections = optional_param('numsections', 1, PARAM_INT);        // Number of sections to insert.
35 $returnurl = optional_param('returnurl', null, PARAM_LOCALURL);    // Where to return to after the action.
36 $sectionreturn = optional_param('sectionreturn', null, PARAM_INT); // Section to return to, ignored if $returnurl is specified.
38 $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
39 $courseformatoptions = course_get_format($course)->get_format_options();
41 $PAGE->set_url('/course/changenumsections.php', array('courseid' => $courseid));
43 // Authorisation checks.
44 require_login($course);
45 require_capability('moodle/course:update', context_course::instance($course->id));
46 require_sesskey();
48 $desirednumsections = 0;
49 $courseformat = course_get_format($course);
50 $lastsectionnumber = $courseformat->get_last_section_number();
51 $maxsections = $courseformat->get_max_sections();
53 if (isset($courseformatoptions['numsections']) && $increase !== null) {
54     $desirednumsections = $courseformatoptions['numsections'] + 1;
55 } else if (course_get_format($course)->uses_sections() && $insertsection !== null) {
56     // Count the sections in the course.
57     $desirednumsections = $lastsectionnumber + $numsections;
58 }
60 if ($desirednumsections > $maxsections) {
61     // Increase in number of sections is not allowed.
62     \core\notification::warning(get_string('maxsectionslimit', 'moodle', $maxsections));
63     $increase = null;
64     $insertsection = null;
65     $numsections = 0;
67     if (!$returnurl) {
68         $returnurl = course_get_url($course);
69     }
70 }
72 if (isset($courseformatoptions['numsections']) && $increase !== null) {
73     if ($increase) {
74         // Add an additional section.
75         $courseformatoptions['numsections']++;
76         course_create_sections_if_missing($course, $courseformatoptions['numsections']);
77     } else {
78         // Remove a section.
79         $courseformatoptions['numsections']--;
80     }
82     // Don't go less than 0, intentionally redirect silently (for the case of
83     // double clicks).
84     if ($courseformatoptions['numsections'] >= 0) {
85         update_course((object)array('id' => $course->id,
86             'numsections' => $courseformatoptions['numsections']));
87     }
88     if (!$returnurl) {
89         $returnurl = course_get_url($course);
90         $returnurl->set_anchor('changenumsections');
91     }
93 } else if (course_get_format($course)->uses_sections() && $insertsection !== null) {
94     if ($insertsection) {
95         // Inserting sections at any position except in the very end requires capability to move sections.
96         require_capability('moodle/course:movesections', context_course::instance($course->id));
97     }
98     $sections = [];
99     for ($i = 0; $i < max($numsections, 1); $i ++) {
100         $sections[] = course_create_section($course, $insertsection);
101     }
102     if (!$returnurl) {
103         $returnurl = course_get_url($course, $sections[0]->section,
104             ($sectionreturn !== null) ? ['sr' => $sectionreturn] : []);
105     }
108 // Redirect to where we were..
109 redirect($returnurl);