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 int (cm id) => cm_info object
102 * Array from string (modname) => int (instance id) => cm_info object
108 * Groups that the current user belongs to. This value is calculated on first
109 * request to the property or function.
110 * When set, it is an array of grouping id => array of group id => group id.
111 * Includes grouping id 0 for 'all groups'.
117 * List of class read-only properties and their getter methods.
118 * Used by magic functions __get(), __isset(), __empty()
121 private static $standardproperties = array(
122 'courseid' => 'get_course_id',
123 'userid' => 'get_user_id',
124 'sections' => 'get_sections',
126 'instances' => 'get_instances',
127 'groups' => 'get_groups_all',
131 * Magic method getter
133 * @param string $name
136 public function __get($name) {
137 if (isset(self
::$standardproperties[$name])) {
138 $method = self
::$standardproperties[$name];
139 return $this->$method();
141 debugging('Invalid course_modinfo property accessed: '.$name);
147 * Magic method for function isset()
149 * @param string $name
152 public function __isset($name) {
153 if (isset(self
::$standardproperties[$name])) {
154 $value = $this->__get($name);
155 return isset($value);
161 * Magic method for function empty()
163 * @param string $name
166 public function __empty($name) {
167 if (isset(self
::$standardproperties[$name])) {
168 $value = $this->__get($name);
169 return empty($value);
175 * Magic method setter
177 * Will display the developer warning when trying to set/overwrite existing property.
179 * @param string $name
180 * @param mixed $value
182 public function __set($name, $value) {
183 debugging("It is not allowed to set the property course_modinfo::\${$name}", DEBUG_DEVELOPER
);
187 * Returns course object that was used in the first {@link get_fast_modinfo()} call.
189 * It may not contain all fields from DB table {course} but always has at least the following:
190 * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
194 public function get_course() {
195 return $this->course
;
199 * @return int Course ID
201 public function get_course_id() {
202 return $this->course
->id
;
206 * @return int User ID
208 public function get_user_id() {
209 return $this->userid
;
213 * @return array Array from section number (e.g. 0) to array of course-module IDs in that
214 * section; this only includes sections that contain at least one course-module
216 public function get_sections() {
217 return $this->sections
;
221 * @return cm_info[] Array from course-module instance to cm_info object within this course, in
222 * order of appearance
224 public function get_cms() {
229 * Obtains a single course-module object (for a course-module that is on this course).
230 * @param int $cmid Course-module ID
231 * @return cm_info Information about that course-module
232 * @throws moodle_exception If the course-module does not exist
234 public function get_cm($cmid) {
235 if (empty($this->cms
[$cmid])) {
236 throw new moodle_exception('invalidcoursemodule', 'error');
238 return $this->cms
[$cmid];
242 * Obtains all module instances on this course.
243 * @return cm_info[][] Array from module name => array from instance id => cm_info
245 public function get_instances() {
246 return $this->instances
;
250 * Returns array of localised human-readable module names used in this course
252 * @param bool $plural if true returns the plural form of modules names
255 public function get_used_module_names($plural = false) {
256 $modnames = get_module_types_names($plural);
257 $modnamesused = array();
258 foreach ($this->get_cms() as $cmid => $mod) {
259 if (!isset($modnamesused[$mod->modname
]) && isset($modnames[$mod->modname
]) && $mod->uservisible
) {
260 $modnamesused[$mod->modname
] = $modnames[$mod->modname
];
263 return $modnamesused;
267 * Obtains all instances of a particular module on this course.
268 * @param $modname Name of module (not full frankenstyle) e.g. 'label'
269 * @return cm_info[] Array from instance id => cm_info for modules on this course; empty if none
271 public function get_instances_of($modname) {
272 if (empty($this->instances
[$modname])) {
275 return $this->instances
[$modname];
279 * Groups that the current user belongs to organised by grouping id. Calculated on the first request.
280 * @return int[][] array of grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'
282 private function get_groups_all() {
283 if (is_null($this->groups
)) {
284 // NOTE: Performance could be improved here. The system caches user groups
285 // in $USER->groupmember[$courseid] => array of groupid=>groupid. Unfortunately this
286 // structure does not include grouping information. It probably could be changed to
287 // do so, without a significant performance hit on login, thus saving this one query
289 $this->groups
= groups_get_user_groups($this->course
->id
, $this->userid
);
291 return $this->groups
;
295 * Returns groups that the current user belongs to on the course. Note: If not already
296 * available, this may make a database query.
297 * @param int $groupingid Grouping ID or 0 (default) for all groups
298 * @return int[] Array of int (group id) => int (same group id again); empty array if none
300 public function get_groups($groupingid = 0) {
301 $allgroups = $this->get_groups_all();
302 if (!isset($allgroups[$groupingid])) {
305 return $allgroups[$groupingid];
309 * Gets all sections as array from section number => data about section.
310 * @return section_info[] Array of section_info objects organised by section number
312 public function get_section_info_all() {
313 return $this->sectioninfo
;
317 * Gets data about specific numbered section.
318 * @param int $sectionnumber Number (not id) of section
319 * @param int $strictness Use MUST_EXIST to throw exception if it doesn't
320 * @return section_info Information for numbered section or null if not found
322 public function get_section_info($sectionnumber, $strictness = IGNORE_MISSING
) {
323 if (!array_key_exists($sectionnumber, $this->sectioninfo
)) {
324 if ($strictness === MUST_EXIST
) {
325 throw new moodle_exception('sectionnotexist');
330 return $this->sectioninfo
[$sectionnumber];
334 * Static cache for generated course_modinfo instances
336 * @see course_modinfo::instance()
337 * @see course_modinfo::clear_instance_cache()
338 * @var course_modinfo[]
340 protected static $instancecache = array();
343 * Timestamps (microtime) when the course_modinfo instances were last accessed
345 * It is used to remove the least recent accessed instances when static cache is full
349 protected static $cacheaccessed = array();
352 * Clears the cache used in course_modinfo::instance()
354 * Used in {@link get_fast_modinfo()} when called with argument $reset = true
355 * and in {@link rebuild_course_cache()}
357 * @param null|int|stdClass $courseorid if specified removes only cached value for this course
359 public static function clear_instance_cache($courseorid = null) {
360 if (empty($courseorid)) {
361 self
::$instancecache = array();
362 self
::$cacheaccessed = array();
365 if (is_object($courseorid)) {
366 $courseorid = $courseorid->id
;
368 if (isset(self
::$instancecache[$courseorid])) {
369 // Unsetting static variable in PHP is peculiar, it removes the reference,
370 // but data remain in memory. Prior to unsetting, the varable needs to be
371 // set to empty to remove its remains from memory.
372 self
::$instancecache[$courseorid] = '';
373 unset(self
::$instancecache[$courseorid]);
374 unset(self
::$cacheaccessed[$courseorid]);
379 * Returns the instance of course_modinfo for the specified course and specified user
381 * This function uses static cache for the retrieved instances. The cache
382 * size is limited by MAX_MODINFO_CACHE_SIZE. If instance is not found in
383 * the static cache or it was created for another user or the cacherev validation
384 * failed - a new instance is constructed and returned.
386 * Used in {@link get_fast_modinfo()}
388 * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
389 * and recommended to have field 'cacherev') or just a course id
390 * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections.
391 * Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
392 * @return course_modinfo
394 public static function instance($courseorid, $userid = 0) {
396 if (is_object($courseorid)) {
397 $course = $courseorid;
399 $course = (object)array('id' => $courseorid);
401 if (empty($userid)) {
405 if (!empty(self
::$instancecache[$course->id
])) {
406 if (self
::$instancecache[$course->id
]->userid
== $userid &&
407 (!isset($course->cacherev
) ||
408 $course->cacherev
== self
::$instancecache[$course->id
]->get_course()->cacherev
)) {
409 // This course's modinfo for the same user was recently retrieved, return cached.
410 self
::$cacheaccessed[$course->id
] = microtime(true);
411 return self
::$instancecache[$course->id
];
413 // Prevent potential reference problems when switching users.
414 self
::clear_instance_cache($course->id
);
417 $modinfo = new course_modinfo($course, $userid);
419 // We have a limit of MAX_MODINFO_CACHE_SIZE entries to store in static variable.
420 if (count(self
::$instancecache) >= MAX_MODINFO_CACHE_SIZE
) {
421 // Find the course that was the least recently accessed.
422 asort(self
::$cacheaccessed, SORT_NUMERIC
);
423 $courseidtoremove = key(array_reverse(self
::$cacheaccessed, true));
424 self
::clear_instance_cache($courseidtoremove);
427 // Add modinfo to the static cache.
428 self
::$instancecache[$course->id
] = $modinfo;
429 self
::$cacheaccessed[$course->id
] = microtime(true);
435 * Constructs based on course.
436 * Note: This constructor should not usually be called directly.
437 * Use get_fast_modinfo($course) instead as this maintains a cache.
438 * @param stdClass $course course object, only property id is required.
439 * @param int $userid User ID
440 * @throws moodle_exception if course is not found
442 public function __construct($course, $userid) {
443 global $CFG, $COURSE, $SITE, $DB;
445 if (!isset($course->cacherev
)) {
446 // We require presence of property cacherev to validate the course cache.
447 // No need to clone the $COURSE or $SITE object here because we clone it below anyway.
448 $course = get_course($course->id
, false);
451 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
453 // Retrieve modinfo from cache. If not present or cacherev mismatches, call rebuild and retrieve again.
454 $coursemodinfo = $cachecoursemodinfo->get($course->id
);
455 if ($coursemodinfo === false ||
($course->cacherev
!= $coursemodinfo->cacherev
)) {
456 $lock = self
::get_course_cache_lock($course->id
);
458 // Only actually do the build if it's still needed after getting the lock (not if
459 // somebody else, who might have been holding the lock, built it already).
460 $coursemodinfo = $cachecoursemodinfo->get($course->id
);
461 if ($coursemodinfo === false ||
($course->cacherev
!= $coursemodinfo->cacherev
)) {
462 $coursemodinfo = self
::inner_build_course_cache($course, $lock);
469 // Set initial values
470 $this->userid
= $userid;
471 $this->sections
= array();
472 $this->cms
= array();
473 $this->instances
= array();
474 $this->groups
= null;
476 // If we haven't already preloaded contexts for the course, do it now
477 // Modules are also cached here as long as it's the first time this course has been preloaded.
478 context_helper
::preload_course($course->id
);
480 // Quick integrity check: as a result of race conditions modinfo may not be regenerated after the change.
481 // It is especially dangerous if modinfo contains the deleted course module, as it results in fatal error.
482 // We can check it very cheap by validating the existence of module context.
483 if ($course->id
== $COURSE->id ||
$course->id
== $SITE->id
) {
484 // Only verify current course (or frontpage) as pages with many courses may not have module contexts cached.
485 // (Uncached modules will result in a very slow verification).
486 foreach ($coursemodinfo->modinfo
as $mod) {
487 if (!context_module
::instance($mod->cm
, IGNORE_MISSING
)) {
488 debugging('Course cache integrity check failed: course module with id '. $mod->cm
.
489 ' does not have context. Rebuilding cache for course '. $course->id
);
490 // Re-request the course record from DB as well, don't use get_course() here.
491 $course = $DB->get_record('course', array('id' => $course->id
), '*', MUST_EXIST
);
492 $coursemodinfo = self
::build_course_cache($course);
498 // Overwrite unset fields in $course object with cached values, store the course object.
499 $this->course
= fullclone($course);
500 foreach ($coursemodinfo as $key => $value) {
501 if ($key !== 'modinfo' && $key !== 'sectioncache' &&
502 (!isset($this->course
->$key) ||
$key === 'cacherev')) {
503 $this->course
->$key = $value;
507 // Loop through each piece of module data, constructing it
508 static $modexists = array();
509 foreach ($coursemodinfo->modinfo
as $mod) {
510 if (!isset($mod->name
) ||
strval($mod->name
) === '') {
511 // something is wrong here
515 // Skip modules which don't exist
516 if (!array_key_exists($mod->mod
, $modexists)) {
517 $modexists[$mod->mod
] = file_exists("$CFG->dirroot/mod/$mod->mod/lib.php");
519 if (!$modexists[$mod->mod
]) {
523 // Construct info for this module
524 $cm = new cm_info($this, null, $mod, null);
526 // Store module in instances and cms array
527 if (!isset($this->instances
[$cm->modname
])) {
528 $this->instances
[$cm->modname
] = array();
530 $this->instances
[$cm->modname
][$cm->instance
] = $cm;
531 $this->cms
[$cm->id
] = $cm;
533 // Reconstruct sections. This works because modules are stored in order
534 if (!isset($this->sections
[$cm->sectionnum
])) {
535 $this->sections
[$cm->sectionnum
] = array();
537 $this->sections
[$cm->sectionnum
][] = $cm->id
;
540 // Expand section objects
541 $this->sectioninfo
= array();
542 foreach ($coursemodinfo->sectioncache
as $number => $data) {
543 $this->sectioninfo
[$number] = new section_info($data, $number, null, null,
549 * This method can not be used anymore.
551 * @see course_modinfo::build_course_cache()
552 * @deprecated since 2.6
554 public static function build_section_cache($courseid) {
555 throw new coding_exception('Function course_modinfo::build_section_cache() can not be used anymore.' .
556 ' Please use course_modinfo::build_course_cache() whenever applicable.');
560 * Builds a list of information about sections on a course to be stored in
561 * the course cache. (Does not include information that is already cached
562 * in some other way.)
564 * @param stdClass $course Course object (must contain fields
565 * @return array Information about sections, indexed by section number (not id)
567 protected static function build_course_section_cache($course) {
571 $sections = $DB->get_records('course_sections', array('course' => $course->id
), 'section',
572 'section, id, course, name, summary, summaryformat, sequence, visible, availability');
573 $compressedsections = array();
575 $formatoptionsdef = course_get_format($course)->section_format_options();
576 // Remove unnecessary data and add availability
577 foreach ($sections as $number => $section) {
578 // Add cached options from course format to $section object
579 foreach ($formatoptionsdef as $key => $option) {
580 if (!empty($option['cache'])) {
581 $formatoptions = course_get_format($course)->get_format_options($section);
582 if (!array_key_exists('cachedefault', $option) ||
$option['cachedefault'] !== $formatoptions[$key]) {
583 $section->$key = $formatoptions[$key];
587 // Clone just in case it is reused elsewhere
588 $compressedsections[$number] = clone($section);
589 section_info
::convert_for_section_cache($compressedsections[$number]);
592 return $compressedsections;
596 * Gets a lock for rebuilding the cache of a single course.
598 * Caller must release the returned lock.
600 * This is used to ensure that the cache rebuild doesn't happen multiple times in parallel.
601 * This function will wait up to 1 minute for the lock to be obtained. If the lock cannot
602 * be obtained, it throws an exception.
604 * @param int $courseid Course id
605 * @return \core\lock\lock Lock (must be released!)
606 * @throws moodle_exception If the lock cannot be obtained
608 protected static function get_course_cache_lock($courseid) {
609 // Get database lock to ensure this doesn't happen multiple times in parallel. Wait a
610 // reasonable time for the lock to be released, so we can give a suitable error message.
611 // In case the system crashes while building the course cache, the lock will automatically
612 // expire after a (slightly longer) period.
613 $lockfactory = \core\lock\lock_config
::get_lock_factory('core_modinfo');
614 $lock = $lockfactory->get_lock('build_course_cache_' . $courseid,
615 self
::COURSE_CACHE_LOCK_WAIT
, self
::COURSE_CACHE_LOCK_EXPIRY
);
617 throw new moodle_exception('locktimeout', '', '', null,
618 'core_modinfo/build_course_cache_' . $courseid);
624 * Builds and stores in MUC object containing information about course
625 * modules and sections together with cached fields from table course.
627 * @param stdClass $course object from DB table course. Must have property 'id'
628 * but preferably should have all cached fields.
629 * @return stdClass object with all cached keys of the course plus fields modinfo and sectioncache.
630 * The same object is stored in MUC
631 * @throws moodle_exception if course is not found (if $course object misses some of the
632 * necessary fields it is re-requested from database)
634 public static function build_course_cache($course) {
635 if (empty($course->id
)) {
636 throw new coding_exception('Object $course is missing required property \id\'');
639 $lock = self
::get_course_cache_lock($course->id
);
641 return self
::inner_build_course_cache($course, $lock);
648 * Called to build course cache when there is already a lock obtained.
650 * @param stdClass $course object from DB table course
651 * @param \core\lock\lock $lock Lock object - not actually used, just there to indicate you have a lock
652 * @return stdClass Course object that has been stored in MUC
654 protected static function inner_build_course_cache($course, \core\lock\lock
$lock) {
656 require_once("{$CFG->dirroot}/course/lib.php");
658 // Ensure object has all necessary fields.
659 foreach (self
::$cachedfields as $key) {
660 if (!isset($course->$key)) {
661 $course = $DB->get_record('course', array('id' => $course->id
),
662 implode(',', array_merge(array('id'), self
::$cachedfields)), MUST_EXIST
);
666 // Retrieve all information about activities and sections.
667 // This may take time on large courses and it is possible that another user modifies the same course during this process.
668 // Field cacherev stored in both DB and cache will ensure that cached data matches the current course state.
669 $coursemodinfo = new stdClass();
670 $coursemodinfo->modinfo
= self
::get_array_of_activities($course);
671 $coursemodinfo->sectioncache
= self
::build_course_section_cache($course);
672 foreach (self
::$cachedfields as $key) {
673 $coursemodinfo->$key = $course->$key;
675 // Set the accumulated activities and sections information in cache, together with cacherev.
676 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
677 $cachecoursemodinfo->set($course->id
, $coursemodinfo);
678 return $coursemodinfo;
682 * For a given course, returns an array of course activity objects
684 * @param stdClass $course Course object
685 * @return array list of activities
687 public static function get_array_of_activities(stdClass
$course): array {
690 if (empty($course)) {
691 throw new moodle_exception('courseidnotfound');
696 $rawmods = get_course_mods($course->id
);
697 if (empty($rawmods)) {
698 return $mod; // always return array
700 $courseformat = course_get_format($course);
702 if ($sections = $DB->get_records('course_sections', ['course' => $course->id
],
703 'section ASC', 'id,section,sequence,visible')) {
704 // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
705 if ($errormessages = course_integrity_check($course->id
, $rawmods, $sections)) {
706 debugging(join('<br>', $errormessages));
707 $rawmods = get_course_mods($course->id
);
708 $sections = $DB->get_records('course_sections', ['course' => $course->id
],
709 'section ASC', 'id,section,sequence,visible');
711 // Build array of activities.
712 foreach ($sections as $section) {
713 if (!empty($section->sequence
)) {
714 $sequence = explode(",", $section->sequence
);
715 foreach ($sequence as $seq) {
716 if (empty($rawmods[$seq])) {
719 // Adjust visibleoncoursepage, value in DB may not respect format availability.
720 $rawmods[$seq]->visibleoncoursepage
= (!$rawmods[$seq]->visible
721 ||
$rawmods[$seq]->visibleoncoursepage
722 ||
empty($CFG->allowstealth
)
723 ||
!$courseformat->allow_stealth_module_visibility($rawmods[$seq], $section)) ?
1 : 0;
725 // Create an object that will be cached.
726 $mod[$seq] = new stdClass();
727 $mod[$seq]->id
= $rawmods[$seq]->instance
;
728 $mod[$seq]->cm
= $rawmods[$seq]->id
;
729 $mod[$seq]->mod
= $rawmods[$seq]->modname
;
731 // Oh dear. Inconsistent names left here for backward compatibility.
732 $mod[$seq]->section
= $section->section
;
733 $mod[$seq]->sectionid
= $rawmods[$seq]->section
;
735 $mod[$seq]->module
= $rawmods[$seq]->module
;
736 $mod[$seq]->added
= $rawmods[$seq]->added
;
737 $mod[$seq]->score
= $rawmods[$seq]->score
;
738 $mod[$seq]->idnumber
= $rawmods[$seq]->idnumber
;
739 $mod[$seq]->visible
= $rawmods[$seq]->visible
;
740 $mod[$seq]->visibleoncoursepage
= $rawmods[$seq]->visibleoncoursepage
;
741 $mod[$seq]->visibleold
= $rawmods[$seq]->visibleold
;
742 $mod[$seq]->groupmode
= $rawmods[$seq]->groupmode
;
743 $mod[$seq]->groupingid
= $rawmods[$seq]->groupingid
;
744 $mod[$seq]->indent
= $rawmods[$seq]->indent
;
745 $mod[$seq]->completion
= $rawmods[$seq]->completion
;
746 $mod[$seq]->extra
= "";
747 $mod[$seq]->completiongradeitemnumber
=
748 $rawmods[$seq]->completiongradeitemnumber
;
749 $mod[$seq]->completionview
= $rawmods[$seq]->completionview
;
750 $mod[$seq]->completionexpected
= $rawmods[$seq]->completionexpected
;
751 $mod[$seq]->showdescription
= $rawmods[$seq]->showdescription
;
752 $mod[$seq]->availability
= $rawmods[$seq]->availability
;
753 $mod[$seq]->deletioninprogress
= $rawmods[$seq]->deletioninprogress
;
755 $modname = $mod[$seq]->mod
;
756 $functionname = $modname . "_get_coursemodule_info";
758 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
762 include_once("$CFG->dirroot/mod/$modname/lib.php");
764 if ($hasfunction = function_exists($functionname)) {
765 if ($info = $functionname($rawmods[$seq])) {
766 if (!empty($info->icon
)) {
767 $mod[$seq]->icon
= $info->icon
;
769 if (!empty($info->iconcomponent
)) {
770 $mod[$seq]->iconcomponent
= $info->iconcomponent
;
772 if (!empty($info->name
)) {
773 $mod[$seq]->name
= $info->name
;
775 if ($info instanceof cached_cm_info
) {
776 // When using cached_cm_info you can include three new fields
777 // that aren't available for legacy code
778 if (!empty($info->content
)) {
779 $mod[$seq]->content
= $info->content
;
781 if (!empty($info->extraclasses
)) {
782 $mod[$seq]->extraclasses
= $info->extraclasses
;
784 if (!empty($info->iconurl
)) {
785 // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
786 $url = new moodle_url($info->iconurl
);
787 $mod[$seq]->iconurl
= $url->out(false);
789 if (!empty($info->onclick
)) {
790 $mod[$seq]->onclick
= $info->onclick
;
792 if (!empty($info->customdata
)) {
793 $mod[$seq]->customdata
= $info->customdata
;
796 // When using a stdclass, the (horrible) deprecated ->extra field
797 // is available for BC
798 if (!empty($info->extra
)) {
799 $mod[$seq]->extra
= $info->extra
;
804 // When there is no modname_get_coursemodule_info function,
805 // but showdescriptions is enabled, then we use the 'intro'
806 // and 'introformat' fields in the module table
807 if (!$hasfunction && $rawmods[$seq]->showdescription
) {
808 if ($modvalues = $DB->get_record($rawmods[$seq]->modname
,
809 ['id' => $rawmods[$seq]->instance
], 'name, intro, introformat')) {
810 // Set content from intro and introformat. Filters are disabled
811 // because we filter it with format_text at display time
812 $mod[$seq]->content
= format_module_intro($rawmods[$seq]->modname
,
813 $modvalues, $rawmods[$seq]->id
, false);
815 // To save making another query just below, put name in here
816 $mod[$seq]->name
= $modvalues->name
;
819 if (!isset($mod[$seq]->name
)) {
821 $DB->get_field($rawmods[$seq]->modname
, "name", ["id" => $rawmods[$seq]->instance
]);
824 // Minimise the database size by unsetting default options when they are
825 // 'empty'. This list corresponds to code in the cm_info constructor.
826 foreach (['idnumber', 'groupmode', 'groupingid',
827 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
828 'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
829 'completionexpected', 'score', 'showdescription', 'deletioninprogress'] as $property) {
830 if (property_exists($mod[$seq], $property) &&
831 empty($mod[$seq]->{$property})) {
832 unset($mod[$seq]->{$property});
835 // Special case: this value is usually set to null, but may be 0
836 if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
837 is_null($mod[$seq]->completiongradeitemnumber
)) {
838 unset($mod[$seq]->completiongradeitemnumber
);
848 * Purge the cache of a given course
850 * @param int $courseid Course id
852 public static function purge_course_cache(int $courseid): void
{
853 $cachemodinfo = cache
::make('core', 'coursemodinfo');
854 $cachemodinfo->delete($courseid);
860 * Data about a single module on a course. This contains most of the fields in the course_modules
861 * table, plus additional data when required.
863 * The object can be accessed by core or any plugin (i.e. course format, block, filter, etc.) as
864 * get_fast_modinfo($courseorid)->cms[$coursemoduleid]
866 * get_fast_modinfo($courseorid)->instances[$moduletype][$instanceid]
868 * There are three stages when activity module can add/modify data in this object:
870 * <b>Stage 1 - during building the cache.</b>
871 * Allows to add to the course cache static user-independent information about the module.
872 * Modules should try to include only absolutely necessary information that may be required
873 * when displaying course view page. The information is stored in application-level cache
874 * and reset when {@link rebuild_course_cache()} is called or cache is purged by admin.
876 * Modules can implement callback XXX_get_coursemodule_info() returning instance of object
877 * {@link cached_cm_info}
879 * <b>Stage 2 - dynamic data.</b>
880 * Dynamic data is user-dependent, it is stored in request-level cache. To reset this cache
881 * {@link get_fast_modinfo()} with $reset argument may be called.
883 * Dynamic data is obtained when any of the following properties/methods is requested:
884 * - {@link cm_info::$url}
885 * - {@link cm_info::$name}
886 * - {@link cm_info::$onclick}
887 * - {@link cm_info::get_icon_url()}
888 * - {@link cm_info::$uservisible}
889 * - {@link cm_info::$available}
890 * - {@link cm_info::$availableinfo}
891 * - plus any of the properties listed in Stage 3.
893 * Modules can implement callback <b>XXX_cm_info_dynamic()</b> and inside this callback they
894 * are allowed to use any of the following set methods:
895 * - {@link cm_info::set_available()}
896 * - {@link cm_info::set_name()}
897 * - {@link cm_info::set_no_view_link()}
898 * - {@link cm_info::set_user_visible()}
899 * - {@link cm_info::set_on_click()}
900 * - {@link cm_info::set_icon_url()}
901 * - {@link cm_info::override_customdata()}
902 * Any methods affecting view elements can also be set in this callback.
904 * <b>Stage 3 (view data).</b>
905 * Also user-dependend data stored in request-level cache. Second stage is created
906 * because populating the view data can be expensive as it may access much more
907 * Moodle APIs such as filters, user information, output renderers and we
908 * don't want to request it until necessary.
909 * View data is obtained when any of the following properties/methods is requested:
910 * - {@link cm_info::$afterediticons}
911 * - {@link cm_info::$content}
912 * - {@link cm_info::get_formatted_content()}
913 * - {@link cm_info::$extraclasses}
914 * - {@link cm_info::$afterlink}
916 * Modules can implement callback <b>XXX_cm_info_view()</b> and inside this callback they
917 * are allowed to use any of the following set methods:
918 * - {@link cm_info::set_after_edit_icons()}
919 * - {@link cm_info::set_after_link()}
920 * - {@link cm_info::set_content()}
921 * - {@link cm_info::set_extra_classes()}
923 * @property-read int $id Course-module ID - from course_modules table
924 * @property-read int $instance Module instance (ID within module table) - from course_modules table
925 * @property-read int $course Course ID - from course_modules table
926 * @property-read string $idnumber 'ID number' from course-modules table (arbitrary text set by user) - from
927 * course_modules table
928 * @property-read int $added Time that this course-module was added (unix time) - from course_modules table
929 * @property-read int $visible Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
930 * course_modules table
931 * @property-read int $visibleoncoursepage Visible on course page setting - from course_modules table, adjusted to
932 * whether course format allows this module to have the "stealth" mode
933 * @property-read int $visibleold Old visible setting (if the entire section is hidden, the previous value for
934 * visible is stored in this field) - from course_modules table
935 * @property-read int $groupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
936 * course_modules table. Use {@link cm_info::$effectivegroupmode} to find the actual group mode that may be forced by course.
937 * @property-read int $groupingid Grouping ID (0 = all groupings)
938 * @property-read bool $coursegroupmodeforce Indicates whether the course containing the module has forced the groupmode
939 * This means that cm_info::$groupmode should be ignored and cm_info::$coursegroupmode be used instead
940 * @property-read int $coursegroupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
941 * course table - as specified for the course containing the module
942 * Effective only if {@link cm_info::$coursegroupmodeforce} is set
943 * @property-read int $effectivegroupmode Effective group mode for this module (one of the constants NOGROUPS, SEPARATEGROUPS,
944 * or VISIBLEGROUPS). This can be different from groupmode set for the module if the groupmode is forced for the course.
945 * This value will always be NOGROUPS if module type does not support group mode.
946 * @property-read int $indent Indent level on course page (0 = no indent) - from course_modules table
947 * @property-read int $completion Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
948 * course_modules table
949 * @property-read mixed $completiongradeitemnumber Set to the item number (usually 0) if completion depends on a particular
950 * grade of this activity, or null if completion does not depend on a grade - from course_modules table
951 * @property-read int $completionview 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
952 * @property-read int $completionexpected Set to a unix time if completion of this activity is expected at a
953 * particular time, 0 if no time set - from course_modules table
954 * @property-read string $availability Availability information as JSON string or null if none -
955 * from course_modules table
956 * @property-read int $showdescription Controls whether the description of the activity displays on the course main page (in
957 * addition to anywhere it might display within the activity itself). 0 = do not show
958 * on main page, 1 = show on main page.
959 * @property-read string $extra (deprecated) Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
960 * course page - from cached data in modinfo field. Deprecated, replaced by ->extraclasses and ->onclick
961 * @property-read string $icon Name of icon to use - from cached data in modinfo field
962 * @property-read string $iconcomponent Component that contains icon - from cached data in modinfo field
963 * @property-read string $modname Name of module e.g. 'forum' (this is the same name as the module's main database
964 * table) - from cached data in modinfo field
965 * @property-read int $module ID of module type - from course_modules table
966 * @property-read string $name Name of module instance for display on page e.g. 'General discussion forum' - from cached
967 * data in modinfo field
968 * @property-read int $sectionnum Section number that this course-module is in (section 0 = above the calendar, section 1
969 * = week/topic 1, etc) - from cached data in modinfo field
970 * @property-read int $section Section id - from course_modules table
971 * @property-read array $conditionscompletion Availability conditions for this course-module based on the completion of other
972 * course-modules (array from other course-module id to required completion state for that
973 * module) - from cached data in modinfo field
974 * @property-read array $conditionsgrade Availability conditions for this course-module based on course grades (array from
975 * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
976 * @property-read array $conditionsfield Availability conditions for this course-module based on user fields
977 * @property-read bool $available True if this course-module is available to students i.e. if all availability conditions
978 * are met - obtained dynamically
979 * @property-read string $availableinfo If course-module is not available to students, this string gives information about
980 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
981 * January 2010') for display on main page - obtained dynamically
982 * @property-read bool $uservisible True if this course-module is available to the CURRENT user (for example, if current user
983 * has viewhiddenactivities capability, they can access the course-module even if it is not
984 * visible or not available, so this would be true in that case)
985 * @property-read context_module $context Module context
986 * @property-read string $modfullname Returns a localised human-readable name of the module type - calculated on request
987 * @property-read string $modplural Returns a localised human-readable name of the module type in plural form - calculated on request
988 * @property-read string $content Content to display on main (view) page - calculated on request
989 * @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
990 * @property-read string $extraclasses Extra CSS classes to add to html output for this activity on main page - calculated on request
991 * @property-read string $onclick Content of HTML on-click attribute already escaped - calculated on request
992 * @property-read mixed $customdata Optional custom data stored in modinfo cache for this activity, or null if none
993 * @property-read string $afterlink Extra HTML code to display after link - calculated on request
994 * @property-read string $afterediticons Extra HTML code to display after editing icons (e.g. more icons) - calculated on request
995 * @property-read bool $deletioninprogress True if this course module is scheduled for deletion, false otherwise.
997 class cm_info
implements IteratorAggregate
{
999 * State: Only basic data from modinfo cache is available.
1001 const STATE_BASIC
= 0;
1004 * State: In the process of building dynamic data (to avoid recursive calls to obtain_dynamic_data())
1006 const STATE_BUILDING_DYNAMIC
= 1;
1009 * State: Dynamic data is available too.
1011 const STATE_DYNAMIC
= 2;
1014 * State: In the process of building view data (to avoid recursive calls to obtain_view_data())
1016 const STATE_BUILDING_VIEW
= 3;
1019 * State: View data (for course page) is available.
1021 const STATE_VIEW
= 4;
1025 * @var course_modinfo
1030 * Level of information stored inside this object (STATE_xx constant)
1036 * Course-module ID - from course_modules table
1042 * Module instance (ID within module table) - from course_modules table
1048 * 'ID number' from course-modules table (arbitrary text set by user) - from
1049 * course_modules table
1055 * Time that this course-module was added (unix time) - from course_modules table
1061 * This variable is not used and is included here only so it can be documented.
1062 * Once the database entry is removed from course_modules, it should be deleted
1065 * @deprecated Do not use this variable
1070 * Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
1071 * course_modules table
1077 * Visible on course page setting - from course_modules table
1080 private $visibleoncoursepage;
1083 * Old visible setting (if the entire section is hidden, the previous value for
1084 * visible is stored in this field) - from course_modules table
1087 private $visibleold;
1090 * Group mode (one of the constants NONE, SEPARATEGROUPS, or VISIBLEGROUPS) - from
1091 * course_modules table
1097 * Grouping ID (0 = all groupings)
1100 private $groupingid;
1103 * Indent level on course page (0 = no indent) - from course_modules table
1109 * Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
1110 * course_modules table
1113 private $completion;
1116 * Set to the item number (usually 0) if completion depends on a particular
1117 * grade of this activity, or null if completion does not depend on a grade - from
1118 * course_modules table
1121 private $completiongradeitemnumber;
1124 * 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
1127 private $completionview;
1130 * Set to a unix time if completion of this activity is expected at a
1131 * particular time, 0 if no time set - from course_modules table
1134 private $completionexpected;
1137 * Availability information as JSON string or null if none - from course_modules table
1140 private $availability;
1143 * Controls whether the description of the activity displays on the course main page (in
1144 * addition to anywhere it might display within the activity itself). 0 = do not show
1145 * on main page, 1 = show on main page.
1148 private $showdescription;
1151 * Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
1152 * course page - from cached data in modinfo field
1153 * @deprecated This is crazy, don't use it. Replaced by ->extraclasses and ->onclick
1159 * Name of icon to use - from cached data in modinfo field
1165 * Component that contains icon - from cached data in modinfo field
1168 private $iconcomponent;
1171 * Name of module e.g. 'forum' (this is the same name as the module's main database
1172 * table) - from cached data in modinfo field
1178 * ID of module - from course_modules table
1184 * Name of module instance for display on page e.g. 'General discussion forum' - from cached
1185 * data in modinfo field
1191 * Section number that this course-module is in (section 0 = above the calendar, section 1
1192 * = week/topic 1, etc) - from cached data in modinfo field
1195 private $sectionnum;
1198 * Section id - from course_modules table
1204 * Availability conditions for this course-module based on the completion of other
1205 * course-modules (array from other course-module id to required completion state for that
1206 * module) - from cached data in modinfo field
1209 private $conditionscompletion;
1212 * Availability conditions for this course-module based on course grades (array from
1213 * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
1216 private $conditionsgrade;
1219 * Availability conditions for this course-module based on user fields
1222 private $conditionsfield;
1225 * True if this course-module is available to students i.e. if all availability conditions
1226 * are met - obtained dynamically
1232 * If course-module is not available to students, this string gives information about
1233 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
1234 * January 2010') for display on main page - obtained dynamically
1237 private $availableinfo;
1240 * True if this course-module is available to the CURRENT user (for example, if current user
1241 * has viewhiddenactivities capability, they can access the course-module even if it is not
1242 * visible or not available, so this would be true in that case)
1245 private $uservisible;
1248 * True if this course-module is visible to the CURRENT user on the course page
1251 private $uservisibleoncoursepage;
1266 private $contentisformatted;
1271 private $extraclasses;
1274 * @var moodle_url full external url pointing to icon image for activity
1286 private $customdata;
1296 private $afterediticons;
1299 * @var bool representing the deletion state of the module. True if the mod is scheduled for deletion.
1301 private $deletioninprogress;
1304 * List of class read-only properties and their getter methods.
1305 * Used by magic functions __get(), __isset(), __empty()
1308 private static $standardproperties = array(
1310 'content' => 'get_content',
1311 'extraclasses' => 'get_extra_classes',
1312 'onclick' => 'get_on_click',
1313 'customdata' => 'get_custom_data',
1314 'afterlink' => 'get_after_link',
1315 'afterediticons' => 'get_after_edit_icons',
1316 'modfullname' => 'get_module_type_name',
1317 'modplural' => 'get_module_type_name_plural',
1320 'availability' => false,
1321 'available' => 'get_available',
1322 'availableinfo' => 'get_available_info',
1323 'completion' => false,
1324 'completionexpected' => false,
1325 'completiongradeitemnumber' => false,
1326 'completionview' => false,
1327 'conditionscompletion' => false,
1328 'conditionsfield' => false,
1329 'conditionsgrade' => false,
1330 'context' => 'get_context',
1331 'course' => 'get_course_id',
1332 'coursegroupmode' => 'get_course_groupmode',
1333 'coursegroupmodeforce' => 'get_course_groupmodeforce',
1334 'effectivegroupmode' => 'get_effective_groupmode',
1336 'groupingid' => false,
1337 'groupmembersonly' => 'get_deprecated_group_members_only',
1338 'groupmode' => false,
1340 'iconcomponent' => false,
1341 'idnumber' => false,
1343 'instance' => false,
1346 'name' => 'get_name',
1349 'sectionnum' => false,
1350 'showdescription' => false,
1351 'uservisible' => 'get_user_visible',
1353 'visibleoncoursepage' => false,
1354 'visibleold' => false,
1355 'deletioninprogress' => false
1359 * List of methods with no arguments that were public prior to Moodle 2.6.
1361 * They can still be accessed publicly via magic __call() function with no warnings
1362 * but are not listed in the class methods list.
1363 * For the consistency of the code it is better to use corresponding properties.
1365 * These methods be deprecated completely in later versions.
1367 * @var array $standardmethods
1369 private static $standardmethods = array(
1370 // Following methods are not recommended to use because there have associated read-only properties.
1373 'get_extra_classes',
1377 'get_after_edit_icons',
1378 // Method obtain_dynamic_data() should not be called from outside of this class but it was public before Moodle 2.6.
1379 'obtain_dynamic_data',
1383 * Magic method to call functions that are now declared as private but were public in Moodle before 2.6.
1384 * These private methods can not be used anymore.
1386 * @param string $name
1387 * @param array $arguments
1389 * @throws coding_exception
1391 public function __call($name, $arguments) {
1392 if (in_array($name, self
::$standardmethods)) {
1393 $message = "cm_info::$name() can not be used anymore.";
1394 if ($alternative = array_search($name, self
::$standardproperties)) {
1395 $message .= " Please use the property cm_info->$alternative instead.";
1397 throw new coding_exception($message);
1399 throw new coding_exception("Method cm_info::{$name}() does not exist");
1403 * Magic method getter
1405 * @param string $name
1408 public function __get($name) {
1409 if (isset(self
::$standardproperties[$name])) {
1410 if ($method = self
::$standardproperties[$name]) {
1411 return $this->$method();
1413 return $this->$name;
1416 debugging('Invalid cm_info property accessed: '.$name);
1422 * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
1423 * and use {@link convert_to_array()}
1425 * @return ArrayIterator
1427 public function getIterator() {
1428 // Make sure dynamic properties are retrieved prior to view properties.
1429 $this->obtain_dynamic_data();
1432 // Do not iterate over deprecated properties.
1433 $props = self
::$standardproperties;
1434 unset($props['groupmembersonly']);
1436 foreach ($props as $key => $unused) {
1437 $ret[$key] = $this->__get($key);
1439 return new ArrayIterator($ret);
1443 * Magic method for function isset()
1445 * @param string $name
1448 public function __isset($name) {
1449 if (isset(self
::$standardproperties[$name])) {
1450 $value = $this->__get($name);
1451 return isset($value);
1457 * Magic method for function empty()
1459 * @param string $name
1462 public function __empty($name) {
1463 if (isset(self
::$standardproperties[$name])) {
1464 $value = $this->__get($name);
1465 return empty($value);
1471 * Magic method setter
1473 * Will display the developer warning when trying to set/overwrite property.
1475 * @param string $name
1476 * @param mixed $value
1478 public function __set($name, $value) {
1479 debugging("It is not allowed to set the property cm_info::\${$name}", DEBUG_DEVELOPER
);
1483 * @return bool True if this module has a 'view' page that should be linked to in navigation
1484 * etc (note: modules may still have a view.php file, but return false if this is not
1485 * intended to be linked to from 'normal' parts of the interface; this is what label does).
1487 public function has_view() {
1488 return !is_null($this->url
);
1492 * Gets the URL to link to for this module.
1494 * This method is normally called by the property ->url, but can be called directly if
1495 * there is a case when it might be called recursively (you can't call property values
1498 * @return moodle_url URL to link to for this module, or null if it doesn't have a view page
1500 public function get_url() {
1501 $this->obtain_dynamic_data();
1506 * Obtains content to display on main (view) page.
1507 * Note: Will collect view data, if not already obtained.
1508 * @return string Content to display on main page below link, or empty string if none
1510 private function get_content() {
1511 $this->obtain_view_data();
1512 return $this->content
;
1516 * Returns the content to display on course/overview page, formatted and passed through filters
1518 * if $options['context'] is not specified, the module context is used
1520 * @param array|stdClass $options formatting options, see {@link format_text()}
1523 public function get_formatted_content($options = array()) {
1524 $this->obtain_view_data();
1525 if (empty($this->content
)) {
1528 if ($this->contentisformatted
) {
1529 return $this->content
;
1532 // Improve filter performance by preloading filter setttings for all
1533 // activities on the course (this does nothing if called multiple
1535 filter_preload_activities($this->get_modinfo());
1537 $options = (array)$options;
1538 if (!isset($options['context'])) {
1539 $options['context'] = $this->get_context();
1541 return format_text($this->content
, FORMAT_HTML
, $options);
1545 * Getter method for property $name, ensures that dynamic data is obtained.
1547 * This method is normally called by the property ->name, but can be called directly if there
1548 * is a case when it might be called recursively (you can't call property values recursively).
1552 public function get_name() {
1553 $this->obtain_dynamic_data();
1558 * Returns the name to display on course/overview page, formatted and passed through filters
1560 * if $options['context'] is not specified, the module context is used
1562 * @param array|stdClass $options formatting options, see {@link format_string()}
1565 public function get_formatted_name($options = array()) {
1567 $options = (array)$options;
1568 if (!isset($options['context'])) {
1569 $options['context'] = $this->get_context();
1571 // Improve filter performance by preloading filter setttings for all
1572 // activities on the course (this does nothing if called multiple
1574 if (!empty($CFG->filterall
)) {
1575 filter_preload_activities($this->get_modinfo());
1577 return format_string($this->get_name(), true, $options);
1581 * Note: Will collect view data, if not already obtained.
1582 * @return string Extra CSS classes to add to html output for this activity on main page
1584 private function get_extra_classes() {
1585 $this->obtain_view_data();
1586 return $this->extraclasses
;
1590 * @return string Content of HTML on-click attribute. This string will be used literally
1591 * as a string so should be pre-escaped.
1593 private function get_on_click() {
1594 // Does not need view data; may be used by navigation
1595 $this->obtain_dynamic_data();
1596 return $this->onclick
;
1599 * Getter method for property $customdata, ensures that dynamic data is retrieved.
1601 * This method is normally called by the property ->customdata, but can be called directly if there
1602 * is a case when it might be called recursively (you can't call property values recursively).
1604 * @return mixed Optional custom data stored in modinfo cache for this activity, or null if none
1606 public function get_custom_data() {
1607 $this->obtain_dynamic_data();
1608 return $this->customdata
;
1612 * Note: Will collect view data, if not already obtained.
1613 * @return string Extra HTML code to display after link
1615 private function get_after_link() {
1616 $this->obtain_view_data();
1617 return $this->afterlink
;
1621 * Note: Will collect view data, if not already obtained.
1622 * @return string Extra HTML code to display after editing icons (e.g. more icons)
1624 private function get_after_edit_icons() {
1625 $this->obtain_view_data();
1626 return $this->afterediticons
;
1630 * @param moodle_core_renderer $output Output render to use, or null for default (global)
1631 * @return moodle_url Icon URL for a suitable icon to put beside this cm
1633 public function get_icon_url($output = null) {
1635 $this->obtain_dynamic_data();
1639 // Support modules setting their own, external, icon image
1640 if (!empty($this->iconurl
)) {
1641 $icon = $this->iconurl
;
1643 // Fallback to normal local icon + component procesing
1644 } else if (!empty($this->icon
)) {
1645 if (substr($this->icon
, 0, 4) === 'mod/') {
1646 list($modname, $iconname) = explode('/', substr($this->icon
, 4), 2);
1647 $icon = $output->image_url($iconname, $modname);
1649 if (!empty($this->iconcomponent
)) {
1650 // Icon has specified component
1651 $icon = $output->image_url($this->icon
, $this->iconcomponent
);
1653 // Icon does not have specified component, use default
1654 $icon = $output->image_url($this->icon
);
1658 $icon = $output->image_url('icon', $this->modname
);
1664 * @param string $textclasses additionnal classes for grouping label
1665 * @return string An empty string or HTML grouping label span tag
1667 public function get_grouping_label($textclasses = '') {
1668 $groupinglabel = '';
1669 if ($this->effectivegroupmode
!= NOGROUPS
&& !empty($this->groupingid
) &&
1670 has_capability('moodle/course:managegroups', context_course
::instance($this->course
))) {
1671 $groupings = groups_get_all_groupings($this->course
);
1672 $groupinglabel = html_writer
::tag('span', '('.format_string($groupings[$this->groupingid
]->name
).')',
1673 array('class' => 'groupinglabel '.$textclasses));
1675 return $groupinglabel;
1679 * Returns a localised human-readable name of the module type.
1681 * @param bool $plural If true, the function returns the plural form of the name.
1682 * @return lang_string
1684 public function get_module_type_name($plural = false) {
1685 $modnames = get_module_types_names($plural);
1686 if (isset($modnames[$this->modname
])) {
1687 return $modnames[$this->modname
];
1694 * Returns a localised human-readable name of the module type in plural form - calculated on request
1698 private function get_module_type_name_plural() {
1699 return $this->get_module_type_name(true);
1703 * @return course_modinfo Modinfo object that this came from
1705 public function get_modinfo() {
1706 return $this->modinfo
;
1710 * Returns the section this module belongs to
1712 * @return section_info
1714 public function get_section_info() {
1715 return $this->modinfo
->get_section_info($this->sectionnum
);
1719 * Returns course object that was used in the first {@link get_fast_modinfo()} call.
1721 * It may not contain all fields from DB table {course} but always has at least the following:
1722 * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
1724 * If the course object lacks the field you need you can use the global
1725 * function {@link get_course()} that will save extra query if you access
1726 * current course or frontpage course.
1730 public function get_course() {
1731 return $this->modinfo
->get_course();
1735 * Returns course id for which the modinfo was generated.
1739 private function get_course_id() {
1740 return $this->modinfo
->get_course_id();
1744 * Returns group mode used for the course containing the module
1746 * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1748 private function get_course_groupmode() {
1749 return $this->modinfo
->get_course()->groupmode
;
1753 * Returns whether group mode is forced for the course containing the module
1757 private function get_course_groupmodeforce() {
1758 return $this->modinfo
->get_course()->groupmodeforce
;
1762 * Returns effective groupmode of the module that may be overwritten by forced course groupmode.
1764 * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1766 private function get_effective_groupmode() {
1767 $groupmode = $this->groupmode
;
1768 if ($this->modinfo
->get_course()->groupmodeforce
) {
1769 $groupmode = $this->modinfo
->get_course()->groupmode
;
1770 if ($groupmode != NOGROUPS
&& !plugin_supports('mod', $this->modname
, FEATURE_GROUPS
, false)) {
1771 $groupmode = NOGROUPS
;
1778 * @return context_module Current module context
1780 private function get_context() {
1781 return context_module
::instance($this->id
);
1785 * Returns itself in the form of stdClass.
1787 * The object includes all fields that table course_modules has and additionally
1788 * fields 'name', 'modname', 'sectionnum' (if requested).
1790 * This can be used as a faster alternative to {@link get_coursemodule_from_id()}
1792 * @param bool $additionalfields include additional fields 'name', 'modname', 'sectionnum'
1795 public function get_course_module_record($additionalfields = false) {
1796 $cmrecord = new stdClass();
1798 // Standard fields from table course_modules.
1799 static $cmfields = array('id', 'course', 'module', 'instance', 'section', 'idnumber', 'added',
1800 'score', 'indent', 'visible', 'visibleoncoursepage', 'visibleold', 'groupmode', 'groupingid',
1801 'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected',
1802 'showdescription', 'availability', 'deletioninprogress');
1803 foreach ($cmfields as $key) {
1804 $cmrecord->$key = $this->$key;
1807 // Additional fields that function get_coursemodule_from_id() adds.
1808 if ($additionalfields) {
1809 $cmrecord->name
= $this->name
;
1810 $cmrecord->modname
= $this->modname
;
1811 $cmrecord->sectionnum
= $this->sectionnum
;
1821 * Sets content to display on course view page below link (if present).
1822 * @param string $content New content as HTML string (empty string if none)
1823 * @param bool $isformatted Whether user content is already passed through format_text/format_string and should not
1824 * be formatted again. This can be useful when module adds interactive elements on top of formatted user text.
1827 public function set_content($content, $isformatted = false) {
1828 $this->content
= $content;
1829 $this->contentisformatted
= $isformatted;
1833 * Sets extra classes to include in CSS.
1834 * @param string $extraclasses Extra classes (empty string if none)
1837 public function set_extra_classes($extraclasses) {
1838 $this->extraclasses
= $extraclasses;
1842 * Sets the external full url that points to the icon being used
1843 * by the activity. Useful for external-tool modules (lti...)
1844 * If set, takes precedence over $icon and $iconcomponent
1846 * @param moodle_url $iconurl full external url pointing to icon image for activity
1849 public function set_icon_url(moodle_url
$iconurl) {
1850 $this->iconurl
= $iconurl;
1854 * Sets value of on-click attribute for JavaScript.
1855 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1856 * @param string $onclick New onclick attribute which should be HTML-escaped
1857 * (empty string if none)
1860 public function set_on_click($onclick) {
1861 $this->check_not_view_only();
1862 $this->onclick
= $onclick;
1866 * Overrides the value of an element in the customdata array.
1868 * @param string $name The key in the customdata array
1869 * @param mixed $value The value
1871 public function override_customdata($name, $value) {
1872 if (!is_array($this->customdata
)) {
1873 $this->customdata
= [];
1875 $this->customdata
[$name] = $value;
1879 * Sets HTML that displays after link on course view page.
1880 * @param string $afterlink HTML string (empty string if none)
1883 public function set_after_link($afterlink) {
1884 $this->afterlink
= $afterlink;
1888 * Sets HTML that displays after edit icons on course view page.
1889 * @param string $afterediticons HTML string (empty string if none)
1892 public function set_after_edit_icons($afterediticons) {
1893 $this->afterediticons
= $afterediticons;
1897 * Changes the name (text of link) for this module instance.
1898 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1899 * @param string $name Name of activity / link text
1902 public function set_name($name) {
1903 if ($this->state
< self
::STATE_BUILDING_DYNAMIC
) {
1904 $this->update_user_visible();
1906 $this->name
= $name;
1910 * Turns off the view link for this module instance.
1911 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1914 public function set_no_view_link() {
1915 $this->check_not_view_only();
1920 * Sets the 'uservisible' flag. This can be used (by setting false) to prevent access and
1921 * display of this module link for the current user.
1922 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1923 * @param bool $uservisible
1926 public function set_user_visible($uservisible) {
1927 $this->check_not_view_only();
1928 $this->uservisible
= $uservisible;
1932 * Sets the 'available' flag and related details. This flag is normally used to make
1933 * course modules unavailable until a certain date or condition is met. (When a course
1934 * module is unavailable, it is still visible to users who have viewhiddenactivities
1937 * When this is function is called, user-visible status is recalculated automatically.
1939 * The $showavailability flag does not really do anything any more, but is retained
1940 * for backward compatibility. Setting this to false will cause $availableinfo to
1943 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1944 * @param bool $available False if this item is not 'available'
1945 * @param int $showavailability 0 = do not show this item at all if it's not available,
1946 * 1 = show this item greyed out with the following message
1947 * @param string $availableinfo Information about why this is not available, or
1948 * empty string if not displaying
1951 public function set_available($available, $showavailability=0, $availableinfo='') {
1952 $this->check_not_view_only();
1953 $this->available
= $available;
1954 if (!$showavailability) {
1955 $availableinfo = '';
1957 $this->availableinfo
= $availableinfo;
1958 $this->update_user_visible();
1962 * Some set functions can only be called from _cm_info_dynamic and not _cm_info_view.
1963 * This is because they may affect parts of this object which are used on pages other
1964 * than the view page (e.g. in the navigation block, or when checking access on
1968 private function check_not_view_only() {
1969 if ($this->state
>= self
::STATE_DYNAMIC
) {
1970 throw new coding_exception('Cannot set this data from _cm_info_view because it may ' .
1971 'affect other pages as well as view');
1976 * Constructor should not be called directly; use {@link get_fast_modinfo()}
1978 * @param course_modinfo $modinfo Parent object
1979 * @param stdClass $notused1 Argument not used
1980 * @param stdClass $mod Module object from the modinfo field of course table
1981 * @param stdClass $notused2 Argument not used
1983 public function __construct(course_modinfo
$modinfo, $notused1, $mod, $notused2) {
1984 $this->modinfo
= $modinfo;
1986 $this->id
= $mod->cm
;
1987 $this->instance
= $mod->id
;
1988 $this->modname
= $mod->mod
;
1989 $this->idnumber
= isset($mod->idnumber
) ?
$mod->idnumber
: '';
1990 $this->name
= $mod->name
;
1991 $this->visible
= $mod->visible
;
1992 $this->visibleoncoursepage
= $mod->visibleoncoursepage
;
1993 $this->sectionnum
= $mod->section
; // Note weirdness with name here
1994 $this->groupmode
= isset($mod->groupmode
) ?
$mod->groupmode
: 0;
1995 $this->groupingid
= isset($mod->groupingid
) ?
$mod->groupingid
: 0;
1996 $this->indent
= isset($mod->indent
) ?
$mod->indent
: 0;
1997 $this->extra
= isset($mod->extra
) ?
$mod->extra
: '';
1998 $this->extraclasses
= isset($mod->extraclasses
) ?
$mod->extraclasses
: '';
1999 // iconurl may be stored as either string or instance of moodle_url.
2000 $this->iconurl
= isset($mod->iconurl
) ?
new moodle_url($mod->iconurl
) : '';
2001 $this->onclick
= isset($mod->onclick
) ?
$mod->onclick
: '';
2002 $this->content
= isset($mod->content
) ?
$mod->content
: '';
2003 $this->icon
= isset($mod->icon
) ?
$mod->icon
: '';
2004 $this->iconcomponent
= isset($mod->iconcomponent
) ?
$mod->iconcomponent
: '';
2005 $this->customdata
= isset($mod->customdata
) ?
$mod->customdata
: '';
2006 $this->showdescription
= isset($mod->showdescription
) ?
$mod->showdescription
: 0;
2007 $this->state
= self
::STATE_BASIC
;
2009 $this->section
= isset($mod->sectionid
) ?
$mod->sectionid
: 0;
2010 $this->module
= isset($mod->module
) ?
$mod->module
: 0;
2011 $this->added
= isset($mod->added
) ?
$mod->added
: 0;
2012 $this->score
= isset($mod->score
) ?
$mod->score
: 0;
2013 $this->visibleold
= isset($mod->visibleold
) ?
$mod->visibleold
: 0;
2014 $this->deletioninprogress
= isset($mod->deletioninprogress
) ?
$mod->deletioninprogress
: 0;
2016 // Note: it saves effort and database space to always include the
2017 // availability and completion fields, even if availability or completion
2018 // are actually disabled
2019 $this->completion
= isset($mod->completion
) ?
$mod->completion
: 0;
2020 $this->completiongradeitemnumber
= isset($mod->completiongradeitemnumber
)
2021 ?
$mod->completiongradeitemnumber
: null;
2022 $this->completionview
= isset($mod->completionview
)
2023 ?
$mod->completionview
: 0;
2024 $this->completionexpected
= isset($mod->completionexpected
)
2025 ?
$mod->completionexpected
: 0;
2026 $this->availability
= isset($mod->availability
) ?
$mod->availability
: null;
2027 $this->conditionscompletion
= isset($mod->conditionscompletion
)
2028 ?
$mod->conditionscompletion
: array();
2029 $this->conditionsgrade
= isset($mod->conditionsgrade
)
2030 ?
$mod->conditionsgrade
: array();
2031 $this->conditionsfield
= isset($mod->conditionsfield
)
2032 ?
$mod->conditionsfield
: array();
2034 static $modviews = array();
2035 if (!isset($modviews[$this->modname
])) {
2036 $modviews[$this->modname
] = !plugin_supports('mod', $this->modname
,
2037 FEATURE_NO_VIEW_LINK
);
2039 $this->url
= $modviews[$this->modname
]
2040 ?
new moodle_url('/mod/' . $this->modname
. '/view.php', array('id'=>$this->id
))
2045 * Creates a cm_info object from a database record (also accepts cm_info
2046 * in which case it is just returned unchanged).
2048 * @param stdClass|cm_info|null|bool $cm Stdclass or cm_info (or null or false)
2049 * @param int $userid Optional userid (default to current)
2050 * @return cm_info|null Object as cm_info, or null if input was null/false
2052 public static function create($cm, $userid = 0) {
2053 // Null, false, etc. gets passed through as null.
2057 // If it is already a cm_info object, just return it.
2058 if ($cm instanceof cm_info
) {
2061 // Otherwise load modinfo.
2062 if (empty($cm->id
) ||
empty($cm->course
)) {
2063 throw new coding_exception('$cm must contain ->id and ->course');
2065 $modinfo = get_fast_modinfo($cm->course
, $userid);
2066 return $modinfo->get_cm($cm->id
);
2070 * If dynamic data for this course-module is not yet available, gets it.
2072 * This function is automatically called when requesting any course_modinfo property
2073 * that can be modified by modules (have a set_xxx method).
2075 * Dynamic data is data which does not come directly from the cache but is calculated at
2076 * runtime based on the current user. Primarily this concerns whether the user can access
2077 * the module or not.
2079 * As part of this function, the module's _cm_info_dynamic function from its lib.php will
2080 * be called (if it exists). Make sure that the functions that are called here do not use
2081 * any getter magic method from cm_info.
2084 private function obtain_dynamic_data() {
2086 $userid = $this->modinfo
->get_user_id();
2087 if ($this->state
>= self
::STATE_BUILDING_DYNAMIC ||
$userid == -1) {
2090 $this->state
= self
::STATE_BUILDING_DYNAMIC
;
2092 if (!empty($CFG->enableavailability
)) {
2093 // Get availability information.
2094 $ci = new \core_availability\
info_module($this);
2096 // Note that the modinfo currently available only includes minimal details (basic data)
2097 // but we know that this function does not need anything more than basic data.
2098 $this->available
= $ci->is_available($this->availableinfo
, true,
2099 $userid, $this->modinfo
);
2101 $this->available
= true;
2104 // Check parent section.
2105 if ($this->available
) {
2106 $parentsection = $this->modinfo
->get_section_info($this->sectionnum
);
2107 if (!$parentsection->get_available()) {
2108 // Do not store info from section here, as that is already
2109 // presented from the section (if appropriate) - just change
2111 $this->available
= false;
2115 // Update visible state for current user.
2116 $this->update_user_visible();
2118 // Let module make dynamic changes at this point
2119 $this->call_mod_function('cm_info_dynamic');
2120 $this->state
= self
::STATE_DYNAMIC
;
2124 * Getter method for property $uservisible, ensures that dynamic data is retrieved.
2126 * This method is normally called by the property ->uservisible, but can be called directly if
2127 * there is a case when it might be called recursively (you can't call property values
2132 public function get_user_visible() {
2133 $this->obtain_dynamic_data();
2134 return $this->uservisible
;
2138 * Returns whether this module is visible to the current user on course page
2140 * Activity may be visible on the course page but not available, for example
2141 * when it is hidden conditionally but the condition information is displayed.
2145 public function is_visible_on_course_page() {
2146 $this->obtain_dynamic_data();
2147 return $this->uservisibleoncoursepage
;
2151 * Whether this module is available but hidden from course page
2153 * "Stealth" modules are the ones that are not shown on course page but available by following url.
2154 * They are normally also displayed in grade reports and other reports.
2155 * Module will be stealth either if visibleoncoursepage=0 or it is a visible module inside the hidden
2160 public function is_stealth() {
2161 return !$this->visibleoncoursepage ||
2162 ($this->visible
&& ($section = $this->get_section_info()) && !$section->visible
);
2166 * Getter method for property $available, ensures that dynamic data is retrieved
2169 private function get_available() {
2170 $this->obtain_dynamic_data();
2171 return $this->available
;
2175 * This method can not be used anymore.
2177 * @see \core_availability\info_module::filter_user_list()
2178 * @deprecated Since Moodle 2.8
2180 private function get_deprecated_group_members_only() {
2181 throw new coding_exception('$cm->groupmembersonly can not be used anymore. ' .
2182 'If used to restrict a list of enrolled users to only those who can ' .
2183 'access the module, consider \core_availability\info_module::filter_user_list.');
2187 * Getter method for property $availableinfo, ensures that dynamic data is retrieved
2189 * @return string Available info (HTML)
2191 private function get_available_info() {
2192 $this->obtain_dynamic_data();
2193 return $this->availableinfo
;
2197 * Works out whether activity is available to the current user
2199 * If the activity is unavailable, additional checks are required to determine if its hidden or greyed out
2203 private function update_user_visible() {
2204 $userid = $this->modinfo
->get_user_id();
2205 if ($userid == -1) {
2208 $this->uservisible
= true;
2210 // If the module is being deleted, set the uservisible state to false and return.
2211 if ($this->deletioninprogress
) {
2212 $this->uservisible
= false;
2216 // If the user cannot access the activity set the uservisible flag to false.
2217 // Additional checks are required to determine whether the activity is entirely hidden or just greyed out.
2218 if ((!$this->visible
&& !has_capability('moodle/course:viewhiddenactivities', $this->get_context(), $userid)) ||
2219 (!$this->get_available() &&
2220 !has_capability('moodle/course:ignoreavailabilityrestrictions', $this->get_context(), $userid))) {
2222 $this->uservisible
= false;
2225 // Check group membership.
2226 if ($this->is_user_access_restricted_by_capability()) {
2228 $this->uservisible
= false;
2229 // Ensure activity is completely hidden from the user.
2230 $this->availableinfo
= '';
2233 $this->uservisibleoncoursepage
= $this->uservisible
&&
2234 ($this->visibleoncoursepage ||
2235 has_capability('moodle/course:manageactivities', $this->get_context(), $userid) ||
2236 has_capability('moodle/course:activityvisibility', $this->get_context(), $userid));
2237 // Activity that is not available, not hidden from course page and has availability
2238 // info is actually visible on the course page (with availability info and without a link).
2239 if (!$this->uservisible
&& $this->visibleoncoursepage
&& $this->availableinfo
) {
2240 $this->uservisibleoncoursepage
= true;
2245 * This method has been deprecated and should not be used.
2248 * @deprecated Since Moodle 2.8
2250 public function is_user_access_restricted_by_group() {
2251 throw new coding_exception('cm_info::is_user_access_restricted_by_group() can not be used any more.' .
2252 ' Use $cm->uservisible to decide whether the current user can access an activity.');
2256 * Checks whether mod/...:view capability restricts the current user's access.
2258 * @return bool True if the user access is restricted.
2260 public function is_user_access_restricted_by_capability() {
2261 $userid = $this->modinfo
->get_user_id();
2262 if ($userid == -1) {
2265 $capability = 'mod/' . $this->modname
. ':view';
2266 $capabilityinfo = get_capability_info($capability);
2267 if (!$capabilityinfo) {
2268 // Capability does not exist, no one is prevented from seeing the activity.
2272 // You are blocked if you don't have the capability.
2273 return !has_capability($capability, $this->get_context(), $userid);
2277 * Checks whether the module's conditional access settings mean that the
2278 * user cannot see the activity at all
2280 * @deprecated since 2.7 MDL-44070
2282 public function is_user_access_restricted_by_conditional_access() {
2283 throw new coding_exception('cm_info::is_user_access_restricted_by_conditional_access() ' .
2284 'can not be used any more; this function is not needed (use $cm->uservisible ' .
2285 'and $cm->availableinfo to decide whether it should be available ' .
2290 * Calls a module function (if exists), passing in one parameter: this object.
2291 * @param string $type Name of function e.g. if this is 'grooblezorb' and the modname is
2292 * 'forum' then it will try to call 'mod_forum_grooblezorb' or 'forum_grooblezorb'
2295 private function call_mod_function($type) {
2297 $libfile = $CFG->dirroot
. '/mod/' . $this->modname
. '/lib.php';
2298 if (file_exists($libfile)) {
2299 include_once($libfile);
2300 $function = 'mod_' . $this->modname
. '_' . $type;
2301 if (function_exists($function)) {
2304 $function = $this->modname
. '_' . $type;
2305 if (function_exists($function)) {
2313 * If view data for this course-module is not yet available, obtains it.
2315 * This function is automatically called if any of the functions (marked) which require
2316 * view data are called.
2318 * View data is data which is needed only for displaying the course main page (& any similar
2319 * functionality on other pages) but is not needed in general. Obtaining view data may have
2320 * a performance cost.
2322 * As part of this function, the module's _cm_info_view function from its lib.php will
2323 * be called (if it exists).
2326 private function obtain_view_data() {
2327 if ($this->state
>= self
::STATE_BUILDING_VIEW ||
$this->modinfo
->get_user_id() == -1) {
2330 $this->obtain_dynamic_data();
2331 $this->state
= self
::STATE_BUILDING_VIEW
;
2333 // Let module make changes at this point
2334 $this->call_mod_function('cm_info_view');
2335 $this->state
= self
::STATE_VIEW
;
2341 * Returns reference to full info about modules in course (including visibility).
2342 * Cached and as fast as possible (0 or 1 db query).
2344 * use get_fast_modinfo($courseid, 0, true) to reset the static cache for particular course
2345 * use get_fast_modinfo(0, 0, true) to reset the static cache for all courses
2347 * use rebuild_course_cache($courseid, true) to reset the application AND static cache
2348 * for particular course when it's contents has changed
2350 * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
2351 * and recommended to have field 'cacherev') or just a course id. Just course id
2352 * is enough when calling get_fast_modinfo() for current course or site or when
2353 * calling for any other course for the second time.
2354 * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections.
2355 * Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
2356 * @param bool $resetonly whether we want to get modinfo or just reset the cache
2357 * @return course_modinfo|null Module information for course, or null if resetting
2358 * @throws moodle_exception when course is not found (nothing is thrown if resetting)
2360 function get_fast_modinfo($courseorid, $userid = 0, $resetonly = false) {
2361 // compartibility with syntax prior to 2.4:
2362 if ($courseorid === 'reset') {
2363 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
);
2368 // Function get_fast_modinfo() can never be called during upgrade unless it is used for clearing cache only.
2370 upgrade_ensure_not_running();
2373 // Function is called with $reset = true
2375 course_modinfo
::clear_instance_cache($courseorid);
2379 // Function is called with $reset = false, retrieve modinfo
2380 return course_modinfo
::instance($courseorid, $userid);
2384 * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given
2385 * a cmid. If module name is also provided, it will ensure the cm is of that type.
2388 * list($course, $cm) = get_course_and_cm_from_cmid($cmid, 'forum');
2390 * Using this method has a performance advantage because it works by loading
2391 * modinfo for the course - which will then be cached and it is needed later
2392 * in most requests. It also guarantees that the $cm object is a cm_info and
2395 * The $course object can be supplied if already known and will speed
2396 * up this function - although it is more efficient to use this function to
2397 * get the course if you are starting from a cmid.
2399 * To avoid security problems and obscure bugs, you should always specify
2400 * $modulename if the cmid value came from user input.
2402 * By default this obtains information (for example, whether user can access
2403 * the activity) for current user, but you can specify a userid if required.
2405 * @param stdClass|int $cmorid Id of course-module, or database object
2406 * @param string $modulename Optional modulename (improves security)
2407 * @param stdClass|int $courseorid Optional course object if already loaded
2408 * @param int $userid Optional userid (default = current)
2409 * @return array Array with 2 elements $course and $cm
2410 * @throws moodle_exception If the item doesn't exist or is of wrong module name
2412 function get_course_and_cm_from_cmid($cmorid, $modulename = '', $courseorid = 0, $userid = 0) {
2414 if (is_object($cmorid)) {
2415 $cmid = $cmorid->id
;
2416 if (isset($cmorid->course
)) {
2417 $courseid = (int)$cmorid->course
;
2422 $cmid = (int)$cmorid;
2426 // Validate module name if supplied.
2427 if ($modulename && !core_component
::is_valid_plugin_name('mod', $modulename)) {
2428 throw new coding_exception('Invalid modulename parameter');
2431 // Get course from last parameter if supplied.
2433 if (is_object($courseorid)) {
2434 $course = $courseorid;
2435 } else if ($courseorid) {
2436 $courseid = (int)$courseorid;
2441 // If course ID is known, get it using normal function.
2442 $course = get_course($courseid);
2444 // Get course record in a single query based on cmid.
2445 $course = $DB->get_record_sql("
2447 FROM {course_modules} cm
2448 JOIN {course} c ON c.id = cm.course
2449 WHERE cm.id = ?", array($cmid), MUST_EXIST
);
2453 // Get cm from get_fast_modinfo.
2454 $modinfo = get_fast_modinfo($course, $userid);
2455 $cm = $modinfo->get_cm($cmid);
2456 if ($modulename && $cm->modname
!== $modulename) {
2457 throw new moodle_exception('invalidcoursemodule', 'error');
2459 return array($course, $cm);
2463 * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given
2464 * an instance id or record and module name.
2467 * list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
2469 * Using this method has a performance advantage because it works by loading
2470 * modinfo for the course - which will then be cached and it is needed later
2471 * in most requests. It also guarantees that the $cm object is a cm_info and
2474 * The $course object can be supplied if already known and will speed
2475 * up this function - although it is more efficient to use this function to
2476 * get the course if you are starting from an instance id.
2478 * By default this obtains information (for example, whether user can access
2479 * the activity) for current user, but you can specify a userid if required.
2481 * @param stdclass|int $instanceorid Id of module instance, or database object
2482 * @param string $modulename Modulename (required)
2483 * @param stdClass|int $courseorid Optional course object if already loaded
2484 * @param int $userid Optional userid (default = current)
2485 * @return array Array with 2 elements $course and $cm
2486 * @throws moodle_exception If the item doesn't exist or is of wrong module name
2488 function get_course_and_cm_from_instance($instanceorid, $modulename, $courseorid = 0, $userid = 0) {
2491 // Get data from parameter.
2492 if (is_object($instanceorid)) {
2493 $instanceid = $instanceorid->id
;
2494 if (isset($instanceorid->course
)) {
2495 $courseid = (int)$instanceorid->course
;
2500 $instanceid = (int)$instanceorid;
2504 // Get course from last parameter if supplied.
2506 if (is_object($courseorid)) {
2507 $course = $courseorid;
2508 } else if ($courseorid) {
2509 $courseid = (int)$courseorid;
2512 // Validate module name if supplied.
2513 if (!core_component
::is_valid_plugin_name('mod', $modulename)) {
2514 throw new coding_exception('Invalid modulename parameter');
2519 // If course ID is known, get it using normal function.
2520 $course = get_course($courseid);
2522 // Get course record in a single query based on instance id.
2523 $pagetable = '{' . $modulename . '}';
2524 $course = $DB->get_record_sql("
2526 FROM $pagetable instance
2527 JOIN {course} c ON c.id = instance.course
2528 WHERE instance.id = ?", array($instanceid), MUST_EXIST
);
2532 // Get cm from get_fast_modinfo.
2533 $modinfo = get_fast_modinfo($course, $userid);
2534 $instances = $modinfo->get_instances_of($modulename);
2535 if (!array_key_exists($instanceid, $instances)) {
2536 throw new moodle_exception('invalidmoduleid', 'error', $instanceid);
2538 return array($course, $instances[$instanceid]);
2543 * Rebuilds or resets the cached list of course activities stored in MUC.
2545 * rebuild_course_cache() must NEVER be called from lib/db/upgrade.php.
2546 * At the same time course cache may ONLY be cleared using this function in
2547 * upgrade scripts of plugins.
2549 * During the bulk operations if it is necessary to reset cache of multiple
2550 * courses it is enough to call {@link increment_revision_number()} for the
2551 * table 'course' and field 'cacherev' specifying affected courses in select.
2553 * Cached course information is stored in MUC core/coursemodinfo and is
2554 * validated with the DB field {course}.cacherev
2556 * @global moodle_database $DB
2557 * @param int $courseid id of course to rebuild, empty means all
2558 * @param boolean $clearonly only clear the cache, gets rebuild automatically on the fly.
2559 * Recommended to set to true to avoid unnecessary multiple rebuilding.
2561 function rebuild_course_cache($courseid=0, $clearonly=false) {
2562 global $COURSE, $SITE, $DB, $CFG;
2564 // Function rebuild_course_cache() can not be called during upgrade unless it's clear only.
2565 if (!$clearonly && !upgrade_ensure_not_running(true)) {
2569 // Destroy navigation caches
2570 navigation_cache
::destroy_volatile_caches();
2572 if (class_exists('format_base')) {
2573 // if file containing class is not loaded, there is no cache there anyway
2574 format_base
::reset_course_cache($courseid);
2577 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
2578 if (empty($courseid)) {
2579 // Clearing caches for all courses.
2580 increment_revision_number('course', 'cacherev', '');
2581 $cachecoursemodinfo->purge();
2582 course_modinfo
::clear_instance_cache();
2583 // Update global values too.
2584 $sitecacherev = $DB->get_field('course', 'cacherev', array('id' => SITEID
));
2585 $SITE->cachrev
= $sitecacherev;
2586 if ($COURSE->id
== SITEID
) {
2587 $COURSE->cacherev
= $sitecacherev;
2589 $COURSE->cacherev
= $DB->get_field('course', 'cacherev', array('id' => $COURSE->id
));
2592 // Clearing cache for one course, make sure it is deleted from user request cache as well.
2593 increment_revision_number('course', 'cacherev', 'id = :id', array('id' => $courseid));
2594 $cachecoursemodinfo->delete($courseid);
2595 course_modinfo
::clear_instance_cache($courseid);
2596 // Update global values too.
2597 if ($courseid == $COURSE->id ||
$courseid == $SITE->id
) {
2598 $cacherev = $DB->get_field('course', 'cacherev', array('id' => $courseid));
2599 if ($courseid == $COURSE->id
) {
2600 $COURSE->cacherev
= $cacherev;
2602 if ($courseid == $SITE->id
) {
2603 $SITE->cachrev
= $cacherev;
2613 $select = array('id'=>$courseid);
2616 core_php_time_limit
::raise(); // this could take a while! MDL-10954
2619 $rs = $DB->get_recordset("course", $select,'','id,'.join(',', course_modinfo
::$cachedfields));
2620 // Rebuild cache for each course.
2621 foreach ($rs as $course) {
2622 course_modinfo
::build_course_cache($course);
2629 * Class that is the return value for the _get_coursemodule_info module API function.
2631 * Note: For backward compatibility, you can also return a stdclass object from that function.
2632 * The difference is that the stdclass object may contain an 'extra' field (deprecated,
2633 * use extraclasses and onclick instead). The stdclass object may not contain
2634 * the new fields defined here (content, extraclasses, customdata).
2636 class cached_cm_info
{
2638 * Name (text of link) for this activity; Leave unset to accept default name
2644 * Name of icon for this activity. Normally, this should be used together with $iconcomponent
2645 * to define the icon, as per image_url function.
2646 * For backward compatibility, if this value is of the form 'mod/forum/icon' then an icon
2647 * within that module will be used.
2648 * @see cm_info::get_icon_url()
2649 * @see renderer_base::image_url()
2655 * Component for icon for this activity, as per image_url; leave blank to use default 'moodle'
2657 * @see renderer_base::image_url()
2660 public $iconcomponent;
2663 * HTML content to be displayed on the main page below the link (if any) for this course-module
2669 * Custom data to be stored in modinfo for this activity; useful if there are cases when
2670 * internal information for this activity type needs to be accessible from elsewhere on the
2671 * course without making database queries. May be of any type but should be short.
2677 * Extra CSS class or classes to be added when this activity is displayed on the main page;
2678 * space-separated string
2681 public $extraclasses;
2684 * External URL image to be used by activity as icon, useful for some external-tool modules
2685 * like lti. If set, takes precedence over $icon and $iconcomponent
2691 * Content of onclick JavaScript; escaped HTML to be inserted as attribute value
2699 * Data about a single section on a course. This contains the fields from the
2700 * course_sections table, plus additional data when required.
2702 * @property-read int $id Section ID - from course_sections table
2703 * @property-read int $course Course ID - from course_sections table
2704 * @property-read int $section Section number - from course_sections table
2705 * @property-read string $name Section name if specified - from course_sections table
2706 * @property-read int $visible Section visibility (1 = visible) - from course_sections table
2707 * @property-read string $summary Section summary text if specified - from course_sections table
2708 * @property-read int $summaryformat Section summary text format (FORMAT_xx constant) - from course_sections table
2709 * @property-read string $availability Availability information as JSON string -
2710 * from course_sections table
2711 * @property-read array $conditionscompletion Availability conditions for this section based on the completion of
2712 * course-modules (array from course-module id to required completion state
2713 * for that module) - from cached data in sectioncache field
2714 * @property-read array $conditionsgrade Availability conditions for this section based on course grades (array from
2715 * grade item id to object with ->min, ->max fields) - from cached data in
2716 * sectioncache field
2717 * @property-read array $conditionsfield Availability conditions for this section based on user fields
2718 * @property-read bool $available True if this section is available to the given user i.e. if all availability conditions
2719 * are met - obtained dynamically
2720 * @property-read string $availableinfo If section is not available to some users, this string gives information about
2721 * availability which can be displayed to students and/or staff (e.g. 'Available from 3 January 2010')
2722 * for display on main page - obtained dynamically
2723 * @property-read bool $uservisible True if this section is available to the given user (for example, if current user
2724 * has viewhiddensections capability, they can access the section even if it is not
2725 * visible or not available, so this would be true in that case) - obtained dynamically
2726 * @property-read string $sequence Comma-separated list of all modules in the section. Note, this field may not exactly
2727 * match course_sections.sequence if later has references to non-existing modules or not modules of not available module types.
2728 * @property-read course_modinfo $modinfo
2730 class section_info
implements IteratorAggregate
{
2732 * Section ID - from course_sections table
2738 * Section number - from course_sections table
2744 * Section name if specified - from course_sections table
2750 * Section visibility (1 = visible) - from course_sections table
2756 * Section summary text if specified - from course_sections table
2762 * Section summary text format (FORMAT_xx constant) - from course_sections table
2765 private $_summaryformat;
2768 * Availability information as JSON string - from course_sections table
2771 private $_availability;
2774 * Availability conditions for this section based on the completion of
2775 * course-modules (array from course-module id to required completion state
2776 * for that module) - from cached data in sectioncache field
2779 private $_conditionscompletion;
2782 * Availability conditions for this section based on course grades (array from
2783 * grade item id to object with ->min, ->max fields) - from cached data in
2784 * sectioncache field
2787 private $_conditionsgrade;
2790 * Availability conditions for this section based on user fields
2793 private $_conditionsfield;
2796 * True if this section is available to students i.e. if all availability conditions
2797 * are met - obtained dynamically on request, see function {@link section_info::get_available()}
2800 private $_available;
2803 * If section is not available to some users, this string gives information about
2804 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
2805 * January 2010') for display on main page - obtained dynamically on request, see
2806 * function {@link section_info::get_availableinfo()}
2809 private $_availableinfo;
2812 * True if this section is available to the CURRENT user (for example, if current user
2813 * has viewhiddensections capability, they can access the section even if it is not
2814 * visible or not available, so this would be true in that case) - obtained dynamically
2815 * on request, see function {@link section_info::get_uservisible()}
2818 private $_uservisible;
2821 * Default values for sectioncache fields; if a field has this value, it won't
2822 * be stored in the sectioncache cache, to save space. Checks are done by ===
2823 * which means values must all be strings.
2826 private static $sectioncachedefaults = array(
2829 'summaryformat' => '1', // FORMAT_HTML, but must be a string
2831 'availability' => null
2835 * Stores format options that have been cached when building 'coursecache'
2836 * When the format option is requested we look first if it has been cached
2839 private $cachedformatoptions = array();
2842 * Stores the list of all possible section options defined in each used course format.
2845 static private $sectionformatoptions = array();
2848 * Stores the modinfo object passed in constructor, may be used when requesting
2849 * dynamically obtained attributes such as available, availableinfo, uservisible.
2850 * Also used to retrun information about current course or user.
2851 * @var course_modinfo
2856 * Constructs object from database information plus extra required data.
2857 * @param object $data Array entry from cached sectioncache
2858 * @param int $number Section number (array key)
2859 * @param int $notused1 argument not used (informaion is available in $modinfo)
2860 * @param int $notused2 argument not used (informaion is available in $modinfo)
2861 * @param course_modinfo $modinfo Owner (needed for checking availability)
2862 * @param int $notused3 argument not used (informaion is available in $modinfo)
2864 public function __construct($data, $number, $notused1, $notused2, $modinfo, $notused3) {
2866 require_once($CFG->dirroot
.'/course/lib.php');
2868 // Data that is always present
2869 $this->_id
= $data->id
;
2871 $defaults = self
::$sectioncachedefaults +
2872 array('conditionscompletion' => array(),
2873 'conditionsgrade' => array(),
2874 'conditionsfield' => array());
2876 // Data that may use default values to save cache size
2877 foreach ($defaults as $field => $value) {
2878 if (isset($data->{$field})) {
2879 $this->{'_'.$field} = $data->{$field};
2881 $this->{'_'.$field} = $value;
2885 // Other data from constructor arguments.
2886 $this->_section
= $number;
2887 $this->modinfo
= $modinfo;
2889 // Cached course format data.
2890 $course = $modinfo->get_course();
2891 if (!isset(self
::$sectionformatoptions[$course->format
])) {
2892 // Store list of section format options defined in each used course format.
2893 // They do not depend on particular course but only on its format.
2894 self
::$sectionformatoptions[$course->format
] =
2895 course_get_format($course)->section_format_options();
2897 foreach (self
::$sectionformatoptions[$course->format
] as $field => $option) {
2898 if (!empty($option['cache'])) {
2899 if (isset($data->{$field})) {
2900 $this->cachedformatoptions
[$field] = $data->{$field};
2901 } else if (array_key_exists('cachedefault', $option)) {
2902 $this->cachedformatoptions
[$field] = $option['cachedefault'];
2909 * Magic method to check if the property is set
2911 * @param string $name name of the property
2914 public function __isset($name) {
2915 if (method_exists($this, 'get_'.$name) ||
2916 property_exists($this, '_'.$name) ||
2917 array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
2918 $value = $this->__get($name);
2919 return isset($value);
2925 * Magic method to check if the property is empty
2927 * @param string $name name of the property
2930 public function __empty($name) {
2931 if (method_exists($this, 'get_'.$name) ||
2932 property_exists($this, '_'.$name) ||
2933 array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
2934 $value = $this->__get($name);
2935 return empty($value);
2941 * Magic method to retrieve the property, this is either basic section property
2942 * or availability information or additional properties added by course format
2944 * @param string $name name of the property
2947 public function __get($name) {
2948 if (method_exists($this, 'get_'.$name)) {
2949 return $this->{'get_'.$name}();
2951 if (property_exists($this, '_'.$name)) {
2952 return $this->{'_'.$name};
2954 if (array_key_exists($name, $this->cachedformatoptions
)) {
2955 return $this->cachedformatoptions
[$name];
2957 // precheck if the option is defined in format to avoid unnecessary DB queries in get_format_options()
2958 if (array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
2959 $formatoptions = course_get_format($this->modinfo
->get_course())->get_format_options($this);
2960 return $formatoptions[$name];
2962 debugging('Invalid section_info property accessed! '.$name);
2967 * Finds whether this section is available at the moment for the current user.
2969 * The value can be accessed publicly as $sectioninfo->available, but can be called directly if there
2970 * is a case when it might be called recursively (you can't call property values recursively).
2974 public function get_available() {
2976 $userid = $this->modinfo
->get_user_id();
2977 if ($this->_available
!== null ||
$userid == -1) {
2978 // Has already been calculated or does not need calculation.
2979 return $this->_available
;
2981 $this->_available
= true;
2982 $this->_availableinfo
= '';
2983 if (!empty($CFG->enableavailability
)) {
2984 // Get availability information.
2985 $ci = new \core_availability\
info_section($this);
2986 $this->_available
= $ci->is_available($this->_availableinfo
, true,
2987 $userid, $this->modinfo
);
2989 // Execute the hook from the course format that may override the available/availableinfo properties.
2990 $currentavailable = $this->_available
;
2991 course_get_format($this->modinfo
->get_course())->
2992 section_get_available_hook($this, $this->_available
, $this->_availableinfo
);
2993 if (!$currentavailable && $this->_available
) {
2994 debugging('section_get_available_hook() can not make unavailable section available', DEBUG_DEVELOPER
);
2995 $this->_available
= $currentavailable;
2997 return $this->_available
;
3001 * Returns the availability text shown next to the section on course page.
3005 private function get_availableinfo() {
3006 // Calling get_available() will also fill the availableinfo property
3007 // (or leave it null if there is no userid).
3008 $this->get_available();
3009 return $this->_availableinfo
;
3013 * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
3014 * and use {@link convert_to_array()}
3016 * @return ArrayIterator
3018 public function getIterator() {
3020 foreach (get_object_vars($this) as $key => $value) {
3021 if (substr($key, 0, 1) == '_') {
3022 if (method_exists($this, 'get'.$key)) {
3023 $ret[substr($key, 1)] = $this->{'get'.$key}();
3025 $ret[substr($key, 1)] = $this->$key;
3029 $ret['sequence'] = $this->get_sequence();
3030 $ret['course'] = $this->get_course();
3031 $ret = array_merge($ret, course_get_format($this->modinfo
->get_course())->get_format_options($this->_section
));
3032 return new ArrayIterator($ret);
3036 * Works out whether activity is visible *for current user* - if this is false, they
3037 * aren't allowed to access it.
3041 private function get_uservisible() {
3042 $userid = $this->modinfo
->get_user_id();
3043 if ($this->_uservisible
!== null ||
$userid == -1) {
3044 // Has already been calculated or does not need calculation.
3045 return $this->_uservisible
;
3047 $this->_uservisible
= true;
3048 if (!$this->_visible ||
!$this->get_available()) {
3049 $coursecontext = context_course
::instance($this->get_course());
3050 if (!$this->_visible
&& !has_capability('moodle/course:viewhiddensections', $coursecontext, $userid) ||
3051 (!$this->get_available() &&
3052 !has_capability('moodle/course:ignoreavailabilityrestrictions', $coursecontext, $userid))) {
3054 $this->_uservisible
= false;
3057 return $this->_uservisible
;
3061 * Restores the course_sections.sequence value
3065 private function get_sequence() {
3066 if (!empty($this->modinfo
->sections
[$this->_section
])) {
3067 return implode(',', $this->modinfo
->sections
[$this->_section
]);
3074 * Returns course ID - from course_sections table
3078 private function get_course() {
3079 return $this->modinfo
->get_course_id();
3085 * @return course_modinfo
3087 private function get_modinfo() {
3088 return $this->modinfo
;
3092 * Prepares section data for inclusion in sectioncache cache, removing items
3093 * that are set to defaults, and adding availability data if required.
3095 * Called by build_section_cache in course_modinfo only; do not use otherwise.
3096 * @param object $section Raw section data object
3098 public static function convert_for_section_cache($section) {
3101 // Course id stored in course table
3102 unset($section->course
);
3103 // Section number stored in array key
3104 unset($section->section
);
3105 // Sequence stored implicity in modinfo $sections array
3106 unset($section->sequence
);
3108 // Remove default data
3109 foreach (self
::$sectioncachedefaults as $field => $value) {
3110 // Exact compare as strings to avoid problems if some strings are set
3112 if (isset($section->{$field}) && $section->{$field} === $value) {
3113 unset($section->{$field});