9201c9e2d6f75dc08f567fb8c4e47e68e25fad29
[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 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  */
27 /**
28  * Indicates this format uses sections.
29  *
30  * @return bool Returns true
31  */
32 function callback_weeks_uses_sections() {
33     return true;
34 }
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  *
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
45  */
46 function callback_weeks_load_content(&$navigation, $course, $coursenode) {
47     return $navigation->load_generic_course_sections($course, $coursenode, 'weeks');
48 }
50 /**
51  * The string that is used to describe a section of the course
52  * e.g. Topic, Week...
53  *
54  * @return string
55  */
56 function callback_weeks_definition() {
57     return get_string('week');
58 }
60 /**
61  * Gets the name for the provided section.
62  *
63  * @param stdClass $course
64  * @param stdClass $section
65  * @return string
66  */
67 function callback_weeks_get_section_name($course, $section) {
68     // We can't add a node without text
69     if (!empty($section->name)) {
70         // Return the name the user set
71         return format_string($section->name, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
72     } else if ($section->section == 0) {
73         // Return the section0name
74         return get_string('section0name', 'format_weeks');
75     } else {
76         // Got to work out the date of the week so that we can show it
77         $sections = get_all_sections($course->id);
78         $weekdate = $course->startdate+7200;
79         foreach ($sections as $sec) {
80             if ($sec->id == $section->id) {
81                 break;
82             } else if ($sec->section != 0) {
83                 $weekdate += 604800;
84             }
85         }
86         $strftimedateshort = ' '.get_string('strftimedateshort');
87         $weekday = userdate($weekdate, $strftimedateshort);
88         $endweekday = userdate($weekdate+518400, $strftimedateshort);
89         return $weekday.' - '.$endweekday;
90     }
91 }
93 /**
94  * Declares support for course AJAX features
95  *
96  * @see course_format_ajax_support()
97  * @return stdClass
98  */
99 function callback_weeks_ajax_support() {
100     $ajaxsupport = new stdClass();
101     $ajaxsupport->capable = true;
102     $ajaxsupport->testedbrowsers = array('MSIE' => 6.0, 'Gecko' => 20061111, 'Safari' => 531, 'Chrome' => 6.0);
103     return $ajaxsupport;