MDL-55074 theme_boost: Navigation and blocks
[moodle.git] / course / format / topics / lib.php
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/>.
17 /**
18  * This file contains main class for the course format Topic
19  *
20  * @since     Moodle 2.0
21  * @package   format_topics
22  * @copyright 2009 Sam Hemelryk
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->dirroot. '/course/format/lib.php');
29 /**
30  * Main class for the Topics course format
31  *
32  * @package    format_topics
33  * @copyright  2012 Marina Glancy
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class format_topics extends format_base {
38     /**
39      * Returns true if this course format uses sections
40      *
41      * @return bool
42      */
43     public function uses_sections() {
44         return true;
45     }
47     /**
48      * Returns the display name of the given section that the course prefers.
49      *
50      * Use section name is specified by user. Otherwise use default ("Topic #")
51      *
52      * @param int|stdClass $section Section object from database or just field section.section
53      * @return string Display name that the course format prefers, e.g. "Topic 2"
54      */
55     public function get_section_name($section) {
56         $section = $this->get_section($section);
57         if ((string)$section->name !== '') {
58             return format_string($section->name, true,
59                     array('context' => context_course::instance($this->courseid)));
60         } else {
61             return $this->get_default_section_name($section);
62         }
63     }
65     /**
66      * Returns the default section name for the topics course format.
67      *
68      * If the section number is 0, it will use the string with key = section0name from the course format's lang file.
69      * If the section number is not 0, the base implementation of format_base::get_default_section_name which uses
70      * the string with the key = 'sectionname' from the course format's lang file + the section number will be used.
71      *
72      * @param stdClass $section Section object from database or just field course_sections section
73      * @return string The default value for the section name.
74      */
75     public function get_default_section_name($section) {
76         if ($section->section == 0) {
77             // Return the general section.
78             return get_string('section0name', 'format_topics');
79         } else {
80             // Use format_base::get_default_section_name implementation which
81             // will display the section name in "Topic n" format.
82             return parent::get_default_section_name($section);
83         }
84     }
86     /**
87      * The URL to use for the specified course (with section)
88      *
89      * @param int|stdClass $section Section object from database or just field course_sections.section
90      *     if omitted the course view page is returned
91      * @param array $options options for view URL. At the moment core uses:
92      *     'navigation' (bool) if true and section has no separate page, the function returns null
93      *     'sr' (int) used by multipage formats to specify to which section to return
94      * @return null|moodle_url
95      */
96     public function get_view_url($section, $options = array()) {
97         global $CFG;
98         $course = $this->get_course();
99         $url = new moodle_url('/course/view.php', array('id' => $course->id));
101         $sr = null;
102         if (array_key_exists('sr', $options)) {
103             $sr = $options['sr'];
104         }
105         if (is_object($section)) {
106             $sectionno = $section->section;
107         } else {
108             $sectionno = $section;
109         }
110         if ($sectionno !== null) {
111             if ($sr !== null) {
112                 if ($sr) {
113                     $usercoursedisplay = COURSE_DISPLAY_MULTIPAGE;
114                     $sectionno = $sr;
115                 } else {
116                     $usercoursedisplay = COURSE_DISPLAY_SINGLEPAGE;
117                 }
118             } else {
119                 $usercoursedisplay = $course->coursedisplay;
120             }
121             if ($sectionno != 0 && $usercoursedisplay == COURSE_DISPLAY_MULTIPAGE) {
122                 $url->param('section', $sectionno);
123             } else {
124                 $url->set_anchor('section-'.$sectionno);
125             }
126         }
127         return $url;
128     }
130     /**
131      * Returns the information about the ajax support in the given source format
132      *
133      * The returned object's property (boolean)capable indicates that
134      * the course format supports Moodle course ajax features.
135      *
136      * @return stdClass
137      */
138     public function supports_ajax() {
139         $ajaxsupport = new stdClass();
140         $ajaxsupport->capable = true;
141         return $ajaxsupport;
142     }
144     /**
145      * Loads all of the course sections into the navigation
146      *
147      * @param global_navigation $navigation
148      * @param navigation_node $node The course node within the navigation
149      */
150     public function extend_course_navigation($navigation, navigation_node $node) {
151         global $PAGE;
152         // if section is specified in course/view.php, make sure it is expanded in navigation
153         if ($navigation->includesectionnum === false) {
154             $selectedsection = optional_param('section', null, PARAM_INT);
155             if ($selectedsection !== null && (!defined('AJAX_SCRIPT') || AJAX_SCRIPT == '0') &&
156                     $PAGE->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
157                 $navigation->includesectionnum = $selectedsection;
158             }
159         }
161         // check if there are callbacks to extend course navigation
162         parent::extend_course_navigation($navigation, $node);
164         // We want to remove the general section if it is empty.
165         $modinfo = get_fast_modinfo($this->get_course());
166         $sections = $modinfo->get_sections();
167         if (!isset($sections[0])) {
168             // The general section is empty to find the navigation node for it we need to get its ID.
169             $section = $modinfo->get_section_info(0);
170             $generalsection = $node->get($section->id, navigation_node::TYPE_SECTION);
171             if ($generalsection) {
172                 // We found the node - now remove it.
173                 $generalsection->remove();
174             }
175         }
176     }
178     /**
179      * Custom action after section has been moved in AJAX mode
180      *
181      * Used in course/rest.php
182      *
183      * @return array This will be passed in ajax respose
184      */
185     function ajax_section_move() {
186         global $PAGE;
187         $titles = array();
188         $course = $this->get_course();
189         $modinfo = get_fast_modinfo($course);
190         $renderer = $this->get_renderer($PAGE);
191         if ($renderer && ($sections = $modinfo->get_section_info_all())) {
192             foreach ($sections as $number => $section) {
193                 $titles[$number] = $renderer->section_title($section, $course);
194             }
195         }
196         return array('sectiontitles' => $titles, 'action' => 'move');
197     }
199     /**
200      * Returns the list of blocks to be automatically added for the newly created course
201      *
202      * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
203      *     each of values is an array of block names (for left and right side columns)
204      */
205     public function get_default_blocks() {
206         return array(
207             BLOCK_POS_LEFT => array(),
208             BLOCK_POS_RIGHT => array('search_forums', 'news_items', 'calendar_upcoming', 'recent_activity')
209         );
210     }
212     /**
213      * Definitions of the additional options that this course format uses for course
214      *
215      * Topics format uses the following options:
216      * - coursedisplay
217      * - numsections
218      * - hiddensections
219      *
220      * @param bool $foreditform
221      * @return array of options
222      */
223     public function course_format_options($foreditform = false) {
224         static $courseformatoptions = false;
225         if ($courseformatoptions === false) {
226             $courseconfig = get_config('moodlecourse');
227             $courseformatoptions = array(
228                 'numsections' => array(
229                     'default' => $courseconfig->numsections,
230                     'type' => PARAM_INT,
231                 ),
232                 'hiddensections' => array(
233                     'default' => $courseconfig->hiddensections,
234                     'type' => PARAM_INT,
235                 ),
236                 'coursedisplay' => array(
237                     'default' => $courseconfig->coursedisplay,
238                     'type' => PARAM_INT,
239                 ),
240             );
241         }
242         if ($foreditform && !isset($courseformatoptions['coursedisplay']['label'])) {
243             $courseconfig = get_config('moodlecourse');
244             $max = $courseconfig->maxsections;
245             if (!isset($max) || !is_numeric($max)) {
246                 $max = 52;
247             }
248             $sectionmenu = array();
249             for ($i = 0; $i <= $max; $i++) {
250                 $sectionmenu[$i] = "$i";
251             }
252             $courseformatoptionsedit = array(
253                 'numsections' => array(
254                     'label' => new lang_string('numberweeks'),
255                     'element_type' => 'select',
256                     'element_attributes' => array($sectionmenu),
257                 ),
258                 'hiddensections' => array(
259                     'label' => new lang_string('hiddensections'),
260                     'help' => 'hiddensections',
261                     'help_component' => 'moodle',
262                     'element_type' => 'select',
263                     'element_attributes' => array(
264                         array(
265                             0 => new lang_string('hiddensectionscollapsed'),
266                             1 => new lang_string('hiddensectionsinvisible')
267                         )
268                     ),
269                 ),
270                 'coursedisplay' => array(
271                     'label' => new lang_string('coursedisplay'),
272                     'element_type' => 'select',
273                     'element_attributes' => array(
274                         array(
275                             COURSE_DISPLAY_SINGLEPAGE => new lang_string('coursedisplay_single'),
276                             COURSE_DISPLAY_MULTIPAGE => new lang_string('coursedisplay_multi')
277                         )
278                     ),
279                     'help' => 'coursedisplay',
280                     'help_component' => 'moodle',
281                 )
282             );
283             $courseformatoptions = array_merge_recursive($courseformatoptions, $courseformatoptionsedit);
284         }
285         return $courseformatoptions;
286     }
288     /**
289      * Adds format options elements to the course/section edit form.
290      *
291      * This function is called from {@link course_edit_form::definition_after_data()}.
292      *
293      * @param MoodleQuickForm $mform form the elements are added to.
294      * @param bool $forsection 'true' if this is a section edit form, 'false' if this is course edit form.
295      * @return array array of references to the added form elements.
296      */
297     public function create_edit_form_elements(&$mform, $forsection = false) {
298         $elements = parent::create_edit_form_elements($mform, $forsection);
300         // Increase the number of sections combo box values if the user has increased the number of sections
301         // using the icon on the course page beyond course 'maxsections' or course 'maxsections' has been
302         // reduced below the number of sections already set for the course on the site administration course
303         // defaults page.  This is so that the number of sections is not reduced leaving unintended orphaned
304         // activities / resources.
305         if (!$forsection) {
306             $maxsections = get_config('moodlecourse', 'maxsections');
307             $numsections = $mform->getElementValue('numsections');
308             $numsections = $numsections[0];
309             if ($numsections > $maxsections) {
310                 $element = $mform->getElement('numsections');
311                 for ($i = $maxsections+1; $i <= $numsections; $i++) {
312                     $element->addOption("$i", $i);
313                 }
314             }
315         }
316         return $elements;
317     }
319     /**
320      * Updates format options for a course
321      *
322      * In case if course format was changed to 'topics', we try to copy options
323      * 'coursedisplay', 'numsections' and 'hiddensections' from the previous format.
324      * If previous course format did not have 'numsections' option, we populate it with the
325      * current number of sections
326      *
327      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
328      * @param stdClass $oldcourse if this function is called from {@link update_course()}
329      *     this object contains information about the course before update
330      * @return bool whether there were any changes to the options values
331      */
332     public function update_course_format_options($data, $oldcourse = null) {
333         global $DB;
334         $data = (array)$data;
335         if ($oldcourse !== null) {
336             $oldcourse = (array)$oldcourse;
337             $options = $this->course_format_options();
338             foreach ($options as $key => $unused) {
339                 if (!array_key_exists($key, $data)) {
340                     if (array_key_exists($key, $oldcourse)) {
341                         $data[$key] = $oldcourse[$key];
342                     } else if ($key === 'numsections') {
343                         // If previous format does not have the field 'numsections'
344                         // and $data['numsections'] is not set,
345                         // we fill it with the maximum section number from the DB
346                         $maxsection = $DB->get_field_sql('SELECT max(section) from {course_sections}
347                             WHERE course = ?', array($this->courseid));
348                         if ($maxsection) {
349                             // If there are no sections, or just default 0-section, 'numsections' will be set to default
350                             $data['numsections'] = $maxsection;
351                         }
352                     }
353                 }
354             }
355         }
356         $changed = $this->update_format_options($data);
357         if ($changed && array_key_exists('numsections', $data)) {
358             // If the numsections was decreased, try to completely delete the orphaned sections (unless they are not empty).
359             $numsections = (int)$data['numsections'];
360             $maxsection = $DB->get_field_sql('SELECT max(section) from {course_sections}
361                         WHERE course = ?', array($this->courseid));
362             for ($sectionnum = $maxsection; $sectionnum > $numsections; $sectionnum--) {
363                 if (!$this->delete_section($sectionnum, false)) {
364                     break;
365                 }
366             }
367         }
368         return $changed;
369     }
371     /**
372      * Whether this format allows to delete sections
373      *
374      * Do not call this function directly, instead use {@link course_can_delete_section()}
375      *
376      * @param int|stdClass|section_info $section
377      * @return bool
378      */
379     public function can_delete_section($section) {
380         return true;
381     }
383     /**
384      * Prepares the templateable object to display section name
385      *
386      * @param \section_info|\stdClass $section
387      * @param bool $linkifneeded
388      * @param bool $editable
389      * @param null|lang_string|string $edithint
390      * @param null|lang_string|string $editlabel
391      * @return \core\output\inplace_editable
392      */
393     public function inplace_editable_render_section_name($section, $linkifneeded = true,
394                                                          $editable = null, $edithint = null, $editlabel = null) {
395         if (empty($edithint)) {
396             $edithint = new lang_string('editsectionname', 'format_topics');
397         }
398         if (empty($editlabel)) {
399             $title = get_section_name($section->course, $section);
400             $editlabel = new lang_string('newsectionname', 'format_topics', $title);
401         }
402         return parent::inplace_editable_render_section_name($section, $linkifneeded, $editable, $edithint, $editlabel);
403     }
406 /**
407  * Implements callback inplace_editable() allowing to edit values in-place
408  *
409  * @param string $itemtype
410  * @param int $itemid
411  * @param mixed $newvalue
412  * @return \core\output\inplace_editable
413  */
414 function format_topics_inplace_editable($itemtype, $itemid, $newvalue) {
415     global $DB, $CFG;
416     require_once($CFG->dirroot . '/course/lib.php');
417     if ($itemtype === 'sectionname' || $itemtype === 'sectionnamenl') {
418         $section = $DB->get_record_sql(
419             'SELECT s.* FROM {course_sections} s JOIN {course} c ON s.course = c.id WHERE s.id = ? AND c.format = ?',
420             array($itemid, 'topics'), MUST_EXIST);
421         return course_get_format($section->course)->inplace_editable_update_section_name($section, $itemtype, $newvalue);
422     }