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