MDL-55074 theme_boost: Navigation and blocks
[moodle.git] / course / format / weeks / 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 Weeks
19  *
20  * @since     Moodle 2.0
21  * @package   format_weeks
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 Weeks course format
31  *
32  * @package    format_weeks
33  * @copyright  2012 Marina Glancy
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class format_weeks 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      * @param int|stdClass $section Section object from database or just field section.section
51      * @return string Display name that the course format prefers, e.g. "Topic 2"
52      */
53     public function get_section_name($section) {
54         $section = $this->get_section($section);
55         if ((string)$section->name !== '') {
56             // Return the name the user set.
57             return format_string($section->name, true, array('context' => context_course::instance($this->courseid)));
58         } else {
59             return $this->get_default_section_name($section);
60         }
61     }
63     /**
64      * Returns the default section name for the weekly course format.
65      *
66      * If the section number is 0, it will use the string with key = section0name from the course format's lang file.
67      * Otherwise, the default format of "[start date] - [end date]" will be returned.
68      *
69      * @param stdClass $section Section object from database or just field course_sections section
70      * @return string The default value for the section name.
71      */
72     public function get_default_section_name($section) {
73         if ($section->section == 0) {
74             // Return the general section.
75             return get_string('section0name', 'format_weeks');
76         } else {
77             $dates = $this->get_section_dates($section);
79             // We subtract 24 hours for display purposes.
80             $dates->end = ($dates->end - 86400);
82             $dateformat = get_string('strftimedateshort');
83             $weekday = userdate($dates->start, $dateformat);
84             $endweekday = userdate($dates->end, $dateformat);
85             return $weekday.' - '.$endweekday;
86         }
87     }
89     /**
90      * The URL to use for the specified course (with section)
91      *
92      * @param int|stdClass $section Section object from database or just field course_sections.section
93      *     if omitted the course view page is returned
94      * @param array $options options for view URL. At the moment core uses:
95      *     'navigation' (bool) if true and section has no separate page, the function returns null
96      *     'sr' (int) used by multipage formats to specify to which section to return
97      * @return null|moodle_url
98      */
99     public function get_view_url($section, $options = array()) {
100         global $CFG;
101         $course = $this->get_course();
102         $url = new moodle_url('/course/view.php', array('id' => $course->id));
104         $sr = null;
105         if (array_key_exists('sr', $options)) {
106             $sr = $options['sr'];
107         }
108         if (is_object($section)) {
109             $sectionno = $section->section;
110         } else {
111             $sectionno = $section;
112         }
113         if ($sectionno !== null) {
114             if ($sr !== null) {
115                 if ($sr) {
116                     $usercoursedisplay = COURSE_DISPLAY_MULTIPAGE;
117                     $sectionno = $sr;
118                 } else {
119                     $usercoursedisplay = COURSE_DISPLAY_SINGLEPAGE;
120                 }
121             } else {
122                 $usercoursedisplay = $course->coursedisplay;
123             }
124             if ($sectionno != 0 && $usercoursedisplay == COURSE_DISPLAY_MULTIPAGE) {
125                 $url->param('section', $sectionno);
126             } else {
127                 $url->set_anchor('section-'.$sectionno);
128             }
129         }
130         return $url;
131     }
133     /**
134      * Returns the information about the ajax support in the given source format
135      *
136      * The returned object's property (boolean)capable indicates that
137      * the course format supports Moodle course ajax features.
138      *
139      * @return stdClass
140      */
141     public function supports_ajax() {
142         $ajaxsupport = new stdClass();
143         $ajaxsupport->capable = true;
144         return $ajaxsupport;
145     }
147     /**
148      * Loads all of the course sections into the navigation
149      *
150      * @param global_navigation $navigation
151      * @param navigation_node $node The course node within the navigation
152      */
153     public function extend_course_navigation($navigation, navigation_node $node) {
154         global $PAGE;
155         // if section is specified in course/view.php, make sure it is expanded in navigation
156         if ($navigation->includesectionnum === false) {
157             $selectedsection = optional_param('section', null, PARAM_INT);
158             if ($selectedsection !== null && (!defined('AJAX_SCRIPT') || AJAX_SCRIPT == '0') &&
159                     $PAGE->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
160                 $navigation->includesectionnum = $selectedsection;
161             }
162         }
163         parent::extend_course_navigation($navigation, $node);
165         // We want to remove the general section if it is empty.
166         $modinfo = get_fast_modinfo($this->get_course());
167         $sections = $modinfo->get_sections();
168         if (!isset($sections[0])) {
169             // The general section is empty to find the navigation node for it we need to get its ID.
170             $section = $modinfo->get_section_info(0);
171             $generalsection = $node->get($section->id, navigation_node::TYPE_SECTION);
172             if ($generalsection) {
173                 // We found the node - now remove it.
174                 $generalsection->remove();
175             }
176         }
177     }
179     /**
180      * Custom action after section has been moved in AJAX mode
181      *
182      * Used in course/rest.php
183      *
184      * @return array This will be passed in ajax respose
185      */
186     function ajax_section_move() {
187         global $PAGE;
188         $titles = array();
189         $current = -1;
190         $course = $this->get_course();
191         $modinfo = get_fast_modinfo($course);
192         $renderer = $this->get_renderer($PAGE);
193         if ($renderer && ($sections = $modinfo->get_section_info_all())) {
194             foreach ($sections as $number => $section) {
195                 $titles[$number] = $renderer->section_title($section, $course);
196                 if ($this->is_section_current($section)) {
197                     $current = $number;
198                 }
199             }
200         }
201         return array('sectiontitles' => $titles, 'current' => $current, 'action' => 'move');
202     }
204     /**
205      * Returns the list of blocks to be automatically added for the newly created course
206      *
207      * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
208      *     each of values is an array of block names (for left and right side columns)
209      */
210     public function get_default_blocks() {
211         return array(
212             BLOCK_POS_LEFT => array(),
213             BLOCK_POS_RIGHT => array('search_forums', 'news_items', 'calendar_upcoming', 'recent_activity')
214         );
215     }
217     /**
218      * Definitions of the additional options that this course format uses for course
219      *
220      * Weeks format uses the following options:
221      * - coursedisplay
222      * - numsections
223      * - hiddensections
224      *
225      * @param bool $foreditform
226      * @return array of options
227      */
228     public function course_format_options($foreditform = false) {
229         static $courseformatoptions = false;
230         if ($courseformatoptions === false) {
231             $courseconfig = get_config('moodlecourse');
232             $courseformatoptions = array(
233                 'numsections' => array(
234                     'default' => $courseconfig->numsections,
235                     'type' => PARAM_INT,
236                 ),
237                 'hiddensections' => array(
238                     'default' => $courseconfig->hiddensections,
239                     'type' => PARAM_INT,
240                 ),
241                 'coursedisplay' => array(
242                     'default' => $courseconfig->coursedisplay,
243                     'type' => PARAM_INT,
244                 ),
245             );
246         }
247         if ($foreditform && !isset($courseformatoptions['coursedisplay']['label'])) {
248             $courseconfig = get_config('moodlecourse');
249             $sectionmenu = array();
250             $max = $courseconfig->maxsections;
251             if (!isset($max) || !is_numeric($max)) {
252                 $max = 52;
253             }
254             for ($i = 0; $i <= $max; $i++) {
255                 $sectionmenu[$i] = "$i";
256             }
257             $courseformatoptionsedit = array(
258                 'numsections' => array(
259                     'label' => new lang_string('numberweeks'),
260                     'element_type' => 'select',
261                     'element_attributes' => array($sectionmenu),
262                 ),
263                 'hiddensections' => array(
264                     'label' => new lang_string('hiddensections'),
265                     'help' => 'hiddensections',
266                     'help_component' => 'moodle',
267                     'element_type' => 'select',
268                     'element_attributes' => array(
269                         array(
270                             0 => new lang_string('hiddensectionscollapsed'),
271                             1 => new lang_string('hiddensectionsinvisible')
272                         )
273                     ),
274                 ),
275                 'coursedisplay' => array(
276                     'label' => new lang_string('coursedisplay'),
277                     'element_type' => 'select',
278                     'element_attributes' => array(
279                         array(
280                             COURSE_DISPLAY_SINGLEPAGE => new lang_string('coursedisplay_single'),
281                             COURSE_DISPLAY_MULTIPAGE => new lang_string('coursedisplay_multi')
282                         )
283                     ),
284                     'help' => 'coursedisplay',
285                     'help_component' => 'moodle',
286                 )
287             );
288             $courseformatoptions = array_merge_recursive($courseformatoptions, $courseformatoptionsedit);
289         }
290         return $courseformatoptions;
291     }
293     /**
294      * Adds format options elements to the course/section edit form.
295      *
296      * This function is called from {@link course_edit_form::definition_after_data()}.
297      *
298      * @param MoodleQuickForm $mform form the elements are added to.
299      * @param bool $forsection 'true' if this is a section edit form, 'false' if this is course edit form.
300      * @return array array of references to the added form elements.
301      */
302     public function create_edit_form_elements(&$mform, $forsection = false) {
303         $elements = parent::create_edit_form_elements($mform, $forsection);
305         // Increase the number of sections combo box values if the user has increased the number of sections
306         // using the icon on the course page beyond course 'maxsections' or course 'maxsections' has been
307         // reduced below the number of sections already set for the course on the site administration course
308         // defaults page.  This is so that the number of sections is not reduced leaving unintended orphaned
309         // activities / resources.
310         if (!$forsection) {
311             $maxsections = get_config('moodlecourse', 'maxsections');
312             $numsections = $mform->getElementValue('numsections');
313             $numsections = $numsections[0];
314             if ($numsections > $maxsections) {
315                 $element = $mform->getElement('numsections');
316                 for ($i = $maxsections+1; $i <= $numsections; $i++) {
317                     $element->addOption("$i", $i);
318                 }
319             }
320         }
321         return $elements;
322     }
324     /**
325      * Updates format options for a course
326      *
327      * In case if course format was changed to 'weeks', we try to copy options
328      * 'coursedisplay', 'numsections' and 'hiddensections' from the previous format.
329      * If previous course format did not have 'numsections' option, we populate it with the
330      * current number of sections
331      *
332      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
333      * @param stdClass $oldcourse if this function is called from {@link update_course()}
334      *     this object contains information about the course before update
335      * @return bool whether there were any changes to the options values
336      */
337     public function update_course_format_options($data, $oldcourse = null) {
338         global $DB;
339         $data = (array)$data;
340         if ($oldcourse !== null) {
341             $oldcourse = (array)$oldcourse;
342             $options = $this->course_format_options();
343             foreach ($options as $key => $unused) {
344                 if (!array_key_exists($key, $data)) {
345                     if (array_key_exists($key, $oldcourse)) {
346                         $data[$key] = $oldcourse[$key];
347                     } else if ($key === 'numsections') {
348                         // If previous format does not have the field 'numsections'
349                         // and $data['numsections'] is not set,
350                         // we fill it with the maximum section number from the DB
351                         $maxsection = $DB->get_field_sql('SELECT max(section) from {course_sections}
352                             WHERE course = ?', array($this->courseid));
353                         if ($maxsection) {
354                             // If there are no sections, or just default 0-section, 'numsections' will be set to default
355                             $data['numsections'] = $maxsection;
356                         }
357                     }
358                 }
359             }
360         }
361         $changed = $this->update_format_options($data);
362         if ($changed && array_key_exists('numsections', $data)) {
363             // If the numsections was decreased, try to completely delete the orphaned sections (unless they are not empty).
364             $numsections = (int)$data['numsections'];
365             $maxsection = $DB->get_field_sql('SELECT max(section) from {course_sections}
366                         WHERE course = ?', array($this->courseid));
367             for ($sectionnum = $maxsection; $sectionnum > $numsections; $sectionnum--) {
368                 if (!$this->delete_section($sectionnum, false)) {
369                     break;
370                 }
371             }
372         }
373         return $changed;
374     }
376     /**
377      * Return the start and end date of the passed section
378      *
379      * @param int|stdClass|section_info $section section to get the dates for
380      * @param int $startdate Force course start date, useful when the course is not yet created
381      * @return stdClass property start for startdate, property end for enddate
382      */
383     public function get_section_dates($section, $startdate = false) {
385         if ($startdate === false) {
386             $course = $this->get_course();
387             $startdate = $course->startdate;
388         }
390         if (is_object($section)) {
391             $sectionnum = $section->section;
392         } else {
393             $sectionnum = $section;
394         }
395         $oneweekseconds = 604800;
396         // Hack alert. We add 2 hours to avoid possible DST problems. (e.g. we go into daylight
397         // savings and the date changes.
398         $startdate = $startdate + 7200;
400         $dates = new stdClass();
401         $dates->start = $startdate + ($oneweekseconds * ($sectionnum - 1));
402         $dates->end = $dates->start + $oneweekseconds;
404         return $dates;
405     }
407     /**
408      * Returns true if the specified week is current
409      *
410      * @param int|stdClass|section_info $section
411      * @return bool
412      */
413     public function is_section_current($section) {
414         if (is_object($section)) {
415             $sectionnum = $section->section;
416         } else {
417             $sectionnum = $section;
418         }
419         if ($sectionnum < 1) {
420             return false;
421         }
422         $timenow = time();
423         $dates = $this->get_section_dates($section);
424         return (($timenow >= $dates->start) && ($timenow < $dates->end));
425     }
427     /**
428      * Whether this format allows to delete sections
429      *
430      * Do not call this function directly, instead use {@link course_can_delete_section()}
431      *
432      * @param int|stdClass|section_info $section
433      * @return bool
434      */
435     public function can_delete_section($section) {
436         return true;
437     }
439     /**
440      * Prepares the templateable object to display section name
441      *
442      * @param \section_info|\stdClass $section
443      * @param bool $linkifneeded
444      * @param bool $editable
445      * @param null|lang_string|string $edithint
446      * @param null|lang_string|string $editlabel
447      * @return \core\output\inplace_editable
448      */
449     public function inplace_editable_render_section_name($section, $linkifneeded = true,
450                                                          $editable = null, $edithint = null, $editlabel = null) {
451         if (empty($edithint)) {
452             $edithint = new lang_string('editsectionname', 'format_weeks');
453         }
454         if (empty($editlabel)) {
455             $title = get_section_name($section->course, $section);
456             $editlabel = new lang_string('newsectionname', 'format_weeks', $title);
457         }
458         return parent::inplace_editable_render_section_name($section, $linkifneeded, $editable, $edithint, $editlabel);
459     }
461     /**
462      * Returns the default end date for weeks course format.
463      *
464      * @param moodleform $mform
465      * @param array $fieldnames The form - field names mapping.
466      * @return int
467      */
468     public function get_default_course_enddate($mform, $fieldnames = array()) {
470         if (empty($fieldnames['startdate'])) {
471             $fieldnames['startdate'] = 'startdate';
472         }
474         if (empty($fieldnames['numsections'])) {
475             $fieldnames['numsections'] = 'numsections';
476         }
478         $startdate = $this->get_form_start_date($mform, $fieldnames);
479         if ($mform->elementExists($fieldnames['numsections'])) {
480             $numsections = $mform->getElementValue($fieldnames['numsections']);
481             $numsections = $mform->getElement($fieldnames['numsections'])->exportValue($numsections);
482         } else {
483             // Fallback to the default value for new courses.
484             $numsections = get_config('moodlecourse', $fieldnames['numsections']);
485         }
487         // Final week's last day.
488         $dates = $this->get_section_dates(intval($numsections), $startdate);
489         return $dates->end;
490     }
493 /**
494  * Implements callback inplace_editable() allowing to edit values in-place
495  *
496  * @param string $itemtype
497  * @param int $itemid
498  * @param mixed $newvalue
499  * @return \core\output\inplace_editable
500  */
501 function format_weeks_inplace_editable($itemtype, $itemid, $newvalue) {
502     global $DB, $CFG;
503     require_once($CFG->dirroot . '/course/lib.php');
504     if ($itemtype === 'sectionname' || $itemtype === 'sectionnamenl') {
505         $section = $DB->get_record_sql(
506             'SELECT s.* FROM {course_sections} s JOIN {course} c ON s.course = c.id WHERE s.id = ? AND c.format = ?',
507             array($itemid, 'weeks'), MUST_EXIST);
508         return course_get_format($section->course)->inplace_editable_update_section_name($section, $itemtype, $newvalue);
509     }