Merge branch 'wip-MDL-56439-master' of git://github.com/marinaglancy/moodle
[moodle.git] / course / format / 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  * Base class for course format plugins
19  *
20  * @package    core_course
21  * @copyright  2012 Marina Glancy
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die;
27 /**
28  * Returns an instance of format class (extending format_base) for given course
29  *
30  * @param int|stdClass $courseorid either course id or
31  *     an object that has the property 'format' and may contain property 'id'
32  * @return format_base
33  */
34 function course_get_format($courseorid) {
35     return format_base::instance($courseorid);
36 }
38 /**
39  * Base class for course formats
40  *
41  * Each course format must declare class
42  * class format_FORMATNAME extends format_base {}
43  * in file lib.php
44  *
45  * For each course just one instance of this class is created and it will always be returned by
46  * course_get_format($courseorid). Format may store it's specific course-dependent options in
47  * variables of this class.
48  *
49  * In rare cases instance of child class may be created just for format without course id
50  * i.e. to check if format supports AJAX.
51  *
52  * Also course formats may extend class section_info and overwrite
53  * format_base::build_section_cache() to return more information about sections.
54  *
55  * If you are upgrading from Moodle 2.3 start with copying the class format_legacy and renaming
56  * it to format_FORMATNAME, then move the code from your callback functions into
57  * appropriate functions of the class.
58  *
59  * @package    core_course
60  * @copyright  2012 Marina Glancy
61  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
62  */
63 abstract class format_base {
64     /** @var int Id of the course in this instance (maybe 0) */
65     protected $courseid;
66     /** @var string format used for this course. Please note that it can be different from
67      * course.format field if course referes to non-existing of disabled format */
68     protected $format;
69     /** @var stdClass data for course object, please use {@link format_base::get_course()} */
70     protected $course = false;
71     /** @var array caches format options, please use {@link format_base::get_format_options()} */
72     protected $formatoptions = array();
73     /** @var array cached instances */
74     private static $instances = array();
75     /** @var array plugin name => class name. */
76     private static $classesforformat = array('site' => 'site');
78     /**
79      * Creates a new instance of class
80      *
81      * Please use {@link course_get_format($courseorid)} to get an instance of the format class
82      *
83      * @param string $format
84      * @param int $courseid
85      * @return format_base
86      */
87     protected function __construct($format, $courseid) {
88         $this->format = $format;
89         $this->courseid = $courseid;
90     }
92     /**
93      * Validates that course format exists and enabled and returns either itself or default format
94      *
95      * @param string $format
96      * @return string
97      */
98     protected static final function get_format_or_default($format) {
99         global $CFG;
100         require_once($CFG->dirroot . '/course/lib.php');
102         if (array_key_exists($format, self::$classesforformat)) {
103             return self::$classesforformat[$format];
104         }
106         $plugins = get_sorted_course_formats();
107         foreach ($plugins as $plugin) {
108             self::$classesforformat[$plugin] = $plugin;
109         }
111         if (array_key_exists($format, self::$classesforformat)) {
112             return self::$classesforformat[$format];
113         }
115         if (PHPUNIT_TEST && class_exists('format_' . $format)) {
116             // Allow unittests to use non-existing course formats.
117             return $format;
118         }
120         // Else return default format
121         $defaultformat = get_config('moodlecourse', 'format');
122         if (!in_array($defaultformat, $plugins)) {
123             // when default format is not set correctly, use the first available format
124             $defaultformat = reset($plugins);
125         }
126         debugging('Format plugin format_'.$format.' is not found. Using default format_'.$defaultformat, DEBUG_DEVELOPER);
128         self::$classesforformat[$format] = $defaultformat;
129         return $defaultformat;
130     }
132     /**
133      * Get class name for the format
134      *
135      * If course format xxx does not declare class format_xxx, format_legacy will be returned.
136      * This function also includes lib.php file from corresponding format plugin
137      *
138      * @param string $format
139      * @return string
140      */
141     protected static final function get_class_name($format) {
142         global $CFG;
143         static $classnames = array('site' => 'format_site');
144         if (!isset($classnames[$format])) {
145             $plugins = core_component::get_plugin_list('format');
146             $usedformat = self::get_format_or_default($format);
147             if (isset($plugins[$usedformat]) && file_exists($plugins[$usedformat].'/lib.php')) {
148                 require_once($plugins[$usedformat].'/lib.php');
149             }
150             $classnames[$format] = 'format_'. $usedformat;
151             if (!class_exists($classnames[$format])) {
152                 require_once($CFG->dirroot.'/course/format/formatlegacy.php');
153                 $classnames[$format] = 'format_legacy';
154             }
155         }
156         return $classnames[$format];
157     }
159     /**
160      * Returns an instance of the class
161      *
162      * @todo MDL-35727 use MUC for caching of instances, limit the number of cached instances
163      *
164      * @param int|stdClass $courseorid either course id or
165      *     an object that has the property 'format' and may contain property 'id'
166      * @return format_base
167      */
168     public static final function instance($courseorid) {
169         global $DB;
170         if (!is_object($courseorid)) {
171             $courseid = (int)$courseorid;
172             if ($courseid && isset(self::$instances[$courseid]) && count(self::$instances[$courseid]) == 1) {
173                 $formats = array_keys(self::$instances[$courseid]);
174                 $format = reset($formats);
175             } else {
176                 $format = $DB->get_field('course', 'format', array('id' => $courseid), MUST_EXIST);
177             }
178         } else {
179             $format = $courseorid->format;
180             if (isset($courseorid->id)) {
181                 $courseid = clean_param($courseorid->id, PARAM_INT);
182             } else {
183                 $courseid = 0;
184             }
185         }
186         // validate that format exists and enabled, use default otherwise
187         $format = self::get_format_or_default($format);
188         if (!isset(self::$instances[$courseid][$format])) {
189             $classname = self::get_class_name($format);
190             self::$instances[$courseid][$format] = new $classname($format, $courseid);
191         }
192         return self::$instances[$courseid][$format];
193     }
195     /**
196      * Resets cache for the course (or all caches)
197      * To be called from {@link rebuild_course_cache()}
198      *
199      * @param int $courseid
200      */
201     public static final function reset_course_cache($courseid = 0) {
202         if ($courseid) {
203             if (isset(self::$instances[$courseid])) {
204                 foreach (self::$instances[$courseid] as $format => $object) {
205                     // in case somebody keeps the reference to course format object
206                     self::$instances[$courseid][$format]->course = false;
207                     self::$instances[$courseid][$format]->formatoptions = array();
208                 }
209                 unset(self::$instances[$courseid]);
210             }
211         } else {
212             self::$instances = array();
213         }
214     }
216     /**
217      * Returns the format name used by this course
218      *
219      * @return string
220      */
221     public final function get_format() {
222         return $this->format;
223     }
225     /**
226      * Returns id of the course (0 if course is not specified)
227      *
228      * @return int
229      */
230     public final function get_courseid() {
231         return $this->courseid;
232     }
234     /**
235      * Returns a record from course database table plus additional fields
236      * that course format defines
237      *
238      * @return stdClass
239      */
240     public function get_course() {
241         global $DB;
242         if (!$this->courseid) {
243             return null;
244         }
245         if ($this->course === false) {
246             $this->course = get_course($this->courseid);
247             $options = $this->get_format_options();
248             $dbcoursecolumns = null;
249             foreach ($options as $optionname => $optionvalue) {
250                 if (isset($this->course->$optionname)) {
251                     // Course format options must not have the same names as existing columns in db table "course".
252                     if (!isset($dbcoursecolumns)) {
253                         $dbcoursecolumns = $DB->get_columns('course');
254                     }
255                     if (isset($dbcoursecolumns[$optionname])) {
256                         debugging('The option name '.$optionname.' in course format '.$this->format.
257                             ' is invalid because the field with the same name exists in {course} table',
258                             DEBUG_DEVELOPER);
259                         continue;
260                     }
261                 }
262                 $this->course->$optionname = $optionvalue;
263             }
264         }
265         return $this->course;
266     }
268     /**
269      * Returns true if the course has a front page.
270      *
271      * This function is called to determine if the course has a view page, whether or not
272      * it contains a listing of activities. It can be useful to set this to false when the course
273      * format has only one activity and ignores the course page. Or if there are multiple
274      * activities but no page to see the centralised information.
275      *
276      * Initially this was created to know if forms should add a button to return to the course page.
277      * So if 'Return to course' does not make sense in your format your should probably return false.
278      *
279      * @return boolean
280      * @since Moodle 2.6
281      */
282     public function has_view_page() {
283         return true;
284     }
286     /**
287      * Returns true if this course format uses sections
288      *
289      * This function may be called without specifying the course id
290      * i.e. in {@link course_format_uses_sections()}
291      *
292      * Developers, note that if course format does use sections there should be defined a language
293      * string with the name 'sectionname' defining what the section relates to in the format, i.e.
294      * $string['sectionname'] = 'Topic';
295      * or
296      * $string['sectionname'] = 'Week';
297      *
298      * @return bool
299      */
300     public function uses_sections() {
301         return false;
302     }
304     /**
305      * Returns a list of sections used in the course
306      *
307      * This is a shortcut to get_fast_modinfo()->get_section_info_all()
308      * @see get_fast_modinfo()
309      * @see course_modinfo::get_section_info_all()
310      *
311      * @return array of section_info objects
312      */
313     public final function get_sections() {
314         if ($course = $this->get_course()) {
315             $modinfo = get_fast_modinfo($course);
316             return $modinfo->get_section_info_all();
317         }
318         return array();
319     }
321     /**
322      * Returns information about section used in course
323      *
324      * @param int|stdClass $section either section number (field course_section.section) or row from course_section table
325      * @param int $strictness
326      * @return section_info
327      */
328     public final function get_section($section, $strictness = IGNORE_MISSING) {
329         if (is_object($section)) {
330             $sectionnum = $section->section;
331         } else {
332             $sectionnum = $section;
333         }
334         $sections = $this->get_sections();
335         if (array_key_exists($sectionnum, $sections)) {
336             return $sections[$sectionnum];
337         }
338         if ($strictness == MUST_EXIST) {
339             throw new moodle_exception('sectionnotexist');
340         }
341         return null;
342     }
344     /**
345      * Returns the display name of the given section that the course prefers.
346      *
347      * @param int|stdClass $section Section object from database or just field course_sections.section
348      * @return Display name that the course format prefers, e.g. "Topic 2"
349      */
350     public function get_section_name($section) {
351         if (is_object($section)) {
352             $sectionnum = $section->section;
353         } else {
354             $sectionnum = $section;
355         }
357         if (get_string_manager()->string_exists('sectionname', 'format_' . $this->format)) {
358             return get_string('sectionname', 'format_' . $this->format) . ' ' . $sectionnum;
359         }
361         // Return an empty string if there's no available section name string for the given format.
362         return '';
363     }
365     /**
366      * Returns the default section using format_base's implementation of get_section_name.
367      *
368      * @param int|stdClass $section Section object from database or just field course_sections section
369      * @return string The default value for the section name based on the given course format.
370      */
371     public function get_default_section_name($section) {
372         return self::get_section_name($section);
373     }
375     /**
376      * Returns the information about the ajax support in the given source format
377      *
378      * The returned object's property (boolean)capable indicates that
379      * the course format supports Moodle course ajax features.
380      *
381      * @return stdClass
382      */
383     public function supports_ajax() {
384         // no support by default
385         $ajaxsupport = new stdClass();
386         $ajaxsupport->capable = false;
387         return $ajaxsupport;
388     }
390     /**
391      * Custom action after section has been moved in AJAX mode
392      *
393      * Used in course/rest.php
394      *
395      * @return array This will be passed in ajax respose
396      */
397     public function ajax_section_move() {
398         return null;
399     }
401     /**
402      * The URL to use for the specified course (with section)
403      *
404      * Please note that course view page /course/view.php?id=COURSEID is hardcoded in many
405      * places in core and contributed modules. If course format wants to change the location
406      * of the view script, it is not enough to change just this function. Do not forget
407      * to add proper redirection.
408      *
409      * @param int|stdClass $section Section object from database or just field course_sections.section
410      *     if null the course view page is returned
411      * @param array $options options for view URL. At the moment core uses:
412      *     'navigation' (bool) if true and section has no separate page, the function returns null
413      *     'sr' (int) used by multipage formats to specify to which section to return
414      * @return null|moodle_url
415      */
416     public function get_view_url($section, $options = array()) {
417         global $CFG;
418         $course = $this->get_course();
419         $url = new moodle_url('/course/view.php', array('id' => $course->id));
421         if (array_key_exists('sr', $options)) {
422             $sectionno = $options['sr'];
423         } else if (is_object($section)) {
424             $sectionno = $section->section;
425         } else {
426             $sectionno = $section;
427         }
428         if (empty($CFG->linkcoursesections) && !empty($options['navigation']) && $sectionno !== null) {
429             // by default assume that sections are never displayed on separate pages
430             return null;
431         }
432         if ($this->uses_sections() && $sectionno !== null) {
433             $url->set_anchor('section-'.$sectionno);
434         }
435         return $url;
436     }
438     /**
439      * Loads all of the course sections into the navigation
440      *
441      * This method is called from {@link global_navigation::load_course_sections()}
442      *
443      * By default the method {@link global_navigation::load_generic_course_sections()} is called
444      *
445      * When overwriting please note that navigationlib relies on using the correct values for
446      * arguments $type and $key in {@link navigation_node::add()}
447      *
448      * Example of code creating a section node:
449      * $sectionnode = $node->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
450      * $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
451      *
452      * Example of code creating an activity node:
453      * $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
454      * if (global_navigation::module_extends_navigation($activity->modname)) {
455      *     $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
456      * } else {
457      *     $activitynode->nodetype = navigation_node::NODETYPE_LEAF;
458      * }
459      *
460      * Also note that if $navigation->includesectionnum is not null, the section with this relative
461      * number needs is expected to be loaded
462      *
463      * @param global_navigation $navigation
464      * @param navigation_node $node The course node within the navigation
465      */
466     public function extend_course_navigation($navigation, navigation_node $node) {
467         if ($course = $this->get_course()) {
468             $navigation->load_generic_course_sections($course, $node);
469         }
470         return array();
471     }
473     /**
474      * Returns the list of blocks to be automatically added for the newly created course
475      *
476      * @see blocks_add_default_course_blocks()
477      *
478      * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
479      *     each of values is an array of block names (for left and right side columns)
480      */
481     public function get_default_blocks() {
482         global $CFG;
483         if (isset($CFG->defaultblocks)) {
484             return blocks_parse_default_blocks_list($CFG->defaultblocks);
485         }
486         $blocknames = array(
487             BLOCK_POS_LEFT => array(),
488             BLOCK_POS_RIGHT => array()
489         );
490         return $blocknames;
491     }
493     /**
494      * Returns the localised name of this course format plugin
495      *
496      * @return lang_string
497      */
498     public final function get_format_name() {
499         return new lang_string('pluginname', 'format_'.$this->get_format());
500     }
502     /**
503      * Definitions of the additional options that this course format uses for course
504      *
505      * This function may be called often, it should be as fast as possible.
506      * Avoid using get_string() method, use "new lang_string()" instead
507      * It is not recommended to use dynamic or course-dependant expressions here
508      * This function may be also called when course does not exist yet.
509      *
510      * Option names must be different from fields in the {course} talbe or any form elements on
511      * course edit form, it may even make sence to use special prefix for them.
512      *
513      * Each option must have the option name as a key and the array of properties as a value:
514      * 'default' - default value for this option (assumed null if not specified)
515      * 'type' - type of the option value (PARAM_INT, PARAM_RAW, etc.)
516      *
517      * Additional properties used by default implementation of
518      * {@link format_base::create_edit_form_elements()} (calls this method with $foreditform = true)
519      * 'label' - localised human-readable label for the edit form
520      * 'element_type' - type of the form element, default 'text'
521      * 'element_attributes' - additional attributes for the form element, these are 4th and further
522      *    arguments in the moodleform::addElement() method
523      * 'help' - string for help button. Note that if 'help' value is 'myoption' then the string with
524      *    the name 'myoption_help' must exist in the language file
525      * 'help_component' - language component to look for help string, by default this the component
526      *    for this course format
527      *
528      * This is an interface for creating simple form elements. If format plugin wants to use other
529      * methods such as disableIf, it can be done by overriding create_edit_form_elements().
530      *
531      * Course format options can be accessed as:
532      * $this->get_course()->OPTIONNAME (inside the format class)
533      * course_get_format($course)->get_course()->OPTIONNAME (outside of format class)
534      *
535      * All course options are returned by calling:
536      * $this->get_format_options();
537      *
538      * @param bool $foreditform
539      * @return array of options
540      */
541     public function course_format_options($foreditform = false) {
542         return array();
543     }
545     /**
546      * Definitions of the additional options that this course format uses for section
547      *
548      * See {@link format_base::course_format_options()} for return array definition.
549      *
550      * Additionally section format options may have property 'cache' set to true
551      * if this option needs to be cached in {@link get_fast_modinfo()}. The 'cache' property
552      * is recommended to be set only for fields used in {@link format_base::get_section_name()},
553      * {@link format_base::extend_course_navigation()} and {@link format_base::get_view_url()}
554      *
555      * For better performance cached options are recommended to have 'cachedefault' property
556      * Unlike 'default', 'cachedefault' should be static and not access get_config().
557      *
558      * Regardless of value of 'cache' all options are accessed in the code as
559      * $sectioninfo->OPTIONNAME
560      * where $sectioninfo is instance of section_info, returned by
561      * get_fast_modinfo($course)->get_section_info($sectionnum)
562      * or get_fast_modinfo($course)->get_section_info_all()
563      *
564      * All format options for particular section are returned by calling:
565      * $this->get_format_options($section);
566      *
567      * @param bool $foreditform
568      * @return array
569      */
570     public function section_format_options($foreditform = false) {
571         return array();
572     }
574     /**
575      * Returns the format options stored for this course or course section
576      *
577      * When overriding please note that this function is called from rebuild_course_cache()
578      * and section_info object, therefore using of get_fast_modinfo() and/or any function that
579      * accesses it may lead to recursion.
580      *
581      * @param null|int|stdClass|section_info $section if null the course format options will be returned
582      *     otherwise options for specified section will be returned. This can be either
583      *     section object or relative section number (field course_sections.section)
584      * @return array
585      */
586     public function get_format_options($section = null) {
587         global $DB;
588         if ($section === null) {
589             $options = $this->course_format_options();
590         } else {
591             $options = $this->section_format_options();
592         }
593         if (empty($options)) {
594             // there are no option for course/sections anyway, no need to go further
595             return array();
596         }
597         if ($section === null) {
598             // course format options will be returned
599             $sectionid = 0;
600         } else if ($this->courseid && isset($section->id)) {
601             // course section format options will be returned
602             $sectionid = $section->id;
603         } else if ($this->courseid && is_int($section) &&
604                 ($sectionobj = $DB->get_record('course_sections',
605                         array('section' => $section, 'course' => $this->courseid), 'id'))) {
606             // course section format options will be returned
607             $sectionid = $sectionobj->id;
608         } else {
609             // non-existing (yet) section was passed as an argument
610             // default format options for course section will be returned
611             $sectionid = -1;
612         }
613         if (!array_key_exists($sectionid, $this->formatoptions)) {
614             $this->formatoptions[$sectionid] = array();
615             // first fill with default values
616             foreach ($options as $optionname => $optionparams) {
617                 $this->formatoptions[$sectionid][$optionname] = null;
618                 if (array_key_exists('default', $optionparams)) {
619                     $this->formatoptions[$sectionid][$optionname] = $optionparams['default'];
620                 }
621             }
622             if ($this->courseid && $sectionid !== -1) {
623                 // overwrite the default options values with those stored in course_format_options table
624                 // nothing can be stored if we are interested in generic course ($this->courseid == 0)
625                 // or generic section ($sectionid === 0)
626                 $records = $DB->get_records('course_format_options',
627                         array('courseid' => $this->courseid,
628                               'format' => $this->format,
629                               'sectionid' => $sectionid
630                             ), '', 'id,name,value');
631                 foreach ($records as $record) {
632                     if (array_key_exists($record->name, $this->formatoptions[$sectionid])) {
633                         $value = $record->value;
634                         if ($value !== null && isset($options[$record->name]['type'])) {
635                             // this will convert string value to number if needed
636                             $value = clean_param($value, $options[$record->name]['type']);
637                         }
638                         $this->formatoptions[$sectionid][$record->name] = $value;
639                     }
640                 }
641             }
642         }
643         return $this->formatoptions[$sectionid];
644     }
646     /**
647      * Adds format options elements to the course/section edit form
648      *
649      * This function is called from {@link course_edit_form::definition_after_data()}
650      *
651      * @param MoodleQuickForm $mform form the elements are added to
652      * @param bool $forsection 'true' if this is a section edit form, 'false' if this is course edit form
653      * @return array array of references to the added form elements
654      */
655     public function create_edit_form_elements(&$mform, $forsection = false) {
656         $elements = array();
657         if ($forsection) {
658             $options = $this->section_format_options(true);
659         } else {
660             $options = $this->course_format_options(true);
661         }
662         foreach ($options as $optionname => $option) {
663             if (!isset($option['element_type'])) {
664                 $option['element_type'] = 'text';
665             }
666             $args = array($option['element_type'], $optionname, $option['label']);
667             if (!empty($option['element_attributes'])) {
668                 $args = array_merge($args, $option['element_attributes']);
669             }
670             $elements[] = call_user_func_array(array($mform, 'addElement'), $args);
671             if (isset($option['help'])) {
672                 $helpcomponent = 'format_'. $this->get_format();
673                 if (isset($option['help_component'])) {
674                     $helpcomponent = $option['help_component'];
675                 }
676                 $mform->addHelpButton($optionname, $option['help'], $helpcomponent);
677             }
678             if (isset($option['type'])) {
679                 $mform->setType($optionname, $option['type']);
680             }
681             if (is_null($mform->getElementValue($optionname)) && isset($option['default'])) {
682                 $mform->setDefault($optionname, $option['default']);
683             }
684         }
686         if (!$forsection && empty($this->courseid)) {
687             // At this stage (this is called from definition_after_data) course data is already set as default.
688             // We can not overwrite what is in the database.
689             $mform->setDefault('enddate', $this->get_default_course_enddate($mform));
690         }
692         return $elements;
693     }
695     /**
696      * Override if you need to perform some extra validation of the format options
697      *
698      * @param array $data array of ("fieldname"=>value) of submitted data
699      * @param array $files array of uploaded files "element_name"=>tmp_file_path
700      * @param array $errors errors already discovered in edit form validation
701      * @return array of "element_name"=>"error_description" if there are errors,
702      *         or an empty array if everything is OK.
703      *         Do not repeat errors from $errors param here
704      */
705     public function edit_form_validation($data, $files, $errors) {
706         return array();
707     }
709     /**
710      * Updates format options for a course or section
711      *
712      * If $data does not contain property with the option name, the option will not be updated
713      *
714      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
715      * @param null|int null if these are options for course or section id (course_sections.id)
716      *     if these are options for section
717      * @return bool whether there were any changes to the options values
718      */
719     protected function update_format_options($data, $sectionid = null) {
720         global $DB;
721         if (!$sectionid) {
722             $allformatoptions = $this->course_format_options();
723             $sectionid = 0;
724         } else {
725             $allformatoptions = $this->section_format_options();
726         }
727         if (empty($allformatoptions)) {
728             // nothing to update anyway
729             return false;
730         }
731         $defaultoptions = array();
732         $cached = array();
733         foreach ($allformatoptions as $key => $option) {
734             $defaultoptions[$key] = null;
735             if (array_key_exists('default', $option)) {
736                 $defaultoptions[$key] = $option['default'];
737             }
738             $cached[$key] = ($sectionid === 0 || !empty($option['cache']));
739         }
740         $records = $DB->get_records('course_format_options',
741                 array('courseid' => $this->courseid,
742                       'format' => $this->format,
743                       'sectionid' => $sectionid
744                     ), '', 'name,id,value');
745         $changed = $needrebuild = false;
746         $data = (array)$data;
747         foreach ($defaultoptions as $key => $value) {
748             if (isset($records[$key])) {
749                 if (array_key_exists($key, $data) && $records[$key]->value !== $data[$key]) {
750                     $DB->set_field('course_format_options', 'value',
751                             $data[$key], array('id' => $records[$key]->id));
752                     $changed = true;
753                     $needrebuild = $needrebuild || $cached[$key];
754                 }
755             } else {
756                 if (array_key_exists($key, $data) && $data[$key] !== $value) {
757                     $newvalue = $data[$key];
758                     $changed = true;
759                     $needrebuild = $needrebuild || $cached[$key];
760                 } else {
761                     $newvalue = $value;
762                     // we still insert entry in DB but there are no changes from user point of
763                     // view and no need to call rebuild_course_cache()
764                 }
765                 $DB->insert_record('course_format_options', array(
766                     'courseid' => $this->courseid,
767                     'format' => $this->format,
768                     'sectionid' => $sectionid,
769                     'name' => $key,
770                     'value' => $newvalue
771                 ));
772             }
773         }
774         if ($needrebuild) {
775             rebuild_course_cache($this->courseid, true);
776         }
777         if ($changed) {
778             // reset internal caches
779             if (!$sectionid) {
780                 $this->course = false;
781             }
782             unset($this->formatoptions[$sectionid]);
783         }
784         return $changed;
785     }
787     /**
788      * Updates format options for a course
789      *
790      * If $data does not contain property with the option name, the option will not be updated
791      *
792      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
793      * @param stdClass $oldcourse if this function is called from {@link update_course()}
794      *     this object contains information about the course before update
795      * @return bool whether there were any changes to the options values
796      */
797     public function update_course_format_options($data, $oldcourse = null) {
798         return $this->update_format_options($data);
799     }
801     /**
802      * Updates format options for a section
803      *
804      * Section id is expected in $data->id (or $data['id'])
805      * If $data does not contain property with the option name, the option will not be updated
806      *
807      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
808      * @return bool whether there were any changes to the options values
809      */
810     public function update_section_format_options($data) {
811         $data = (array)$data;
812         return $this->update_format_options($data, $data['id']);
813     }
815     /**
816      * Return an instance of moodleform to edit a specified section
817      *
818      * Default implementation returns instance of editsection_form that automatically adds
819      * additional fields defined in {@link format_base::section_format_options()}
820      *
821      * Format plugins may extend editsection_form if they want to have custom edit section form.
822      *
823      * @param mixed $action the action attribute for the form. If empty defaults to auto detect the
824      *              current url. If a moodle_url object then outputs params as hidden variables.
825      * @param array $customdata the array with custom data to be passed to the form
826      *     /course/editsection.php passes section_info object in 'cs' field
827      *     for filling availability fields
828      * @return moodleform
829      */
830     public function editsection_form($action, $customdata = array()) {
831         global $CFG;
832         require_once($CFG->dirroot. '/course/editsection_form.php');
833         $context = context_course::instance($this->courseid);
834         if (!array_key_exists('course', $customdata)) {
835             $customdata['course'] = $this->get_course();
836         }
837         return new editsection_form($action, $customdata);
838     }
840     /**
841      * Allows course format to execute code on moodle_page::set_course()
842      *
843      * @param moodle_page $page instance of page calling set_course
844      */
845     public function page_set_course(moodle_page $page) {
846     }
848     /**
849      * Allows course format to execute code on moodle_page::set_cm()
850      *
851      * Current module can be accessed as $page->cm (returns instance of cm_info)
852      *
853      * @param moodle_page $page instance of page calling set_cm
854      */
855     public function page_set_cm(moodle_page $page) {
856     }
858     /**
859      * Course-specific information to be output on any course page (usually above navigation bar)
860      *
861      * Example of usage:
862      * define
863      * class format_FORMATNAME_XXX implements renderable {}
864      *
865      * create format renderer in course/format/FORMATNAME/renderer.php, define rendering function:
866      * class format_FORMATNAME_renderer extends plugin_renderer_base {
867      *     protected function render_format_FORMATNAME_XXX(format_FORMATNAME_XXX $xxx) {
868      *         return html_writer::tag('div', 'This is my header/footer');
869      *     }
870      * }
871      *
872      * Return instance of format_FORMATNAME_XXX in this function, the appropriate method from
873      * plugin renderer will be called
874      *
875      * @return null|renderable null for no output or object with data for plugin renderer
876      */
877     public function course_header() {
878         return null;
879     }
881     /**
882      * Course-specific information to be output on any course page (usually in the beginning of
883      * standard footer)
884      *
885      * See {@link format_base::course_header()} for usage
886      *
887      * @return null|renderable null for no output or object with data for plugin renderer
888      */
889     public function course_footer() {
890         return null;
891     }
893     /**
894      * Course-specific information to be output immediately above content on any course page
895      *
896      * See {@link format_base::course_header()} for usage
897      *
898      * @return null|renderable null for no output or object with data for plugin renderer
899      */
900     public function course_content_header() {
901         return null;
902     }
904     /**
905      * Course-specific information to be output immediately below content on any course page
906      *
907      * See {@link format_base::course_header()} for usage
908      *
909      * @return null|renderable null for no output or object with data for plugin renderer
910      */
911     public function course_content_footer() {
912         return null;
913     }
915     /**
916      * Returns instance of page renderer used by this plugin
917      *
918      * @param moodle_page $page
919      * @return renderer_base
920      */
921     public function get_renderer(moodle_page $page) {
922         return $page->get_renderer('format_'. $this->get_format());
923     }
925     /**
926      * Returns true if the specified section is current
927      *
928      * By default we analyze $course->marker
929      *
930      * @param int|stdClass|section_info $section
931      * @return bool
932      */
933     public function is_section_current($section) {
934         if (is_object($section)) {
935             $sectionnum = $section->section;
936         } else {
937             $sectionnum = $section;
938         }
939         return ($sectionnum && ($course = $this->get_course()) && $course->marker == $sectionnum);
940     }
942     /**
943      * Allows to specify for modinfo that section is not available even when it is visible and conditionally available.
944      *
945      * Note: affected user can be retrieved as: $section->modinfo->userid
946      *
947      * Course format plugins can override the method to change the properties $available and $availableinfo that were
948      * calculated by conditional availability.
949      * To make section unavailable set:
950      *     $available = false;
951      * To make unavailable section completely hidden set:
952      *     $availableinfo = '';
953      * To make unavailable section visible with availability message set:
954      *     $availableinfo = get_string('sectionhidden', 'format_xxx');
955      *
956      * @param section_info $section
957      * @param bool $available the 'available' propery of the section_info as it was evaluated by conditional availability.
958      *     Can be changed by the method but 'false' can not be overridden by 'true'.
959      * @param string $availableinfo the 'availableinfo' propery of the section_info as it was evaluated by conditional availability.
960      *     Can be changed by the method
961      */
962     public function section_get_available_hook(section_info $section, &$available, &$availableinfo) {
963     }
965     /**
966      * Whether this format allows to delete sections
967      *
968      * If format supports deleting sections it is also recommended to define language string
969      * 'deletesection' inside the format.
970      *
971      * Do not call this function directly, instead use {@link course_can_delete_section()}
972      *
973      * @param int|stdClass|section_info $section
974      * @return bool
975      */
976     public function can_delete_section($section) {
977         return false;
978     }
980     /**
981      * Deletes a section
982      *
983      * Do not call this function directly, instead call {@link course_delete_section()}
984      *
985      * @param int|stdClass|section_info $section
986      * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
987      * @return bool whether section was deleted
988      */
989     public function delete_section($section, $forcedeleteifnotempty = false) {
990         global $DB;
991         if (!$this->uses_sections()) {
992             // Not possible to delete section if sections are not used.
993             return false;
994         }
995         if (!is_object($section)) {
996             $section = $DB->get_record('course_sections', array('course' => $this->get_courseid(), 'section' => $section),
997                 'id,section,sequence,summary');
998         }
999         if (!$section || !$section->section) {
1000             // Not possible to delete 0-section.
1001             return false;
1002         }
1004         if (!$forcedeleteifnotempty && (!empty($section->sequence) || !empty($section->summary))) {
1005             return false;
1006         }
1008         $course = $this->get_course();
1010         // Remove the marker if it points to this section.
1011         if ($section->section == $course->marker) {
1012             course_set_marker($course->id, 0);
1013         }
1015         $lastsection = $DB->get_field_sql('SELECT max(section) from {course_sections}
1016                             WHERE course = ?', array($course->id));
1018         // Find out if we need to descrease the 'numsections' property later.
1019         $courseformathasnumsections = array_key_exists('numsections',
1020             $this->get_format_options());
1021         $decreasenumsections = $courseformathasnumsections && ($section->section <= $course->numsections);
1023         // Move the section to the end.
1024         move_section_to($course, $section->section, $lastsection, true);
1026         // Delete all modules from the section.
1027         foreach (preg_split('/,/', $section->sequence, -1, PREG_SPLIT_NO_EMPTY) as $cmid) {
1028             course_delete_module($cmid);
1029         }
1031         // Delete section and it's format options.
1032         $DB->delete_records('course_format_options', array('sectionid' => $section->id));
1033         $DB->delete_records('course_sections', array('id' => $section->id));
1034         rebuild_course_cache($course->id, true);
1036         // Descrease 'numsections' if needed.
1037         if ($decreasenumsections) {
1038             $this->update_course_format_options(array('numsections' => $course->numsections - 1));
1039         }
1041         return true;
1042     }
1044     /**
1045      * Prepares the templateable object to display section name
1046      *
1047      * @param \section_info|\stdClass $section
1048      * @param bool $linkifneeded
1049      * @param bool $editable
1050      * @param null|lang_string|string $edithint
1051      * @param null|lang_string|string $editlabel
1052      * @return \core\output\inplace_editable
1053      */
1054     public function inplace_editable_render_section_name($section, $linkifneeded = true,
1055                                                          $editable = null, $edithint = null, $editlabel = null) {
1056         global $USER, $CFG;
1057         require_once($CFG->dirroot.'/course/lib.php');
1059         if ($editable === null) {
1060             $editable = !empty($USER->editing) && has_capability('moodle/course:update',
1061                     context_course::instance($section->course));
1062         }
1064         $displayvalue = $title = get_section_name($section->course, $section);
1065         if ($linkifneeded) {
1066             // Display link under the section name if the course format setting is to display one section per page.
1067             $url = course_get_url($section->course, $section->section, array('navigation' => true));
1068             if ($url) {
1069                 $displayvalue = html_writer::link($url, $title);
1070             }
1071             $itemtype = 'sectionname';
1072         } else {
1073             // If $linkifneeded==false, we never display the link (this is used when rendering the section header).
1074             // Itemtype 'sectionnamenl' (nl=no link) will tell the callback that link should not be rendered -
1075             // there is no other way callback can know where we display the section name.
1076             $itemtype = 'sectionnamenl';
1077         }
1078         if (empty($edithint)) {
1079             $edithint = new lang_string('editsectionname');
1080         }
1081         if (empty($editlabel)) {
1082             $editlabel = new lang_string('newsectionname', '', $title);
1083         }
1085         return new \core\output\inplace_editable('format_' . $this->format, $itemtype, $section->id, $editable,
1086             $displayvalue, $section->name, $edithint, $editlabel);
1087     }
1089     /**
1090      * Updates the value in the database and modifies this object respectively.
1091      *
1092      * ALWAYS check user permissions before performing an update! Throw exceptions if permissions are not sufficient
1093      * or value is not legit.
1094      *
1095      * @param stdClass $section
1096      * @param string $itemtype
1097      * @param mixed $newvalue
1098      * @return \core\output\inplace_editable
1099      */
1100     public function inplace_editable_update_section_name($section, $itemtype, $newvalue) {
1101         if ($itemtype === 'sectionname' || $itemtype === 'sectionnamenl') {
1102             $context = context_course::instance($section->course);
1103             external_api::validate_context($context);
1104             require_capability('moodle/course:update', $context);
1106             $newtitle = clean_param($newvalue, PARAM_TEXT);
1107             if (strval($section->name) !== strval($newtitle)) {
1108                 course_update_section($section->course, $section, array('name' => $newtitle));
1109             }
1110             return $this->inplace_editable_render_section_name($section, ($itemtype === 'sectionname'), true);
1111         }
1112     }
1115     /**
1116      * Returns the default end date value based on the start date.
1117      *
1118      * This is the default implementation for course formats, it is based on
1119      * moodlecourse/courseduration setting. Course formats like format_weeks for
1120      * example can overwrite this method and return a value based on their internal options.
1121      *
1122      * @param moodleform $mform
1123      * @param array $fieldnames The form - field names mapping.
1124      * @return int
1125      */
1126     public function get_default_course_enddate($mform, $fieldnames = array()) {
1128         if (empty($fieldnames)) {
1129             $fieldnames = array('startdate' => 'startdate');
1130         }
1132         $startdate = $this->get_form_start_date($mform, $fieldnames);
1133         $courseduration = intval(get_config('moodlecourse', 'courseduration'));
1134         if (!$courseduration) {
1135             // Default, it should be already set during upgrade though.
1136             $courseduration = YEARSECS;
1137         }
1139         return $startdate + $courseduration;
1140     }
1142     /**
1143      * Get the start date value from the course settings page form.
1144      *
1145      * @param moodleform $mform
1146      * @param array $fieldnames The form - field names mapping.
1147      * @return int
1148      */
1149     protected function get_form_start_date($mform, $fieldnames) {
1150         $startdate = $mform->getElementValue($fieldnames['startdate']);
1151         return $mform->getElement($fieldnames['startdate'])->exportValue($startdate);
1152     }
1155 /**
1156  * Pseudo course format used for the site main page
1157  *
1158  * @package    core_course
1159  * @copyright  2012 Marina Glancy
1160  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1161  */
1162 class format_site extends format_base {
1164     /**
1165      * Returns the display name of the given section that the course prefers.
1166      *
1167      * @param int|stdClass $section Section object from database or just field section.section
1168      * @return Display name that the course format prefers, e.g. "Topic 2"
1169      */
1170     function get_section_name($section) {
1171         return get_string('site');
1172     }
1174     /**
1175      * For this fake course referring to the whole site, the site homepage is always returned
1176      * regardless of arguments
1177      *
1178      * @param int|stdClass $section
1179      * @param array $options
1180      * @return null|moodle_url
1181      */
1182     public function get_view_url($section, $options = array()) {
1183         return new moodle_url('/', array('redirect' => 0));
1184     }
1186     /**
1187      * Returns the list of blocks to be automatically added on the site frontpage when moodle is installed
1188      *
1189      * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
1190      *     each of values is an array of block names (for left and right side columns)
1191      */
1192     public function get_default_blocks() {
1193         return blocks_get_default_site_course_blocks();
1194     }
1196     /**
1197      * Definitions of the additional options that site uses
1198      *
1199      * @param bool $foreditform
1200      * @return array of options
1201      */
1202     public function course_format_options($foreditform = false) {
1203         static $courseformatoptions = false;
1204         if ($courseformatoptions === false) {
1205             $courseformatoptions = array(
1206                 'numsections' => array(
1207                     'default' => 1,
1208                     'type' => PARAM_INT,
1209                 ),
1210             );
1211         }
1212         return $courseformatoptions;
1213     }