931748b1e92e67896f85b46da2546927891f1819
[moodle.git] / lib / modinfolib.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  * modinfolib.php - Functions/classes relating to cached information about module instances on
19  * a course.
20  * @package    core
21  * @subpackage lib
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @author     sam marshall
24  */
27 // Maximum number of modinfo items to keep in memory cache. Do not increase this to a large
28 // number because:
29 // a) modinfo can be big (megabyte range) for some courses
30 // b) performance of cache will deteriorate if there are very many items in it
31 if (!defined('MAX_MODINFO_CACHE_SIZE')) {
32     define('MAX_MODINFO_CACHE_SIZE', 10);
33 }
36 /**
37  * Information about a course that is cached in the course table 'modinfo' field (and then in
38  * memory) in order to reduce the need for other database queries.
39  *
40  * This includes information about the course-modules and the sections on the course. It can also
41  * include dynamic data that has been updated for the current user.
42  *
43  * Use {@link get_fast_modinfo()} to retrieve the instance of the object for particular course
44  * and particular user.
45  *
46  * @property-read int $courseid Course ID
47  * @property-read int $userid User ID
48  * @property-read array $sections Array from section number (e.g. 0) to array of course-module IDs in that
49  *     section; this only includes sections that contain at least one course-module
50  * @property-read cm_info[] $cms Array from course-module instance to cm_info object within this course, in
51  *     order of appearance
52  * @property-read cm_info[][] $instances Array from string (modname) => int (instance id) => cm_info object
53  * @property-read array $groups Groups that the current user belongs to. Calculated on the first request.
54  *     Is an array of grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'
55  */
56 class course_modinfo {
57     /**
58      * List of fields from DB table 'course' that are cached in MUC and are always present in course_modinfo::$course
59      * @var array
60      */
61     public static $cachedfields = array('shortname', 'fullname', 'format',
62             'enablecompletion', 'groupmode', 'groupmodeforce', 'cacherev');
64     /**
65      * For convenience we store the course object here as it is needed in other parts of code
66      * @var stdClass
67      */
68     private $course;
70     /**
71      * Array of section data from cache
72      * @var section_info[]
73      */
74     private $sectioninfo;
76     /**
77      * User ID
78      * @var int
79      */
80     private $userid;
82     /**
83      * Array from int (section num, e.g. 0) => array of int (course-module id); this list only
84      * includes sections that actually contain at least one course-module
85      * @var array
86      */
87     private $sections;
89     /**
90      * Array from int (cm id) => cm_info object
91      * @var cm_info[]
92      */
93     private $cms;
95     /**
96      * Array from string (modname) => int (instance id) => cm_info object
97      * @var cm_info[][]
98      */
99     private $instances;
101     /**
102      * Groups that the current user belongs to. This value is usually not available (set to null)
103      * unless the course has activities set to groupmembersonly. When set, it is an array of
104      * grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'.
105      * @var int[][]
106      */
107     private $groups;
109     /**
110      * List of class read-only properties and their getter methods.
111      * Used by magic functions __get(), __isset(), __empty()
112      * @var array
113      */
114     private static $standardproperties = array(
115         'courseid' => 'get_course_id',
116         'userid' => 'get_user_id',
117         'sections' => 'get_sections',
118         'cms' => 'get_cms',
119         'instances' => 'get_instances',
120         'groups' => 'get_groups_all',
121     );
123     /**
124      * Magic method getter
125      *
126      * @param string $name
127      * @return mixed
128      */
129     public function __get($name) {
130         if (isset(self::$standardproperties[$name])) {
131             $method = self::$standardproperties[$name];
132             return $this->$method();
133         } else {
134             debugging('Invalid course_modinfo property accessed: '.$name);
135             return null;
136         }
137     }
139     /**
140      * Magic method for function isset()
141      *
142      * @param string $name
143      * @return bool
144      */
145     public function __isset($name) {
146         if (isset(self::$standardproperties[$name])) {
147             $value = $this->__get($name);
148             return isset($value);
149         }
150         return false;
151     }
153     /**
154      * Magic method for function empty()
155      *
156      * @param string $name
157      * @return bool
158      */
159     public function __empty($name) {
160         if (isset(self::$standardproperties[$name])) {
161             $value = $this->__get($name);
162             return empty($value);
163         }
164         return true;
165     }
167     /**
168      * Magic method setter
169      *
170      * Will display the developer warning when trying to set/overwrite existing property.
171      *
172      * @param string $name
173      * @param mixed $value
174      */
175     public function __set($name, $value) {
176         debugging("It is not allowed to set the property course_modinfo::\${$name}", DEBUG_DEVELOPER);
177     }
179     /**
180      * Returns course object that was used in the first {@link get_fast_modinfo()} call.
181      *
182      * It may not contain all fields from DB table {course} but always has at least the following:
183      * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
184      *
185      * @return stdClass
186      */
187     public function get_course() {
188         return $this->course;
189     }
191     /**
192      * @return int Course ID
193      */
194     public function get_course_id() {
195         return $this->course->id;
196     }
198     /**
199      * @return int User ID
200      */
201     public function get_user_id() {
202         return $this->userid;
203     }
205     /**
206      * @return array Array from section number (e.g. 0) to array of course-module IDs in that
207      *   section; this only includes sections that contain at least one course-module
208      */
209     public function get_sections() {
210         return $this->sections;
211     }
213     /**
214      * @return cm_info[] Array from course-module instance to cm_info object within this course, in
215      *   order of appearance
216      */
217     public function get_cms() {
218         return $this->cms;
219     }
221     /**
222      * Obtains a single course-module object (for a course-module that is on this course).
223      * @param int $cmid Course-module ID
224      * @return cm_info Information about that course-module
225      * @throws moodle_exception If the course-module does not exist
226      */
227     public function get_cm($cmid) {
228         if (empty($this->cms[$cmid])) {
229             throw new moodle_exception('invalidcoursemodule', 'error');
230         }
231         return $this->cms[$cmid];
232     }
234     /**
235      * Obtains all module instances on this course.
236      * @return cm_info[][] Array from module name => array from instance id => cm_info
237      */
238     public function get_instances() {
239         return $this->instances;
240     }
242     /**
243      * Returns array of localised human-readable module names used in this course
244      *
245      * @param bool $plural if true returns the plural form of modules names
246      * @return array
247      */
248     public function get_used_module_names($plural = false) {
249         $modnames = get_module_types_names($plural);
250         $modnamesused = array();
251         foreach ($this->get_cms() as $cmid => $mod) {
252             if (isset($modnames[$mod->modname]) && $mod->uservisible) {
253                 $modnamesused[$mod->modname] = $modnames[$mod->modname];
254             }
255         }
256         core_collator::asort($modnamesused);
257         return $modnamesused;
258     }
260     /**
261      * Obtains all instances of a particular module on this course.
262      * @param $modname Name of module (not full frankenstyle) e.g. 'label'
263      * @return cm_info[] Array from instance id => cm_info for modules on this course; empty if none
264      */
265     public function get_instances_of($modname) {
266         if (empty($this->instances[$modname])) {
267             return array();
268         }
269         return $this->instances[$modname];
270     }
272     /**
273      * Groups that the current user belongs to organised by grouping id. Calculated on the first request.
274      * @return int[][] array of grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'
275      */
276     private function get_groups_all() {
277         if (is_null($this->groups)) {
278             // NOTE: Performance could be improved here. The system caches user groups
279             // in $USER->groupmember[$courseid] => array of groupid=>groupid. Unfortunately this
280             // structure does not include grouping information. It probably could be changed to
281             // do so, without a significant performance hit on login, thus saving this one query
282             // each request.
283             $this->groups = groups_get_user_groups($this->course->id, $this->userid);
284         }
285         return $this->groups;
286     }
288     /**
289      * Returns groups that the current user belongs to on the course. Note: If not already
290      * available, this may make a database query.
291      * @param int $groupingid Grouping ID or 0 (default) for all groups
292      * @return int[] Array of int (group id) => int (same group id again); empty array if none
293      */
294     public function get_groups($groupingid = 0) {
295         $allgroups = $this->get_groups_all();
296         if (!isset($allgroups[$groupingid])) {
297             return array();
298         }
299         return $allgroups[$groupingid];
300     }
302     /**
303      * Gets all sections as array from section number => data about section.
304      * @return section_info[] Array of section_info objects organised by section number
305      */
306     public function get_section_info_all() {
307         return $this->sectioninfo;
308     }
310     /**
311      * Gets data about specific numbered section.
312      * @param int $sectionnumber Number (not id) of section
313      * @param int $strictness Use MUST_EXIST to throw exception if it doesn't
314      * @return section_info Information for numbered section or null if not found
315      */
316     public function get_section_info($sectionnumber, $strictness = IGNORE_MISSING) {
317         if (!array_key_exists($sectionnumber, $this->sectioninfo)) {
318             if ($strictness === MUST_EXIST) {
319                 throw new moodle_exception('sectionnotexist');
320             } else {
321                 return null;
322             }
323         }
324         return $this->sectioninfo[$sectionnumber];
325     }
327     /**
328      * Static cache for generated course_modinfo instances
329      *
330      * @see course_modinfo::instance()
331      * @see course_modinfo::clear_instance_cache()
332      * @var course_modinfo[]
333      */
334     protected static $instancecache = array();
336     /**
337      * Timestamps (microtime) when the course_modinfo instances were last accessed
338      *
339      * It is used to remove the least recent accessed instances when static cache is full
340      *
341      * @var float[]
342      */
343     protected static $cacheaccessed = array();
345     /**
346      * Clears the cache used in course_modinfo::instance()
347      *
348      * Used in {@link get_fast_modinfo()} when called with argument $reset = true
349      * and in {@link rebuild_course_cache()}
350      *
351      * @param null|int|stdClass $courseorid if specified removes only cached value for this course
352      */
353     public static function clear_instance_cache($courseorid = null) {
354         if (empty($courseorid)) {
355             self::$instancecache = array();
356             self::$cacheaccessed = array();
357             return;
358         }
359         if (is_object($courseorid)) {
360             $courseorid = $courseorid->id;
361         }
362         if (isset(self::$instancecache[$courseorid])) {
363             // Unsetting static variable in PHP is peculiar, it removes the reference,
364             // but data remain in memory. Prior to unsetting, the varable needs to be
365             // set to empty to remove its remains from memory.
366             self::$instancecache[$courseorid] = '';
367             unset(self::$instancecache[$courseorid]);
368             unset(self::$cacheaccessed[$courseorid]);
369         }
370     }
372     /**
373      * Returns the instance of course_modinfo for the specified course and specified user
374      *
375      * This function uses static cache for the retrieved instances. The cache
376      * size is limited by MAX_MODINFO_CACHE_SIZE. If instance is not found in
377      * the static cache or it was created for another user or the cacherev validation
378      * failed - a new instance is constructed and returned.
379      *
380      * Used in {@link get_fast_modinfo()}
381      *
382      * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
383      *     and recommended to have field 'cacherev') or just a course id
384      * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections.
385      *     Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
386      * @return course_modinfo
387      */
388     public static function instance($courseorid, $userid = 0) {
389         global $USER;
390         if (is_object($courseorid)) {
391             $course = $courseorid;
392         } else {
393             $course = (object)array('id' => $courseorid);
394         }
395         if (empty($userid)) {
396             $userid = $USER->id;
397         }
399         if (!empty(self::$instancecache[$course->id])) {
400             if (self::$instancecache[$course->id]->userid == $userid &&
401                     (!isset($course->cacherev) ||
402                     $course->cacherev == self::$instancecache[$course->id]->get_course()->cacherev)) {
403                 // This course's modinfo for the same user was recently retrieved, return cached.
404                 self::$cacheaccessed[$course->id] = microtime(true);
405                 return self::$instancecache[$course->id];
406             } else {
407                 // Prevent potential reference problems when switching users.
408                 self::clear_instance_cache($course->id);
409             }
410         }
411         $modinfo = new course_modinfo($course, $userid);
413         // We have a limit of MAX_MODINFO_CACHE_SIZE entries to store in static variable.
414         if (count(self::$instancecache) >= MAX_MODINFO_CACHE_SIZE) {
415             // Find the course that was the least recently accessed.
416             asort(self::$cacheaccessed, SORT_NUMERIC);
417             $courseidtoremove = key(array_reverse(self::$cacheaccessed, true));
418             self::clear_instance_cache($courseidtoremove);
419         }
421         // Add modinfo to the static cache.
422         self::$instancecache[$course->id] = $modinfo;
423         self::$cacheaccessed[$course->id] = microtime(true);
425         return $modinfo;
426     }
428     /**
429      * Constructs based on course.
430      * Note: This constructor should not usually be called directly.
431      * Use get_fast_modinfo($course) instead as this maintains a cache.
432      * @param stdClass $course course object, only property id is required.
433      * @param int $userid User ID
434      * @throws moodle_exception if course is not found
435      */
436     public function __construct($course, $userid) {
437         global $CFG, $COURSE, $SITE, $DB;
439         if (!isset($course->cacherev)) {
440             // We require presence of property cacherev to validate the course cache.
441             // No need to clone the $COURSE or $SITE object here because we clone it below anyway.
442             $course = get_course($course->id, false);
443         }
445         $cachecoursemodinfo = cache::make('core', 'coursemodinfo');
447         // Retrieve modinfo from cache. If not present or cacherev mismatches, call rebuild and retrieve again.
448         $coursemodinfo = $cachecoursemodinfo->get($course->id);
449         if ($coursemodinfo === false || ($course->cacherev != $coursemodinfo->cacherev)) {
450             $coursemodinfo = self::build_course_cache($course);
451         }
453         // Set initial values
454         $this->userid = $userid;
455         $this->sections = array();
456         $this->cms = array();
457         $this->instances = array();
458         $this->groups = null;
460         // If we haven't already preloaded contexts for the course, do it now
461         // Modules are also cached here as long as it's the first time this course has been preloaded.
462         context_helper::preload_course($course->id);
464         // Quick integrity check: as a result of race conditions modinfo may not be regenerated after the change.
465         // It is especially dangerous if modinfo contains the deleted course module, as it results in fatal error.
466         // We can check it very cheap by validating the existence of module context.
467         if ($course->id == $COURSE->id || $course->id == $SITE->id) {
468             // Only verify current course (or frontpage) as pages with many courses may not have module contexts cached.
469             // (Uncached modules will result in a very slow verification).
470             foreach ($coursemodinfo->modinfo as $mod) {
471                 if (!context_module::instance($mod->cm, IGNORE_MISSING)) {
472                     debugging('Course cache integrity check failed: course module with id '. $mod->cm.
473                             ' does not have context. Rebuilding cache for course '. $course->id);
474                     // Re-request the course record from DB as well, don't use get_course() here.
475                     $course = $DB->get_record('course', array('id' => $course->id), '*', MUST_EXIST);
476                     $coursemodinfo = self::build_course_cache($course);
477                     break;
478                 }
479             }
480         }
482         // Overwrite unset fields in $course object with cached values, store the course object.
483         $this->course = fullclone($course);
484         foreach ($coursemodinfo as $key => $value) {
485             if ($key !== 'modinfo' && $key !== 'sectioncache' &&
486                     (!isset($this->course->$key) || $key === 'cacherev')) {
487                 $this->course->$key = $value;
488             }
489         }
491         // Loop through each piece of module data, constructing it
492         static $modexists = array();
493         foreach ($coursemodinfo->modinfo as $mod) {
494             if (empty($mod->name)) {
495                 // something is wrong here
496                 continue;
497             }
499             // Skip modules which don't exist
500             if (!array_key_exists($mod->mod, $modexists)) {
501                 $modexists[$mod->mod] = file_exists("$CFG->dirroot/mod/$mod->mod/lib.php");
502             }
503             if (!$modexists[$mod->mod]) {
504                 continue;
505             }
507             // Construct info for this module
508             $cm = new cm_info($this, null, $mod, null);
510             // Store module in instances and cms array
511             if (!isset($this->instances[$cm->modname])) {
512                 $this->instances[$cm->modname] = array();
513             }
514             $this->instances[$cm->modname][$cm->instance] = $cm;
515             $this->cms[$cm->id] = $cm;
517             // Reconstruct sections. This works because modules are stored in order
518             if (!isset($this->sections[$cm->sectionnum])) {
519                 $this->sections[$cm->sectionnum] = array();
520             }
521             $this->sections[$cm->sectionnum][] = $cm->id;
522         }
524         // Expand section objects
525         $this->sectioninfo = array();
526         foreach ($coursemodinfo->sectioncache as $number => $data) {
527             $this->sectioninfo[$number] = new section_info($data, $number, null, null,
528                     $this, null);
529         }
530     }
532     /**
533      * Builds a list of information about sections on a course to be stored in
534      * the course cache. (Does not include information that is already cached
535      * in some other way.)
536      *
537      * This function will be removed in 2.7
538      *
539      * @deprecated since 2.6
540      * @param int $courseid Course ID
541      * @return array Information about sections, indexed by section number (not id)
542      */
543     public static function build_section_cache($courseid) {
544         global $DB;
545         debugging('Function course_modinfo::build_section_cache() is deprecated. It can only be used internally to build course cache.');
546         $course = $DB->get_record('course', array('id' => $course->id),
547                         array_merge(array('id'), self::$cachedfields), MUST_EXIST);
548         return self::build_course_section_cache($course);
549     }
551     /**
552      * Builds a list of information about sections on a course to be stored in
553      * the course cache. (Does not include information that is already cached
554      * in some other way.)
555      *
556      * @param stdClass $course Course object (must contain fields
557      * @return array Information about sections, indexed by section number (not id)
558      */
559     protected static function build_course_section_cache($course) {
560         global $DB;
562         // Get section data
563         $sections = $DB->get_records('course_sections', array('course' => $course->id), 'section',
564                 'section, id, course, name, summary, summaryformat, sequence, visible, ' .
565                 'availablefrom, availableuntil, showavailability, groupingid');
566         $compressedsections = array();
568         $formatoptionsdef = course_get_format($course)->section_format_options();
569         // Remove unnecessary data and add availability
570         foreach ($sections as $number => $section) {
571             // Add cached options from course format to $section object
572             foreach ($formatoptionsdef as $key => $option) {
573                 if (!empty($option['cache'])) {
574                     $formatoptions = course_get_format($course)->get_format_options($section);
575                     if (!array_key_exists('cachedefault', $option) || $option['cachedefault'] !== $formatoptions[$key]) {
576                         $section->$key = $formatoptions[$key];
577                     }
578                 }
579             }
580             // Clone just in case it is reused elsewhere
581             $compressedsections[$number] = clone($section);
582             section_info::convert_for_section_cache($compressedsections[$number]);
583         }
585         return $compressedsections;
586     }
588     /**
589      * Builds and stores in MUC object containing information about course
590      * modules and sections together with cached fields from table course.
591      *
592      * @param stdClass $course object from DB table course. Must have property 'id'
593      *     but preferably should have all cached fields.
594      * @return stdClass object with all cached keys of the course plus fields modinfo and sectioncache.
595      *     The same object is stored in MUC
596      * @throws moodle_exception if course is not found (if $course object misses some of the
597      *     necessary fields it is re-requested from database)
598      */
599     public static function build_course_cache($course) {
600         global $DB, $CFG;
601         require_once("$CFG->dirroot/course/lib.php");
602         if (empty($course->id)) {
603             throw new coding_exception('Object $course is missing required property \id\'');
604         }
605         // Ensure object has all necessary fields.
606         foreach (self::$cachedfields as $key) {
607             if (!isset($course->$key)) {
608                 $course = $DB->get_record('course', array('id' => $course->id),
609                         array_merge(array('id'), self::$cachedfields), MUST_EXIST);
610                 break;
611             }
612         }
613         // Retrieve all information about activities and sections.
614         // This may take time on large courses and it is possible that another user modifies the same course during this process.
615         // Field cacherev stored in both DB and cache will ensure that cached data matches the current course state.
616         $coursemodinfo = new stdClass();
617         $coursemodinfo->modinfo = get_array_of_activities($course->id);
618         $coursemodinfo->sectioncache = self::build_course_section_cache($course);
619         foreach (self::$cachedfields as $key) {
620             $coursemodinfo->$key = $course->$key;
621         }
622         // Set the accumulated activities and sections information in cache, together with cacherev.
623         $cachecoursemodinfo = cache::make('core', 'coursemodinfo');
624         $cachecoursemodinfo->set($course->id, $coursemodinfo);
625         return $coursemodinfo;
626     }
630 /**
631  * Data about a single module on a course. This contains most of the fields in the course_modules
632  * table, plus additional data when required.
633  *
634  * The object can be accessed by core or any plugin (i.e. course format, block, filter, etc.) as
635  * get_fast_modinfo($courseorid)->cms[$coursemoduleid]
636  * or
637  * get_fast_modinfo($courseorid)->instances[$moduletype][$instanceid]
638  *
639  * There are three stages when activity module can add/modify data in this object:
640  *
641  * <b>Stage 1 - during building the cache.</b>
642  * Allows to add to the course cache static user-independent information about the module.
643  * Modules should try to include only absolutely necessary information that may be required
644  * when displaying course view page. The information is stored in application-level cache
645  * and reset when {@link rebuild_course_cache()} is called or cache is purged by admin.
646  *
647  * Modules can implement callback XXX_get_coursemodule_info() returning instance of object
648  * {@link cached_cm_info}
649  *
650  * <b>Stage 2 - dynamic data.</b>
651  * Dynamic data is user-dependend, it is stored in request-level cache. To reset this cache
652  * {@link get_fast_modinfo()} with $reset argument may be called.
653  *
654  * Dynamic data is obtained when any of the following properties/methods is requested:
655  * - {@link cm_info::$url}
656  * - {@link cm_info::$name}
657  * - {@link cm_info::$onclick}
658  * - {@link cm_info::get_icon_url()}
659  * - {@link cm_info::$uservisible}
660  * - {@link cm_info::$available}
661  * - {@link cm_info::$showavailability}
662  * - {@link cm_info::$availableinfo}
663  * - plus any of the properties listed in Stage 3.
664  *
665  * Modules can implement callback <b>XXX_cm_info_dynamic()</b> and inside this callback they
666  * are allowed to use any of the following set methods:
667  * - {@link cm_info::set_available()}
668  * - {@link cm_info::set_name()}
669  * - {@link cm_info::set_no_view_link()}
670  * - {@link cm_info::set_user_visible()}
671  * - {@link cm_info::set_on_click()}
672  * - {@link cm_info::set_icon_url()}
673  * Any methods affecting view elements can also be set in this callback.
674  *
675  * <b>Stage 3 (view data).</b>
676  * Also user-dependend data stored in request-level cache. Second stage is created
677  * because populating the view data can be expensive as it may access much more
678  * Moodle APIs such as filters, user information, output renderers and we
679  * don't want to request it until necessary.
680  * View data is obtained when any of the following properties/methods is requested:
681  * - {@link cm_info::$afterediticons}
682  * - {@link cm_info::$content}
683  * - {@link cm_info::get_formatted_content()}
684  * - {@link cm_info::$extraclasses}
685  * - {@link cm_info::$afterlink}
686  *
687  * Modules can implement callback <b>XXX_cm_info_view()</b> and inside this callback they
688  * are allowed to use any of the following set methods:
689  * - {@link cm_info::set_after_edit_icons()}
690  * - {@link cm_info::set_after_link()}
691  * - {@link cm_info::set_content()}
692  * - {@link cm_info::set_extra_classes()}
693  *
694  * @property-read int $id Course-module ID - from course_modules table
695  * @property-read int $instance Module instance (ID within module table) - from course_modules table
696  * @property-read int $course Course ID - from course_modules table
697  * @property-read string $idnumber 'ID number' from course-modules table (arbitrary text set by user) - from
698  *    course_modules table
699  * @property-read int $added Time that this course-module was added (unix time) - from course_modules table
700  * @property-read int $visible Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
701  *    course_modules table
702  * @property-read int $visibleold Old visible setting (if the entire section is hidden, the previous value for
703  *    visible is stored in this field) - from course_modules table
704  * @property-read int $groupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
705  *    course_modules table. Use {@link cm_info::$effectivegroupmode} to find the actual group mode that may be forced by course.
706  * @property-read int $groupingid Grouping ID (0 = all groupings)
707  * @property-read int $groupmembersonly Group members only (if set to 1, only members of a suitable group see this link on the
708  *    course page; 0 = everyone sees it even if they don't belong to a suitable group) - from
709  *    course_modules table
710  * @property-read bool $coursegroupmodeforce Indicates whether the course containing the module has forced the groupmode
711  *    This means that cm_info::$groupmode should be ignored and cm_info::$coursegroupmode be used instead
712  * @property-read int $coursegroupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
713  *    course table - as specified for the course containing the module
714  *    Effective only if {@link cm_info::$coursegroupmodeforce} is set
715  * @property-read int $effectivegroupmode Effective group mode for this module (one of the constants NOGROUPS, SEPARATEGROUPS,
716  *    or VISIBLEGROUPS). This can be different from groupmode set for the module if the groupmode is forced for the course.
717  *    This value will always be NOGROUPS if module type does not support group mode.
718  * @property-read int $indent Indent level on course page (0 = no indent) - from course_modules table
719  * @property-read int $completion Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
720  *    course_modules table
721  * @property-read mixed $completiongradeitemnumber Set to the item number (usually 0) if completion depends on a particular
722  *    grade of this activity, or null if completion does not depend on a grade - from course_modules table
723  * @property-read int $completionview 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
724  * @property-read int $completionexpected Set to a unix time if completion of this activity is expected at a
725  *    particular time, 0 if no time set - from course_modules table
726  * @property-read int $availablefrom Available date for this activity (0 if not set, or set to seconds since epoch; before this
727  *    date, activity does not display to students) - from course_modules table
728  * @property-read int $availableuntil Available until date for this activity (0 if not set, or set to seconds since epoch; from
729  *    this date, activity does not display to students) - from course_modules table
730  * @property-read int $showavailability When activity is unavailable, this field controls whether it is shown to students (0 =
731  *    hide completely, 1 = show greyed out with information about when it will be available) -
732  *    from course_modules table
733  * @property-read int $showdescription Controls whether the description of the activity displays on the course main page (in
734  *    addition to anywhere it might display within the activity itself). 0 = do not show
735  *    on main page, 1 = show on main page.
736  * @property-read string $extra (deprecated) Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
737  *    course page - from cached data in modinfo field. Deprecated, replaced by ->extraclasses and ->onclick
738  * @property-read string $icon Name of icon to use - from cached data in modinfo field
739  * @property-read string $iconcomponent Component that contains icon - from cached data in modinfo field
740  * @property-read string $modname Name of module e.g. 'forum' (this is the same name as the module's main database
741  *    table) - from cached data in modinfo field
742  * @property-read int $module ID of module type - from course_modules table
743  * @property-read string $name Name of module instance for display on page e.g. 'General discussion forum' - from cached
744  *    data in modinfo field
745  * @property-read int $sectionnum Section number that this course-module is in (section 0 = above the calendar, section 1
746  *    = week/topic 1, etc) - from cached data in modinfo field
747  * @property-read int $section Section id - from course_modules table
748  * @property-read array $conditionscompletion Availability conditions for this course-module based on the completion of other
749  *    course-modules (array from other course-module id to required completion state for that
750  *    module) - from cached data in modinfo field
751  * @property-read array $conditionsgrade Availability conditions for this course-module based on course grades (array from
752  *    grade item id to object with ->min, ->max fields) - from cached data in modinfo field
753  * @property-read array $conditionsfield Availability conditions for this course-module based on user fields
754  * @property-read bool $available True if this course-module is available to students i.e. if all availability conditions
755  *    are met - obtained dynamically
756  * @property-read string $availableinfo If course-module is not available to students, this string gives information about
757  *    availability which can be displayed to students and/or staff (e.g. 'Available from 3
758  *    January 2010') for display on main page - obtained dynamically
759  * @property-read bool $uservisible True if this course-module is available to the CURRENT user (for example, if current user
760  *    has viewhiddenactivities capability, they can access the course-module even if it is not
761  *    visible or not available, so this would be true in that case)
762  * @property-read context_module $context Module context
763  * @property-read string $modfullname Returns a localised human-readable name of the module type - calculated on request
764  * @property-read string $modplural Returns a localised human-readable name of the module type in plural form - calculated on request
765  * @property-read string $content Content to display on main (view) page - calculated on request
766  * @property-read moodle_url $url URL to link to for this module, or null if it doesn't have a view page - calculated on request
767  * @property-read string $extraclasses Extra CSS classes to add to html output for this activity on main page - calculated on request
768  * @property-read string $onclick Content of HTML on-click attribute already escaped - calculated on request
769  * @property-read mixed $customdata Optional custom data stored in modinfo cache for this activity, or null if none
770  * @property-read string $afterlink Extra HTML code to display after link - calculated on request
771  * @property-read string $afterediticons Extra HTML code to display after editing icons (e.g. more icons) - calculated on request
772  */
773 class cm_info implements IteratorAggregate {
774     /**
775      * State: Only basic data from modinfo cache is available.
776      */
777     const STATE_BASIC = 0;
779     /**
780      * State: In the process of building dynamic data (to avoid recursive calls to obtain_dynamic_data())
781      */
782     const STATE_BUILDING_DYNAMIC = 1;
784     /**
785      * State: Dynamic data is available too.
786      */
787     const STATE_DYNAMIC = 2;
789     /**
790      * State: In the process of building view data (to avoid recursive calls to obtain_view_data())
791      */
792     const STATE_BUILDING_VIEW = 3;
794     /**
795      * State: View data (for course page) is available.
796      */
797     const STATE_VIEW = 4;
799     /**
800      * Parent object
801      * @var course_modinfo
802      */
803     private $modinfo;
805     /**
806      * Level of information stored inside this object (STATE_xx constant)
807      * @var int
808      */
809     private $state;
811     /**
812      * Course-module ID - from course_modules table
813      * @var int
814      */
815     private $id;
817     /**
818      * Module instance (ID within module table) - from course_modules table
819      * @var int
820      */
821     private $instance;
823     /**
824      * 'ID number' from course-modules table (arbitrary text set by user) - from
825      * course_modules table
826      * @var string
827      */
828     private $idnumber;
830     /**
831      * Time that this course-module was added (unix time) - from course_modules table
832      * @var int
833      */
834     private $added;
836     /**
837      * This variable is not used and is included here only so it can be documented.
838      * Once the database entry is removed from course_modules, it should be deleted
839      * here too.
840      * @var int
841      * @deprecated Do not use this variable
842      */
843     private $score;
845     /**
846      * Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
847      * course_modules table
848      * @var int
849      */
850     private $visible;
852     /**
853      * Old visible setting (if the entire section is hidden, the previous value for
854      * visible is stored in this field) - from course_modules table
855      * @var int
856      */
857     private $visibleold;
859     /**
860      * Group mode (one of the constants NONE, SEPARATEGROUPS, or VISIBLEGROUPS) - from
861      * course_modules table
862      * @var int
863      */
864     private $groupmode;
866     /**
867      * Grouping ID (0 = all groupings)
868      * @var int
869      */
870     private $groupingid;
872     /**
873      * Group members only (if set to 1, only members of a suitable group see this link on the
874      * course page; 0 = everyone sees it even if they don't belong to a suitable group)  - from
875      * course_modules table
876      * @var int
877      */
878     private $groupmembersonly;
880     /**
881      * Indent level on course page (0 = no indent) - from course_modules table
882      * @var int
883      */
884     private $indent;
886     /**
887      * Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
888      * course_modules table
889      * @var int
890      */
891     private $completion;
893     /**
894      * Set to the item number (usually 0) if completion depends on a particular
895      * grade of this activity, or null if completion does not depend on a grade - from
896      * course_modules table
897      * @var mixed
898      */
899     private $completiongradeitemnumber;
901     /**
902      * 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
903      * @var int
904      */
905     private $completionview;
907     /**
908      * Set to a unix time if completion of this activity is expected at a
909      * particular time, 0 if no time set - from course_modules table
910      * @var int
911      */
912     private $completionexpected;
914     /**
915      * Available date for this activity (0 if not set, or set to seconds since epoch; before this
916      * date, activity does not display to students) - from course_modules table
917      * @var int
918      */
919     private $availablefrom;
921     /**
922      * Available until date for this activity (0 if not set, or set to seconds since epoch; from
923      * this date, activity does not display to students) - from course_modules table
924      * @var int
925      */
926     private $availableuntil;
928     /**
929      * When activity is unavailable, this field controls whether it is shown to students (0 =
930      * hide completely, 1 = show greyed out with information about when it will be available) -
931      * from course_modules table
932      * @var int
933      */
934     private $showavailability;
936     /**
937      * Controls whether the description of the activity displays on the course main page (in
938      * addition to anywhere it might display within the activity itself). 0 = do not show
939      * on main page, 1 = show on main page.
940      * @var int
941      */
942     private $showdescription;
944     /**
945      * Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
946      * course page - from cached data in modinfo field
947      * @deprecated This is crazy, don't use it. Replaced by ->extraclasses and ->onclick
948      * @var string
949      */
950     private $extra;
952     /**
953      * Name of icon to use - from cached data in modinfo field
954      * @var string
955      */
956     private $icon;
958     /**
959      * Component that contains icon - from cached data in modinfo field
960      * @var string
961      */
962     private $iconcomponent;
964     /**
965      * Name of module e.g. 'forum' (this is the same name as the module's main database
966      * table) - from cached data in modinfo field
967      * @var string
968      */
969     private $modname;
971     /**
972      * ID of module - from course_modules table
973      * @var int
974      */
975     private $module;
977     /**
978      * Name of module instance for display on page e.g. 'General discussion forum' - from cached
979      * data in modinfo field
980      * @var string
981      */
982     private $name;
984     /**
985      * Section number that this course-module is in (section 0 = above the calendar, section 1
986      * = week/topic 1, etc) - from cached data in modinfo field
987      * @var int
988      */
989     private $sectionnum;
991     /**
992      * Section id - from course_modules table
993      * @var int
994      */
995     private $section;
997     /**
998      * Availability conditions for this course-module based on the completion of other
999      * course-modules (array from other course-module id to required completion state for that
1000      * module) - from cached data in modinfo field
1001      * @var array
1002      */
1003     private $conditionscompletion;
1005     /**
1006      * Availability conditions for this course-module based on course grades (array from
1007      * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
1008      * @var array
1009      */
1010     private $conditionsgrade;
1012     /**
1013      * Availability conditions for this course-module based on user fields
1014      * @var array
1015      */
1016     private $conditionsfield;
1018     /**
1019      * True if this course-module is available to students i.e. if all availability conditions
1020      * are met - obtained dynamically
1021      * @var bool
1022      */
1023     private $available;
1025     /**
1026      * If course-module is not available to students, this string gives information about
1027      * availability which can be displayed to students and/or staff (e.g. 'Available from 3
1028      * January 2010') for display on main page - obtained dynamically
1029      * @var string
1030      */
1031     private $availableinfo;
1033     /**
1034      * True if this course-module is available to the CURRENT user (for example, if current user
1035      * has viewhiddenactivities capability, they can access the course-module even if it is not
1036      * visible or not available, so this would be true in that case)
1037      * @var bool
1038      */
1039     private $uservisible;
1041     /**
1042      * @var moodle_url
1043      */
1044     private $url;
1046     /**
1047      * @var string
1048      */
1049     private $content;
1051     /**
1052      * @var string
1053      */
1054     private $extraclasses;
1056     /**
1057      * @var moodle_url full external url pointing to icon image for activity
1058      */
1059     private $iconurl;
1061     /**
1062      * @var string
1063      */
1064     private $onclick;
1066     /**
1067      * @var mixed
1068      */
1069     private $customdata;
1071     /**
1072      * @var string
1073      */
1074     private $afterlink;
1076     /**
1077      * @var string
1078      */
1079     private $afterediticons;
1081     /**
1082      * List of class read-only properties and their getter methods.
1083      * Used by magic functions __get(), __isset(), __empty()
1084      * @var array
1085      */
1086     private static $standardproperties = array(
1087         'url' => 'get_url',
1088         'content' => 'get_content',
1089         'extraclasses' => 'get_extra_classes',
1090         'onclick' => 'get_on_click',
1091         'customdata' => 'get_custom_data',
1092         'afterlink' => 'get_after_link',
1093         'afterediticons' => 'get_after_edit_icons',
1094         'modfullname' => 'get_module_type_name',
1095         'modplural' => 'get_module_type_name_plural',
1096         'id' => false,
1097         'added' => false,
1098         'available' => 'get_available',
1099         'availablefrom' => false,
1100         'availableinfo' => 'get_available_info',
1101         'availableuntil' => false,
1102         'completion' => false,
1103         'completionexpected' => false,
1104         'completiongradeitemnumber' => false,
1105         'completionview' => false,
1106         'conditionscompletion' => false,
1107         'conditionsfield' => false,
1108         'conditionsgrade' => false,
1109         'context' => 'get_context',
1110         'course' => 'get_course_id',
1111         'coursegroupmode' => 'get_course_groupmode',
1112         'coursegroupmodeforce' => 'get_course_groupmodeforce',
1113         'effectivegroupmode' => 'get_effective_groupmode',
1114         'extra' => false,
1115         'groupingid' => false,
1116         'groupmembersonly' => false,
1117         'groupmode' => false,
1118         'icon' => false,
1119         'iconcomponent' => false,
1120         'idnumber' => false,
1121         'indent' => false,
1122         'instance' => false,
1123         'modname' => false,
1124         'module' => false,
1125         'name' => 'get_name',
1126         'score' => false,
1127         'section' => false,
1128         'sectionnum' => false,
1129         'showavailability' => 'get_show_availability',
1130         'showdescription' => false,
1131         'uservisible' => 'get_user_visible',
1132         'visible' => false,
1133         'visibleold' => false,
1134     );
1136     /**
1137      * List of methods with no arguments that were public prior to Moodle 2.6.
1138      *
1139      * They can still be accessed publicly via magic __call() function with no warnings
1140      * but are not listed in the class methods list.
1141      * For the consistency of the code it is better to use corresponding properties.
1142      *
1143      * These methods be deprecated completely in later versions.
1144      *
1145      * @var array $standardmethods
1146      */
1147     private static $standardmethods = array(
1148         // Following methods are not recommended to use because there have associated read-only properties.
1149         'get_url',
1150         'get_content',
1151         'get_extra_classes',
1152         'get_on_click',
1153         'get_custom_data',
1154         'get_after_link',
1155         'get_after_edit_icons',
1156         // Method obtain_dynamic_data() should not be called from outside of this class but it was public before Moodle 2.6.
1157         'obtain_dynamic_data',
1158     );
1160     /**
1161      * Magic method to call functions that are now declared as private now but
1162      * were public in Moodle before 2.6. Developers can access them without
1163      * any warnings but they are not listed in the class methods list.
1164      *
1165      * @param string $name
1166      * @param array $arguments
1167      * @return mixed
1168      */
1169     public function __call($name, $arguments) {
1170         if (in_array($name, self::$standardmethods)) {
1171             // All standard methods do not have arguments anyway.
1172             return $this->$name();
1173         }
1174         throw new coding_exception("Method cm_info::{$name}() does not exist");
1175     }
1177     /**
1178      * Magic method getter
1179      *
1180      * @param string $name
1181      * @return mixed
1182      */
1183     public function __get($name) {
1184         if (isset(self::$standardproperties[$name])) {
1185             if ($method = self::$standardproperties[$name]) {
1186                 return $this->$method();
1187             } else {
1188                 return $this->$name;
1189             }
1190         } else {
1191             debugging('Invalid cm_info property accessed: '.$name);
1192             return null;
1193         }
1194     }
1196     /**
1197      * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
1198      * and use {@link convert_to_array()}
1199      *
1200      * @return ArrayIterator
1201      */
1202     public function getIterator() {
1203         // Make sure dynamic properties are retrieved prior to view properties.
1204         $this->obtain_dynamic_data();
1205         $ret = array();
1206         foreach (self::$standardproperties as $key => $unused) {
1207             $ret[$key] = $this->__get($key);
1208         }
1209         return new ArrayIterator($ret);
1210     }
1212     /**
1213      * Magic method for function isset()
1214      *
1215      * @param string $name
1216      * @return bool
1217      */
1218     public function __isset($name) {
1219         if (isset(self::$standardproperties[$name])) {
1220             $value = $this->__get($name);
1221             return isset($value);
1222         }
1223         return false;
1224     }
1226     /**
1227      * Magic method for function empty()
1228      *
1229      * @param string $name
1230      * @return bool
1231      */
1232     public function __empty($name) {
1233         if (isset(self::$standardproperties[$name])) {
1234             $value = $this->__get($name);
1235             return empty($value);
1236         }
1237         return true;
1238     }
1240     /**
1241      * Magic method setter
1242      *
1243      * Will display the developer warning when trying to set/overwrite property.
1244      *
1245      * @param string $name
1246      * @param mixed $value
1247      */
1248     public function __set($name, $value) {
1249         debugging("It is not allowed to set the property cm_info::\${$name}", DEBUG_DEVELOPER);
1250     }
1252     /**
1253      * @return bool True if this module has a 'view' page that should be linked to in navigation
1254      *   etc (note: modules may still have a view.php file, but return false if this is not
1255      *   intended to be linked to from 'normal' parts of the interface; this is what label does).
1256      */
1257     public function has_view() {
1258         return !is_null($this->url);
1259     }
1261     /**
1262      * @return moodle_url URL to link to for this module, or null if it doesn't have a view page
1263      */
1264     private function get_url() {
1265         $this->obtain_dynamic_data();
1266         return $this->url;
1267     }
1269     /**
1270      * Obtains content to display on main (view) page.
1271      * Note: Will collect view data, if not already obtained.
1272      * @return string Content to display on main page below link, or empty string if none
1273      */
1274     private function get_content() {
1275         $this->obtain_view_data();
1276         return $this->content;
1277     }
1279     /**
1280      * Returns the content to display on course/overview page, formatted and passed through filters
1281      *
1282      * if $options['context'] is not specified, the module context is used
1283      *
1284      * @param array|stdClass $options formatting options, see {@link format_text()}
1285      * @return string
1286      */
1287     public function get_formatted_content($options = array()) {
1288         $this->obtain_view_data();
1289         if (empty($this->content)) {
1290             return '';
1291         }
1292         // Improve filter performance by preloading filter setttings for all
1293         // activities on the course (this does nothing if called multiple
1294         // times)
1295         filter_preload_activities($this->get_modinfo());
1297         $options = (array)$options;
1298         if (!isset($options['context'])) {
1299             $options['context'] = $this->get_context();
1300         }
1301         return format_text($this->content, FORMAT_HTML, $options);
1302     }
1304     /**
1305      * Getter method for property $name, ensures that dynamic data is obtained.
1306      * @return string
1307      */
1308     private function get_name() {
1309         $this->obtain_dynamic_data();
1310         return $this->name;
1311     }
1313     /**
1314      * Returns the name to display on course/overview page, formatted and passed through filters
1315      *
1316      * if $options['context'] is not specified, the module context is used
1317      *
1318      * @param array|stdClass $options formatting options, see {@link format_string()}
1319      * @return string
1320      */
1321     public function get_formatted_name($options = array()) {
1322         $options = (array)$options;
1323         if (!isset($options['context'])) {
1324             $options['context'] = $this->get_context();
1325         }
1326         return format_string($this->get_name(), true,  $options);
1327     }
1329     /**
1330      * Note: Will collect view data, if not already obtained.
1331      * @return string Extra CSS classes to add to html output for this activity on main page
1332      */
1333     private function get_extra_classes() {
1334         $this->obtain_view_data();
1335         return $this->extraclasses;
1336     }
1338     /**
1339      * @return string Content of HTML on-click attribute. This string will be used literally
1340      * as a string so should be pre-escaped.
1341      */
1342     private function get_on_click() {
1343         // Does not need view data; may be used by navigation
1344         $this->obtain_dynamic_data();
1345         return $this->onclick;
1346     }
1347     /**
1348      * @return mixed Optional custom data stored in modinfo cache for this activity, or null if none
1349      */
1350     private function get_custom_data() {
1351         return $this->customdata;
1352     }
1354     /**
1355      * Note: Will collect view data, if not already obtained.
1356      * @return string Extra HTML code to display after link
1357      */
1358     private function get_after_link() {
1359         $this->obtain_view_data();
1360         return $this->afterlink;
1361     }
1363     /**
1364      * Note: Will collect view data, if not already obtained.
1365      * @return string Extra HTML code to display after editing icons (e.g. more icons)
1366      */
1367     private function get_after_edit_icons() {
1368         $this->obtain_view_data();
1369         return $this->afterediticons;
1370     }
1372     /**
1373      * @param moodle_core_renderer $output Output render to use, or null for default (global)
1374      * @return moodle_url Icon URL for a suitable icon to put beside this cm
1375      */
1376     public function get_icon_url($output = null) {
1377         global $OUTPUT;
1378         $this->obtain_dynamic_data();
1379         if (!$output) {
1380             $output = $OUTPUT;
1381         }
1382         // Support modules setting their own, external, icon image
1383         if (!empty($this->iconurl)) {
1384             $icon = $this->iconurl;
1386         // Fallback to normal local icon + component procesing
1387         } else if (!empty($this->icon)) {
1388             if (substr($this->icon, 0, 4) === 'mod/') {
1389                 list($modname, $iconname) = explode('/', substr($this->icon, 4), 2);
1390                 $icon = $output->pix_url($iconname, $modname);
1391             } else {
1392                 if (!empty($this->iconcomponent)) {
1393                     // Icon  has specified component
1394                     $icon = $output->pix_url($this->icon, $this->iconcomponent);
1395                 } else {
1396                     // Icon does not have specified component, use default
1397                     $icon = $output->pix_url($this->icon);
1398                 }
1399             }
1400         } else {
1401             $icon = $output->pix_url('icon', $this->modname);
1402         }
1403         return $icon;
1404     }
1406     /**
1407      * Returns a localised human-readable name of the module type
1408      *
1409      * @param bool $plural return plural form
1410      * @return string
1411      */
1412     public function get_module_type_name($plural = false) {
1413         $modnames = get_module_types_names($plural);
1414         if (isset($modnames[$this->modname])) {
1415             return $modnames[$this->modname];
1416         } else {
1417             return null;
1418         }
1419     }
1421     /**
1422      * Returns a localised human-readable name of the module type in plural form - calculated on request
1423      *
1424      * @return string
1425      */
1426     private function get_module_type_name_plural() {
1427         return $this->get_module_type_name(true);
1428     }
1430     /**
1431      * @return course_modinfo Modinfo object that this came from
1432      */
1433     public function get_modinfo() {
1434         return $this->modinfo;
1435     }
1437     /**
1438      * Returns course object that was used in the first {@link get_fast_modinfo()} call.
1439      *
1440      * It may not contain all fields from DB table {course} but always has at least the following:
1441      * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
1442      *
1443      * If the course object lacks the field you need you can use the global
1444      * function {@link get_course()} that will save extra query if you access
1445      * current course or frontpage course.
1446      *
1447      * @return stdClass
1448      */
1449     public function get_course() {
1450         return $this->modinfo->get_course();
1451     }
1453     /**
1454      * Returns course id for which the modinfo was generated.
1455      *
1456      * @return int
1457      */
1458     private function get_course_id() {
1459         return $this->modinfo->get_course_id();
1460     }
1462     /**
1463      * Returns group mode used for the course containing the module
1464      *
1465      * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1466      */
1467     private function get_course_groupmode() {
1468         return $this->modinfo->get_course()->groupmode;
1469     }
1471     /**
1472      * Returns whether group mode is forced for the course containing the module
1473      *
1474      * @return bool
1475      */
1476     private function get_course_groupmodeforce() {
1477         return $this->modinfo->get_course()->groupmodeforce;
1478     }
1480     /**
1481      * Returns effective groupmode of the module that may be overwritten by forced course groupmode.
1482      *
1483      * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1484      */
1485     private function get_effective_groupmode() {
1486         $groupmode = $this->groupmode;
1487         if ($this->modinfo->get_course()->groupmodeforce) {
1488             $groupmode = $this->modinfo->get_course()->groupmode;
1489             if ($groupmode != NOGROUPS && !plugin_supports('mod', $this->modname, FEATURE_GROUPS, 0)) {
1490                 $groupmode = NOGROUPS;
1491             }
1492         }
1493         return $groupmode;
1494     }
1496     /**
1497      * @return context_module Current module context
1498      */
1499     private function get_context() {
1500         return context_module::instance($this->id);
1501     }
1503     // Set functions
1504     ////////////////
1506     /**
1507      * Sets content to display on course view page below link (if present).
1508      * @param string $content New content as HTML string (empty string if none)
1509      * @return void
1510      */
1511     public function set_content($content) {
1512         $this->content = $content;
1513     }
1515     /**
1516      * Sets extra classes to include in CSS.
1517      * @param string $extraclasses Extra classes (empty string if none)
1518      * @return void
1519      */
1520     public function set_extra_classes($extraclasses) {
1521         $this->extraclasses = $extraclasses;
1522     }
1524     /**
1525      * Sets the external full url that points to the icon being used
1526      * by the activity. Useful for external-tool modules (lti...)
1527      * If set, takes precedence over $icon and $iconcomponent
1528      *
1529      * @param moodle_url $iconurl full external url pointing to icon image for activity
1530      * @return void
1531      */
1532     public function set_icon_url(moodle_url $iconurl) {
1533         $this->iconurl = $iconurl;
1534     }
1536     /**
1537      * Sets value of on-click attribute for JavaScript.
1538      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1539      * @param string $onclick New onclick attribute which should be HTML-escaped
1540      *   (empty string if none)
1541      * @return void
1542      */
1543     public function set_on_click($onclick) {
1544         $this->check_not_view_only();
1545         $this->onclick = $onclick;
1546     }
1548     /**
1549      * Sets HTML that displays after link on course view page.
1550      * @param string $afterlink HTML string (empty string if none)
1551      * @return void
1552      */
1553     public function set_after_link($afterlink) {
1554         $this->afterlink = $afterlink;
1555     }
1557     /**
1558      * Sets HTML that displays after edit icons on course view page.
1559      * @param string $afterediticons HTML string (empty string if none)
1560      * @return void
1561      */
1562     public function set_after_edit_icons($afterediticons) {
1563         $this->afterediticons = $afterediticons;
1564     }
1566     /**
1567      * Changes the name (text of link) for this module instance.
1568      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1569      * @param string $name Name of activity / link text
1570      * @return void
1571      */
1572     public function set_name($name) {
1573         if ($this->state < self::STATE_BUILDING_DYNAMIC) {
1574             $this->update_user_visible();
1575         }
1576         $this->name = $name;
1577     }
1579     /**
1580      * Turns off the view link for this module instance.
1581      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1582      * @return void
1583      */
1584     public function set_no_view_link() {
1585         $this->check_not_view_only();
1586         $this->url = null;
1587     }
1589     /**
1590      * Sets the 'uservisible' flag. This can be used (by setting false) to prevent access and
1591      * display of this module link for the current user.
1592      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1593      * @param bool $uservisible
1594      * @return void
1595      */
1596     public function set_user_visible($uservisible) {
1597         $this->check_not_view_only();
1598         $this->uservisible = $uservisible;
1599     }
1601     /**
1602      * Sets the 'available' flag and related details. This flag is normally used to make
1603      * course modules unavailable until a certain date or condition is met. (When a course
1604      * module is unavailable, it is still visible to users who have viewhiddenactivities
1605      * permission.)
1606      *
1607      * When this is function is called, user-visible status is recalculated automatically.
1608      *
1609      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1610      * @param bool $available False if this item is not 'available'
1611      * @param int $showavailability 0 = do not show this item at all if it's not available,
1612      *   1 = show this item greyed out with the following message
1613      * @param string $availableinfo Information about why this is not available which displays
1614      *   to those who have viewhiddenactivities, and to everyone if showavailability is set;
1615      *   note that this function replaces the existing data (if any)
1616      * @return void
1617      */
1618     public function set_available($available, $showavailability=0, $availableinfo='') {
1619         $this->check_not_view_only();
1620         $this->available = $available;
1621         $this->showavailability = $showavailability;
1622         $this->availableinfo = $availableinfo;
1623         $this->update_user_visible();
1624     }
1626     /**
1627      * Some set functions can only be called from _cm_info_dynamic and not _cm_info_view.
1628      * This is because they may affect parts of this object which are used on pages other
1629      * than the view page (e.g. in the navigation block, or when checking access on
1630      * module pages).
1631      * @return void
1632      */
1633     private function check_not_view_only() {
1634         if ($this->state >= self::STATE_DYNAMIC) {
1635             throw new coding_exception('Cannot set this data from _cm_info_view because it may ' .
1636                     'affect other pages as well as view');
1637         }
1638     }
1640     /**
1641      * Constructor should not be called directly; use {@link get_fast_modinfo()}
1642      *
1643      * @param course_modinfo $modinfo Parent object
1644      * @param stdClass $notused1 Argument not used
1645      * @param stdClass $mod Module object from the modinfo field of course table
1646      * @param stdClass $notused2 Argument not used
1647      */
1648     public function __construct(course_modinfo $modinfo, $notused1, $mod, $notused2) {
1649         $this->modinfo = $modinfo;
1651         $this->id               = $mod->cm;
1652         $this->instance         = $mod->id;
1653         $this->modname          = $mod->mod;
1654         $this->idnumber         = isset($mod->idnumber) ? $mod->idnumber : '';
1655         $this->name             = $mod->name;
1656         $this->visible          = $mod->visible;
1657         $this->sectionnum       = $mod->section; // Note weirdness with name here
1658         $this->groupmode        = isset($mod->groupmode) ? $mod->groupmode : 0;
1659         $this->groupingid       = isset($mod->groupingid) ? $mod->groupingid : 0;
1660         $this->groupmembersonly = isset($mod->groupmembersonly) ? $mod->groupmembersonly : 0;
1661         $this->indent           = isset($mod->indent) ? $mod->indent : 0;
1662         $this->extra            = isset($mod->extra) ? $mod->extra : '';
1663         $this->extraclasses     = isset($mod->extraclasses) ? $mod->extraclasses : '';
1664         // iconurl may be stored as either string or instance of moodle_url.
1665         $this->iconurl          = isset($mod->iconurl) ? new moodle_url($mod->iconurl) : '';
1666         $this->onclick          = isset($mod->onclick) ? $mod->onclick : '';
1667         $this->content          = isset($mod->content) ? $mod->content : '';
1668         $this->icon             = isset($mod->icon) ? $mod->icon : '';
1669         $this->iconcomponent    = isset($mod->iconcomponent) ? $mod->iconcomponent : '';
1670         $this->customdata       = isset($mod->customdata) ? $mod->customdata : '';
1671         $this->showdescription  = isset($mod->showdescription) ? $mod->showdescription : 0;
1672         $this->state = self::STATE_BASIC;
1674         $this->section = isset($mod->sectionid) ? $mod->sectionid : 0;
1675         $this->module = isset($mod->module) ? $mod->module : 0;
1676         $this->added = isset($mod->added) ? $mod->added : 0;
1677         $this->score = isset($mod->score) ? $mod->score : 0;
1678         $this->visibleold = isset($mod->visibleold) ? $mod->visibleold : 0;
1680         // Note: it saves effort and database space to always include the
1681         // availability and completion fields, even if availability or completion
1682         // are actually disabled
1683         $this->completion = isset($mod->completion) ? $mod->completion : 0;
1684         $this->completiongradeitemnumber = isset($mod->completiongradeitemnumber)
1685                 ? $mod->completiongradeitemnumber : null;
1686         $this->completionview = isset($mod->completionview)
1687                 ? $mod->completionview : 0;
1688         $this->completionexpected = isset($mod->completionexpected)
1689                 ? $mod->completionexpected : 0;
1690         $this->showavailability = isset($mod->showavailability) ? $mod->showavailability : 0;
1691         $this->availablefrom = isset($mod->availablefrom) ? $mod->availablefrom : 0;
1692         $this->availableuntil = isset($mod->availableuntil) ? $mod->availableuntil : 0;
1693         $this->conditionscompletion = isset($mod->conditionscompletion)
1694                 ? $mod->conditionscompletion : array();
1695         $this->conditionsgrade = isset($mod->conditionsgrade)
1696                 ? $mod->conditionsgrade : array();
1697         $this->conditionsfield = isset($mod->conditionsfield)
1698                 ? $mod->conditionsfield : array();
1700         static $modviews = array();
1701         if (!isset($modviews[$this->modname])) {
1702             $modviews[$this->modname] = !plugin_supports('mod', $this->modname,
1703                     FEATURE_NO_VIEW_LINK);
1704         }
1705         $this->url = $modviews[$this->modname]
1706                 ? new moodle_url('/mod/' . $this->modname . '/view.php', array('id'=>$this->id))
1707                 : null;
1708     }
1710     /**
1711      * If dynamic data for this course-module is not yet available, gets it.
1712      *
1713      * This function is automatically called when requesting any course_modinfo property
1714      * that can be modified by modules (have a set_xxx method).
1715      *
1716      * Dynamic data is data which does not come directly from the cache but is calculated at
1717      * runtime based on the current user. Primarily this concerns whether the user can access
1718      * the module or not.
1719      *
1720      * As part of this function, the module's _cm_info_dynamic function from its lib.php will
1721      * be called (if it exists).
1722      * @return void
1723      */
1724     private function obtain_dynamic_data() {
1725         global $CFG;
1726         if ($this->state >= self::STATE_BUILDING_DYNAMIC) {
1727             return;
1728         }
1729         $this->state = self::STATE_BUILDING_DYNAMIC;
1730         $userid = $this->modinfo->get_user_id();
1732         if (!empty($CFG->enableavailability)) {
1733             require_once($CFG->libdir. '/conditionlib.php');
1734             // Get availability information
1735             $ci = new condition_info($this);
1736             // Note that the modinfo currently available only includes minimal details (basic data)
1737             // but we know that this function does not need anything more than basic data.
1738             $this->available = $ci->is_available($this->availableinfo, true,
1739                     $userid, $this->modinfo);
1741             // Check parent section
1742             $parentsection = $this->modinfo->get_section_info($this->sectionnum);
1743             if (!$parentsection->available) {
1744                 // Do not store info from section here, as that is already
1745                 // presented from the section (if appropriate) - just change
1746                 // the flag
1747                 $this->available = false;
1748             }
1749         } else {
1750             $this->available = true;
1751         }
1753         // Update visible state for current user
1754         $this->update_user_visible();
1756         // Let module make dynamic changes at this point
1757         $this->call_mod_function('cm_info_dynamic');
1758         $this->state = self::STATE_DYNAMIC;
1759     }
1761     /**
1762      * Getter method for property $uservisible, ensures that dynamic data is retrieved.
1763      * @return bool
1764      */
1765     private function get_user_visible() {
1766         $this->obtain_dynamic_data();
1767         return $this->uservisible;
1768     }
1770     /**
1771      * Getter method for property $available, ensures that dynamic data is retrieved
1772      * @return bool
1773      */
1774     private function get_available() {
1775         $this->obtain_dynamic_data();
1776         return $this->available;
1777     }
1779     /**
1780      * Getter method for property $showavailability, ensures that dynamic data is retrieved
1781      * @return int
1782      */
1783     private function get_show_availability() {
1784         $this->obtain_dynamic_data();
1785         return $this->showavailability;
1786     }
1788     /**
1789      * Getter method for property $availableinfo, ensures that dynamic data is retrieved
1790      * @return type
1791      */
1792     private function get_available_info() {
1793         $this->obtain_dynamic_data();
1794         return $this->availableinfo;
1795     }
1797     /**
1798      * Works out whether activity is available to the current user
1799      *
1800      * If the activity is unavailable, additional checks are required to determine if its hidden or greyed out
1801      *
1802      * @see is_user_access_restricted_by_group()
1803      * @see is_user_access_restricted_by_conditional_access()
1804      * @return void
1805      */
1806     private function update_user_visible() {
1807         $userid = $this->modinfo->get_user_id();
1808         $this->uservisible = true;
1810         // If the user cannot access the activity set the uservisible flag to false.
1811         // Additional checks are required to determine whether the activity is entirely hidden or just greyed out.
1812         if ((!$this->visible or !$this->get_available()) and
1813                 !has_capability('moodle/course:viewhiddenactivities', $this->get_context(), $userid)) {
1815             $this->uservisible = false;
1816         }
1818         // Check group membership.
1819         if ($this->is_user_access_restricted_by_group() ||
1820                 $this->is_user_access_restricted_by_capability()) {
1822              $this->uservisible = false;
1823             // Ensure activity is completely hidden from the user.
1824             $this->showavailability = 0;
1825         }
1826     }
1828     /**
1829      * Checks whether the module's group settings restrict the current user's access
1830      *
1831      * @return bool True if the user access is restricted
1832      */
1833     public function is_user_access_restricted_by_group() {
1834         global $CFG;
1836         if (!empty($CFG->enablegroupmembersonly) and !empty($this->groupmembersonly)) {
1837             $userid = $this->modinfo->get_user_id();
1838             if (!has_capability('moodle/site:accessallgroups', $this->get_context(), $userid)) {
1839                 // If the activity has 'group members only' and you don't have accessallgroups...
1840                 $groups = $this->modinfo->get_groups($this->groupingid);
1841                 if (empty($groups)) {
1842                     // ...and you don't belong to a group, then set it so you can't see/access it
1843                     return true;
1844                 }
1845             }
1846         }
1847         return false;
1848     }
1850     /**
1851      * Checks whether mod/...:view capability restricts the current user's access.
1852      *
1853      * @return bool True if the user access is restricted.
1854      */
1855     public function is_user_access_restricted_by_capability() {
1856         $capability = 'mod/' . $this->modname . ':view';
1857         $capabilityinfo = get_capability_info($capability);
1858         if (!$capabilityinfo) {
1859             // Capability does not exist, no one is prevented from seeing the activity.
1860             return false;
1861         }
1863         // You are blocked if you don't have the capability.
1864         $userid = $this->modinfo->get_user_id();
1865         return !has_capability($capability, $this->get_context(), $userid);
1866     }
1868     /**
1869      * Checks whether the module's conditional access settings mean that the user cannot see the activity at all
1870      *
1871      * @return bool True if the user cannot see the module. False if the activity is either available or should be greyed out.
1872      */
1873     public function is_user_access_restricted_by_conditional_access() {
1874         global $CFG;
1876         if (empty($CFG->enableavailability)) {
1877             return false;
1878         }
1880         require_once($CFG->libdir. '/conditionlib.php');
1882         // If module will always be visible anyway (but greyed out), don't bother checking anything else
1883         if ($this->get_show_availability() == CONDITION_STUDENTVIEW_SHOW) {
1884             return false;
1885         }
1887         // Can the user see hidden modules?
1888         $userid = $this->modinfo->get_user_id();
1889         if (has_capability('moodle/course:viewhiddenactivities', $this->get_context(), $userid)) {
1890             return false;
1891         }
1893         // Is the module hidden due to unmet conditions?
1894         if (!$this->get_available()) {
1895             return true;
1896         }
1898         return false;
1899     }
1901     /**
1902      * Calls a module function (if exists), passing in one parameter: this object.
1903      * @param string $type Name of function e.g. if this is 'grooblezorb' and the modname is
1904      *   'forum' then it will try to call 'mod_forum_grooblezorb' or 'forum_grooblezorb'
1905      * @return void
1906      */
1907     private function call_mod_function($type) {
1908         global $CFG;
1909         $libfile = $CFG->dirroot . '/mod/' . $this->modname . '/lib.php';
1910         if (file_exists($libfile)) {
1911             include_once($libfile);
1912             $function = 'mod_' . $this->modname . '_' . $type;
1913             if (function_exists($function)) {
1914                 $function($this);
1915             } else {
1916                 $function = $this->modname . '_' . $type;
1917                 if (function_exists($function)) {
1918                     $function($this);
1919                 }
1920             }
1921         }
1922     }
1924     /**
1925      * If view data for this course-module is not yet available, obtains it.
1926      *
1927      * This function is automatically called if any of the functions (marked) which require
1928      * view data are called.
1929      *
1930      * View data is data which is needed only for displaying the course main page (& any similar
1931      * functionality on other pages) but is not needed in general. Obtaining view data may have
1932      * a performance cost.
1933      *
1934      * As part of this function, the module's _cm_info_view function from its lib.php will
1935      * be called (if it exists).
1936      * @return void
1937      */
1938     private function obtain_view_data() {
1939         if ($this->state >= self::STATE_BUILDING_VIEW) {
1940             return;
1941         }
1942         $this->obtain_dynamic_data();
1943         $this->state = self::STATE_BUILDING_VIEW;
1945         // Let module make changes at this point
1946         $this->call_mod_function('cm_info_view');
1947         $this->state = self::STATE_VIEW;
1948     }
1952 /**
1953  * Returns reference to full info about modules in course (including visibility).
1954  * Cached and as fast as possible (0 or 1 db query).
1955  *
1956  * use get_fast_modinfo($courseid, 0, true) to reset the static cache for particular course
1957  * use get_fast_modinfo(0, 0, true) to reset the static cache for all courses
1958  *
1959  * use rebuild_course_cache($courseid, true) to reset the application AND static cache
1960  * for particular course when it's contents has changed
1961  *
1962  * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
1963  *     and recommended to have field 'cacherev') or just a course id. Just course id
1964  *     is enough when calling get_fast_modinfo() for current course or site or when
1965  *     calling for any other course for the second time.
1966  * @param int $userid User id to populate 'uservisible' attributes of modules and sections.
1967  *     Set to 0 for current user (default)
1968  * @param bool $resetonly whether we want to get modinfo or just reset the cache
1969  * @return course_modinfo|null Module information for course, or null if resetting
1970  * @throws moodle_exception when course is not found (nothing is thrown if resetting)
1971  */
1972 function get_fast_modinfo($courseorid, $userid = 0, $resetonly = false) {
1973     // compartibility with syntax prior to 2.4:
1974     if ($courseorid === 'reset') {
1975         debugging("Using the string 'reset' as the first argument of get_fast_modinfo() is deprecated. Use get_fast_modinfo(0,0,true) instead.", DEBUG_DEVELOPER);
1976         $courseorid = 0;
1977         $resetonly = true;
1978     }
1980     // Function get_fast_modinfo() can never be called during upgrade unless it is used for clearing cache only.
1981     if (!$resetonly) {
1982         upgrade_ensure_not_running();
1983     }
1985     // Function is called with $reset = true
1986     if ($resetonly) {
1987         course_modinfo::clear_instance_cache($courseorid);
1988         return null;
1989     }
1991     // Function is called with $reset = false, retrieve modinfo
1992     return course_modinfo::instance($courseorid, $userid);
1995 /**
1996  * Rebuilds or resets the cached list of course activities stored in MUC.
1997  *
1998  * rebuild_course_cache() must NEVER be called from lib/db/upgrade.php.
1999  * At the same time course cache may ONLY be cleared using this function in
2000  * upgrade scripts of plugins.
2001  *
2002  * During the bulk operations if it is necessary to reset cache of multiple
2003  * courses it is enough to call {@link increment_revision_number()} for the
2004  * table 'course' and field 'cacherev' specifying affected courses in select.
2005  *
2006  * Cached course information is stored in MUC core/coursemodinfo and is
2007  * validated with the DB field {course}.cacherev
2008  *
2009  * @global moodle_database $DB
2010  * @param int $courseid id of course to rebuild, empty means all
2011  * @param boolean $clearonly only clear the cache, gets rebuild automatically on the fly.
2012  *     Recommended to set to true to avoid unnecessary multiple rebuilding.
2013  */
2014 function rebuild_course_cache($courseid=0, $clearonly=false) {
2015     global $COURSE, $SITE, $DB, $CFG;
2017     // Function rebuild_course_cache() can not be called during upgrade unless it's clear only.
2018     if (!$clearonly && !upgrade_ensure_not_running(true)) {
2019         $clearonly = true;
2020     }
2022     // Destroy navigation caches
2023     navigation_cache::destroy_volatile_caches();
2025     if (class_exists('format_base')) {
2026         // if file containing class is not loaded, there is no cache there anyway
2027         format_base::reset_course_cache($courseid);
2028     }
2030     $cachecoursemodinfo = cache::make('core', 'coursemodinfo');
2031     if (empty($courseid)) {
2032         // Clearing caches for all courses.
2033         increment_revision_number('course', 'cacherev', '');
2034         $cachecoursemodinfo->purge();
2035         course_modinfo::clear_instance_cache();
2036         // Update global values too.
2037         $sitecacherev = $DB->get_field('course', 'cacherev', array('id' => SITEID));
2038         $SITE->cachrev = $sitecacherev;
2039         if ($COURSE->id == SITEID) {
2040             $COURSE->cacherev = $sitecacherev;
2041         } else {
2042             $COURSE->cacherev = $DB->get_field('course', 'cacherev', array('id' => $COURSE->id));
2043         }
2044     } else {
2045         // Clearing cache for one course, make sure it is deleted from user request cache as well.
2046         increment_revision_number('course', 'cacherev', 'id = :id', array('id' => $courseid));
2047         $cachecoursemodinfo->delete($courseid);
2048         course_modinfo::clear_instance_cache($courseid);
2049         // Update global values too.
2050         if ($courseid == $COURSE->id || $courseid == $SITE->id) {
2051             $cacherev = $DB->get_field('course', 'cacherev', array('id' => $courseid));
2052             if ($courseid == $COURSE->id) {
2053                 $COURSE->cacherev = $cacherev;
2054             }
2055             if ($courseid == $SITE->id) {
2056                 $SITE->cachrev = $cacherev;
2057             }
2058         }
2059     }
2061     if ($clearonly) {
2062         return;
2063     }
2065     if ($courseid) {
2066         $select = array('id'=>$courseid);
2067     } else {
2068         $select = array();
2069         @set_time_limit(0);  // this could take a while!   MDL-10954
2070     }
2072     $rs = $DB->get_recordset("course", $select,'','id,'.join(',', course_modinfo::$cachedfields));
2073     // Rebuild cache for each course.
2074     foreach ($rs as $course) {
2075         course_modinfo::build_course_cache($course);
2076     }
2077     $rs->close();
2081 /**
2082  * Class that is the return value for the _get_coursemodule_info module API function.
2083  *
2084  * Note: For backward compatibility, you can also return a stdclass object from that function.
2085  * The difference is that the stdclass object may contain an 'extra' field (deprecated,
2086  * use extraclasses and onclick instead). The stdclass object may not contain
2087  * the new fields defined here (content, extraclasses, customdata).
2088  */
2089 class cached_cm_info {
2090     /**
2091      * Name (text of link) for this activity; Leave unset to accept default name
2092      * @var string
2093      */
2094     public $name;
2096     /**
2097      * Name of icon for this activity. Normally, this should be used together with $iconcomponent
2098      * to define the icon, as per pix_url function.
2099      * For backward compatibility, if this value is of the form 'mod/forum/icon' then an icon
2100      * within that module will be used.
2101      * @see cm_info::get_icon_url()
2102      * @see renderer_base::pix_url()
2103      * @var string
2104      */
2105     public $icon;
2107     /**
2108      * Component for icon for this activity, as per pix_url; leave blank to use default 'moodle'
2109      * component
2110      * @see renderer_base::pix_url()
2111      * @var string
2112      */
2113     public $iconcomponent;
2115     /**
2116      * HTML content to be displayed on the main page below the link (if any) for this course-module
2117      * @var string
2118      */
2119     public $content;
2121     /**
2122      * Custom data to be stored in modinfo for this activity; useful if there are cases when
2123      * internal information for this activity type needs to be accessible from elsewhere on the
2124      * course without making database queries. May be of any type but should be short.
2125      * @var mixed
2126      */
2127     public $customdata;
2129     /**
2130      * Extra CSS class or classes to be added when this activity is displayed on the main page;
2131      * space-separated string
2132      * @var string
2133      */
2134     public $extraclasses;
2136     /**
2137      * External URL image to be used by activity as icon, useful for some external-tool modules
2138      * like lti. If set, takes precedence over $icon and $iconcomponent
2139      * @var $moodle_url
2140      */
2141     public $iconurl;
2143     /**
2144      * Content of onclick JavaScript; escaped HTML to be inserted as attribute value
2145      * @var string
2146      */
2147     public $onclick;
2151 /**
2152  * Data about a single section on a course. This contains the fields from the
2153  * course_sections table, plus additional data when required.
2154  *
2155  * @property-read int $id Section ID - from course_sections table
2156  * @property-read int $course Course ID - from course_sections table
2157  * @property-read int $section Section number - from course_sections table
2158  * @property-read string $name Section name if specified - from course_sections table
2159  * @property-read int $visible Section visibility (1 = visible) - from course_sections table
2160  * @property-read string $summary Section summary text if specified - from course_sections table
2161  * @property-read int $summaryformat Section summary text format (FORMAT_xx constant) - from course_sections table
2162  * @property-read int $showavailability When section is unavailable, this field controls whether it is shown to students (0 =
2163  *    hide completely, 1 = show greyed out with information about when it will be available) -
2164  *    from course_sections table
2165  * @property-read int $availablefrom Available date for this section (0 if not set, or set to seconds since epoch;
2166  *    before this date, section does not display to students) - from course_sections table
2167  * @property-read int $availableuntil Available until date for this section  (0 if not set, or set to seconds since epoch;
2168  *    from this date, section does not display to students) - from course_sections table
2169  * @property-read int $groupingid If section is restricted to users of a particular grouping, this is its id (0 if not set) -
2170  *    from course_sections table
2171  * @property-read array $conditionscompletion Availability conditions for this section based on the completion of
2172  *    course-modules (array from course-module id to required completion state
2173  *    for that module) - from cached data in sectioncache field
2174  * @property-read array $conditionsgrade Availability conditions for this section based on course grades (array from
2175  *    grade item id to object with ->min, ->max fields) - from cached data in
2176  *    sectioncache field
2177  * @property-read array $conditionsfield Availability conditions for this section based on user fields
2178  * @property-read bool $available True if this section is available to the given user i.e. if all availability conditions
2179  *    are met - obtained dynamically
2180  * @property-read string $availableinfo If section is not available to some users, this string gives information about
2181  *    availability which can be displayed to students and/or staff (e.g. 'Available from 3 January 2010')
2182  *    for display on main page - obtained dynamically
2183  * @property-read bool $uservisible True if this section is available to the given user (for example, if current user
2184  *    has viewhiddensections capability, they can access the section even if it is not
2185  *    visible or not available, so this would be true in that case) - obtained dynamically
2186  * @property-read string $sequence Comma-separated list of all modules in the section. Note, this field may not exactly
2187  *    match course_sections.sequence if later has references to non-existing modules or not modules of not available module types.
2188  */
2189 class section_info implements IteratorAggregate {
2190     /**
2191      * Section ID - from course_sections table
2192      * @var int
2193      */
2194     private $_id;
2196     /**
2197      * Section number - from course_sections table
2198      * @var int
2199      */
2200     private $_section;
2202     /**
2203      * Section name if specified - from course_sections table
2204      * @var string
2205      */
2206     private $_name;
2208     /**
2209      * Section visibility (1 = visible) - from course_sections table
2210      * @var int
2211      */
2212     private $_visible;
2214     /**
2215      * Section summary text if specified - from course_sections table
2216      * @var string
2217      */
2218     private $_summary;
2220     /**
2221      * Section summary text format (FORMAT_xx constant) - from course_sections table
2222      * @var int
2223      */
2224     private $_summaryformat;
2226     /**
2227      * When section is unavailable, this field controls whether it is shown to students (0 =
2228      * hide completely, 1 = show greyed out with information about when it will be available) -
2229      * from course_sections table
2230      * @var int
2231      */
2232     private $_showavailability;
2234     /**
2235      * Available date for this section (0 if not set, or set to seconds since epoch; before this
2236      * date, section does not display to students) - from course_sections table
2237      * @var int
2238      */
2239     private $_availablefrom;
2241     /**
2242      * Available until date for this section  (0 if not set, or set to seconds since epoch; from
2243      * this date, section does not display to students) - from course_sections table
2244      * @var int
2245      */
2246     private $_availableuntil;
2248     /**
2249      * If section is restricted to users of a particular grouping, this is its id
2250      * (0 if not set) - from course_sections table
2251      * @var int
2252      */
2253     private $_groupingid;
2255     /**
2256      * Availability conditions for this section based on the completion of
2257      * course-modules (array from course-module id to required completion state
2258      * for that module) - from cached data in sectioncache field
2259      * @var array
2260      */
2261     private $_conditionscompletion;
2263     /**
2264      * Availability conditions for this section based on course grades (array from
2265      * grade item id to object with ->min, ->max fields) - from cached data in
2266      * sectioncache field
2267      * @var array
2268      */
2269     private $_conditionsgrade;
2271     /**
2272      * Availability conditions for this section based on user fields
2273      * @var array
2274      */
2275     private $_conditionsfield;
2277     /**
2278      * True if this section is available to students i.e. if all availability conditions
2279      * are met - obtained dynamically on request, see function {@link section_info::get_available()}
2280      * @var bool|null
2281      */
2282     private $_available;
2284     /**
2285      * If section is not available to some users, this string gives information about
2286      * availability which can be displayed to students and/or staff (e.g. 'Available from 3
2287      * January 2010') for display on main page - obtained dynamically on request, see
2288      * function {@link section_info::get_availableinfo()}
2289      * @var string
2290      */
2291     private $_availableinfo;
2293     /**
2294      * True if this section is available to the CURRENT user (for example, if current user
2295      * has viewhiddensections capability, they can access the section even if it is not
2296      * visible or not available, so this would be true in that case) - obtained dynamically
2297      * on request, see function {@link section_info::get_uservisible()}
2298      * @var bool|null
2299      */
2300     private $_uservisible;
2302     /**
2303      * Default values for sectioncache fields; if a field has this value, it won't
2304      * be stored in the sectioncache cache, to save space. Checks are done by ===
2305      * which means values must all be strings.
2306      * @var array
2307      */
2308     private static $sectioncachedefaults = array(
2309         'name' => null,
2310         'summary' => '',
2311         'summaryformat' => '1', // FORMAT_HTML, but must be a string
2312         'visible' => '1',
2313         'showavailability' => '0',
2314         'availablefrom' => '0',
2315         'availableuntil' => '0',
2316         'groupingid' => '0',
2317     );
2319     /**
2320      * Stores format options that have been cached when building 'coursecache'
2321      * When the format option is requested we look first if it has been cached
2322      * @var array
2323      */
2324     private $cachedformatoptions = array();
2326     /**
2327      * Stores the list of all possible section options defined in each used course format.
2328      * @var array
2329      */
2330     static private $sectionformatoptions = array();
2332     /**
2333      * Stores the modinfo object passed in constructor, may be used when requesting
2334      * dynamically obtained attributes such as available, availableinfo, uservisible.
2335      * Also used to retrun information about current course or user.
2336      * @var course_modinfo
2337      */
2338     private $modinfo;
2340     /**
2341      * Constructs object from database information plus extra required data.
2342      * @param object $data Array entry from cached sectioncache
2343      * @param int $number Section number (array key)
2344      * @param int $notused1 argument not used (informaion is available in $modinfo)
2345      * @param int $notused2 argument not used (informaion is available in $modinfo)
2346      * @param course_modinfo $modinfo Owner (needed for checking availability)
2347      * @param int $notused3 argument not used (informaion is available in $modinfo)
2348      */
2349     public function __construct($data, $number, $notused1, $notused2, $modinfo, $notused3) {
2350         global $CFG;
2351         require_once($CFG->dirroot.'/course/lib.php');
2353         // Data that is always present
2354         $this->_id = $data->id;
2356         $defaults = self::$sectioncachedefaults +
2357                 array('conditionscompletion' => array(),
2358                     'conditionsgrade' => array(),
2359                     'conditionsfield' => array());
2361         // Data that may use default values to save cache size
2362         foreach ($defaults as $field => $value) {
2363             if (isset($data->{$field})) {
2364                 $this->{'_'.$field} = $data->{$field};
2365             } else {
2366                 $this->{'_'.$field} = $value;
2367             }
2368         }
2370         // Other data from constructor arguments.
2371         $this->_section = $number;
2372         $this->modinfo = $modinfo;
2374         // Cached course format data.
2375         $course = $modinfo->get_course();
2376         if (!isset(self::$sectionformatoptions[$course->format])) {
2377             // Store list of section format options defined in each used course format.
2378             // They do not depend on particular course but only on its format.
2379             self::$sectionformatoptions[$course->format] =
2380                     course_get_format($course)->section_format_options();
2381         }
2382         foreach (self::$sectionformatoptions[$course->format] as $field => $option) {
2383             if (!empty($option['cache'])) {
2384                 if (isset($data->{$field})) {
2385                     $this->cachedformatoptions[$field] = $data->{$field};
2386                 } else if (array_key_exists('cachedefault', $option)) {
2387                     $this->cachedformatoptions[$field] = $option['cachedefault'];
2388                 }
2389             }
2390         }
2391     }
2393     /**
2394      * Magic method to check if the property is set
2395      *
2396      * @param string $name name of the property
2397      * @return bool
2398      */
2399     public function __isset($name) {
2400         if (method_exists($this, 'get_'.$name) ||
2401                 property_exists($this, '_'.$name) ||
2402                 array_key_exists($name, self::$sectionformatoptions[$this->modinfo->get_course()->format])) {
2403             $value = $this->__get($name);
2404             return isset($value);
2405         }
2406         return false;
2407     }
2409     /**
2410      * Magic method to check if the property is empty
2411      *
2412      * @param string $name name of the property
2413      * @return bool
2414      */
2415     public function __empty($name) {
2416         if (method_exists($this, 'get_'.$name) ||
2417                 property_exists($this, '_'.$name) ||
2418                 in_array($name, self::$sectionformatoptions[$this->modinfo->get_course()->format])) {
2419             $value = $this->__get($name);
2420             return empty($value);
2421         }
2422         return true;
2423     }
2425     /**
2426      * Magic method to retrieve the property, this is either basic section property
2427      * or availability information or additional properties added by course format
2428      *
2429      * @param string $name name of the property
2430      * @return bool
2431      */
2432     public function __get($name) {
2433         if (method_exists($this, 'get_'.$name)) {
2434             return $this->{'get_'.$name}();
2435         }
2436         if (property_exists($this, '_'.$name)) {
2437             return $this->{'_'.$name};
2438         }
2439         if (array_key_exists($name, $this->cachedformatoptions)) {
2440             return $this->cachedformatoptions[$name];
2441         }
2442         // precheck if the option is defined in format to avoid unnecessary DB queries in get_format_options()
2443         if (in_array($name, self::$sectionformatoptions[$this->modinfo->get_course()->format])) {
2444             $formatoptions = course_get_format($this->modinfo->get_course())->get_format_options($this);
2445             return $formatoptions[$name];
2446         }
2447         debugging('Invalid section_info property accessed! '.$name);
2448         return null;
2449     }
2451     /**
2452      * Finds whether this section is available at the moment for the current user.
2453      *
2454      * The value can be accessed publicly as $sectioninfo->available
2455      *
2456      * @return bool
2457      */
2458     private function get_available() {
2459         global $CFG;
2460         if ($this->_available !== null) {
2461             // Has already been calculated.
2462             return $this->_available;
2463         }
2464         if (!empty($CFG->enableavailability)) {
2465             require_once($CFG->libdir. '/conditionlib.php');
2466             // Get availability information
2467             $ci = new condition_info_section($this);
2468             $this->_available = $ci->is_available($this->_availableinfo, true,
2469                     $this->modinfo->get_user_id(), $this->modinfo);
2470             if ($this->_availableinfo === '' && $this->_groupingid) {
2471                 // Still may have some extra text in availableinfo because of groupping.
2472                 // Set as undefined so the next call to get_availabeinfo() calculates it.
2473                 $this->_availableinfo = null;
2474             }
2475         } else {
2476             $this->_available = true;
2477             $this->_availableinfo = '';
2478         }
2479         return $this->_available;
2480     }
2482     /**
2483      * Returns the availability text shown next to the section on course page.
2484      *
2485      * @return string
2486      */
2487     private function get_availableinfo() {
2488         // Make sure $this->_available has been calculated, it may also fill the _availableinfo property.
2489         $this->get_available();
2490         if ($this->_availableinfo !== null) {
2491             // It has been already calculated.
2492             return $this->_availableinfo;
2493         }
2494         $this->_availableinfo = '';
2495         // Display grouping info if available & not already displaying
2496         // (it would already display if current user doesn't have access)
2497         // for people with managegroups - same logic/class as grouping label
2498         // on individual activities.
2499         $context = context_course::instance($this->get_course());
2500         $userid = $this->modinfo->get_user_id();
2501         if ($this->_groupingid && has_capability('moodle/course:managegroups', $context, $userid)) {
2502             $groupings = groups_get_all_groupings($this->get_course());
2503             $this->_availableinfo = html_writer::tag('span', '(' . format_string(
2504                     $groupings[$this->_groupingid]->name, true, array('context' => $context)) .
2505                     ')', array('class' => 'groupinglabel'));
2506         }
2507         return $this->_availableinfo;
2508     }
2510     /**
2511      * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
2512      * and use {@link convert_to_array()}
2513      *
2514      * @return ArrayIterator
2515      */
2516     public function getIterator() {
2517         $ret = array();
2518         foreach (get_object_vars($this) as $key => $value) {
2519             if (substr($key, 0, 1) == '_') {
2520                 if (method_exists($this, 'get'.$key)) {
2521                     $ret[substr($key, 1)] = $this->{'get'.$key}();
2522                 } else {
2523                     $ret[substr($key, 1)] = $this->$key;
2524                 }
2525             }
2526         }
2527         $ret['sequence'] = $this->get_sequence();
2528         $ret['course'] = $this->get_course();
2529         $ret = array_merge($ret, course_get_format($this->modinfo->get_course())->get_format_options($this->_section));
2530         return new ArrayIterator($ret);
2531     }
2533     /**
2534      * Works out whether activity is visible *for current user* - if this is false, they
2535      * aren't allowed to access it.
2536      *
2537      * @return bool
2538      */
2539     private function get_uservisible() {
2540         if ($this->_uservisible !== null) {
2541             // Has already been calculated.
2542             return $this->_uservisible;
2543         }
2544         $this->_uservisible = true;
2545         if (!$this->_visible || !$this->get_available()) {
2546             $coursecontext = context_course::instance($this->get_course());
2547             $userid = $this->modinfo->get_user_id();
2548             if (!has_capability('moodle/course:viewhiddensections', $coursecontext, $userid)) {
2549                 $this->_uservisible = false;
2550             }
2551         }
2552         return $this->_uservisible;
2553     }
2555     /**
2556      * Restores the course_sections.sequence value
2557      *
2558      * @return string
2559      */
2560     private function get_sequence() {
2561         if (!empty($this->modinfo->sections[$this->_section])) {
2562             return implode(',', $this->modinfo->sections[$this->_section]);
2563         } else {
2564             return '';
2565         }
2566     }
2568     /**
2569      * Returns course ID - from course_sections table
2570      *
2571      * @return int
2572      */
2573     private function get_course() {
2574         return $this->modinfo->get_course_id();
2575     }
2577     /**
2578      * Prepares section data for inclusion in sectioncache cache, removing items
2579      * that are set to defaults, and adding availability data if required.
2580      *
2581      * Called by build_section_cache in course_modinfo only; do not use otherwise.
2582      * @param object $section Raw section data object
2583      */
2584     public static function convert_for_section_cache($section) {
2585         global $CFG;
2587         // Course id stored in course table
2588         unset($section->course);
2589         // Section number stored in array key
2590         unset($section->section);
2591         // Sequence stored implicity in modinfo $sections array
2592         unset($section->sequence);
2594         // Add availability data if turned on
2595         if ($CFG->enableavailability) {
2596             require_once($CFG->dirroot . '/lib/conditionlib.php');
2597             condition_info_section::fill_availability_conditions($section);
2598             if (count($section->conditionscompletion) == 0) {
2599                 unset($section->conditionscompletion);
2600             }
2601             if (count($section->conditionsgrade) == 0) {
2602                 unset($section->conditionsgrade);
2603             }
2604         }
2606         // Remove default data
2607         foreach (self::$sectioncachedefaults as $field => $value) {
2608             // Exact compare as strings to avoid problems if some strings are set
2609             // to "0" etc.
2610             if (isset($section->{$field}) && $section->{$field} === $value) {
2611                 unset($section->{$field});
2612             }
2613         }
2614     }