2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * modinfolib.php - Functions/classes relating to cached information about module instances on
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 * @author sam marshall
27 // Maximum number of modinfo items to keep in memory cache. Do not increase this to a large
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);
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.
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.
43 * Use {@link get_fast_modinfo()} to retrieve the instance of the object for particular course
44 * and particular user.
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
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'
56 class course_modinfo
{
57 /** @var int Maximum time the course cache building lock can be held */
58 const COURSE_CACHE_LOCK_EXPIRY
= 180;
60 /** @var int Time to wait for the course cache building lock before throwing an exception */
61 const COURSE_CACHE_LOCK_WAIT
= 60;
64 * List of fields from DB table 'course' that are cached in MUC and are always present in course_modinfo::$course
67 public static $cachedfields = array('shortname', 'fullname', 'format',
68 'enablecompletion', 'groupmode', 'groupmodeforce', 'cacherev');
71 * For convenience we store the course object here as it is needed in other parts of code
77 * Array of section data from cache
89 * Array from int (section num, e.g. 0) => array of int (course-module id); this list only
90 * includes sections that actually contain at least one course-module
96 * Array from section id => section num.
102 * Array from int (cm id) => cm_info object
108 * Array from string (modname) => int (instance id) => cm_info object
114 * Groups that the current user belongs to. This value is calculated on first
115 * request to the property or function.
116 * When set, it is an array of grouping id => array of group id => group id.
117 * Includes grouping id 0 for 'all groups'.
123 * List of class read-only properties and their getter methods.
124 * Used by magic functions __get(), __isset(), __empty()
127 private static $standardproperties = array(
128 'courseid' => 'get_course_id',
129 'userid' => 'get_user_id',
130 'sections' => 'get_sections',
132 'instances' => 'get_instances',
133 'groups' => 'get_groups_all',
137 * Magic method getter
139 * @param string $name
142 public function __get($name) {
143 if (isset(self
::$standardproperties[$name])) {
144 $method = self
::$standardproperties[$name];
145 return $this->$method();
147 debugging('Invalid course_modinfo property accessed: '.$name);
153 * Magic method for function isset()
155 * @param string $name
158 public function __isset($name) {
159 if (isset(self
::$standardproperties[$name])) {
160 $value = $this->__get($name);
161 return isset($value);
167 * Magic method for function empty()
169 * @param string $name
172 public function __empty($name) {
173 if (isset(self
::$standardproperties[$name])) {
174 $value = $this->__get($name);
175 return empty($value);
181 * Magic method setter
183 * Will display the developer warning when trying to set/overwrite existing property.
185 * @param string $name
186 * @param mixed $value
188 public function __set($name, $value) {
189 debugging("It is not allowed to set the property course_modinfo::\${$name}", DEBUG_DEVELOPER
);
193 * Returns course object that was used in the first {@link get_fast_modinfo()} call.
195 * It may not contain all fields from DB table {course} but always has at least the following:
196 * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
200 public function get_course() {
201 return $this->course
;
205 * @return int Course ID
207 public function get_course_id() {
208 return $this->course
->id
;
212 * @return int User ID
214 public function get_user_id() {
215 return $this->userid
;
219 * @return array Array from section number (e.g. 0) to array of course-module IDs in that
220 * section; this only includes sections that contain at least one course-module
222 public function get_sections() {
223 return $this->sections
;
227 * @return cm_info[] Array from course-module instance to cm_info object within this course, in
228 * order of appearance
230 public function get_cms() {
235 * Obtains a single course-module object (for a course-module that is on this course).
236 * @param int $cmid Course-module ID
237 * @return cm_info Information about that course-module
238 * @throws moodle_exception If the course-module does not exist
240 public function get_cm($cmid) {
241 if (empty($this->cms
[$cmid])) {
242 throw new moodle_exception('invalidcoursemodule', 'error');
244 return $this->cms
[$cmid];
248 * Obtains all module instances on this course.
249 * @return cm_info[][] Array from module name => array from instance id => cm_info
251 public function get_instances() {
252 return $this->instances
;
256 * Returns array of localised human-readable module names used in this course
258 * @param bool $plural if true returns the plural form of modules names
261 public function get_used_module_names($plural = false) {
262 $modnames = get_module_types_names($plural);
263 $modnamesused = array();
264 foreach ($this->get_cms() as $cmid => $mod) {
265 if (!isset($modnamesused[$mod->modname
]) && isset($modnames[$mod->modname
]) && $mod->uservisible
) {
266 $modnamesused[$mod->modname
] = $modnames[$mod->modname
];
269 return $modnamesused;
273 * Obtains all instances of a particular module on this course.
274 * @param string $modname Name of module (not full frankenstyle) e.g. 'label'
275 * @return cm_info[] Array from instance id => cm_info for modules on this course; empty if none
277 public function get_instances_of($modname) {
278 if (empty($this->instances
[$modname])) {
281 return $this->instances
[$modname];
285 * Groups that the current user belongs to organised by grouping id. Calculated on the first request.
286 * @return int[][] array of grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'
288 private function get_groups_all() {
289 if (is_null($this->groups
)) {
290 // NOTE: Performance could be improved here. The system caches user groups
291 // in $USER->groupmember[$courseid] => array of groupid=>groupid. Unfortunately this
292 // structure does not include grouping information. It probably could be changed to
293 // do so, without a significant performance hit on login, thus saving this one query
295 $this->groups
= groups_get_user_groups($this->course
->id
, $this->userid
);
297 return $this->groups
;
301 * Returns groups that the current user belongs to on the course. Note: If not already
302 * available, this may make a database query.
303 * @param int $groupingid Grouping ID or 0 (default) for all groups
304 * @return int[] Array of int (group id) => int (same group id again); empty array if none
306 public function get_groups($groupingid = 0) {
307 $allgroups = $this->get_groups_all();
308 if (!isset($allgroups[$groupingid])) {
311 return $allgroups[$groupingid];
315 * Gets all sections as array from section number => data about section.
316 * @return section_info[] Array of section_info objects organised by section number
318 public function get_section_info_all() {
319 return $this->sectioninfo
;
323 * Gets data about specific numbered section.
324 * @param int $sectionnumber Number (not id) of section
325 * @param int $strictness Use MUST_EXIST to throw exception if it doesn't
326 * @return section_info Information for numbered section or null if not found
328 public function get_section_info($sectionnumber, $strictness = IGNORE_MISSING
) {
329 if (!array_key_exists($sectionnumber, $this->sectioninfo
)) {
330 if ($strictness === MUST_EXIST
) {
331 throw new moodle_exception('sectionnotexist');
336 return $this->sectioninfo
[$sectionnumber];
340 * Gets data about specific section ID.
341 * @param int $sectionid ID (not number) of section
342 * @param int $strictness Use MUST_EXIST to throw exception if it doesn't
343 * @return section_info|null Information for numbered section or null if not found
345 public function get_section_info_by_id(int $sectionid, int $strictness = IGNORE_MISSING
): ?section_info
{
347 if (!isset($this->sectionids
[$sectionid])) {
348 if ($strictness === MUST_EXIST
) {
349 throw new moodle_exception('sectionnotexist');
354 return $this->get_section_info($this->sectionids
[$sectionid], $strictness);
358 * Static cache for generated course_modinfo instances
360 * @see course_modinfo::instance()
361 * @see course_modinfo::clear_instance_cache()
362 * @var course_modinfo[]
364 protected static $instancecache = array();
367 * Timestamps (microtime) when the course_modinfo instances were last accessed
369 * It is used to remove the least recent accessed instances when static cache is full
373 protected static $cacheaccessed = array();
376 * Clears the cache used in course_modinfo::instance()
378 * Used in {@link get_fast_modinfo()} when called with argument $reset = true
379 * and in {@link rebuild_course_cache()}
381 * @param null|int|stdClass $courseorid if specified removes only cached value for this course
383 public static function clear_instance_cache($courseorid = null) {
384 if (empty($courseorid)) {
385 self
::$instancecache = array();
386 self
::$cacheaccessed = array();
389 if (is_object($courseorid)) {
390 $courseorid = $courseorid->id
;
392 if (isset(self
::$instancecache[$courseorid])) {
393 // Unsetting static variable in PHP is peculiar, it removes the reference,
394 // but data remain in memory. Prior to unsetting, the varable needs to be
395 // set to empty to remove its remains from memory.
396 self
::$instancecache[$courseorid] = '';
397 unset(self
::$instancecache[$courseorid]);
398 unset(self
::$cacheaccessed[$courseorid]);
403 * Returns the instance of course_modinfo for the specified course and specified user
405 * This function uses static cache for the retrieved instances. The cache
406 * size is limited by MAX_MODINFO_CACHE_SIZE. If instance is not found in
407 * the static cache or it was created for another user or the cacherev validation
408 * failed - a new instance is constructed and returned.
410 * Used in {@link get_fast_modinfo()}
412 * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
413 * and recommended to have field 'cacherev') or just a course id
414 * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections.
415 * Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
416 * @return course_modinfo
418 public static function instance($courseorid, $userid = 0) {
420 if (is_object($courseorid)) {
421 $course = $courseorid;
423 $course = (object)array('id' => $courseorid);
425 if (empty($userid)) {
429 if (!empty(self
::$instancecache[$course->id
])) {
430 if (self
::$instancecache[$course->id
]->userid
== $userid &&
431 (!isset($course->cacherev
) ||
432 $course->cacherev
== self
::$instancecache[$course->id
]->get_course()->cacherev
)) {
433 // This course's modinfo for the same user was recently retrieved, return cached.
434 self
::$cacheaccessed[$course->id
] = microtime(true);
435 return self
::$instancecache[$course->id
];
437 // Prevent potential reference problems when switching users.
438 self
::clear_instance_cache($course->id
);
441 $modinfo = new course_modinfo($course, $userid);
443 // We have a limit of MAX_MODINFO_CACHE_SIZE entries to store in static variable.
444 if (count(self
::$instancecache) >= MAX_MODINFO_CACHE_SIZE
) {
445 // Find the course that was the least recently accessed.
446 asort(self
::$cacheaccessed, SORT_NUMERIC
);
447 $courseidtoremove = key(array_reverse(self
::$cacheaccessed, true));
448 self
::clear_instance_cache($courseidtoremove);
451 // Add modinfo to the static cache.
452 self
::$instancecache[$course->id
] = $modinfo;
453 self
::$cacheaccessed[$course->id
] = microtime(true);
459 * Constructs based on course.
460 * Note: This constructor should not usually be called directly.
461 * Use get_fast_modinfo($course) instead as this maintains a cache.
462 * @param stdClass $course course object, only property id is required.
463 * @param int $userid User ID
464 * @throws moodle_exception if course is not found
466 public function __construct($course, $userid) {
467 global $CFG, $COURSE, $SITE, $DB;
469 if (!isset($course->cacherev
)) {
470 // We require presence of property cacherev to validate the course cache.
471 // No need to clone the $COURSE or $SITE object here because we clone it below anyway.
472 $course = get_course($course->id
, false);
475 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
477 // Retrieve modinfo from cache. If not present or cacherev mismatches, call rebuild and retrieve again.
478 $coursemodinfo = $cachecoursemodinfo->get_versioned($course->id
, $course->cacherev
);
479 // Note the version comparison using the data in the cache should not be necessary, but the
480 // partial rebuild logic sometimes sets the $coursemodinfo->cacherev to -1 which is an
481 // indicator that it needs rebuilding.
482 if ($coursemodinfo === false ||
($course->cacherev
> $coursemodinfo->cacherev
)) {
483 $lock = self
::get_course_cache_lock($course->id
);
485 // Only actually do the build if it's still needed after getting the lock (not if
486 // somebody else, who might have been holding the lock, built it already).
487 $coursemodinfo = $cachecoursemodinfo->get_versioned($course->id
, $course->cacherev
);
488 if ($coursemodinfo === false ||
($course->cacherev
> $coursemodinfo->cacherev
)) {
489 $coursemodinfo = self
::inner_build_course_cache($course, $lock);
496 // Set initial values
497 $this->userid
= $userid;
498 $this->sections
= array();
499 $this->sectionids
= [];
500 $this->cms
= array();
501 $this->instances
= array();
502 $this->groups
= null;
504 // If we haven't already preloaded contexts for the course, do it now
505 // Modules are also cached here as long as it's the first time this course has been preloaded.
506 context_helper
::preload_course($course->id
);
508 // Quick integrity check: as a result of race conditions modinfo may not be regenerated after the change.
509 // It is especially dangerous if modinfo contains the deleted course module, as it results in fatal error.
510 // We can check it very cheap by validating the existence of module context.
511 if ($course->id
== $COURSE->id ||
$course->id
== $SITE->id
) {
512 // Only verify current course (or frontpage) as pages with many courses may not have module contexts cached.
513 // (Uncached modules will result in a very slow verification).
514 foreach ($coursemodinfo->modinfo
as $mod) {
515 if (!context_module
::instance($mod->cm
, IGNORE_MISSING
)) {
516 debugging('Course cache integrity check failed: course module with id '. $mod->cm
.
517 ' does not have context. Rebuilding cache for course '. $course->id
);
518 // Re-request the course record from DB as well, don't use get_course() here.
519 $course = $DB->get_record('course', array('id' => $course->id
), '*', MUST_EXIST
);
520 $coursemodinfo = self
::build_course_cache($course, true);
526 // Overwrite unset fields in $course object with cached values, store the course object.
527 $this->course
= fullclone($course);
528 foreach ($coursemodinfo as $key => $value) {
529 if ($key !== 'modinfo' && $key !== 'sectioncache' &&
530 (!isset($this->course
->$key) ||
$key === 'cacherev')) {
531 $this->course
->$key = $value;
535 // Loop through each piece of module data, constructing it
536 static $modexists = array();
537 foreach ($coursemodinfo->modinfo
as $mod) {
538 if (!isset($mod->name
) ||
strval($mod->name
) === '') {
539 // something is wrong here
543 // Skip modules which don't exist
544 if (!array_key_exists($mod->mod
, $modexists)) {
545 $modexists[$mod->mod
] = file_exists("$CFG->dirroot/mod/$mod->mod/lib.php");
547 if (!$modexists[$mod->mod
]) {
551 // Construct info for this module
552 $cm = new cm_info($this, null, $mod, null);
554 // Store module in instances and cms array
555 if (!isset($this->instances
[$cm->modname
])) {
556 $this->instances
[$cm->modname
] = array();
558 $this->instances
[$cm->modname
][$cm->instance
] = $cm;
559 $this->cms
[$cm->id
] = $cm;
561 // Reconstruct sections. This works because modules are stored in order
562 if (!isset($this->sections
[$cm->sectionnum
])) {
563 $this->sections
[$cm->sectionnum
] = array();
565 $this->sections
[$cm->sectionnum
][] = $cm->id
;
568 // Expand section objects
569 $this->sectioninfo
= array();
570 foreach ($coursemodinfo->sectioncache
as $number => $data) {
571 $this->sectionids
[$data->id
] = $number;
572 $this->sectioninfo
[$number] = new section_info($data, $number, null, null,
578 * This method can not be used anymore.
580 * @see course_modinfo::build_course_cache()
581 * @deprecated since 2.6
583 public static function build_section_cache($courseid) {
584 throw new coding_exception('Function course_modinfo::build_section_cache() can not be used anymore.' .
585 ' Please use course_modinfo::build_course_cache() whenever applicable.');
589 * Builds a list of information about sections on a course to be stored in
590 * the course cache. (Does not include information that is already cached
591 * in some other way.)
593 * @param stdClass $course Course object (must contain fields
594 * @param boolean $usecache use cached section info if exists, use true for partial course rebuild
595 * @return array Information about sections, indexed by section number (not id)
597 protected static function build_course_section_cache(\stdClass
$course, bool $usecache = false): array {
601 $sections = $DB->get_records('course_sections', array('course' => $course->id
), 'section',
602 'section, id, course, name, summary, summaryformat, sequence, visible, availability');
603 $compressedsections = [];
604 $courseformat = course_get_format($course);
607 $cachecoursemodinfo = \cache
::make('core', 'coursemodinfo');
608 $coursemodinfo = $cachecoursemodinfo->get_versioned($course->id
, $course->cacherev
);
609 if ($coursemodinfo !== false) {
610 $compressedsections = $coursemodinfo->sectioncache
;
614 $formatoptionsdef = course_get_format($course)->section_format_options();
615 // Remove unnecessary data and add availability
616 foreach ($sections as $number => $section) {
617 $sectioninfocached = isset($compressedsections[$number]);
618 if ($sectioninfocached) {
621 // Add cached options from course format to $section object
622 foreach ($formatoptionsdef as $key => $option) {
623 if (!empty($option['cache'])) {
624 $formatoptions = $courseformat->get_format_options($section);
625 if (!array_key_exists('cachedefault', $option) ||
$option['cachedefault'] !== $formatoptions[$key]) {
626 $section->$key = $formatoptions[$key];
630 // Clone just in case it is reused elsewhere
631 $compressedsections[$number] = clone($section);
632 section_info
::convert_for_section_cache($compressedsections[$number]);
635 ksort($compressedsections);
636 return $compressedsections;
640 * Gets a lock for rebuilding the cache of a single course.
642 * Caller must release the returned lock.
644 * This is used to ensure that the cache rebuild doesn't happen multiple times in parallel.
645 * This function will wait up to 1 minute for the lock to be obtained. If the lock cannot
646 * be obtained, it throws an exception.
648 * @param int $courseid Course id
649 * @return \core\lock\lock Lock (must be released!)
650 * @throws moodle_exception If the lock cannot be obtained
652 protected static function get_course_cache_lock($courseid) {
653 // Get database lock to ensure this doesn't happen multiple times in parallel. Wait a
654 // reasonable time for the lock to be released, so we can give a suitable error message.
655 // In case the system crashes while building the course cache, the lock will automatically
656 // expire after a (slightly longer) period.
657 $lockfactory = \core\lock\lock_config
::get_lock_factory('core_modinfo');
658 $lock = $lockfactory->get_lock('build_course_cache_' . $courseid,
659 self
::COURSE_CACHE_LOCK_WAIT
, self
::COURSE_CACHE_LOCK_EXPIRY
);
661 throw new moodle_exception('locktimeout', '', '', null,
662 'core_modinfo/build_course_cache_' . $courseid);
668 * Builds and stores in MUC object containing information about course
669 * modules and sections together with cached fields from table course.
671 * @param stdClass $course object from DB table course. Must have property 'id'
672 * but preferably should have all cached fields.
673 * @param boolean $partialrebuild Indicate if it's partial course cache rebuild or not
674 * @return stdClass object with all cached keys of the course plus fields modinfo and sectioncache.
675 * The same object is stored in MUC
676 * @throws moodle_exception if course is not found (if $course object misses some of the
677 * necessary fields it is re-requested from database)
679 public static function build_course_cache(\stdClass
$course, bool $partialrebuild = false): \stdClass
{
680 if (empty($course->id
)) {
681 throw new coding_exception('Object $course is missing required property \id\'');
684 $lock = self
::get_course_cache_lock($course->id
);
686 return self
::inner_build_course_cache($course, $lock, $partialrebuild);
693 * Called to build course cache when there is already a lock obtained.
695 * @param stdClass $course object from DB table course
696 * @param \core\lock\lock $lock Lock object - not actually used, just there to indicate you have a lock
697 * @param bool $partialrebuild Indicate if it's partial course cache rebuild or not
698 * @return stdClass Course object that has been stored in MUC
700 protected static function inner_build_course_cache(\stdClass
$course, \core\lock\lock
$lock,
701 bool $partialrebuild = false): \stdClass
{
703 require_once("{$CFG->dirroot}/course/lib.php");
705 // Always reload the course object from database to ensure we have the latest possible
706 // value for cacherev.
707 $course = $DB->get_record('course', ['id' => $course->id
],
708 implode(',', array_merge(['id'], self
::$cachedfields)), MUST_EXIST
);
710 // Retrieve all information about activities and sections.
711 $coursemodinfo = new stdClass();
712 $coursemodinfo->modinfo
= self
::get_array_of_activities($course, $partialrebuild);
713 $coursemodinfo->sectioncache
= self
::build_course_section_cache($course, $partialrebuild);
714 foreach (self
::$cachedfields as $key) {
715 $coursemodinfo->$key = $course->$key;
717 // Set the accumulated activities and sections information in cache, together with cacherev.
718 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
719 $cachecoursemodinfo->set_versioned($course->id
, $course->cacherev
, $coursemodinfo);
720 return $coursemodinfo;
724 * Purge the cache of a course section by its id.
726 * @param int $courseid The course to purge cache in
727 * @param int $sectionid The section _id_ to purge
729 public static function purge_course_section_cache_by_id(int $courseid, int $sectionid): void
{
730 $course = get_course($courseid);
731 $cache = cache
::make('core', 'coursemodinfo');
732 $cache->acquire_lock($course->id
);
733 $coursemodinfo = $cache->get_versioned($course->id
, $course->cacherev
);
734 if ($coursemodinfo !== false) {
735 foreach ($coursemodinfo->sectioncache
as $sectionno => $sectioncache) {
736 if ($sectioncache->id
== $sectionid) {
737 $coursemodinfo->cacherev
= -1;
738 unset($coursemodinfo->sectioncache
[$sectionno]);
739 $cache->set_versioned($course->id
, $course->cacherev
, $coursemodinfo);
744 $cache->release_lock($course->id
);
748 * Purge the cache of a course section by its number.
750 * @param int $courseid The course to purge cache in
751 * @param int $sectionno The section number to purge
753 public static function purge_course_section_cache_by_number(int $courseid, int $sectionno): void
{
754 $course = get_course($courseid);
755 $cache = cache
::make('core', 'coursemodinfo');
756 $cache->acquire_lock($course->id
);
757 $coursemodinfo = $cache->get_versioned($course->id
, $course->cacherev
);
758 if ($coursemodinfo !== false && array_key_exists($sectionno, $coursemodinfo->sectioncache
)) {
759 $coursemodinfo->cacherev
= -1;
760 unset($coursemodinfo->sectioncache
[$sectionno]);
761 $cache->set_versioned($course->id
, $course->cacherev
, $coursemodinfo);
763 $cache->release_lock($course->id
);
767 * Purge the cache of a course module.
769 * @param int $courseid Course id
770 * @param int $cmid Course module id
772 public static function purge_course_module_cache(int $courseid, int $cmid): void
{
773 $course = get_course($courseid);
774 $cache = cache
::make('core', 'coursemodinfo');
775 $cache->acquire_lock($course->id
);
776 $coursemodinfo = $cache->get_versioned($course->id
, $course->cacherev
);
777 $hascache = ($coursemodinfo !== false) && array_key_exists($cmid, $coursemodinfo->modinfo
);
779 $coursemodinfo->cacherev
= -1;
780 unset($coursemodinfo->modinfo
[$cmid]);
781 $cache->set_versioned($course->id
, $course->cacherev
, $coursemodinfo);
782 $coursemodinfo = $cache->get_versioned($course->id
, $course->cacherev
);
784 $cache->release_lock($course->id
);
788 * For a given course, returns an array of course activity objects
790 * @param stdClass $course Course object
791 * @param bool $usecache get activities from cache if modinfo exists when $usecache is true
792 * @return array list of activities
794 public static function get_array_of_activities(stdClass
$course, bool $usecache = false): array {
797 if (empty($course)) {
798 throw new moodle_exception('courseidnotfound');
801 $rawmods = get_course_mods($course->id
);
802 if (empty($rawmods)) {
808 // Get existing cache.
809 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
810 $coursemodinfo = $cachecoursemodinfo->get_versioned($course->id
, $course->cacherev
);
811 if ($coursemodinfo !== false) {
812 $mods = $coursemodinfo->modinfo
;
816 $courseformat = course_get_format($course);
818 if ($sections = $DB->get_records('course_sections', ['course' => $course->id
],
819 'section ASC', 'id,section,sequence,visible')) {
820 // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
821 if ($errormessages = course_integrity_check($course->id
, $rawmods, $sections)) {
822 debugging(join('<br>', $errormessages));
823 $rawmods = get_course_mods($course->id
);
824 $sections = $DB->get_records('course_sections', ['course' => $course->id
],
825 'section ASC', 'id,section,sequence,visible');
827 // Build array of activities.
828 foreach ($sections as $section) {
829 if (!empty($section->sequence
)) {
830 $cmids = explode(",", $section->sequence
);
831 $numberofmods = count($cmids);
832 foreach ($cmids as $cmid) {
833 // Activity does not exist in the database.
834 $notexistindb = empty($rawmods[$cmid]);
835 $activitycached = isset($mods[$cmid]);
836 if ($activitycached ||
$notexistindb) {
840 // Adjust visibleoncoursepage, value in DB may not respect format availability.
841 $rawmods[$cmid]->visibleoncoursepage
= (!$rawmods[$cmid]->visible
842 ||
$rawmods[$cmid]->visibleoncoursepage
843 ||
empty($CFG->allowstealth
)
844 ||
!$courseformat->allow_stealth_module_visibility($rawmods[$cmid], $section)) ?
1 : 0;
846 $mods[$cmid] = new stdClass();
847 $mods[$cmid]->id
= $rawmods[$cmid]->instance
;
848 $mods[$cmid]->cm
= $rawmods[$cmid]->id
;
849 $mods[$cmid]->mod
= $rawmods[$cmid]->modname
;
851 // Oh dear. Inconsistent names left here for backward compatibility.
852 $mods[$cmid]->section
= $section->section
;
853 $mods[$cmid]->sectionid
= $rawmods[$cmid]->section
;
855 $mods[$cmid]->module
= $rawmods[$cmid]->module
;
856 $mods[$cmid]->added
= $rawmods[$cmid]->added
;
857 $mods[$cmid]->score
= $rawmods[$cmid]->score
;
858 $mods[$cmid]->idnumber
= $rawmods[$cmid]->idnumber
;
859 $mods[$cmid]->visible
= $rawmods[$cmid]->visible
;
860 $mods[$cmid]->visibleoncoursepage
= $rawmods[$cmid]->visibleoncoursepage
;
861 $mods[$cmid]->visibleold
= $rawmods[$cmid]->visibleold
;
862 $mods[$cmid]->groupmode
= $rawmods[$cmid]->groupmode
;
863 $mods[$cmid]->groupingid
= $rawmods[$cmid]->groupingid
;
864 $mods[$cmid]->indent
= $rawmods[$cmid]->indent
;
865 $mods[$cmid]->completion
= $rawmods[$cmid]->completion
;
866 $mods[$cmid]->extra
= "";
867 $mods[$cmid]->completiongradeitemnumber
=
868 $rawmods[$cmid]->completiongradeitemnumber
;
869 $mods[$cmid]->completionpassgrade
= $rawmods[$cmid]->completionpassgrade
;
870 $mods[$cmid]->completionview
= $rawmods[$cmid]->completionview
;
871 $mods[$cmid]->completionexpected
= $rawmods[$cmid]->completionexpected
;
872 $mods[$cmid]->showdescription
= $rawmods[$cmid]->showdescription
;
873 $mods[$cmid]->availability
= $rawmods[$cmid]->availability
;
874 $mods[$cmid]->deletioninprogress
= $rawmods[$cmid]->deletioninprogress
;
875 $mods[$cmid]->downloadcontent
= $rawmods[$cmid]->downloadcontent
;
877 $modname = $mods[$cmid]->mod
;
878 $functionname = $modname . "_get_coursemodule_info";
880 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
884 include_once("$CFG->dirroot/mod/$modname/lib.php");
886 if ($hasfunction = function_exists($functionname)) {
887 if ($info = $functionname($rawmods[$cmid])) {
888 if (!empty($info->icon
)) {
889 $mods[$cmid]->icon
= $info->icon
;
891 if (!empty($info->iconcomponent
)) {
892 $mods[$cmid]->iconcomponent
= $info->iconcomponent
;
894 if (!empty($info->name
)) {
895 $mods[$cmid]->name
= $info->name
;
897 if ($info instanceof cached_cm_info
) {
898 // When using cached_cm_info you can include three new fields.
899 // That aren't available for legacy code.
900 if (!empty($info->content
)) {
901 $mods[$cmid]->content
= $info->content
;
903 if (!empty($info->extraclasses
)) {
904 $mods[$cmid]->extraclasses
= $info->extraclasses
;
906 if (!empty($info->iconurl
)) {
907 // Convert URL to string as it's easier to store.
908 // Also serialized object contains \0 byte,
909 // ... and can not be written to Postgres DB.
910 $url = new moodle_url($info->iconurl
);
911 $mods[$cmid]->iconurl
= $url->out(false);
913 if (!empty($info->onclick
)) {
914 $mods[$cmid]->onclick
= $info->onclick
;
916 if (!empty($info->customdata
)) {
917 $mods[$cmid]->customdata
= $info->customdata
;
920 // When using a stdclass, the (horrible) deprecated ->extra field,
921 // ... that is available for BC.
922 if (!empty($info->extra
)) {
923 $mods[$cmid]->extra
= $info->extra
;
928 // When there is no modname_get_coursemodule_info function,
929 // ... but showdescriptions is enabled, then we use the 'intro',
930 // ... and 'introformat' fields in the module table.
931 if (!$hasfunction && $rawmods[$cmid]->showdescription
) {
932 if ($modvalues = $DB->get_record($rawmods[$cmid]->modname
,
933 ['id' => $rawmods[$cmid]->instance
], 'name, intro, introformat')) {
934 // Set content from intro and introformat. Filters are disabled.
935 // Because we filter it with format_text at display time.
936 $mods[$cmid]->content
= format_module_intro($rawmods[$cmid]->modname
,
937 $modvalues, $rawmods[$cmid]->id
, false);
939 // To save making another query just below, put name in here.
940 $mods[$cmid]->name
= $modvalues->name
;
943 if (!isset($mods[$cmid]->name
)) {
944 $mods[$cmid]->name
= $DB->get_field($rawmods[$cmid]->modname
, "name",
945 ["id" => $rawmods[$cmid]->instance
]);
948 // Minimise the database size by unsetting default options when they are 'empty'.
949 // This list corresponds to code in the cm_info constructor.
950 foreach (['idnumber', 'groupmode', 'groupingid',
951 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
952 'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
953 'completionexpected', 'score', 'showdescription', 'deletioninprogress'] as $property) {
954 if (property_exists($mods[$cmid], $property) &&
955 empty($mods[$cmid]->{$property})) {
956 unset($mods[$cmid]->{$property});
959 // Special case: this value is usually set to null, but may be 0.
960 if (property_exists($mods[$cmid], 'completiongradeitemnumber') &&
961 is_null($mods[$cmid]->completiongradeitemnumber
)) {
962 unset($mods[$cmid]->completiongradeitemnumber
);
972 * Purge the cache of a given course
974 * @param int $courseid Course id
976 public static function purge_course_cache(int $courseid): void
{
977 $cachemodinfo = cache
::make('core', 'coursemodinfo');
978 $cachemodinfo->delete($courseid);
984 * Data about a single module on a course. This contains most of the fields in the course_modules
985 * table, plus additional data when required.
987 * The object can be accessed by core or any plugin (i.e. course format, block, filter, etc.) as
988 * get_fast_modinfo($courseorid)->cms[$coursemoduleid]
990 * get_fast_modinfo($courseorid)->instances[$moduletype][$instanceid]
992 * There are three stages when activity module can add/modify data in this object:
994 * <b>Stage 1 - during building the cache.</b>
995 * Allows to add to the course cache static user-independent information about the module.
996 * Modules should try to include only absolutely necessary information that may be required
997 * when displaying course view page. The information is stored in application-level cache
998 * and reset when {@link rebuild_course_cache()} is called or cache is purged by admin.
1000 * Modules can implement callback XXX_get_coursemodule_info() returning instance of object
1001 * {@link cached_cm_info}
1003 * <b>Stage 2 - dynamic data.</b>
1004 * Dynamic data is user-dependent, it is stored in request-level cache. To reset this cache
1005 * {@link get_fast_modinfo()} with $reset argument may be called.
1007 * Dynamic data is obtained when any of the following properties/methods is requested:
1008 * - {@link cm_info::$url}
1009 * - {@link cm_info::$name}
1010 * - {@link cm_info::$onclick}
1011 * - {@link cm_info::get_icon_url()}
1012 * - {@link cm_info::$uservisible}
1013 * - {@link cm_info::$available}
1014 * - {@link cm_info::$availableinfo}
1015 * - plus any of the properties listed in Stage 3.
1017 * Modules can implement callback <b>XXX_cm_info_dynamic()</b> and inside this callback they
1018 * are allowed to use any of the following set methods:
1019 * - {@link cm_info::set_available()}
1020 * - {@link cm_info::set_name()}
1021 * - {@link cm_info::set_no_view_link()}
1022 * - {@link cm_info::set_user_visible()}
1023 * - {@link cm_info::set_on_click()}
1024 * - {@link cm_info::set_icon_url()}
1025 * - {@link cm_info::override_customdata()}
1026 * Any methods affecting view elements can also be set in this callback.
1028 * <b>Stage 3 (view data).</b>
1029 * Also user-dependend data stored in request-level cache. Second stage is created
1030 * because populating the view data can be expensive as it may access much more
1031 * Moodle APIs such as filters, user information, output renderers and we
1032 * don't want to request it until necessary.
1033 * View data is obtained when any of the following properties/methods is requested:
1034 * - {@link cm_info::$afterediticons}
1035 * - {@link cm_info::$content}
1036 * - {@link cm_info::get_formatted_content()}
1037 * - {@link cm_info::$extraclasses}
1038 * - {@link cm_info::$afterlink}
1040 * Modules can implement callback <b>XXX_cm_info_view()</b> and inside this callback they
1041 * are allowed to use any of the following set methods:
1042 * - {@link cm_info::set_after_edit_icons()}
1043 * - {@link cm_info::set_after_link()}
1044 * - {@link cm_info::set_content()}
1045 * - {@link cm_info::set_extra_classes()}
1047 * @property-read int $id Course-module ID - from course_modules table
1048 * @property-read int $instance Module instance (ID within module table) - from course_modules table
1049 * @property-read int $course Course ID - from course_modules table
1050 * @property-read string $idnumber 'ID number' from course-modules table (arbitrary text set by user) - from
1051 * course_modules table
1052 * @property-read int $added Time that this course-module was added (unix time) - from course_modules table
1053 * @property-read int $visible Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
1054 * course_modules table
1055 * @property-read int $visibleoncoursepage Visible on course page setting - from course_modules table, adjusted to
1056 * whether course format allows this module to have the "stealth" mode
1057 * @property-read int $visibleold Old visible setting (if the entire section is hidden, the previous value for
1058 * visible is stored in this field) - from course_modules table
1059 * @property-read int $groupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
1060 * course_modules table. Use {@link cm_info::$effectivegroupmode} to find the actual group mode that may be forced by course.
1061 * @property-read int $groupingid Grouping ID (0 = all groupings)
1062 * @property-read bool $coursegroupmodeforce Indicates whether the course containing the module has forced the groupmode
1063 * This means that cm_info::$groupmode should be ignored and cm_info::$coursegroupmode be used instead
1064 * @property-read int $coursegroupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
1065 * course table - as specified for the course containing the module
1066 * Effective only if {@link cm_info::$coursegroupmodeforce} is set
1067 * @property-read int $effectivegroupmode Effective group mode for this module (one of the constants NOGROUPS, SEPARATEGROUPS,
1068 * or VISIBLEGROUPS). This can be different from groupmode set for the module if the groupmode is forced for the course.
1069 * This value will always be NOGROUPS if module type does not support group mode.
1070 * @property-read int $indent Indent level on course page (0 = no indent) - from course_modules table
1071 * @property-read int $completion Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
1072 * course_modules table
1073 * @property-read mixed $completiongradeitemnumber Set to the item number (usually 0) if completion depends on a particular
1074 * grade of this activity, or null if completion does not depend on a grade - from course_modules table
1075 * @property-read int $completionview 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
1076 * @property-read int $completionexpected Set to a unix time if completion of this activity is expected at a
1077 * particular time, 0 if no time set - from course_modules table
1078 * @property-read string $availability Availability information as JSON string or null if none -
1079 * from course_modules table
1080 * @property-read int $showdescription Controls whether the description of the activity displays on the course main page (in
1081 * addition to anywhere it might display within the activity itself). 0 = do not show
1082 * on main page, 1 = show on main page.
1083 * @property-read string $extra (deprecated) Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
1084 * course page - from cached data in modinfo field. Deprecated, replaced by ->extraclasses and ->onclick
1085 * @property-read string $icon Name of icon to use - from cached data in modinfo field
1086 * @property-read string $iconcomponent Component that contains icon - from cached data in modinfo field
1087 * @property-read string $modname Name of module e.g. 'forum' (this is the same name as the module's main database
1088 * table) - from cached data in modinfo field
1089 * @property-read int $module ID of module type - from course_modules table
1090 * @property-read string $name Name of module instance for display on page e.g. 'General discussion forum' - from cached
1091 * data in modinfo field
1092 * @property-read int $sectionnum Section number that this course-module is in (section 0 = above the calendar, section 1
1093 * = week/topic 1, etc) - from cached data in modinfo field
1094 * @property-read int $section Section id - from course_modules table
1095 * @property-read array $conditionscompletion Availability conditions for this course-module based on the completion of other
1096 * course-modules (array from other course-module id to required completion state for that
1097 * module) - from cached data in modinfo field
1098 * @property-read array $conditionsgrade Availability conditions for this course-module based on course grades (array from
1099 * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
1100 * @property-read array $conditionsfield Availability conditions for this course-module based on user fields
1101 * @property-read bool $available True if this course-module is available to students i.e. if all availability conditions
1102 * are met - obtained dynamically
1103 * @property-read string $availableinfo If course-module is not available to students, this string gives information about
1104 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
1105 * January 2010') for display on main page - obtained dynamically
1106 * @property-read bool $uservisible True if this course-module is available to the CURRENT user (for example, if current user
1107 * has viewhiddenactivities capability, they can access the course-module even if it is not
1108 * visible or not available, so this would be true in that case)
1109 * @property-read context_module $context Module context
1110 * @property-read string $modfullname Returns a localised human-readable name of the module type - calculated on request
1111 * @property-read string $modplural Returns a localised human-readable name of the module type in plural form - calculated on request
1112 * @property-read string $content Content to display on main (view) page - calculated on request
1113 * @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
1114 * @property-read string $extraclasses Extra CSS classes to add to html output for this activity on main page - calculated on request
1115 * @property-read string $onclick Content of HTML on-click attribute already escaped - calculated on request
1116 * @property-read mixed $customdata Optional custom data stored in modinfo cache for this activity, or null if none
1117 * @property-read string $afterlink Extra HTML code to display after link - calculated on request
1118 * @property-read string $afterediticons Extra HTML code to display after editing icons (e.g. more icons) - calculated on request
1119 * @property-read bool $deletioninprogress True if this course module is scheduled for deletion, false otherwise.
1120 * @property-read bool $downloadcontent True if content download is enabled for this course module, false otherwise.
1122 class cm_info
implements IteratorAggregate
{
1124 * State: Only basic data from modinfo cache is available.
1126 const STATE_BASIC
= 0;
1129 * State: In the process of building dynamic data (to avoid recursive calls to obtain_dynamic_data())
1131 const STATE_BUILDING_DYNAMIC
= 1;
1134 * State: Dynamic data is available too.
1136 const STATE_DYNAMIC
= 2;
1139 * State: In the process of building view data (to avoid recursive calls to obtain_view_data())
1141 const STATE_BUILDING_VIEW
= 3;
1144 * State: View data (for course page) is available.
1146 const STATE_VIEW
= 4;
1150 * @var course_modinfo
1155 * Level of information stored inside this object (STATE_xx constant)
1161 * Course-module ID - from course_modules table
1167 * Module instance (ID within module table) - from course_modules table
1173 * 'ID number' from course-modules table (arbitrary text set by user) - from
1174 * course_modules table
1180 * Time that this course-module was added (unix time) - from course_modules table
1186 * This variable is not used and is included here only so it can be documented.
1187 * Once the database entry is removed from course_modules, it should be deleted
1190 * @deprecated Do not use this variable
1195 * Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
1196 * course_modules table
1202 * Visible on course page setting - from course_modules table
1205 private $visibleoncoursepage;
1208 * Old visible setting (if the entire section is hidden, the previous value for
1209 * visible is stored in this field) - from course_modules table
1212 private $visibleold;
1215 * Group mode (one of the constants NONE, SEPARATEGROUPS, or VISIBLEGROUPS) - from
1216 * course_modules table
1222 * Grouping ID (0 = all groupings)
1225 private $groupingid;
1228 * Indent level on course page (0 = no indent) - from course_modules table
1234 * Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
1235 * course_modules table
1238 private $completion;
1241 * Set to the item number (usually 0) if completion depends on a particular
1242 * grade of this activity, or null if completion does not depend on a grade - from
1243 * course_modules table
1246 private $completiongradeitemnumber;
1249 * 1 if pass grade completion is enabled, 0 otherwise - from course_modules table
1252 private $completionpassgrade;
1255 * 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
1258 private $completionview;
1261 * Set to a unix time if completion of this activity is expected at a
1262 * particular time, 0 if no time set - from course_modules table
1265 private $completionexpected;
1268 * Availability information as JSON string or null if none - from course_modules table
1271 private $availability;
1274 * Controls whether the description of the activity displays on the course main page (in
1275 * addition to anywhere it might display within the activity itself). 0 = do not show
1276 * on main page, 1 = show on main page.
1279 private $showdescription;
1282 * Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
1283 * course page - from cached data in modinfo field
1284 * @deprecated This is crazy, don't use it. Replaced by ->extraclasses and ->onclick
1290 * Name of icon to use - from cached data in modinfo field
1296 * Component that contains icon - from cached data in modinfo field
1299 private $iconcomponent;
1302 * Name of module e.g. 'forum' (this is the same name as the module's main database
1303 * table) - from cached data in modinfo field
1309 * ID of module - from course_modules table
1315 * Name of module instance for display on page e.g. 'General discussion forum' - from cached
1316 * data in modinfo field
1322 * Section number that this course-module is in (section 0 = above the calendar, section 1
1323 * = week/topic 1, etc) - from cached data in modinfo field
1326 private $sectionnum;
1329 * Section id - from course_modules table
1335 * Availability conditions for this course-module based on the completion of other
1336 * course-modules (array from other course-module id to required completion state for that
1337 * module) - from cached data in modinfo field
1340 private $conditionscompletion;
1343 * Availability conditions for this course-module based on course grades (array from
1344 * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
1347 private $conditionsgrade;
1350 * Availability conditions for this course-module based on user fields
1353 private $conditionsfield;
1356 * True if this course-module is available to students i.e. if all availability conditions
1357 * are met - obtained dynamically
1363 * If course-module is not available to students, this string gives information about
1364 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
1365 * January 2010') for display on main page - obtained dynamically
1368 private $availableinfo;
1371 * True if this course-module is available to the CURRENT user (for example, if current user
1372 * has viewhiddenactivities capability, they can access the course-module even if it is not
1373 * visible or not available, so this would be true in that case)
1376 private $uservisible;
1379 * True if this course-module is visible to the CURRENT user on the course page
1382 private $uservisibleoncoursepage;
1397 private $contentisformatted;
1400 * @var bool True if the content has a special course item display like labels.
1402 private $customcmlistitem;
1407 private $extraclasses;
1410 * @var moodle_url full external url pointing to icon image for activity
1422 private $customdata;
1432 private $afterediticons;
1435 * @var bool representing the deletion state of the module. True if the mod is scheduled for deletion.
1437 private $deletioninprogress;
1440 * @var int enable/disable download content for this course module
1442 private $downloadcontent;
1445 * List of class read-only properties and their getter methods.
1446 * Used by magic functions __get(), __isset(), __empty()
1449 private static $standardproperties = array(
1451 'content' => 'get_content',
1452 'extraclasses' => 'get_extra_classes',
1453 'onclick' => 'get_on_click',
1454 'customdata' => 'get_custom_data',
1455 'afterlink' => 'get_after_link',
1456 'afterediticons' => 'get_after_edit_icons',
1457 'modfullname' => 'get_module_type_name',
1458 'modplural' => 'get_module_type_name_plural',
1461 'availability' => false,
1462 'available' => 'get_available',
1463 'availableinfo' => 'get_available_info',
1464 'completion' => false,
1465 'completionexpected' => false,
1466 'completiongradeitemnumber' => false,
1467 'completionpassgrade' => false,
1468 'completionview' => false,
1469 'conditionscompletion' => false,
1470 'conditionsfield' => false,
1471 'conditionsgrade' => false,
1472 'context' => 'get_context',
1473 'course' => 'get_course_id',
1474 'coursegroupmode' => 'get_course_groupmode',
1475 'coursegroupmodeforce' => 'get_course_groupmodeforce',
1476 'customcmlistitem' => 'has_custom_cmlist_item',
1477 'effectivegroupmode' => 'get_effective_groupmode',
1479 'groupingid' => false,
1480 'groupmembersonly' => 'get_deprecated_group_members_only',
1481 'groupmode' => false,
1483 'iconcomponent' => false,
1484 'idnumber' => false,
1486 'instance' => false,
1489 'name' => 'get_name',
1492 'sectionnum' => false,
1493 'showdescription' => false,
1494 'uservisible' => 'get_user_visible',
1496 'visibleoncoursepage' => false,
1497 'visibleold' => false,
1498 'deletioninprogress' => false,
1499 'downloadcontent' => false
1503 * List of methods with no arguments that were public prior to Moodle 2.6.
1505 * They can still be accessed publicly via magic __call() function with no warnings
1506 * but are not listed in the class methods list.
1507 * For the consistency of the code it is better to use corresponding properties.
1509 * These methods be deprecated completely in later versions.
1511 * @var array $standardmethods
1513 private static $standardmethods = array(
1514 // Following methods are not recommended to use because there have associated read-only properties.
1517 'get_extra_classes',
1521 'get_after_edit_icons',
1522 // Method obtain_dynamic_data() should not be called from outside of this class but it was public before Moodle 2.6.
1523 'obtain_dynamic_data',
1527 * Magic method to call functions that are now declared as private but were public in Moodle before 2.6.
1528 * These private methods can not be used anymore.
1530 * @param string $name
1531 * @param array $arguments
1533 * @throws coding_exception
1535 public function __call($name, $arguments) {
1536 if (in_array($name, self
::$standardmethods)) {
1537 $message = "cm_info::$name() can not be used anymore.";
1538 if ($alternative = array_search($name, self
::$standardproperties)) {
1539 $message .= " Please use the property cm_info->$alternative instead.";
1541 throw new coding_exception($message);
1543 throw new coding_exception("Method cm_info::{$name}() does not exist");
1547 * Magic method getter
1549 * @param string $name
1552 public function __get($name) {
1553 if (isset(self
::$standardproperties[$name])) {
1554 if ($method = self
::$standardproperties[$name]) {
1555 return $this->$method();
1557 return $this->$name;
1560 debugging('Invalid cm_info property accessed: '.$name);
1566 * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
1567 * and use {@link convert_to_array()}
1569 * @return ArrayIterator
1571 public function getIterator() {
1572 // Make sure dynamic properties are retrieved prior to view properties.
1573 $this->obtain_dynamic_data();
1576 // Do not iterate over deprecated properties.
1577 $props = self
::$standardproperties;
1578 unset($props['groupmembersonly']);
1580 foreach ($props as $key => $unused) {
1581 $ret[$key] = $this->__get($key);
1583 return new ArrayIterator($ret);
1587 * Magic method for function isset()
1589 * @param string $name
1592 public function __isset($name) {
1593 if (isset(self
::$standardproperties[$name])) {
1594 $value = $this->__get($name);
1595 return isset($value);
1601 * Magic method for function empty()
1603 * @param string $name
1606 public function __empty($name) {
1607 if (isset(self
::$standardproperties[$name])) {
1608 $value = $this->__get($name);
1609 return empty($value);
1615 * Magic method setter
1617 * Will display the developer warning when trying to set/overwrite property.
1619 * @param string $name
1620 * @param mixed $value
1622 public function __set($name, $value) {
1623 debugging("It is not allowed to set the property cm_info::\${$name}", DEBUG_DEVELOPER
);
1627 * @return bool True if this module has a 'view' page that should be linked to in navigation
1628 * etc (note: modules may still have a view.php file, but return false if this is not
1629 * intended to be linked to from 'normal' parts of the interface; this is what label does).
1631 public function has_view() {
1632 return !is_null($this->url
);
1636 * Gets the URL to link to for this module.
1638 * This method is normally called by the property ->url, but can be called directly if
1639 * there is a case when it might be called recursively (you can't call property values
1642 * @return moodle_url URL to link to for this module, or null if it doesn't have a view page
1644 public function get_url() {
1645 $this->obtain_dynamic_data();
1650 * Obtains content to display on main (view) page.
1651 * Note: Will collect view data, if not already obtained.
1652 * @return string Content to display on main page below link, or empty string if none
1654 private function get_content() {
1655 $this->obtain_view_data();
1656 return $this->content
;
1660 * Returns the content to display on course/overview page, formatted and passed through filters
1662 * if $options['context'] is not specified, the module context is used
1664 * @param array|stdClass $options formatting options, see {@link format_text()}
1667 public function get_formatted_content($options = array()) {
1668 $this->obtain_view_data();
1669 if (empty($this->content
)) {
1672 if ($this->contentisformatted
) {
1673 return $this->content
;
1676 // Improve filter performance by preloading filter setttings for all
1677 // activities on the course (this does nothing if called multiple
1679 filter_preload_activities($this->get_modinfo());
1681 $options = (array)$options;
1682 if (!isset($options['context'])) {
1683 $options['context'] = $this->get_context();
1685 return format_text($this->content
, FORMAT_HTML
, $options);
1689 * Return the module custom cmlist item flag.
1691 * Activities like label uses this flag to indicate that it should be
1692 * displayed as a custom course item instead of a tipical activity card.
1696 public function has_custom_cmlist_item(): bool {
1697 $this->obtain_view_data();
1698 return $this->customcmlistitem ??
false;
1702 * Getter method for property $name, ensures that dynamic data is obtained.
1704 * This method is normally called by the property ->name, but can be called directly if there
1705 * is a case when it might be called recursively (you can't call property values recursively).
1709 public function get_name() {
1710 $this->obtain_dynamic_data();
1715 * Returns the name to display on course/overview page, formatted and passed through filters
1717 * if $options['context'] is not specified, the module context is used
1719 * @param array|stdClass $options formatting options, see {@link format_string()}
1722 public function get_formatted_name($options = array()) {
1724 $options = (array)$options;
1725 if (!isset($options['context'])) {
1726 $options['context'] = $this->get_context();
1728 // Improve filter performance by preloading filter setttings for all
1729 // activities on the course (this does nothing if called multiple
1731 if (!empty($CFG->filterall
)) {
1732 filter_preload_activities($this->get_modinfo());
1734 return format_string($this->get_name(), true, $options);
1738 * Note: Will collect view data, if not already obtained.
1739 * @return string Extra CSS classes to add to html output for this activity on main page
1741 private function get_extra_classes() {
1742 $this->obtain_view_data();
1743 return $this->extraclasses
;
1747 * @return string Content of HTML on-click attribute. This string will be used literally
1748 * as a string so should be pre-escaped.
1750 private function get_on_click() {
1751 // Does not need view data; may be used by navigation
1752 $this->obtain_dynamic_data();
1753 return $this->onclick
;
1756 * Getter method for property $customdata, ensures that dynamic data is retrieved.
1758 * This method is normally called by the property ->customdata, but can be called directly if there
1759 * is a case when it might be called recursively (you can't call property values recursively).
1761 * @return mixed Optional custom data stored in modinfo cache for this activity, or null if none
1763 public function get_custom_data() {
1764 $this->obtain_dynamic_data();
1765 return $this->customdata
;
1769 * Note: Will collect view data, if not already obtained.
1770 * @return string Extra HTML code to display after link
1772 private function get_after_link() {
1773 $this->obtain_view_data();
1774 return $this->afterlink
;
1778 * Note: Will collect view data, if not already obtained.
1779 * @return string Extra HTML code to display after editing icons (e.g. more icons)
1781 private function get_after_edit_icons() {
1782 $this->obtain_view_data();
1783 return $this->afterediticons
;
1787 * @param moodle_core_renderer $output Output render to use, or null for default (global)
1788 * @return moodle_url Icon URL for a suitable icon to put beside this cm
1790 public function get_icon_url($output = null) {
1792 $this->obtain_dynamic_data();
1797 if (!empty($this->iconurl
)) {
1798 // Support modules setting their own, external, icon image.
1799 $icon = $this->iconurl
;
1800 } else if (!empty($this->icon
)) {
1801 // Fallback to normal local icon + component processing.
1802 if (substr($this->icon
, 0, 4) === 'mod/') {
1803 list($modname, $iconname) = explode('/', substr($this->icon
, 4), 2);
1804 $icon = $output->image_url($iconname, $modname);
1806 if (!empty($this->iconcomponent
)) {
1807 // Icon has specified component.
1808 $icon = $output->image_url($this->icon
, $this->iconcomponent
);
1810 // Icon does not have specified component, use default.
1811 $icon = $output->image_url($this->icon
);
1815 $icon = $output->image_url('monologo', $this->modname
);
1821 * @param string $textclasses additionnal classes for grouping label
1822 * @return string An empty string or HTML grouping label span tag
1824 public function get_grouping_label($textclasses = '') {
1825 $groupinglabel = '';
1826 if ($this->effectivegroupmode
!= NOGROUPS
&& !empty($this->groupingid
) &&
1827 has_capability('moodle/course:managegroups', context_course
::instance($this->course
))) {
1828 $groupings = groups_get_all_groupings($this->course
);
1829 $groupinglabel = html_writer
::tag('span', '('.format_string($groupings[$this->groupingid
]->name
).')',
1830 array('class' => 'groupinglabel '.$textclasses));
1832 return $groupinglabel;
1836 * Returns a localised human-readable name of the module type.
1838 * @param bool $plural If true, the function returns the plural form of the name.
1839 * @return lang_string
1841 public function get_module_type_name($plural = false) {
1842 $modnames = get_module_types_names($plural);
1843 if (isset($modnames[$this->modname
])) {
1844 return $modnames[$this->modname
];
1851 * Returns a localised human-readable name of the module type in plural form - calculated on request
1855 private function get_module_type_name_plural() {
1856 return $this->get_module_type_name(true);
1860 * @return course_modinfo Modinfo object that this came from
1862 public function get_modinfo() {
1863 return $this->modinfo
;
1867 * Returns the section this module belongs to
1869 * @return section_info
1871 public function get_section_info() {
1872 return $this->modinfo
->get_section_info($this->sectionnum
);
1876 * Returns course object that was used in the first {@link get_fast_modinfo()} call.
1878 * It may not contain all fields from DB table {course} but always has at least the following:
1879 * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
1881 * If the course object lacks the field you need you can use the global
1882 * function {@link get_course()} that will save extra query if you access
1883 * current course or frontpage course.
1887 public function get_course() {
1888 return $this->modinfo
->get_course();
1892 * Returns course id for which the modinfo was generated.
1896 private function get_course_id() {
1897 return $this->modinfo
->get_course_id();
1901 * Returns group mode used for the course containing the module
1903 * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1905 private function get_course_groupmode() {
1906 return $this->modinfo
->get_course()->groupmode
;
1910 * Returns whether group mode is forced for the course containing the module
1914 private function get_course_groupmodeforce() {
1915 return $this->modinfo
->get_course()->groupmodeforce
;
1919 * Returns effective groupmode of the module that may be overwritten by forced course groupmode.
1921 * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1923 private function get_effective_groupmode() {
1924 $groupmode = $this->groupmode
;
1925 if ($this->modinfo
->get_course()->groupmodeforce
) {
1926 $groupmode = $this->modinfo
->get_course()->groupmode
;
1927 if ($groupmode != NOGROUPS
&& !plugin_supports('mod', $this->modname
, FEATURE_GROUPS
, false)) {
1928 $groupmode = NOGROUPS
;
1935 * @return context_module Current module context
1937 private function get_context() {
1938 return context_module
::instance($this->id
);
1942 * Returns itself in the form of stdClass.
1944 * The object includes all fields that table course_modules has and additionally
1945 * fields 'name', 'modname', 'sectionnum' (if requested).
1947 * This can be used as a faster alternative to {@link get_coursemodule_from_id()}
1949 * @param bool $additionalfields include additional fields 'name', 'modname', 'sectionnum'
1952 public function get_course_module_record($additionalfields = false) {
1953 $cmrecord = new stdClass();
1955 // Standard fields from table course_modules.
1956 static $cmfields = array('id', 'course', 'module', 'instance', 'section', 'idnumber', 'added',
1957 'score', 'indent', 'visible', 'visibleoncoursepage', 'visibleold', 'groupmode', 'groupingid',
1958 'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected', 'completionpassgrade',
1959 'showdescription', 'availability', 'deletioninprogress', 'downloadcontent');
1961 foreach ($cmfields as $key) {
1962 $cmrecord->$key = $this->$key;
1965 // Additional fields that function get_coursemodule_from_id() adds.
1966 if ($additionalfields) {
1967 $cmrecord->name
= $this->name
;
1968 $cmrecord->modname
= $this->modname
;
1969 $cmrecord->sectionnum
= $this->sectionnum
;
1979 * Sets content to display on course view page below link (if present).
1980 * @param string $content New content as HTML string (empty string if none)
1981 * @param bool $isformatted Whether user content is already passed through format_text/format_string and should not
1982 * be formatted again. This can be useful when module adds interactive elements on top of formatted user text.
1985 public function set_content($content, $isformatted = false) {
1986 $this->content
= $content;
1987 $this->contentisformatted
= $isformatted;
1991 * Sets extra classes to include in CSS.
1992 * @param string $extraclasses Extra classes (empty string if none)
1995 public function set_extra_classes($extraclasses) {
1996 $this->extraclasses
= $extraclasses;
2000 * Sets the external full url that points to the icon being used
2001 * by the activity. Useful for external-tool modules (lti...)
2002 * If set, takes precedence over $icon and $iconcomponent
2004 * @param moodle_url $iconurl full external url pointing to icon image for activity
2007 public function set_icon_url(moodle_url
$iconurl) {
2008 $this->iconurl
= $iconurl;
2012 * Sets value of on-click attribute for JavaScript.
2013 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
2014 * @param string $onclick New onclick attribute which should be HTML-escaped
2015 * (empty string if none)
2018 public function set_on_click($onclick) {
2019 $this->check_not_view_only();
2020 $this->onclick
= $onclick;
2024 * Overrides the value of an element in the customdata array.
2026 * @param string $name The key in the customdata array
2027 * @param mixed $value The value
2029 public function override_customdata($name, $value) {
2030 if (!is_array($this->customdata
)) {
2031 $this->customdata
= [];
2033 $this->customdata
[$name] = $value;
2037 * Sets HTML that displays after link on course view page.
2038 * @param string $afterlink HTML string (empty string if none)
2041 public function set_after_link($afterlink) {
2042 $this->afterlink
= $afterlink;
2046 * Sets HTML that displays after edit icons on course view page.
2047 * @param string $afterediticons HTML string (empty string if none)
2050 public function set_after_edit_icons($afterediticons) {
2051 $this->afterediticons
= $afterediticons;
2055 * Changes the name (text of link) for this module instance.
2056 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
2057 * @param string $name Name of activity / link text
2060 public function set_name($name) {
2061 if ($this->state
< self
::STATE_BUILDING_DYNAMIC
) {
2062 $this->update_user_visible();
2064 $this->name
= $name;
2068 * Turns off the view link for this module instance.
2069 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
2072 public function set_no_view_link() {
2073 $this->check_not_view_only();
2078 * Sets the 'uservisible' flag. This can be used (by setting false) to prevent access and
2079 * display of this module link for the current user.
2080 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
2081 * @param bool $uservisible
2084 public function set_user_visible($uservisible) {
2085 $this->check_not_view_only();
2086 $this->uservisible
= $uservisible;
2090 * Sets the 'customcmlistitem' flag
2092 * This can be used (by setting true) to prevent the course from rendering the
2093 * activity item as a regular activity card. This is applied to activities like labels.
2095 * @param bool $customcmlistitem if the cmlist item of that activity has a special dysplay other than a card.
2097 public function set_custom_cmlist_item(bool $customcmlistitem) {
2098 $this->customcmlistitem
= $customcmlistitem;
2102 * Sets the 'available' flag and related details. This flag is normally used to make
2103 * course modules unavailable until a certain date or condition is met. (When a course
2104 * module is unavailable, it is still visible to users who have viewhiddenactivities
2107 * When this is function is called, user-visible status is recalculated automatically.
2109 * The $showavailability flag does not really do anything any more, but is retained
2110 * for backward compatibility. Setting this to false will cause $availableinfo to
2113 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
2114 * @param bool $available False if this item is not 'available'
2115 * @param int $showavailability 0 = do not show this item at all if it's not available,
2116 * 1 = show this item greyed out with the following message
2117 * @param string $availableinfo Information about why this is not available, or
2118 * empty string if not displaying
2121 public function set_available($available, $showavailability=0, $availableinfo='') {
2122 $this->check_not_view_only();
2123 $this->available
= $available;
2124 if (!$showavailability) {
2125 $availableinfo = '';
2127 $this->availableinfo
= $availableinfo;
2128 $this->update_user_visible();
2132 * Some set functions can only be called from _cm_info_dynamic and not _cm_info_view.
2133 * This is because they may affect parts of this object which are used on pages other
2134 * than the view page (e.g. in the navigation block, or when checking access on
2138 private function check_not_view_only() {
2139 if ($this->state
>= self
::STATE_DYNAMIC
) {
2140 throw new coding_exception('Cannot set this data from _cm_info_view because it may ' .
2141 'affect other pages as well as view');
2146 * Constructor should not be called directly; use {@link get_fast_modinfo()}
2148 * @param course_modinfo $modinfo Parent object
2149 * @param stdClass $notused1 Argument not used
2150 * @param stdClass $mod Module object from the modinfo field of course table
2151 * @param stdClass $notused2 Argument not used
2153 public function __construct(course_modinfo
$modinfo, $notused1, $mod, $notused2) {
2154 $this->modinfo
= $modinfo;
2156 $this->id
= $mod->cm
;
2157 $this->instance
= $mod->id
;
2158 $this->modname
= $mod->mod
;
2159 $this->idnumber
= isset($mod->idnumber
) ?
$mod->idnumber
: '';
2160 $this->name
= $mod->name
;
2161 $this->visible
= $mod->visible
;
2162 $this->visibleoncoursepage
= $mod->visibleoncoursepage
;
2163 $this->sectionnum
= $mod->section
; // Note weirdness with name here
2164 $this->groupmode
= isset($mod->groupmode
) ?
$mod->groupmode
: 0;
2165 $this->groupingid
= isset($mod->groupingid
) ?
$mod->groupingid
: 0;
2166 $this->indent
= isset($mod->indent
) ?
$mod->indent
: 0;
2167 $this->extra
= isset($mod->extra
) ?
$mod->extra
: '';
2168 $this->extraclasses
= isset($mod->extraclasses
) ?
$mod->extraclasses
: '';
2169 // iconurl may be stored as either string or instance of moodle_url.
2170 $this->iconurl
= isset($mod->iconurl
) ?
new moodle_url($mod->iconurl
) : '';
2171 $this->onclick
= isset($mod->onclick
) ?
$mod->onclick
: '';
2172 $this->content
= isset($mod->content
) ?
$mod->content
: '';
2173 $this->icon
= isset($mod->icon
) ?
$mod->icon
: '';
2174 $this->iconcomponent
= isset($mod->iconcomponent
) ?
$mod->iconcomponent
: '';
2175 $this->customdata
= isset($mod->customdata
) ?
$mod->customdata
: '';
2176 $this->showdescription
= isset($mod->showdescription
) ?
$mod->showdescription
: 0;
2177 $this->state
= self
::STATE_BASIC
;
2179 $this->section
= isset($mod->sectionid
) ?
$mod->sectionid
: 0;
2180 $this->module
= isset($mod->module
) ?
$mod->module
: 0;
2181 $this->added
= isset($mod->added
) ?
$mod->added
: 0;
2182 $this->score
= isset($mod->score
) ?
$mod->score
: 0;
2183 $this->visibleold
= isset($mod->visibleold
) ?
$mod->visibleold
: 0;
2184 $this->deletioninprogress
= isset($mod->deletioninprogress
) ?
$mod->deletioninprogress
: 0;
2185 $this->downloadcontent
= $mod->downloadcontent ??
null;
2187 // Note: it saves effort and database space to always include the
2188 // availability and completion fields, even if availability or completion
2189 // are actually disabled
2190 $this->completion
= isset($mod->completion
) ?
$mod->completion
: 0;
2191 $this->completionpassgrade
= isset($mod->completionpassgrade
) ?
$mod->completionpassgrade
: 0;
2192 $this->completiongradeitemnumber
= isset($mod->completiongradeitemnumber
)
2193 ?
$mod->completiongradeitemnumber
: null;
2194 $this->completionview
= isset($mod->completionview
)
2195 ?
$mod->completionview
: 0;
2196 $this->completionexpected
= isset($mod->completionexpected
)
2197 ?
$mod->completionexpected
: 0;
2198 $this->availability
= isset($mod->availability
) ?
$mod->availability
: null;
2199 $this->conditionscompletion
= isset($mod->conditionscompletion
)
2200 ?
$mod->conditionscompletion
: array();
2201 $this->conditionsgrade
= isset($mod->conditionsgrade
)
2202 ?
$mod->conditionsgrade
: array();
2203 $this->conditionsfield
= isset($mod->conditionsfield
)
2204 ?
$mod->conditionsfield
: array();
2206 static $modviews = array();
2207 if (!isset($modviews[$this->modname
])) {
2208 $modviews[$this->modname
] = !plugin_supports('mod', $this->modname
,
2209 FEATURE_NO_VIEW_LINK
);
2211 $this->url
= $modviews[$this->modname
]
2212 ?
new moodle_url('/mod/' . $this->modname
. '/view.php', array('id'=>$this->id
))
2217 * Creates a cm_info object from a database record (also accepts cm_info
2218 * in which case it is just returned unchanged).
2220 * @param stdClass|cm_info|null|bool $cm Stdclass or cm_info (or null or false)
2221 * @param int $userid Optional userid (default to current)
2222 * @return cm_info|null Object as cm_info, or null if input was null/false
2224 public static function create($cm, $userid = 0) {
2225 // Null, false, etc. gets passed through as null.
2229 // If it is already a cm_info object, just return it.
2230 if ($cm instanceof cm_info
) {
2233 // Otherwise load modinfo.
2234 if (empty($cm->id
) ||
empty($cm->course
)) {
2235 throw new coding_exception('$cm must contain ->id and ->course');
2237 $modinfo = get_fast_modinfo($cm->course
, $userid);
2238 return $modinfo->get_cm($cm->id
);
2242 * If dynamic data for this course-module is not yet available, gets it.
2244 * This function is automatically called when requesting any course_modinfo property
2245 * that can be modified by modules (have a set_xxx method).
2247 * Dynamic data is data which does not come directly from the cache but is calculated at
2248 * runtime based on the current user. Primarily this concerns whether the user can access
2249 * the module or not.
2251 * As part of this function, the module's _cm_info_dynamic function from its lib.php will
2252 * be called (if it exists). Make sure that the functions that are called here do not use
2253 * any getter magic method from cm_info.
2256 private function obtain_dynamic_data() {
2258 $userid = $this->modinfo
->get_user_id();
2259 if ($this->state
>= self
::STATE_BUILDING_DYNAMIC ||
$userid == -1) {
2262 $this->state
= self
::STATE_BUILDING_DYNAMIC
;
2264 if (!empty($CFG->enableavailability
)) {
2265 // Get availability information.
2266 $ci = new \core_availability\
info_module($this);
2268 // Note that the modinfo currently available only includes minimal details (basic data)
2269 // but we know that this function does not need anything more than basic data.
2270 $this->available
= $ci->is_available($this->availableinfo
, true,
2271 $userid, $this->modinfo
);
2273 $this->available
= true;
2276 // Check parent section.
2277 if ($this->available
) {
2278 $parentsection = $this->modinfo
->get_section_info($this->sectionnum
);
2279 if (!$parentsection->get_available()) {
2280 // Do not store info from section here, as that is already
2281 // presented from the section (if appropriate) - just change
2283 $this->available
= false;
2287 // Update visible state for current user.
2288 $this->update_user_visible();
2290 // Let module make dynamic changes at this point
2291 $this->call_mod_function('cm_info_dynamic');
2292 $this->state
= self
::STATE_DYNAMIC
;
2296 * Getter method for property $uservisible, ensures that dynamic data is retrieved.
2298 * This method is normally called by the property ->uservisible, but can be called directly if
2299 * there is a case when it might be called recursively (you can't call property values
2304 public function get_user_visible() {
2305 $this->obtain_dynamic_data();
2306 return $this->uservisible
;
2310 * Returns whether this module is visible to the current user on course page
2312 * Activity may be visible on the course page but not available, for example
2313 * when it is hidden conditionally but the condition information is displayed.
2317 public function is_visible_on_course_page() {
2318 $this->obtain_dynamic_data();
2319 return $this->uservisibleoncoursepage
;
2323 * Whether this module is available but hidden from course page
2325 * "Stealth" modules are the ones that are not shown on course page but available by following url.
2326 * They are normally also displayed in grade reports and other reports.
2327 * Module will be stealth either if visibleoncoursepage=0 or it is a visible module inside the hidden
2332 public function is_stealth() {
2333 return !$this->visibleoncoursepage ||
2334 ($this->visible
&& ($section = $this->get_section_info()) && !$section->visible
);
2338 * Getter method for property $available, ensures that dynamic data is retrieved
2341 private function get_available() {
2342 $this->obtain_dynamic_data();
2343 return $this->available
;
2347 * This method can not be used anymore.
2349 * @see \core_availability\info_module::filter_user_list()
2350 * @deprecated Since Moodle 2.8
2352 private function get_deprecated_group_members_only() {
2353 throw new coding_exception('$cm->groupmembersonly can not be used anymore. ' .
2354 'If used to restrict a list of enrolled users to only those who can ' .
2355 'access the module, consider \core_availability\info_module::filter_user_list.');
2359 * Getter method for property $availableinfo, ensures that dynamic data is retrieved
2361 * @return string Available info (HTML)
2363 private function get_available_info() {
2364 $this->obtain_dynamic_data();
2365 return $this->availableinfo
;
2369 * Works out whether activity is available to the current user
2371 * If the activity is unavailable, additional checks are required to determine if its hidden or greyed out
2375 private function update_user_visible() {
2376 $userid = $this->modinfo
->get_user_id();
2377 if ($userid == -1) {
2380 $this->uservisible
= true;
2382 // If the module is being deleted, set the uservisible state to false and return.
2383 if ($this->deletioninprogress
) {
2384 $this->uservisible
= false;
2388 // If the user cannot access the activity set the uservisible flag to false.
2389 // Additional checks are required to determine whether the activity is entirely hidden or just greyed out.
2390 if ((!$this->visible
&& !has_capability('moodle/course:viewhiddenactivities', $this->get_context(), $userid)) ||
2391 (!$this->get_available() &&
2392 !has_capability('moodle/course:ignoreavailabilityrestrictions', $this->get_context(), $userid))) {
2394 $this->uservisible
= false;
2397 // Check group membership.
2398 if ($this->is_user_access_restricted_by_capability()) {
2400 $this->uservisible
= false;
2401 // Ensure activity is completely hidden from the user.
2402 $this->availableinfo
= '';
2405 $this->uservisibleoncoursepage
= $this->uservisible
&&
2406 ($this->visibleoncoursepage ||
2407 has_capability('moodle/course:manageactivities', $this->get_context(), $userid) ||
2408 has_capability('moodle/course:activityvisibility', $this->get_context(), $userid));
2409 // Activity that is not available, not hidden from course page and has availability
2410 // info is actually visible on the course page (with availability info and without a link).
2411 if (!$this->uservisible
&& $this->visibleoncoursepage
&& $this->availableinfo
) {
2412 $this->uservisibleoncoursepage
= true;
2417 * This method has been deprecated and should not be used.
2420 * @deprecated Since Moodle 2.8
2422 public function is_user_access_restricted_by_group() {
2423 throw new coding_exception('cm_info::is_user_access_restricted_by_group() can not be used any more.' .
2424 ' Use $cm->uservisible to decide whether the current user can access an activity.');
2428 * Checks whether mod/...:view capability restricts the current user's access.
2430 * @return bool True if the user access is restricted.
2432 public function is_user_access_restricted_by_capability() {
2433 $userid = $this->modinfo
->get_user_id();
2434 if ($userid == -1) {
2437 $capability = 'mod/' . $this->modname
. ':view';
2438 $capabilityinfo = get_capability_info($capability);
2439 if (!$capabilityinfo) {
2440 // Capability does not exist, no one is prevented from seeing the activity.
2444 // You are blocked if you don't have the capability.
2445 return !has_capability($capability, $this->get_context(), $userid);
2449 * Checks whether the module's conditional access settings mean that the
2450 * user cannot see the activity at all
2452 * @deprecated since 2.7 MDL-44070
2454 public function is_user_access_restricted_by_conditional_access() {
2455 throw new coding_exception('cm_info::is_user_access_restricted_by_conditional_access() ' .
2456 'can not be used any more; this function is not needed (use $cm->uservisible ' .
2457 'and $cm->availableinfo to decide whether it should be available ' .
2462 * Calls a module function (if exists), passing in one parameter: this object.
2463 * @param string $type Name of function e.g. if this is 'grooblezorb' and the modname is
2464 * 'forum' then it will try to call 'mod_forum_grooblezorb' or 'forum_grooblezorb'
2467 private function call_mod_function($type) {
2469 $libfile = $CFG->dirroot
. '/mod/' . $this->modname
. '/lib.php';
2470 if (file_exists($libfile)) {
2471 include_once($libfile);
2472 $function = 'mod_' . $this->modname
. '_' . $type;
2473 if (function_exists($function)) {
2476 $function = $this->modname
. '_' . $type;
2477 if (function_exists($function)) {
2485 * If view data for this course-module is not yet available, obtains it.
2487 * This function is automatically called if any of the functions (marked) which require
2488 * view data are called.
2490 * View data is data which is needed only for displaying the course main page (& any similar
2491 * functionality on other pages) but is not needed in general. Obtaining view data may have
2492 * a performance cost.
2494 * As part of this function, the module's _cm_info_view function from its lib.php will
2495 * be called (if it exists).
2498 private function obtain_view_data() {
2499 if ($this->state
>= self
::STATE_BUILDING_VIEW ||
$this->modinfo
->get_user_id() == -1) {
2502 $this->obtain_dynamic_data();
2503 $this->state
= self
::STATE_BUILDING_VIEW
;
2505 // Let module make changes at this point
2506 $this->call_mod_function('cm_info_view');
2507 $this->state
= self
::STATE_VIEW
;
2513 * Returns reference to full info about modules in course (including visibility).
2514 * Cached and as fast as possible (0 or 1 db query).
2516 * use get_fast_modinfo($courseid, 0, true) to reset the static cache for particular course
2517 * use get_fast_modinfo(0, 0, true) to reset the static cache for all courses
2519 * use rebuild_course_cache($courseid, true) to reset the application AND static cache
2520 * for particular course when it's contents has changed
2522 * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
2523 * and recommended to have field 'cacherev') or just a course id. Just course id
2524 * is enough when calling get_fast_modinfo() for current course or site or when
2525 * calling for any other course for the second time.
2526 * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections.
2527 * Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
2528 * @param bool $resetonly whether we want to get modinfo or just reset the cache
2529 * @return course_modinfo|null Module information for course, or null if resetting
2530 * @throws moodle_exception when course is not found (nothing is thrown if resetting)
2532 function get_fast_modinfo($courseorid, $userid = 0, $resetonly = false) {
2533 // compartibility with syntax prior to 2.4:
2534 if ($courseorid === 'reset') {
2535 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
);
2540 // Function get_fast_modinfo() can never be called during upgrade unless it is used for clearing cache only.
2542 upgrade_ensure_not_running();
2545 // Function is called with $reset = true
2547 course_modinfo
::clear_instance_cache($courseorid);
2551 // Function is called with $reset = false, retrieve modinfo
2552 return course_modinfo
::instance($courseorid, $userid);
2556 * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given
2557 * a cmid. If module name is also provided, it will ensure the cm is of that type.
2560 * list($course, $cm) = get_course_and_cm_from_cmid($cmid, 'forum');
2562 * Using this method has a performance advantage because it works by loading
2563 * modinfo for the course - which will then be cached and it is needed later
2564 * in most requests. It also guarantees that the $cm object is a cm_info and
2567 * The $course object can be supplied if already known and will speed
2568 * up this function - although it is more efficient to use this function to
2569 * get the course if you are starting from a cmid.
2571 * To avoid security problems and obscure bugs, you should always specify
2572 * $modulename if the cmid value came from user input.
2574 * By default this obtains information (for example, whether user can access
2575 * the activity) for current user, but you can specify a userid if required.
2577 * @param stdClass|int $cmorid Id of course-module, or database object
2578 * @param string $modulename Optional modulename (improves security)
2579 * @param stdClass|int $courseorid Optional course object if already loaded
2580 * @param int $userid Optional userid (default = current)
2581 * @return array Array with 2 elements $course and $cm
2582 * @throws moodle_exception If the item doesn't exist or is of wrong module name
2584 function get_course_and_cm_from_cmid($cmorid, $modulename = '', $courseorid = 0, $userid = 0) {
2586 if (is_object($cmorid)) {
2587 $cmid = $cmorid->id
;
2588 if (isset($cmorid->course
)) {
2589 $courseid = (int)$cmorid->course
;
2594 $cmid = (int)$cmorid;
2598 // Validate module name if supplied.
2599 if ($modulename && !core_component
::is_valid_plugin_name('mod', $modulename)) {
2600 throw new coding_exception('Invalid modulename parameter');
2603 // Get course from last parameter if supplied.
2605 if (is_object($courseorid)) {
2606 $course = $courseorid;
2607 } else if ($courseorid) {
2608 $courseid = (int)$courseorid;
2613 // If course ID is known, get it using normal function.
2614 $course = get_course($courseid);
2616 // Get course record in a single query based on cmid.
2617 $course = $DB->get_record_sql("
2619 FROM {course_modules} cm
2620 JOIN {course} c ON c.id = cm.course
2621 WHERE cm.id = ?", array($cmid), MUST_EXIST
);
2625 // Get cm from get_fast_modinfo.
2626 $modinfo = get_fast_modinfo($course, $userid);
2627 $cm = $modinfo->get_cm($cmid);
2628 if ($modulename && $cm->modname
!== $modulename) {
2629 throw new moodle_exception('invalidcoursemodule', 'error');
2631 return array($course, $cm);
2635 * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given
2636 * an instance id or record and module name.
2639 * list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
2641 * Using this method has a performance advantage because it works by loading
2642 * modinfo for the course - which will then be cached and it is needed later
2643 * in most requests. It also guarantees that the $cm object is a cm_info and
2646 * The $course object can be supplied if already known and will speed
2647 * up this function - although it is more efficient to use this function to
2648 * get the course if you are starting from an instance id.
2650 * By default this obtains information (for example, whether user can access
2651 * the activity) for current user, but you can specify a userid if required.
2653 * @param stdclass|int $instanceorid Id of module instance, or database object
2654 * @param string $modulename Modulename (required)
2655 * @param stdClass|int $courseorid Optional course object if already loaded
2656 * @param int $userid Optional userid (default = current)
2657 * @return array Array with 2 elements $course and $cm
2658 * @throws moodle_exception If the item doesn't exist or is of wrong module name
2660 function get_course_and_cm_from_instance($instanceorid, $modulename, $courseorid = 0, $userid = 0) {
2663 // Get data from parameter.
2664 if (is_object($instanceorid)) {
2665 $instanceid = $instanceorid->id
;
2666 if (isset($instanceorid->course
)) {
2667 $courseid = (int)$instanceorid->course
;
2672 $instanceid = (int)$instanceorid;
2676 // Get course from last parameter if supplied.
2678 if (is_object($courseorid)) {
2679 $course = $courseorid;
2680 } else if ($courseorid) {
2681 $courseid = (int)$courseorid;
2684 // Validate module name if supplied.
2685 if (!core_component
::is_valid_plugin_name('mod', $modulename)) {
2686 throw new coding_exception('Invalid modulename parameter');
2691 // If course ID is known, get it using normal function.
2692 $course = get_course($courseid);
2694 // Get course record in a single query based on instance id.
2695 $pagetable = '{' . $modulename . '}';
2696 $course = $DB->get_record_sql("
2698 FROM $pagetable instance
2699 JOIN {course} c ON c.id = instance.course
2700 WHERE instance.id = ?", array($instanceid), MUST_EXIST
);
2704 // Get cm from get_fast_modinfo.
2705 $modinfo = get_fast_modinfo($course, $userid);
2706 $instances = $modinfo->get_instances_of($modulename);
2707 if (!array_key_exists($instanceid, $instances)) {
2708 throw new moodle_exception('invalidmoduleid', 'error', $instanceid);
2710 return array($course, $instances[$instanceid]);
2715 * Rebuilds or resets the cached list of course activities stored in MUC.
2717 * rebuild_course_cache() must NEVER be called from lib/db/upgrade.php.
2718 * At the same time course cache may ONLY be cleared using this function in
2719 * upgrade scripts of plugins.
2721 * During the bulk operations if it is necessary to reset cache of multiple
2722 * courses it is enough to call {@link increment_revision_number()} for the
2723 * table 'course' and field 'cacherev' specifying affected courses in select.
2725 * Cached course information is stored in MUC core/coursemodinfo and is
2726 * validated with the DB field {course}.cacherev
2728 * @global moodle_database $DB
2729 * @param int $courseid id of course to rebuild, empty means all
2730 * @param boolean $clearonly only clear the cache, gets rebuild automatically on the fly.
2731 * Recommended to set to true to avoid unnecessary multiple rebuilding.
2732 * @param boolean $partialrebuild will not delete the whole cache when it's true.
2733 * use purge_module_cache() or purge_section_cache() must be
2734 * called before when partialrebuild is true.
2735 * use purge_module_cache() to invalidate mod cache.
2736 * use purge_section_cache() to invalidate section cache.
2739 * @throws coding_exception
2741 function rebuild_course_cache(int $courseid = 0, bool $clearonly = false, bool $partialrebuild = false): void
{
2742 global $COURSE, $SITE, $DB;
2744 if ($courseid == 0 and $partialrebuild) {
2745 throw new coding_exception('partialrebuild only works when a valid course id is provided.');
2748 // Function rebuild_course_cache() can not be called during upgrade unless it's clear only.
2749 if (!$clearonly && !upgrade_ensure_not_running(true)) {
2753 // Destroy navigation caches
2754 navigation_cache
::destroy_volatile_caches();
2756 core_courseformat\base
::reset_course_cache($courseid);
2758 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
2759 if (empty($courseid)) {
2760 // Clearing caches for all courses.
2761 increment_revision_number('course', 'cacherev', '');
2762 if (!$partialrebuild) {
2763 $cachecoursemodinfo->purge();
2765 // Clear memory static cache.
2766 course_modinfo
::clear_instance_cache();
2767 // Update global values too.
2768 $sitecacherev = $DB->get_field('course', 'cacherev', array('id' => SITEID
));
2769 $SITE->cachrev
= $sitecacherev;
2770 if ($COURSE->id
== SITEID
) {
2771 $COURSE->cacherev
= $sitecacherev;
2773 $COURSE->cacherev
= $DB->get_field('course', 'cacherev', array('id' => $COURSE->id
));
2776 // Clearing cache for one course, make sure it is deleted from user request cache as well.
2777 increment_revision_number('course', 'cacherev', 'id = :id', array('id' => $courseid));
2778 if (!$partialrebuild) {
2779 // Purge all course modinfo.
2780 $cachecoursemodinfo->delete($courseid);
2782 // Clear memory static cache.
2783 course_modinfo
::clear_instance_cache($courseid);
2784 // Update global values too.
2785 if ($courseid == $COURSE->id ||
$courseid == $SITE->id
) {
2786 $cacherev = $DB->get_field('course', 'cacherev', array('id' => $courseid));
2787 if ($courseid == $COURSE->id
) {
2788 $COURSE->cacherev
= $cacherev;
2790 if ($courseid == $SITE->id
) {
2791 $SITE->cachrev
= $cacherev;
2801 $select = array('id'=>$courseid);
2804 core_php_time_limit
::raise(); // this could take a while! MDL-10954
2807 $fields = 'id,' . join(',', course_modinfo
::$cachedfields);
2809 $rs = $DB->get_recordset("course", $select, $sort, $fields);
2811 // Rebuild cache for each course.
2812 foreach ($rs as $course) {
2813 course_modinfo
::build_course_cache($course, $partialrebuild);
2820 * Class that is the return value for the _get_coursemodule_info module API function.
2822 * Note: For backward compatibility, you can also return a stdclass object from that function.
2823 * The difference is that the stdclass object may contain an 'extra' field (deprecated,
2824 * use extraclasses and onclick instead). The stdclass object may not contain
2825 * the new fields defined here (content, extraclasses, customdata).
2827 class cached_cm_info
{
2829 * Name (text of link) for this activity; Leave unset to accept default name
2835 * Name of icon for this activity. Normally, this should be used together with $iconcomponent
2836 * to define the icon, as per image_url function.
2837 * For backward compatibility, if this value is of the form 'mod/forum/icon' then an icon
2838 * within that module will be used.
2839 * @see cm_info::get_icon_url()
2840 * @see renderer_base::image_url()
2846 * Component for icon for this activity, as per image_url; leave blank to use default 'moodle'
2848 * @see renderer_base::image_url()
2851 public $iconcomponent;
2854 * HTML content to be displayed on the main page below the link (if any) for this course-module
2860 * Custom data to be stored in modinfo for this activity; useful if there are cases when
2861 * internal information for this activity type needs to be accessible from elsewhere on the
2862 * course without making database queries. May be of any type but should be short.
2868 * Extra CSS class or classes to be added when this activity is displayed on the main page;
2869 * space-separated string
2872 public $extraclasses;
2875 * External URL image to be used by activity as icon, useful for some external-tool modules
2876 * like lti. If set, takes precedence over $icon and $iconcomponent
2882 * Content of onclick JavaScript; escaped HTML to be inserted as attribute value
2890 * Data about a single section on a course. This contains the fields from the
2891 * course_sections table, plus additional data when required.
2893 * @property-read int $id Section ID - from course_sections table
2894 * @property-read int $course Course ID - from course_sections table
2895 * @property-read int $section Section number - from course_sections table
2896 * @property-read string $name Section name if specified - from course_sections table
2897 * @property-read int $visible Section visibility (1 = visible) - from course_sections table
2898 * @property-read string $summary Section summary text if specified - from course_sections table
2899 * @property-read int $summaryformat Section summary text format (FORMAT_xx constant) - from course_sections table
2900 * @property-read string $availability Availability information as JSON string -
2901 * from course_sections table
2902 * @property-read array $conditionscompletion Availability conditions for this section based on the completion of
2903 * course-modules (array from course-module id to required completion state
2904 * for that module) - from cached data in sectioncache field
2905 * @property-read array $conditionsgrade Availability conditions for this section based on course grades (array from
2906 * grade item id to object with ->min, ->max fields) - from cached data in
2907 * sectioncache field
2908 * @property-read array $conditionsfield Availability conditions for this section based on user fields
2909 * @property-read bool $available True if this section is available to the given user i.e. if all availability conditions
2910 * are met - obtained dynamically
2911 * @property-read string $availableinfo If section is not available to some users, this string gives information about
2912 * availability which can be displayed to students and/or staff (e.g. 'Available from 3 January 2010')
2913 * for display on main page - obtained dynamically
2914 * @property-read bool $uservisible True if this section is available to the given user (for example, if current user
2915 * has viewhiddensections capability, they can access the section even if it is not
2916 * visible or not available, so this would be true in that case) - obtained dynamically
2917 * @property-read string $sequence Comma-separated list of all modules in the section. Note, this field may not exactly
2918 * match course_sections.sequence if later has references to non-existing modules or not modules of not available module types.
2919 * @property-read course_modinfo $modinfo
2921 class section_info
implements IteratorAggregate
{
2923 * Section ID - from course_sections table
2929 * Section number - from course_sections table
2935 * Section name if specified - from course_sections table
2941 * Section visibility (1 = visible) - from course_sections table
2947 * Section summary text if specified - from course_sections table
2953 * Section summary text format (FORMAT_xx constant) - from course_sections table
2956 private $_summaryformat;
2959 * Availability information as JSON string - from course_sections table
2962 private $_availability;
2965 * Availability conditions for this section based on the completion of
2966 * course-modules (array from course-module id to required completion state
2967 * for that module) - from cached data in sectioncache field
2970 private $_conditionscompletion;
2973 * Availability conditions for this section based on course grades (array from
2974 * grade item id to object with ->min, ->max fields) - from cached data in
2975 * sectioncache field
2978 private $_conditionsgrade;
2981 * Availability conditions for this section based on user fields
2984 private $_conditionsfield;
2987 * True if this section is available to students i.e. if all availability conditions
2988 * are met - obtained dynamically on request, see function {@link section_info::get_available()}
2991 private $_available;
2994 * If section is not available to some users, this string gives information about
2995 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
2996 * January 2010') for display on main page - obtained dynamically on request, see
2997 * function {@link section_info::get_availableinfo()}
3000 private $_availableinfo;
3003 * True if this section is available to the CURRENT user (for example, if current user
3004 * has viewhiddensections capability, they can access the section even if it is not
3005 * visible or not available, so this would be true in that case) - obtained dynamically
3006 * on request, see function {@link section_info::get_uservisible()}
3009 private $_uservisible;
3012 * Default values for sectioncache fields; if a field has this value, it won't
3013 * be stored in the sectioncache cache, to save space. Checks are done by ===
3014 * which means values must all be strings.
3017 private static $sectioncachedefaults = array(
3020 'summaryformat' => '1', // FORMAT_HTML, but must be a string
3022 'availability' => null
3026 * Stores format options that have been cached when building 'coursecache'
3027 * When the format option is requested we look first if it has been cached
3030 private $cachedformatoptions = array();
3033 * Stores the list of all possible section options defined in each used course format.
3036 static private $sectionformatoptions = array();
3039 * Stores the modinfo object passed in constructor, may be used when requesting
3040 * dynamically obtained attributes such as available, availableinfo, uservisible.
3041 * Also used to retrun information about current course or user.
3042 * @var course_modinfo
3047 * Constructs object from database information plus extra required data.
3048 * @param object $data Array entry from cached sectioncache
3049 * @param int $number Section number (array key)
3050 * @param int $notused1 argument not used (informaion is available in $modinfo)
3051 * @param int $notused2 argument not used (informaion is available in $modinfo)
3052 * @param course_modinfo $modinfo Owner (needed for checking availability)
3053 * @param int $notused3 argument not used (informaion is available in $modinfo)
3055 public function __construct($data, $number, $notused1, $notused2, $modinfo, $notused3) {
3057 require_once($CFG->dirroot
.'/course/lib.php');
3059 // Data that is always present
3060 $this->_id
= $data->id
;
3062 $defaults = self
::$sectioncachedefaults +
3063 array('conditionscompletion' => array(),
3064 'conditionsgrade' => array(),
3065 'conditionsfield' => array());
3067 // Data that may use default values to save cache size
3068 foreach ($defaults as $field => $value) {
3069 if (isset($data->{$field})) {
3070 $this->{'_'.$field} = $data->{$field};
3072 $this->{'_'.$field} = $value;
3076 // Other data from constructor arguments.
3077 $this->_section
= $number;
3078 $this->modinfo
= $modinfo;
3080 // Cached course format data.
3081 $course = $modinfo->get_course();
3082 if (!isset(self
::$sectionformatoptions[$course->format
])) {
3083 // Store list of section format options defined in each used course format.
3084 // They do not depend on particular course but only on its format.
3085 self
::$sectionformatoptions[$course->format
] =
3086 course_get_format($course)->section_format_options();
3088 foreach (self
::$sectionformatoptions[$course->format
] as $field => $option) {
3089 if (!empty($option['cache'])) {
3090 if (isset($data->{$field})) {
3091 $this->cachedformatoptions
[$field] = $data->{$field};
3092 } else if (array_key_exists('cachedefault', $option)) {
3093 $this->cachedformatoptions
[$field] = $option['cachedefault'];
3100 * Magic method to check if the property is set
3102 * @param string $name name of the property
3105 public function __isset($name) {
3106 if (method_exists($this, 'get_'.$name) ||
3107 property_exists($this, '_'.$name) ||
3108 array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
3109 $value = $this->__get($name);
3110 return isset($value);
3116 * Magic method to check if the property is empty
3118 * @param string $name name of the property
3121 public function __empty($name) {
3122 if (method_exists($this, 'get_'.$name) ||
3123 property_exists($this, '_'.$name) ||
3124 array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
3125 $value = $this->__get($name);
3126 return empty($value);
3132 * Magic method to retrieve the property, this is either basic section property
3133 * or availability information or additional properties added by course format
3135 * @param string $name name of the property
3138 public function __get($name) {
3139 if (method_exists($this, 'get_'.$name)) {
3140 return $this->{'get_'.$name}();
3142 if (property_exists($this, '_'.$name)) {
3143 return $this->{'_'.$name};
3145 if (array_key_exists($name, $this->cachedformatoptions
)) {
3146 return $this->cachedformatoptions
[$name];
3148 // precheck if the option is defined in format to avoid unnecessary DB queries in get_format_options()
3149 if (array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
3150 $formatoptions = course_get_format($this->modinfo
->get_course())->get_format_options($this);
3151 return $formatoptions[$name];
3153 debugging('Invalid section_info property accessed! '.$name);
3158 * Finds whether this section is available at the moment for the current user.
3160 * The value can be accessed publicly as $sectioninfo->available, but can be called directly if there
3161 * is a case when it might be called recursively (you can't call property values recursively).
3165 public function get_available() {
3167 $userid = $this->modinfo
->get_user_id();
3168 if ($this->_available
!== null ||
$userid == -1) {
3169 // Has already been calculated or does not need calculation.
3170 return $this->_available
;
3172 $this->_available
= true;
3173 $this->_availableinfo
= '';
3174 if (!empty($CFG->enableavailability
)) {
3175 // Get availability information.
3176 $ci = new \core_availability\
info_section($this);
3177 $this->_available
= $ci->is_available($this->_availableinfo
, true,
3178 $userid, $this->modinfo
);
3180 // Execute the hook from the course format that may override the available/availableinfo properties.
3181 $currentavailable = $this->_available
;
3182 course_get_format($this->modinfo
->get_course())->
3183 section_get_available_hook($this, $this->_available
, $this->_availableinfo
);
3184 if (!$currentavailable && $this->_available
) {
3185 debugging('section_get_available_hook() can not make unavailable section available', DEBUG_DEVELOPER
);
3186 $this->_available
= $currentavailable;
3188 return $this->_available
;
3192 * Returns the availability text shown next to the section on course page.
3196 private function get_availableinfo() {
3197 // Calling get_available() will also fill the availableinfo property
3198 // (or leave it null if there is no userid).
3199 $this->get_available();
3200 return $this->_availableinfo
;
3204 * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
3205 * and use {@link convert_to_array()}
3207 * @return ArrayIterator
3209 public function getIterator() {
3211 foreach (get_object_vars($this) as $key => $value) {
3212 if (substr($key, 0, 1) == '_') {
3213 if (method_exists($this, 'get'.$key)) {
3214 $ret[substr($key, 1)] = $this->{'get'.$key}();
3216 $ret[substr($key, 1)] = $this->$key;
3220 $ret['sequence'] = $this->get_sequence();
3221 $ret['course'] = $this->get_course();
3222 $ret = array_merge($ret, course_get_format($this->modinfo
->get_course())->get_format_options($this->_section
));
3223 return new ArrayIterator($ret);
3227 * Works out whether activity is visible *for current user* - if this is false, they
3228 * aren't allowed to access it.
3232 private function get_uservisible() {
3233 $userid = $this->modinfo
->get_user_id();
3234 if ($this->_uservisible
!== null ||
$userid == -1) {
3235 // Has already been calculated or does not need calculation.
3236 return $this->_uservisible
;
3238 $this->_uservisible
= true;
3239 if (!$this->_visible ||
!$this->get_available()) {
3240 $coursecontext = context_course
::instance($this->get_course());
3241 if (!$this->_visible
&& !has_capability('moodle/course:viewhiddensections', $coursecontext, $userid) ||
3242 (!$this->get_available() &&
3243 !has_capability('moodle/course:ignoreavailabilityrestrictions', $coursecontext, $userid))) {
3245 $this->_uservisible
= false;
3248 return $this->_uservisible
;
3252 * Restores the course_sections.sequence value
3256 private function get_sequence() {
3257 if (!empty($this->modinfo
->sections
[$this->_section
])) {
3258 return implode(',', $this->modinfo
->sections
[$this->_section
]);
3265 * Returns course ID - from course_sections table
3269 private function get_course() {
3270 return $this->modinfo
->get_course_id();
3276 * @return course_modinfo
3278 private function get_modinfo() {
3279 return $this->modinfo
;
3283 * Prepares section data for inclusion in sectioncache cache, removing items
3284 * that are set to defaults, and adding availability data if required.
3286 * Called by build_section_cache in course_modinfo only; do not use otherwise.
3287 * @param object $section Raw section data object
3289 public static function convert_for_section_cache($section) {
3292 // Course id stored in course table
3293 unset($section->course
);
3294 // Section number stored in array key
3295 unset($section->section
);
3296 // Sequence stored implicity in modinfo $sections array
3297 unset($section->sequence
);
3299 // Remove default data
3300 foreach (self
::$sectioncachedefaults as $field => $value) {
3301 // Exact compare as strings to avoid problems if some strings are set
3303 if (isset($section->{$field}) && $section->{$field} === $value) {
3304 unset($section->{$field});