7c2dd9ba4f7ff0c472722856a4ff54c2b04a5f86
[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     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 /**
27  * Main class for the Weeks course format
28  *
29  * @package    format_weeks
30  * @copyright  2012 Marina Glancy
31  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32  */
33 class format_weeks extends format_base {
35     /**
36      * Returns true if this course format uses sections
37      *
38      * @return bool
39      */
40     public function uses_sections() {
41         return true;
42     }
44     /**
45      * Returns the display name of the given section that the course prefers.
46      *
47      * @param int|stdClass $section Section object from database or just field section.section
48      * @return string Display name that the course format prefers, e.g. "Topic 2"
49      */
50     public function get_section_name($section) {
51         $section = $this->get_section($section);
52         if ((string)$section->name !== '') {
53             // Return the name the user set.
54             return format_string($section->name, true, array('context' => context_course::instance($this->courseid)));
55         } else if ($section->section == 0) {
56             // Return the general section.
57             return get_string('section0name', 'format_weeks');
58         } else {
59             $dates = $this->get_section_dates($section);
61             // We subtract 24 hours for display purposes.
62             $dates->end = ($dates->end - 86400);
64             $dateformat = ' '.get_string('strftimedateshort');
65             $weekday = userdate($dates->start, $dateformat);
66             $endweekday = userdate($dates->end, $dateformat);
67             return $weekday.' - '.$endweekday;
68         }
69     }
71     /**
72      * The URL to use for the specified course (with section)
73      *
74      * @param int|stdClass $section Section object from database or just field course_sections.section
75      *     if omitted the course view page is returned
76      * @param array $options options for view URL. At the moment core uses:
77      *     'navigation' (bool) if true and section has no separate page, the function returns null
78      *     'sr' (int) used by multipage formats to specify to which section to return
79      * @return null|moodle_url
80      */
81     public function get_view_url($section, $options = array()) {
82         $course = $this->get_course();
83         $url = new moodle_url('/course/view.php', array('id' => $course->id));
85         $sr = null;
86         if (array_key_exists('sr', $options)) {
87             $sr = $options['sr'];
88         }
89         if (is_object($section)) {
90             $sectionno = $section->section;
91         } else {
92             $sectionno = $section;
93         }
94         if ($sectionno !== null) {
95             if ($sr !== null) {
96                 if ($sr) {
97                     $usercoursedisplay = COURSE_DISPLAY_MULTIPAGE;
98                     $sectionno = $sr;
99                 } else {
100                     $usercoursedisplay = COURSE_DISPLAY_SINGLEPAGE;
101                 }
102             } else {
103                 $usercoursedisplay = $course->coursedisplay;
104             }
105             if ($sectionno != 0 && $usercoursedisplay == COURSE_DISPLAY_MULTIPAGE) {
106                 $url->param('section', $sectionno);
107             } else {
108                 if (!empty($options['navigation'])) {
109                     return null;
110                 }
111                 $url->set_anchor('section-'.$sectionno);
112             }
113         }
114         return $url;
115     }
117     /**
118      * Returns the information about the ajax support in the given source format
119      *
120      * The returned object's property (boolean)capable indicates that
121      * the course format supports Moodle course ajax features.
122      * The property (array)testedbrowsers can be used as a parameter for {@link ajaxenabled()}.
123      *
124      * @return stdClass
125      */
126     public function supports_ajax() {
127         $ajaxsupport = new stdClass();
128         $ajaxsupport->capable = true;
129         $ajaxsupport->testedbrowsers = array('MSIE' => 6.0, 'Gecko' => 20061111, 'Safari' => 531, 'Chrome' => 6.0);
130         return $ajaxsupport;
131     }
133     /**
134      * Loads all of the course sections into the navigation
135      *
136      * @param global_navigation $navigation
137      * @param navigation_node $node The course node within the navigation
138      */
139     public function extend_course_navigation($navigation, navigation_node $node) {
140         global $PAGE;
141         // if section is specified in course/view.php, make sure it is expanded in navigation
142         if ($navigation->includesectionnum === false) {
143             $selectedsection = optional_param('section', null, PARAM_INT);
144             if ($selectedsection !== null && (!defined('AJAX_SCRIPT') || AJAX_SCRIPT == '0') &&
145                     $PAGE->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
146                 $navigation->includesectionnum = $selectedsection;
147             }
148         }
149         parent::extend_course_navigation($navigation, $node);
150     }
152     /**
153      * Custom action after section has been moved in AJAX mode
154      *
155      * Used in course/rest.php
156      *
157      * @return array This will be passed in ajax respose
158      */
159     function ajax_section_move() {
160         global $PAGE;
161         $titles = array();
162         $course = $this->get_course();
163         $modinfo = get_fast_modinfo($course);
164         $renderer = $this->get_renderer($PAGE);
165         if ($renderer && ($sections = $modinfo->get_section_info_all())) {
166             foreach ($sections as $number => $section) {
167                 $titles[$number] = $renderer->section_title($section, $course);
168             }
169         }
170         return array('sectiontitles' => $titles, 'action' => 'move');
171     }
173     /**
174      * Returns the list of blocks to be automatically added for the newly created course
175      *
176      * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
177      *     each of values is an array of block names (for left and right side columns)
178      */
179     public function get_default_blocks() {
180         return array(
181             BLOCK_POS_LEFT => array(),
182             BLOCK_POS_RIGHT => array('search_forums', 'news_items', 'calendar_upcoming', 'recent_activity')
183         );
184     }
186     /**
187      * Definitions of the additional options that this course format uses for course
188      *
189      * Weeks format uses the following options:
190      * - coursedisplay
191      * - numsections
192      * - hiddensections
193      *
194      * @param bool $foreditform
195      * @return array of options
196      */
197     public function course_format_options($foreditform = false) {
198         static $courseformatoptions = false;
199         if ($courseformatoptions === false) {
200             $courseconfig = get_config('moodlecourse');
201             $courseformatoptions = array(
202                 'numsections' => array(
203                     'default' => $courseconfig->numsections,
204                     'type' => PARAM_INT,
205                 ),
206                 'hiddensections' => array(
207                     'default' => $courseconfig->hiddensections,
208                     'type' => PARAM_INT,
209                 ),
210                 'coursedisplay' => array(
211                     'default' => $courseconfig->coursedisplay,
212                     'type' => PARAM_INT,
213                 ),
214             );
215         }
216         if ($foreditform && !isset($courseformatoptions['coursedisplay']['label'])) {
217             $courseconfig = get_config('moodlecourse');
218             $sectionmenu = array();
219             for ($i = 0; $i <= $courseconfig->maxsections; $i++) {
220                 $sectionmenu[$i] = "$i";
221             }
222             $courseformatoptionsedit = array(
223                 'numsections' => array(
224                     'label' => new lang_string('numberweeks'),
225                     'element_type' => 'select',
226                     'element_attributes' => array($sectionmenu),
227                 ),
228                 'hiddensections' => array(
229                     'label' => new lang_string('hiddensections'),
230                     'help' => 'hiddensections',
231                     'help_component' => 'moodle',
232                     'element_type' => 'select',
233                     'element_attributes' => array(
234                         array(
235                             0 => new lang_string('hiddensectionscollapsed'),
236                             1 => new lang_string('hiddensectionsinvisible')
237                         )
238                     ),
239                 ),
240                 'coursedisplay' => array(
241                     'label' => new lang_string('coursedisplay'),
242                     'element_type' => 'select',
243                     'element_attributes' => array(
244                         array(
245                             COURSE_DISPLAY_SINGLEPAGE => new lang_string('coursedisplay_single'),
246                             COURSE_DISPLAY_MULTIPAGE => new lang_string('coursedisplay_multi')
247                         )
248                     ),
249                     'help' => 'coursedisplay',
250                     'help_component' => 'moodle',
251                 )
252             );
253             $courseformatoptions = array_merge_recursive($courseformatoptions, $courseformatoptionsedit);
254         }
255         return $courseformatoptions;
256     }
258     /**
259      * Updates format options for a course
260      *
261      * In case if course format was changed to 'weeks', we try to copy options
262      * 'coursedisplay', 'numsections' and 'hiddensections' from the previous format.
263      * If previous course format did not have 'numsections' option, we populate it with the
264      * current number of sections
265      *
266      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
267      * @param stdClass $oldcourse if this function is called from {@link update_course()}
268      *     this object contains information about the course before update
269      * @return bool whether there were any changes to the options values
270      */
271     public function update_course_format_options($data, $oldcourse = null) {
272         if ($oldcourse !== null) {
273             $data = (array)$data;
274             $oldcourse = (array)$oldcourse;
275             $options = $this->course_format_options();
276             foreach ($options as $key => $unused) {
277                 if (!array_key_exists($key, $data)) {
278                     if (array_key_exists($key, $oldcourse)) {
279                         $data[$key] = $oldcourse[$key];
280                     } else if ($key === 'numsections') {
281                         // If previous format does not have the field 'numsections'
282                         // and $data['numsections'] is not set,
283                         // we fill it with the maximum section number from the DB
284                         $maxsection = $DB->get_field_sql('SELECT max(section) from {course_sections}
285                             WHERE course = ?', array($this->courseid));
286                         if ($maxsection) {
287                             // If there are no sections, or just default 0-section, 'numsections' will be set to default
288                             $data['numsections'] = $maxsection;
289                         }
290                     }
291                 }
292             }
293         }
294         return $this->update_format_options($data);
295     }
297     /**
298      * Return the start and end date of the passed section
299      *
300      * @param int|stdClass|section_info $section section to get the dates for
301      * @return stdClass property start for startdate, property end for enddate
302      */
303     public function get_section_dates($section) {
304         $course = $this->get_course();
305         if (is_object($section)) {
306             $sectionnum = $section->section;
307         } else {
308             $sectionnum = $section;
309         }
310         $oneweekseconds = 604800;
311         // Hack alert. We add 2 hours to avoid possible DST problems. (e.g. we go into daylight
312         // savings and the date changes.
313         $startdate = $course->startdate + 7200;
315         $dates = new stdClass();
316         $dates->start = $startdate + ($oneweekseconds * ($sectionnum - 1));
317         $dates->end = $dates->start + $oneweekseconds;
319         return $dates;
320     }
322     /**
323      * Returns true if the specified week is current
324      *
325      * @param int|stdClass|section_info $section
326      * @return bool
327      */
328     public function is_section_current($section) {
329         if (is_object($section)) {
330             $sectionnum = $section->section;
331         } else {
332             $sectionnum = $section;
333         }
334         if ($sectionnum < 1) {
335             return false;
336         }
337         $timenow = time();
338         $dates = $this->get_section_dates($section);
339         return (($timenow >= $dates->start) && ($timenow < $dates->end));
340     }