8789fbf2ad61de52ad72a326582cd23c18139b71
[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()
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      * - hiddensections
223      * - automaticenddate
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                 'hiddensections' => array(
234                     'default' => $courseconfig->hiddensections,
235                     'type' => PARAM_INT,
236                 ),
237                 'coursedisplay' => array(
238                     'default' => $courseconfig->coursedisplay,
239                     'type' => PARAM_INT,
240                 ),
241                 'automaticenddate' => array(
242                     'default' => 1,
243                     'type' => PARAM_BOOL,
244                 ),
245             );
246         }
247         if ($foreditform && !isset($courseformatoptions['coursedisplay']['label'])) {
248             $courseformatoptionsedit = array(
249                 'hiddensections' => array(
250                     'label' => new lang_string('hiddensections'),
251                     'help' => 'hiddensections',
252                     'help_component' => 'moodle',
253                     'element_type' => 'select',
254                     'element_attributes' => array(
255                         array(
256                             0 => new lang_string('hiddensectionscollapsed'),
257                             1 => new lang_string('hiddensectionsinvisible')
258                         )
259                     ),
260                 ),
261                 'coursedisplay' => array(
262                     'label' => new lang_string('coursedisplay'),
263                     'element_type' => 'select',
264                     'element_attributes' => array(
265                         array(
266                             COURSE_DISPLAY_SINGLEPAGE => new lang_string('coursedisplay_single'),
267                             COURSE_DISPLAY_MULTIPAGE => new lang_string('coursedisplay_multi')
268                         )
269                     ),
270                     'help' => 'coursedisplay',
271                     'help_component' => 'moodle',
272                 ),
273                 'automaticenddate' => array(
274                     'label' => new lang_string('automaticenddate', 'format_weeks'),
275                     'help' => 'automaticenddate',
276                     'help_component' => 'format_weeks',
277                     'element_type' => 'advcheckbox',
278                 )
279             );
280             $courseformatoptions = array_merge_recursive($courseformatoptions, $courseformatoptionsedit);
281         }
282         return $courseformatoptions;
283     }
285     /**
286      * Adds format options elements to the course/section edit form.
287      *
288      * This function is called from {@link course_edit_form::definition_after_data()}.
289      *
290      * @param MoodleQuickForm $mform form the elements are added to.
291      * @param bool $forsection 'true' if this is a section edit form, 'false' if this is course edit form.
292      * @return array array of references to the added form elements.
293      */
294     public function create_edit_form_elements(&$mform, $forsection = false) {
295         global $COURSE;
296         $elements = parent::create_edit_form_elements($mform, $forsection);
298         if (!$forsection && (empty($COURSE->id) || $COURSE->id == SITEID)) {
299             // Add "numsections" element to the create course form - it will force new course to be prepopulated
300             // with empty sections.
301             // The "Number of sections" option is no longer available when editing course, instead teachers should
302             // delete and add sections when needed.
303             $courseconfig = get_config('moodlecourse');
304             $max = (int)$courseconfig->maxsections;
305             $element = $mform->addElement('select', 'numsections', get_string('numberweeks'), range(0, $max ?: 52));
306             $mform->setType('numsections', PARAM_INT);
307             if (is_null($mform->getElementValue('numsections'))) {
308                 $mform->setDefault('numsections', $courseconfig->numsections);
309             }
310             array_unshift($elements, $element);
311         }
313         // Re-order things.
314         $mform->insertElementBefore($mform->removeElement('automaticenddate', false), 'idnumber');
315         $mform->disabledIf('enddate', 'automaticenddate', 'checked');
316         foreach ($elements as $key => $element) {
317             if ($element->getName() == 'automaticenddate') {
318                 unset($elements[$key]);
319             }
320         }
322         return $elements;
323     }
325     /**
326      * Updates format options for a course
327      *
328      * In case if course format was changed to 'weeks', we try to copy options
329      * 'coursedisplay', 'numsections' and 'hiddensections' from the previous format.
330      * If previous course format did not have 'numsections' option, we populate it with the
331      * current number of sections
332      *
333      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
334      * @param stdClass $oldcourse if this function is called from {@link update_course()}
335      *     this object contains information about the course before update
336      * @return bool whether there were any changes to the options values
337      */
338     public function update_course_format_options($data, $oldcourse = null) {
339         global $DB;
340         $data = (array)$data;
341         if ($oldcourse !== null) {
342             $oldcourse = (array)$oldcourse;
343             $options = $this->course_format_options();
344             foreach ($options as $key => $unused) {
345                 if (!array_key_exists($key, $data)) {
346                     if (array_key_exists($key, $oldcourse)) {
347                         $data[$key] = $oldcourse[$key];
348                     }
349                 }
350             }
351         }
352         return $this->update_format_options($data);
353     }
355     /**
356      * Return the start and end date of the passed section
357      *
358      * @param int|stdClass|section_info $section section to get the dates for
359      * @param int $startdate Force course start date, useful when the course is not yet created
360      * @return stdClass property start for startdate, property end for enddate
361      */
362     public function get_section_dates($section, $startdate = false) {
364         if ($startdate === false) {
365             $course = $this->get_course();
366             $startdate = $course->startdate;
367         }
369         if (is_object($section)) {
370             $sectionnum = $section->section;
371         } else {
372             $sectionnum = $section;
373         }
374         $oneweekseconds = 604800;
375         // Hack alert. We add 2 hours to avoid possible DST problems. (e.g. we go into daylight
376         // savings and the date changes.
377         $startdate = $startdate + 7200;
379         $dates = new stdClass();
380         $dates->start = $startdate + ($oneweekseconds * ($sectionnum - 1));
381         $dates->end = $dates->start + $oneweekseconds;
383         return $dates;
384     }
386     /**
387      * Returns true if the specified week is current
388      *
389      * @param int|stdClass|section_info $section
390      * @return bool
391      */
392     public function is_section_current($section) {
393         if (is_object($section)) {
394             $sectionnum = $section->section;
395         } else {
396             $sectionnum = $section;
397         }
398         if ($sectionnum < 1) {
399             return false;
400         }
401         $timenow = time();
402         $dates = $this->get_section_dates($section);
403         return (($timenow >= $dates->start) && ($timenow < $dates->end));
404     }
406     /**
407      * Whether this format allows to delete sections
408      *
409      * Do not call this function directly, instead use {@link course_can_delete_section()}
410      *
411      * @param int|stdClass|section_info $section
412      * @return bool
413      */
414     public function can_delete_section($section) {
415         return true;
416     }
418     /**
419      * Prepares the templateable object to display section name
420      *
421      * @param \section_info|\stdClass $section
422      * @param bool $linkifneeded
423      * @param bool $editable
424      * @param null|lang_string|string $edithint
425      * @param null|lang_string|string $editlabel
426      * @return \core\output\inplace_editable
427      */
428     public function inplace_editable_render_section_name($section, $linkifneeded = true,
429                                                          $editable = null, $edithint = null, $editlabel = null) {
430         if (empty($edithint)) {
431             $edithint = new lang_string('editsectionname', 'format_weeks');
432         }
433         if (empty($editlabel)) {
434             $title = get_section_name($section->course, $section);
435             $editlabel = new lang_string('newsectionname', 'format_weeks', $title);
436         }
437         return parent::inplace_editable_render_section_name($section, $linkifneeded, $editable, $edithint, $editlabel);
438     }
440     /**
441      * Returns the default end date for weeks course format.
442      *
443      * @param moodleform $mform
444      * @param array $fieldnames The form - field names mapping.
445      * @return int
446      */
447     public function get_default_course_enddate($mform, $fieldnames = array()) {
449         if (empty($fieldnames['startdate'])) {
450             $fieldnames['startdate'] = 'startdate';
451         }
453         if (empty($fieldnames['numsections'])) {
454             $fieldnames['numsections'] = 'numsections';
455         }
457         $startdate = $this->get_form_start_date($mform, $fieldnames);
458         if ($mform->elementExists($fieldnames['numsections'])) {
459             $numsections = $mform->getElementValue($fieldnames['numsections']);
460             $numsections = $mform->getElement($fieldnames['numsections'])->exportValue($numsections);
461         } else if ($this->get_courseid()) {
462             // For existing courses get the number of sections.
463             $numsections = $this->get_last_section_number();
464         } else {
465             // Fallback to the default value for new courses.
466             $numsections = get_config('moodlecourse', $fieldnames['numsections']);
467         }
469         // Final week's last day.
470         $dates = $this->get_section_dates(intval($numsections), $startdate);
471         return $dates->end;
472     }
474     /**
475      * Indicates whether the course format supports the creation of a news forum.
476      *
477      * @return bool
478      */
479     public function supports_news() {
480         return true;
481     }
483     /**
484      * Returns whether this course format allows the activity to
485      * have "triple visibility state" - visible always, hidden on course page but available, hidden.
486      *
487      * @param stdClass|cm_info $cm course module (may be null if we are displaying a form for adding a module)
488      * @param stdClass|section_info $section section where this module is located or will be added to
489      * @return bool
490      */
491     public function allow_stealth_module_visibility($cm, $section) {
492         // Allow the third visibility state inside visible sections or in section 0.
493         return !$section->section || $section->visible;
494     }
496     public function section_action($section, $action, $sr) {
497         global $PAGE;
499         // Call the parent method and return the new content for .section_availability element.
500         $rv = parent::section_action($section, $action, $sr);
501         $renderer = $PAGE->get_renderer('format_weeks');
502         $rv['section_availability'] = $renderer->section_availability($this->get_section($section));
503         return $rv;
504     }
506     /**
507      * Updates the end date for a course.
508      */
509     public function update_end_date() {
510         global $DB;
512         $options = $this->get_format_options();
513         // Check that the course format for setting an automatic date is set.
514         if (!empty($options['automaticenddate'])) {
515             // Now, check how many sections for this course were created.
516             $numsections = $DB->count_records('course_sections', array('course' => $this->get_courseid()));
518             // The first section is not a week related section, it is the 'General' section which can not be deleted.
519             $numsections--;
521             // Get the final week's last day.
522             $dates = $this->get_section_dates($numsections);
524             // Set the course end date.
525             $DB->set_field('course', 'enddate', $dates->end, array('id' => $this->get_courseid()));
526         }
527     }
530 /**
531  * Implements callback inplace_editable() allowing to edit values in-place
532  *
533  * @param string $itemtype
534  * @param int $itemid
535  * @param mixed $newvalue
536  * @return \core\output\inplace_editable
537  */
538 function format_weeks_inplace_editable($itemtype, $itemid, $newvalue) {
539     global $DB, $CFG;
540     require_once($CFG->dirroot . '/course/lib.php');
541     if ($itemtype === 'sectionname' || $itemtype === 'sectionnamenl') {
542         $section = $DB->get_record_sql(
543             'SELECT s.* FROM {course_sections} s JOIN {course} c ON s.course = c.id WHERE s.id = ? AND c.format = ?',
544             array($itemid, 'weeks'), MUST_EXIST);
545         return course_get_format($section->course)->inplace_editable_update_section_name($section, $itemtype, $newvalue);
546     }