f70371c11370becf6f09b117b6d160f921f7525c
[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      * Method used in the rendered and during backup instead of legacy 'numsections'
270      *
271      * Default renderer will treat sections with sectionnumber greater that the value returned by this
272      * method as "orphaned" and not display them on the course page unless in editing mode.
273      * Backup will store this value as 'numsections'.
274      *
275      * This method ensures that 3rd party course format plugins that still use 'numsections' continue to
276      * work but at the same time we no longer expect formats to have 'numsections' property.
277      *
278      * @return int
279      */
280     public function get_last_section_number() {
281         $course = $this->get_course();
282         if (isset($course->numsections)) {
283             return $course->numsections;
284         }
285         $modinfo = get_fast_modinfo($course);
286         $sections = $modinfo->get_section_info_all();
287         return (int)max(array_keys($sections));
288     }
290     /**
291      * Returns true if the course has a front page.
292      *
293      * This function is called to determine if the course has a view page, whether or not
294      * it contains a listing of activities. It can be useful to set this to false when the course
295      * format has only one activity and ignores the course page. Or if there are multiple
296      * activities but no page to see the centralised information.
297      *
298      * Initially this was created to know if forms should add a button to return to the course page.
299      * So if 'Return to course' does not make sense in your format your should probably return false.
300      *
301      * @return boolean
302      * @since Moodle 2.6
303      */
304     public function has_view_page() {
305         return true;
306     }
308     /**
309      * Returns true if this course format uses sections
310      *
311      * This function may be called without specifying the course id
312      * i.e. in {@link course_format_uses_sections()}
313      *
314      * Developers, note that if course format does use sections there should be defined a language
315      * string with the name 'sectionname' defining what the section relates to in the format, i.e.
316      * $string['sectionname'] = 'Topic';
317      * or
318      * $string['sectionname'] = 'Week';
319      *
320      * @return bool
321      */
322     public function uses_sections() {
323         return false;
324     }
326     /**
327      * Returns a list of sections used in the course
328      *
329      * This is a shortcut to get_fast_modinfo()->get_section_info_all()
330      * @see get_fast_modinfo()
331      * @see course_modinfo::get_section_info_all()
332      *
333      * @return array of section_info objects
334      */
335     public final function get_sections() {
336         if ($course = $this->get_course()) {
337             $modinfo = get_fast_modinfo($course);
338             return $modinfo->get_section_info_all();
339         }
340         return array();
341     }
343     /**
344      * Returns information about section used in course
345      *
346      * @param int|stdClass $section either section number (field course_section.section) or row from course_section table
347      * @param int $strictness
348      * @return section_info
349      */
350     public final function get_section($section, $strictness = IGNORE_MISSING) {
351         if (is_object($section)) {
352             $sectionnum = $section->section;
353         } else {
354             $sectionnum = $section;
355         }
356         $sections = $this->get_sections();
357         if (array_key_exists($sectionnum, $sections)) {
358             return $sections[$sectionnum];
359         }
360         if ($strictness == MUST_EXIST) {
361             throw new moodle_exception('sectionnotexist');
362         }
363         return null;
364     }
366     /**
367      * Returns the display name of the given section that the course prefers.
368      *
369      * @param int|stdClass $section Section object from database or just field course_sections.section
370      * @return Display name that the course format prefers, e.g. "Topic 2"
371      */
372     public function get_section_name($section) {
373         if (is_object($section)) {
374             $sectionnum = $section->section;
375         } else {
376             $sectionnum = $section;
377         }
379         if (get_string_manager()->string_exists('sectionname', 'format_' . $this->format)) {
380             return get_string('sectionname', 'format_' . $this->format) . ' ' . $sectionnum;
381         }
383         // Return an empty string if there's no available section name string for the given format.
384         return '';
385     }
387     /**
388      * Returns the default section using format_base's implementation of get_section_name.
389      *
390      * @param int|stdClass $section Section object from database or just field course_sections section
391      * @return string The default value for the section name based on the given course format.
392      */
393     public function get_default_section_name($section) {
394         return self::get_section_name($section);
395     }
397     /**
398      * Returns the information about the ajax support in the given source format
399      *
400      * The returned object's property (boolean)capable indicates that
401      * the course format supports Moodle course ajax features.
402      *
403      * @return stdClass
404      */
405     public function supports_ajax() {
406         // no support by default
407         $ajaxsupport = new stdClass();
408         $ajaxsupport->capable = false;
409         return $ajaxsupport;
410     }
412     /**
413      * Custom action after section has been moved in AJAX mode
414      *
415      * Used in course/rest.php
416      *
417      * @return array This will be passed in ajax respose
418      */
419     public function ajax_section_move() {
420         return null;
421     }
423     /**
424      * The URL to use for the specified course (with section)
425      *
426      * Please note that course view page /course/view.php?id=COURSEID is hardcoded in many
427      * places in core and contributed modules. If course format wants to change the location
428      * of the view script, it is not enough to change just this function. Do not forget
429      * to add proper redirection.
430      *
431      * @param int|stdClass $section Section object from database or just field course_sections.section
432      *     if null the course view page is returned
433      * @param array $options options for view URL. At the moment core uses:
434      *     'navigation' (bool) if true and section has no separate page, the function returns null
435      *     'sr' (int) used by multipage formats to specify to which section to return
436      * @return null|moodle_url
437      */
438     public function get_view_url($section, $options = array()) {
439         global $CFG;
440         $course = $this->get_course();
441         $url = new moodle_url('/course/view.php', array('id' => $course->id));
443         if (array_key_exists('sr', $options)) {
444             $sectionno = $options['sr'];
445         } else if (is_object($section)) {
446             $sectionno = $section->section;
447         } else {
448             $sectionno = $section;
449         }
450         if (empty($CFG->linkcoursesections) && !empty($options['navigation']) && $sectionno !== null) {
451             // by default assume that sections are never displayed on separate pages
452             return null;
453         }
454         if ($this->uses_sections() && $sectionno !== null) {
455             $url->set_anchor('section-'.$sectionno);
456         }
457         return $url;
458     }
460     /**
461      * Loads all of the course sections into the navigation
462      *
463      * This method is called from {@link global_navigation::load_course_sections()}
464      *
465      * By default the method {@link global_navigation::load_generic_course_sections()} is called
466      *
467      * When overwriting please note that navigationlib relies on using the correct values for
468      * arguments $type and $key in {@link navigation_node::add()}
469      *
470      * Example of code creating a section node:
471      * $sectionnode = $node->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
472      * $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
473      *
474      * Example of code creating an activity node:
475      * $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
476      * if (global_navigation::module_extends_navigation($activity->modname)) {
477      *     $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
478      * } else {
479      *     $activitynode->nodetype = navigation_node::NODETYPE_LEAF;
480      * }
481      *
482      * Also note that if $navigation->includesectionnum is not null, the section with this relative
483      * number needs is expected to be loaded
484      *
485      * @param global_navigation $navigation
486      * @param navigation_node $node The course node within the navigation
487      */
488     public function extend_course_navigation($navigation, navigation_node $node) {
489         if ($course = $this->get_course()) {
490             $navigation->load_generic_course_sections($course, $node);
491         }
492         return array();
493     }
495     /**
496      * Returns the list of blocks to be automatically added for the newly created course
497      *
498      * @see blocks_add_default_course_blocks()
499      *
500      * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
501      *     each of values is an array of block names (for left and right side columns)
502      */
503     public function get_default_blocks() {
504         global $CFG;
505         if (isset($CFG->defaultblocks)) {
506             return blocks_parse_default_blocks_list($CFG->defaultblocks);
507         }
508         $blocknames = array(
509             BLOCK_POS_LEFT => array(),
510             BLOCK_POS_RIGHT => array()
511         );
512         return $blocknames;
513     }
515     /**
516      * Returns the localised name of this course format plugin
517      *
518      * @return lang_string
519      */
520     public final function get_format_name() {
521         return new lang_string('pluginname', 'format_'.$this->get_format());
522     }
524     /**
525      * Definitions of the additional options that this course format uses for course
526      *
527      * This function may be called often, it should be as fast as possible.
528      * Avoid using get_string() method, use "new lang_string()" instead
529      * It is not recommended to use dynamic or course-dependant expressions here
530      * This function may be also called when course does not exist yet.
531      *
532      * Option names must be different from fields in the {course} talbe or any form elements on
533      * course edit form, it may even make sence to use special prefix for them.
534      *
535      * Each option must have the option name as a key and the array of properties as a value:
536      * 'default' - default value for this option (assumed null if not specified)
537      * 'type' - type of the option value (PARAM_INT, PARAM_RAW, etc.)
538      *
539      * Additional properties used by default implementation of
540      * {@link format_base::create_edit_form_elements()} (calls this method with $foreditform = true)
541      * 'label' - localised human-readable label for the edit form
542      * 'element_type' - type of the form element, default 'text'
543      * 'element_attributes' - additional attributes for the form element, these are 4th and further
544      *    arguments in the moodleform::addElement() method
545      * 'help' - string for help button. Note that if 'help' value is 'myoption' then the string with
546      *    the name 'myoption_help' must exist in the language file
547      * 'help_component' - language component to look for help string, by default this the component
548      *    for this course format
549      *
550      * This is an interface for creating simple form elements. If format plugin wants to use other
551      * methods such as disableIf, it can be done by overriding create_edit_form_elements().
552      *
553      * Course format options can be accessed as:
554      * $this->get_course()->OPTIONNAME (inside the format class)
555      * course_get_format($course)->get_course()->OPTIONNAME (outside of format class)
556      *
557      * All course options are returned by calling:
558      * $this->get_format_options();
559      *
560      * @param bool $foreditform
561      * @return array of options
562      */
563     public function course_format_options($foreditform = false) {
564         return array();
565     }
567     /**
568      * Definitions of the additional options that this course format uses for section
569      *
570      * See {@link format_base::course_format_options()} for return array definition.
571      *
572      * Additionally section format options may have property 'cache' set to true
573      * if this option needs to be cached in {@link get_fast_modinfo()}. The 'cache' property
574      * is recommended to be set only for fields used in {@link format_base::get_section_name()},
575      * {@link format_base::extend_course_navigation()} and {@link format_base::get_view_url()}
576      *
577      * For better performance cached options are recommended to have 'cachedefault' property
578      * Unlike 'default', 'cachedefault' should be static and not access get_config().
579      *
580      * Regardless of value of 'cache' all options are accessed in the code as
581      * $sectioninfo->OPTIONNAME
582      * where $sectioninfo is instance of section_info, returned by
583      * get_fast_modinfo($course)->get_section_info($sectionnum)
584      * or get_fast_modinfo($course)->get_section_info_all()
585      *
586      * All format options for particular section are returned by calling:
587      * $this->get_format_options($section);
588      *
589      * @param bool $foreditform
590      * @return array
591      */
592     public function section_format_options($foreditform = false) {
593         return array();
594     }
596     /**
597      * Returns the format options stored for this course or course section
598      *
599      * When overriding please note that this function is called from rebuild_course_cache()
600      * and section_info object, therefore using of get_fast_modinfo() and/or any function that
601      * accesses it may lead to recursion.
602      *
603      * @param null|int|stdClass|section_info $section if null the course format options will be returned
604      *     otherwise options for specified section will be returned. This can be either
605      *     section object or relative section number (field course_sections.section)
606      * @return array
607      */
608     public function get_format_options($section = null) {
609         global $DB;
610         if ($section === null) {
611             $options = $this->course_format_options();
612         } else {
613             $options = $this->section_format_options();
614         }
615         if (empty($options)) {
616             // there are no option for course/sections anyway, no need to go further
617             return array();
618         }
619         if ($section === null) {
620             // course format options will be returned
621             $sectionid = 0;
622         } else if ($this->courseid && isset($section->id)) {
623             // course section format options will be returned
624             $sectionid = $section->id;
625         } else if ($this->courseid && is_int($section) &&
626                 ($sectionobj = $DB->get_record('course_sections',
627                         array('section' => $section, 'course' => $this->courseid), 'id'))) {
628             // course section format options will be returned
629             $sectionid = $sectionobj->id;
630         } else {
631             // non-existing (yet) section was passed as an argument
632             // default format options for course section will be returned
633             $sectionid = -1;
634         }
635         if (!array_key_exists($sectionid, $this->formatoptions)) {
636             $this->formatoptions[$sectionid] = array();
637             // first fill with default values
638             foreach ($options as $optionname => $optionparams) {
639                 $this->formatoptions[$sectionid][$optionname] = null;
640                 if (array_key_exists('default', $optionparams)) {
641                     $this->formatoptions[$sectionid][$optionname] = $optionparams['default'];
642                 }
643             }
644             if ($this->courseid && $sectionid !== -1) {
645                 // overwrite the default options values with those stored in course_format_options table
646                 // nothing can be stored if we are interested in generic course ($this->courseid == 0)
647                 // or generic section ($sectionid === 0)
648                 $records = $DB->get_records('course_format_options',
649                         array('courseid' => $this->courseid,
650                               'format' => $this->format,
651                               'sectionid' => $sectionid
652                             ), '', 'id,name,value');
653                 foreach ($records as $record) {
654                     if (array_key_exists($record->name, $this->formatoptions[$sectionid])) {
655                         $value = $record->value;
656                         if ($value !== null && isset($options[$record->name]['type'])) {
657                             // this will convert string value to number if needed
658                             $value = clean_param($value, $options[$record->name]['type']);
659                         }
660                         $this->formatoptions[$sectionid][$record->name] = $value;
661                     }
662                 }
663             }
664         }
665         return $this->formatoptions[$sectionid];
666     }
668     /**
669      * Adds format options elements to the course/section edit form
670      *
671      * This function is called from {@link course_edit_form::definition_after_data()}
672      *
673      * @param MoodleQuickForm $mform form the elements are added to
674      * @param bool $forsection 'true' if this is a section edit form, 'false' if this is course edit form
675      * @return array array of references to the added form elements
676      */
677     public function create_edit_form_elements(&$mform, $forsection = false) {
678         $elements = array();
679         if ($forsection) {
680             $options = $this->section_format_options(true);
681         } else {
682             $options = $this->course_format_options(true);
683         }
684         foreach ($options as $optionname => $option) {
685             if (!isset($option['element_type'])) {
686                 $option['element_type'] = 'text';
687             }
688             $args = array($option['element_type'], $optionname, $option['label']);
689             if (!empty($option['element_attributes'])) {
690                 $args = array_merge($args, $option['element_attributes']);
691             }
692             $elements[] = call_user_func_array(array($mform, 'addElement'), $args);
693             if (isset($option['help'])) {
694                 $helpcomponent = 'format_'. $this->get_format();
695                 if (isset($option['help_component'])) {
696                     $helpcomponent = $option['help_component'];
697                 }
698                 $mform->addHelpButton($optionname, $option['help'], $helpcomponent);
699             }
700             if (isset($option['type'])) {
701                 $mform->setType($optionname, $option['type']);
702             }
703             if (isset($option['default']) && !array_key_exists($optionname, $mform->_defaultValues)) {
704                 // Set defaults for the elements in the form.
705                 // Since we call this method after set_data() make sure that we don't override what was already set.
706                 $mform->setDefault($optionname, $option['default']);
707             }
708         }
710         if (!$forsection && empty($this->courseid)) {
711             // Check if course end date form field should be enabled by default.
712             // If a default date is provided to the form element, it is magically enabled by default in the
713             // MoodleQuickForm_date_time_selector class, otherwise it's disabled by default.
714             if (get_config('moodlecourse', 'courseenddateenabled')) {
715                 // At this stage (this is called from definition_after_data) course data is already set as default.
716                 // We can not overwrite what is in the database.
717                 $mform->setDefault('enddate', $this->get_default_course_enddate($mform));
718             }
719         }
721         return $elements;
722     }
724     /**
725      * Override if you need to perform some extra validation of the format options
726      *
727      * @param array $data array of ("fieldname"=>value) of submitted data
728      * @param array $files array of uploaded files "element_name"=>tmp_file_path
729      * @param array $errors errors already discovered in edit form validation
730      * @return array of "element_name"=>"error_description" if there are errors,
731      *         or an empty array if everything is OK.
732      *         Do not repeat errors from $errors param here
733      */
734     public function edit_form_validation($data, $files, $errors) {
735         return array();
736     }
738     /**
739      * Prepares values of course or section format options before storing them in DB
740      *
741      * If an option has invalid value it is not returned
742      *
743      * @param array $rawdata associative array of the proposed course/section format options
744      * @param int|null $sectionid null if it is course format option
745      * @return array array of options that have valid values
746      */
747     protected function validate_format_options(array $rawdata, int $sectionid = null) : array {
748         if (!$sectionid) {
749             $allformatoptions = $this->course_format_options(true);
750         } else {
751             $allformatoptions = $this->section_format_options(true);
752         }
753         $data = array_intersect_key($rawdata, $allformatoptions);
754         foreach ($data as $key => $value) {
755             $option = $allformatoptions[$key] + ['type' => PARAM_RAW, 'element_type' => null, 'element_attributes' => [[]]];
756             $data[$key] = clean_param($value, $option['type']);
757             if ($option['element_type'] === 'select' && !array_key_exists($data[$key], $option['element_attributes'][0])) {
758                 // Value invalid for select element, skip.
759                 unset($data[$key]);
760             }
761         }
762         return $data;
763     }
765     /**
766      * Validates format options for the course
767      *
768      * @param array $data data to insert/update
769      * @return array array of options that have valid values
770      */
771     public function validate_course_format_options(array $data) : array {
772         return $this->validate_format_options($data);
773     }
775     /**
776      * Updates format options for a course or section
777      *
778      * If $data does not contain property with the option name, the option will not be updated
779      *
780      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
781      * @param null|int null if these are options for course or section id (course_sections.id)
782      *     if these are options for section
783      * @return bool whether there were any changes to the options values
784      */
785     protected function update_format_options($data, $sectionid = null) {
786         global $DB;
787         $data = $this->validate_format_options((array)$data, $sectionid);
788         if (!$sectionid) {
789             $allformatoptions = $this->course_format_options();
790             $sectionid = 0;
791         } else {
792             $allformatoptions = $this->section_format_options();
793         }
794         if (empty($allformatoptions)) {
795             // nothing to update anyway
796             return false;
797         }
798         $defaultoptions = array();
799         $cached = array();
800         foreach ($allformatoptions as $key => $option) {
801             $defaultoptions[$key] = null;
802             if (array_key_exists('default', $option)) {
803                 $defaultoptions[$key] = $option['default'];
804             }
805             $cached[$key] = ($sectionid === 0 || !empty($option['cache']));
806         }
807         $records = $DB->get_records('course_format_options',
808                 array('courseid' => $this->courseid,
809                       'format' => $this->format,
810                       'sectionid' => $sectionid
811                     ), '', 'name,id,value');
812         $changed = $needrebuild = false;
813         foreach ($defaultoptions as $key => $value) {
814             if (isset($records[$key])) {
815                 if (array_key_exists($key, $data) && $records[$key]->value !== $data[$key]) {
816                     $DB->set_field('course_format_options', 'value',
817                             $data[$key], array('id' => $records[$key]->id));
818                     $changed = true;
819                     $needrebuild = $needrebuild || $cached[$key];
820                 }
821             } else {
822                 if (array_key_exists($key, $data) && $data[$key] !== $value) {
823                     $newvalue = $data[$key];
824                     $changed = true;
825                     $needrebuild = $needrebuild || $cached[$key];
826                 } else {
827                     $newvalue = $value;
828                     // we still insert entry in DB but there are no changes from user point of
829                     // view and no need to call rebuild_course_cache()
830                 }
831                 $DB->insert_record('course_format_options', array(
832                     'courseid' => $this->courseid,
833                     'format' => $this->format,
834                     'sectionid' => $sectionid,
835                     'name' => $key,
836                     'value' => $newvalue
837                 ));
838             }
839         }
840         if ($needrebuild) {
841             rebuild_course_cache($this->courseid, true);
842         }
843         if ($changed) {
844             // reset internal caches
845             if (!$sectionid) {
846                 $this->course = false;
847             }
848             unset($this->formatoptions[$sectionid]);
849         }
850         return $changed;
851     }
853     /**
854      * Updates format options for a course
855      *
856      * If $data does not contain property with the option name, the option will not be updated
857      *
858      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
859      * @param stdClass $oldcourse if this function is called from {@link update_course()}
860      *     this object contains information about the course before update
861      * @return bool whether there were any changes to the options values
862      */
863     public function update_course_format_options($data, $oldcourse = null) {
864         return $this->update_format_options($data);
865     }
867     /**
868      * Updates format options for a section
869      *
870      * Section id is expected in $data->id (or $data['id'])
871      * If $data does not contain property with the option name, the option will not be updated
872      *
873      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
874      * @return bool whether there were any changes to the options values
875      */
876     public function update_section_format_options($data) {
877         $data = (array)$data;
878         return $this->update_format_options($data, $data['id']);
879     }
881     /**
882      * Return an instance of moodleform to edit a specified section
883      *
884      * Default implementation returns instance of editsection_form that automatically adds
885      * additional fields defined in {@link format_base::section_format_options()}
886      *
887      * Format plugins may extend editsection_form if they want to have custom edit section form.
888      *
889      * @param mixed $action the action attribute for the form. If empty defaults to auto detect the
890      *              current url. If a moodle_url object then outputs params as hidden variables.
891      * @param array $customdata the array with custom data to be passed to the form
892      *     /course/editsection.php passes section_info object in 'cs' field
893      *     for filling availability fields
894      * @return moodleform
895      */
896     public function editsection_form($action, $customdata = array()) {
897         global $CFG;
898         require_once($CFG->dirroot. '/course/editsection_form.php');
899         $context = context_course::instance($this->courseid);
900         if (!array_key_exists('course', $customdata)) {
901             $customdata['course'] = $this->get_course();
902         }
903         return new editsection_form($action, $customdata);
904     }
906     /**
907      * Allows course format to execute code on moodle_page::set_course()
908      *
909      * @param moodle_page $page instance of page calling set_course
910      */
911     public function page_set_course(moodle_page $page) {
912     }
914     /**
915      * Allows course format to execute code on moodle_page::set_cm()
916      *
917      * Current module can be accessed as $page->cm (returns instance of cm_info)
918      *
919      * @param moodle_page $page instance of page calling set_cm
920      */
921     public function page_set_cm(moodle_page $page) {
922     }
924     /**
925      * Course-specific information to be output on any course page (usually above navigation bar)
926      *
927      * Example of usage:
928      * define
929      * class format_FORMATNAME_XXX implements renderable {}
930      *
931      * create format renderer in course/format/FORMATNAME/renderer.php, define rendering function:
932      * class format_FORMATNAME_renderer extends plugin_renderer_base {
933      *     protected function render_format_FORMATNAME_XXX(format_FORMATNAME_XXX $xxx) {
934      *         return html_writer::tag('div', 'This is my header/footer');
935      *     }
936      * }
937      *
938      * Return instance of format_FORMATNAME_XXX in this function, the appropriate method from
939      * plugin renderer will be called
940      *
941      * @return null|renderable null for no output or object with data for plugin renderer
942      */
943     public function course_header() {
944         return null;
945     }
947     /**
948      * Course-specific information to be output on any course page (usually in the beginning of
949      * standard footer)
950      *
951      * See {@link format_base::course_header()} for usage
952      *
953      * @return null|renderable null for no output or object with data for plugin renderer
954      */
955     public function course_footer() {
956         return null;
957     }
959     /**
960      * Course-specific information to be output immediately above content on any course page
961      *
962      * See {@link format_base::course_header()} for usage
963      *
964      * @return null|renderable null for no output or object with data for plugin renderer
965      */
966     public function course_content_header() {
967         return null;
968     }
970     /**
971      * Course-specific information to be output immediately below content on any course page
972      *
973      * See {@link format_base::course_header()} for usage
974      *
975      * @return null|renderable null for no output or object with data for plugin renderer
976      */
977     public function course_content_footer() {
978         return null;
979     }
981     /**
982      * Returns instance of page renderer used by this plugin
983      *
984      * @param moodle_page $page
985      * @return renderer_base
986      */
987     public function get_renderer(moodle_page $page) {
988         return $page->get_renderer('format_'. $this->get_format());
989     }
991     /**
992      * Returns true if the specified section is current
993      *
994      * By default we analyze $course->marker
995      *
996      * @param int|stdClass|section_info $section
997      * @return bool
998      */
999     public function is_section_current($section) {
1000         if (is_object($section)) {
1001             $sectionnum = $section->section;
1002         } else {
1003             $sectionnum = $section;
1004         }
1005         return ($sectionnum && ($course = $this->get_course()) && $course->marker == $sectionnum);
1006     }
1008     /**
1009      * Allows to specify for modinfo that section is not available even when it is visible and conditionally available.
1010      *
1011      * Note: affected user can be retrieved as: $section->modinfo->userid
1012      *
1013      * Course format plugins can override the method to change the properties $available and $availableinfo that were
1014      * calculated by conditional availability.
1015      * To make section unavailable set:
1016      *     $available = false;
1017      * To make unavailable section completely hidden set:
1018      *     $availableinfo = '';
1019      * To make unavailable section visible with availability message set:
1020      *     $availableinfo = get_string('sectionhidden', 'format_xxx');
1021      *
1022      * @param section_info $section
1023      * @param bool $available the 'available' propery of the section_info as it was evaluated by conditional availability.
1024      *     Can be changed by the method but 'false' can not be overridden by 'true'.
1025      * @param string $availableinfo the 'availableinfo' propery of the section_info as it was evaluated by conditional availability.
1026      *     Can be changed by the method
1027      */
1028     public function section_get_available_hook(section_info $section, &$available, &$availableinfo) {
1029     }
1031     /**
1032      * Whether this format allows to delete sections
1033      *
1034      * If format supports deleting sections it is also recommended to define language string
1035      * 'deletesection' inside the format.
1036      *
1037      * Do not call this function directly, instead use {@link course_can_delete_section()}
1038      *
1039      * @param int|stdClass|section_info $section
1040      * @return bool
1041      */
1042     public function can_delete_section($section) {
1043         return false;
1044     }
1046     /**
1047      * Deletes a section
1048      *
1049      * Do not call this function directly, instead call {@link course_delete_section()}
1050      *
1051      * @param int|stdClass|section_info $section
1052      * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1053      * @return bool whether section was deleted
1054      */
1055     public function delete_section($section, $forcedeleteifnotempty = false) {
1056         global $DB;
1057         if (!$this->uses_sections()) {
1058             // Not possible to delete section if sections are not used.
1059             return false;
1060         }
1061         if (!is_object($section)) {
1062             $section = $DB->get_record('course_sections', array('course' => $this->get_courseid(), 'section' => $section),
1063                 'id,section,sequence,summary');
1064         }
1065         if (!$section || !$section->section) {
1066             // Not possible to delete 0-section.
1067             return false;
1068         }
1070         if (!$forcedeleteifnotempty && (!empty($section->sequence) || !empty($section->summary))) {
1071             return false;
1072         }
1074         $course = $this->get_course();
1076         // Remove the marker if it points to this section.
1077         if ($section->section == $course->marker) {
1078             course_set_marker($course->id, 0);
1079         }
1081         $lastsection = $DB->get_field_sql('SELECT max(section) from {course_sections}
1082                             WHERE course = ?', array($course->id));
1084         // Find out if we need to descrease the 'numsections' property later.
1085         $courseformathasnumsections = array_key_exists('numsections',
1086             $this->get_format_options());
1087         $decreasenumsections = $courseformathasnumsections && ($section->section <= $course->numsections);
1089         // Move the section to the end.
1090         move_section_to($course, $section->section, $lastsection, true);
1092         // Delete all modules from the section.
1093         foreach (preg_split('/,/', $section->sequence, -1, PREG_SPLIT_NO_EMPTY) as $cmid) {
1094             course_delete_module($cmid);
1095         }
1097         // Delete section and it's format options.
1098         $DB->delete_records('course_format_options', array('sectionid' => $section->id));
1099         $DB->delete_records('course_sections', array('id' => $section->id));
1100         rebuild_course_cache($course->id, true);
1102         // Descrease 'numsections' if needed.
1103         if ($decreasenumsections) {
1104             $this->update_course_format_options(array('numsections' => $course->numsections - 1));
1105         }
1107         return true;
1108     }
1110     /**
1111      * Prepares the templateable object to display section name
1112      *
1113      * @param \section_info|\stdClass $section
1114      * @param bool $linkifneeded
1115      * @param bool $editable
1116      * @param null|lang_string|string $edithint
1117      * @param null|lang_string|string $editlabel
1118      * @return \core\output\inplace_editable
1119      */
1120     public function inplace_editable_render_section_name($section, $linkifneeded = true,
1121                                                          $editable = null, $edithint = null, $editlabel = null) {
1122         global $USER, $CFG;
1123         require_once($CFG->dirroot.'/course/lib.php');
1125         if ($editable === null) {
1126             $editable = !empty($USER->editing) && has_capability('moodle/course:update',
1127                     context_course::instance($section->course));
1128         }
1130         $displayvalue = $title = get_section_name($section->course, $section);
1131         if ($linkifneeded) {
1132             // Display link under the section name if the course format setting is to display one section per page.
1133             $url = course_get_url($section->course, $section->section, array('navigation' => true));
1134             if ($url) {
1135                 $displayvalue = html_writer::link($url, $title);
1136             }
1137             $itemtype = 'sectionname';
1138         } else {
1139             // If $linkifneeded==false, we never display the link (this is used when rendering the section header).
1140             // Itemtype 'sectionnamenl' (nl=no link) will tell the callback that link should not be rendered -
1141             // there is no other way callback can know where we display the section name.
1142             $itemtype = 'sectionnamenl';
1143         }
1144         if (empty($edithint)) {
1145             $edithint = new lang_string('editsectionname');
1146         }
1147         if (empty($editlabel)) {
1148             $editlabel = new lang_string('newsectionname', '', $title);
1149         }
1151         return new \core\output\inplace_editable('format_' . $this->format, $itemtype, $section->id, $editable,
1152             $displayvalue, $section->name, $edithint, $editlabel);
1153     }
1155     /**
1156      * Updates the value in the database and modifies this object respectively.
1157      *
1158      * ALWAYS check user permissions before performing an update! Throw exceptions if permissions are not sufficient
1159      * or value is not legit.
1160      *
1161      * @param stdClass $section
1162      * @param string $itemtype
1163      * @param mixed $newvalue
1164      * @return \core\output\inplace_editable
1165      */
1166     public function inplace_editable_update_section_name($section, $itemtype, $newvalue) {
1167         if ($itemtype === 'sectionname' || $itemtype === 'sectionnamenl') {
1168             $context = context_course::instance($section->course);
1169             external_api::validate_context($context);
1170             require_capability('moodle/course:update', $context);
1172             $newtitle = clean_param($newvalue, PARAM_TEXT);
1173             if (strval($section->name) !== strval($newtitle)) {
1174                 course_update_section($section->course, $section, array('name' => $newtitle));
1175             }
1176             return $this->inplace_editable_render_section_name($section, ($itemtype === 'sectionname'), true);
1177         }
1178     }
1181     /**
1182      * Returns the default end date value based on the start date.
1183      *
1184      * This is the default implementation for course formats, it is based on
1185      * moodlecourse/courseduration setting. Course formats like format_weeks for
1186      * example can overwrite this method and return a value based on their internal options.
1187      *
1188      * @param moodleform $mform
1189      * @param array $fieldnames The form - field names mapping.
1190      * @return int
1191      */
1192     public function get_default_course_enddate($mform, $fieldnames = array()) {
1194         if (empty($fieldnames)) {
1195             $fieldnames = array('startdate' => 'startdate');
1196         }
1198         $startdate = $this->get_form_start_date($mform, $fieldnames);
1199         $courseduration = intval(get_config('moodlecourse', 'courseduration'));
1200         if (!$courseduration) {
1201             // Default, it should be already set during upgrade though.
1202             $courseduration = YEARSECS;
1203         }
1205         return $startdate + $courseduration;
1206     }
1208     /**
1209      * Indicates whether the course format supports the creation of the Announcements forum.
1210      *
1211      * For course format plugin developers, please override this to return true if you want the Announcements forum
1212      * to be created upon course creation.
1213      *
1214      * @return bool
1215      */
1216     public function supports_news() {
1217         // For backwards compatibility, check if default blocks include the news_items block.
1218         $defaultblocks = $this->get_default_blocks();
1219         foreach ($defaultblocks as $blocks) {
1220             if (in_array('news_items', $blocks)) {
1221                 return true;
1222             }
1223         }
1224         // Return false by default.
1225         return false;
1226     }
1228     /**
1229      * Get the start date value from the course settings page form.
1230      *
1231      * @param moodleform $mform
1232      * @param array $fieldnames The form - field names mapping.
1233      * @return int
1234      */
1235     protected function get_form_start_date($mform, $fieldnames) {
1236         $startdate = $mform->getElementValue($fieldnames['startdate']);
1237         return $mform->getElement($fieldnames['startdate'])->exportValue($startdate);
1238     }
1240     /**
1241      * Returns whether this course format allows the activity to
1242      * have "triple visibility state" - visible always, hidden on course page but available, hidden.
1243      *
1244      * @param stdClass|cm_info $cm course module (may be null if we are displaying a form for adding a module)
1245      * @param stdClass|section_info $section section where this module is located or will be added to
1246      * @return bool
1247      */
1248     public function allow_stealth_module_visibility($cm, $section) {
1249         return false;
1250     }
1252     /**
1253      * Callback used in WS core_course_edit_section when teacher performs an AJAX action on a section (show/hide)
1254      *
1255      * Access to the course is already validated in the WS but the callback has to make sure
1256      * that particular action is allowed by checking capabilities
1257      *
1258      * Course formats should register
1259      *
1260      * @param stdClass|section_info $section
1261      * @param string $action
1262      * @param int $sr
1263      * @return null|array|stdClass any data for the Javascript post-processor (must be json-encodeable)
1264      */
1265     public function section_action($section, $action, $sr) {
1266         global $PAGE;
1267         if (!$this->uses_sections() || !$section->section) {
1268             // No section actions are allowed if course format does not support sections.
1269             // No actions are allowed on the 0-section by default (overwrite in course format if needed).
1270             throw new moodle_exception('sectionactionnotsupported', 'core', null, s($action));
1271         }
1273         $course = $this->get_course();
1274         $coursecontext = context_course::instance($course->id);
1275         switch($action) {
1276             case 'hide':
1277             case 'show':
1278                 require_capability('moodle/course:sectionvisibility', $coursecontext);
1279                 $visible = ($action === 'hide') ? 0 : 1;
1280                 course_update_section($course, $section, array('visible' => $visible));
1281                 break;
1282             default:
1283                 throw new moodle_exception('sectionactionnotsupported', 'core', null, s($action));
1284         }
1286         $modules = [];
1288         $modinfo = get_fast_modinfo($course);
1289         $coursesections = $modinfo->sections;
1290         if (array_key_exists($section->section, $coursesections)) {
1291             $courserenderer = $PAGE->get_renderer('core', 'course');
1292             $completioninfo = new completion_info($course);
1293             foreach ($coursesections[$section->section] as $cmid) {
1294                 $cm = $modinfo->get_cm($cmid);
1295                 $modules[] = $courserenderer->course_section_cm_list_item($course, $completioninfo, $cm, $sr);
1296             }
1297         }
1299         return ['modules' => $modules];
1300     }
1302     /**
1303      * Return the plugin config settings for external functions,
1304      * in some cases the configs will need formatting or be returned only if the current user has some capabilities enabled.
1305      *
1306      * @return array the list of configs
1307      * @since Moodle 3.5
1308      */
1309     public function get_config_for_external() {
1310         return array();
1311     }
1314 /**
1315  * Pseudo course format used for the site main page
1316  *
1317  * @package    core_course
1318  * @copyright  2012 Marina Glancy
1319  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1320  */
1321 class format_site extends format_base {
1323     /**
1324      * Returns the display name of the given section that the course prefers.
1325      *
1326      * @param int|stdClass $section Section object from database or just field section.section
1327      * @return Display name that the course format prefers, e.g. "Topic 2"
1328      */
1329     function get_section_name($section) {
1330         return get_string('site');
1331     }
1333     /**
1334      * For this fake course referring to the whole site, the site homepage is always returned
1335      * regardless of arguments
1336      *
1337      * @param int|stdClass $section
1338      * @param array $options
1339      * @return null|moodle_url
1340      */
1341     public function get_view_url($section, $options = array()) {
1342         return new moodle_url('/', array('redirect' => 0));
1343     }
1345     /**
1346      * Returns the list of blocks to be automatically added on the site frontpage when moodle is installed
1347      *
1348      * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
1349      *     each of values is an array of block names (for left and right side columns)
1350      */
1351     public function get_default_blocks() {
1352         return blocks_get_default_site_course_blocks();
1353     }
1355     /**
1356      * Definitions of the additional options that site uses
1357      *
1358      * @param bool $foreditform
1359      * @return array of options
1360      */
1361     public function course_format_options($foreditform = false) {
1362         static $courseformatoptions = false;
1363         if ($courseformatoptions === false) {
1364             $courseformatoptions = array(
1365                 'numsections' => array(
1366                     'default' => 1,
1367                     'type' => PARAM_INT,
1368                 ),
1369             );
1370         }
1371         return $courseformatoptions;
1372     }
1374     /**
1375      * Returns whether this course format allows the activity to
1376      * have "triple visibility state" - visible always, hidden on course page but available, hidden.
1377      *
1378      * @param stdClass|cm_info $cm course module (may be null if we are displaying a form for adding a module)
1379      * @param stdClass|section_info $section section where this module is located or will be added to
1380      * @return bool
1381      */
1382     public function allow_stealth_module_visibility($cm, $section) {
1383         return true;
1384     }