MDL-33307 format_weeks - sort out week date display
[moodle.git] / course / format / weeks / lib.php
CommitLineData
7d2a0492 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/**
18 * This file contains general functions for the course format Week
19 *
20 * @since 2.0
21 * @package moodlecore
22 * @copyright 2009 Sam Hemelryk
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
7487c856
SH
26
27/**
28 * Indicates this format uses sections.
29 *
30 * @return bool Returns true
31 */
32function callback_weeks_uses_sections() {
33 return true;
34}
35
7d2a0492 36/**
37 * Used to display the course structure for a course where format=weeks
38 *
39 * This is called automatically by {@link load_course()} if the current course
40 * format = weeks.
41 *
47c96a77 42 * @param navigation_node $navigation The course node
43 * @param array $path An array of keys to the course node
44 * @param stdClass $course The course we are loading the section for
7d2a0492 45 */
3406acde 46function callback_weeks_load_content(&$navigation, $course, $coursenode) {
0f4ab67d 47 return $navigation->load_generic_course_sections($course, $coursenode, 'weeks');
7d2a0492 48}
49
50/**
51 * The string that is used to describe a section of the course
52 * e.g. Topic, Week...
53 *
54 * @return string
55 */
56function callback_weeks_definition() {
57 return get_string('week');
58}
59
7487c856
SH
60/**
61 * Gets the name for the provided section.
62 *
63 * @param stdClass $course
64 * @param stdClass $section
65 * @return string
66 */
67function callback_weeks_get_section_name($course, $section) {
0f4ab67d
SH
68 // We can't add a node without text
69 if (!empty($section->name)) {
b6283a49
DP
70 // Return the name the user set.
71 return format_string($section->name, true, array('context' => context_course::instance($course->id)));
0f4ab67d 72 } else if ($section->section == 0) {
b6283a49 73 // Return the general section.
0f4ab67d
SH
74 return get_string('section0name', 'format_weeks');
75 } else {
b6283a49
DP
76 $dates = format_weeks_get_section_dates($section, $course);
77
78 // We subtract 24 hours for display purposes.
79 $dates->end = ($dates->end - 86400);
80
81 $dateformat = ' '.get_string('strftimedateshort');
82 $weekday = userdate($dates->start, $dateformat);
83 $endweekday = userdate($dates->end, $dateformat);
0f4ab67d
SH
84 return $weekday.' - '.$endweekday;
85 }
86}
c0b5d925
DM
87
88/**
89 * Declares support for course AJAX features
90 *
91 * @see course_format_ajax_support()
92 * @return stdClass
93 */
94function callback_weeks_ajax_support() {
95 $ajaxsupport = new stdClass();
96 $ajaxsupport->capable = true;
97 $ajaxsupport->testedbrowsers = array('MSIE' => 6.0, 'Gecko' => 20061111, 'Safari' => 531, 'Chrome' => 6.0);
98 return $ajaxsupport;
99}
b6283a49
DP
100
101/**
102 * Return the start and end date of the passed section
103 *
104 * @param stdClass $section The course_section entry from the DB
105 * @param stdClass $course The course entry from DB
106 * @return stdClass property start for startdate, property end for enddate
107 */
108function format_weeks_get_section_dates($section, $course) {
109 $oneweekseconds = 604800;
110 // Hack alert. We add 2 hours to avoid possible DST problems. (e.g. we go into daylight
111 // savings and the date changes.
112 $startdate = $course->startdate + 7200;
113
114 $dates = new stdClass();
115 $dates->start = $startdate + ($oneweekseconds * ($section->section - 1));
116 $dates->end = $dates->start + $oneweekseconds;
117
118 return $dates;
119}