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
= get_array_of_activities($course->id
);
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;
684 * Data about a single module on a course. This contains most of the fields in the course_modules
685 * table, plus additional data when required.
687 * The object can be accessed by core or any plugin (i.e. course format, block, filter, etc.) as
688 * get_fast_modinfo($courseorid)->cms[$coursemoduleid]
690 * get_fast_modinfo($courseorid)->instances[$moduletype][$instanceid]
692 * There are three stages when activity module can add/modify data in this object:
694 * <b>Stage 1 - during building the cache.</b>
695 * Allows to add to the course cache static user-independent information about the module.
696 * Modules should try to include only absolutely necessary information that may be required
697 * when displaying course view page. The information is stored in application-level cache
698 * and reset when {@link rebuild_course_cache()} is called or cache is purged by admin.
700 * Modules can implement callback XXX_get_coursemodule_info() returning instance of object
701 * {@link cached_cm_info}
703 * <b>Stage 2 - dynamic data.</b>
704 * Dynamic data is user-dependend, it is stored in request-level cache. To reset this cache
705 * {@link get_fast_modinfo()} with $reset argument may be called.
707 * Dynamic data is obtained when any of the following properties/methods is requested:
708 * - {@link cm_info::$url}
709 * - {@link cm_info::$name}
710 * - {@link cm_info::$onclick}
711 * - {@link cm_info::get_icon_url()}
712 * - {@link cm_info::$uservisible}
713 * - {@link cm_info::$available}
714 * - {@link cm_info::$availableinfo}
715 * - plus any of the properties listed in Stage 3.
717 * Modules can implement callback <b>XXX_cm_info_dynamic()</b> and inside this callback they
718 * are allowed to use any of the following set methods:
719 * - {@link cm_info::set_available()}
720 * - {@link cm_info::set_name()}
721 * - {@link cm_info::set_no_view_link()}
722 * - {@link cm_info::set_user_visible()}
723 * - {@link cm_info::set_on_click()}
724 * - {@link cm_info::set_icon_url()}
725 * Any methods affecting view elements can also be set in this callback.
727 * <b>Stage 3 (view data).</b>
728 * Also user-dependend data stored in request-level cache. Second stage is created
729 * because populating the view data can be expensive as it may access much more
730 * Moodle APIs such as filters, user information, output renderers and we
731 * don't want to request it until necessary.
732 * View data is obtained when any of the following properties/methods is requested:
733 * - {@link cm_info::$afterediticons}
734 * - {@link cm_info::$content}
735 * - {@link cm_info::get_formatted_content()}
736 * - {@link cm_info::$extraclasses}
737 * - {@link cm_info::$afterlink}
739 * Modules can implement callback <b>XXX_cm_info_view()</b> and inside this callback they
740 * are allowed to use any of the following set methods:
741 * - {@link cm_info::set_after_edit_icons()}
742 * - {@link cm_info::set_after_link()}
743 * - {@link cm_info::set_content()}
744 * - {@link cm_info::set_extra_classes()}
746 * @property-read int $id Course-module ID - from course_modules table
747 * @property-read int $instance Module instance (ID within module table) - from course_modules table
748 * @property-read int $course Course ID - from course_modules table
749 * @property-read string $idnumber 'ID number' from course-modules table (arbitrary text set by user) - from
750 * course_modules table
751 * @property-read int $added Time that this course-module was added (unix time) - from course_modules table
752 * @property-read int $visible Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
753 * course_modules table
754 * @property-read int $visibleoncoursepage Visible on course page setting - from course_modules table, adjusted to
755 * whether course format allows this module to have the "stealth" mode
756 * @property-read int $visibleold Old visible setting (if the entire section is hidden, the previous value for
757 * visible is stored in this field) - from course_modules table
758 * @property-read int $groupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
759 * course_modules table. Use {@link cm_info::$effectivegroupmode} to find the actual group mode that may be forced by course.
760 * @property-read int $groupingid Grouping ID (0 = all groupings)
761 * @property-read bool $coursegroupmodeforce Indicates whether the course containing the module has forced the groupmode
762 * This means that cm_info::$groupmode should be ignored and cm_info::$coursegroupmode be used instead
763 * @property-read int $coursegroupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
764 * course table - as specified for the course containing the module
765 * Effective only if {@link cm_info::$coursegroupmodeforce} is set
766 * @property-read int $effectivegroupmode Effective group mode for this module (one of the constants NOGROUPS, SEPARATEGROUPS,
767 * or VISIBLEGROUPS). This can be different from groupmode set for the module if the groupmode is forced for the course.
768 * This value will always be NOGROUPS if module type does not support group mode.
769 * @property-read int $indent Indent level on course page (0 = no indent) - from course_modules table
770 * @property-read int $completion Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
771 * course_modules table
772 * @property-read mixed $completiongradeitemnumber Set to the item number (usually 0) if completion depends on a particular
773 * grade of this activity, or null if completion does not depend on a grade - from course_modules table
774 * @property-read int $completionview 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
775 * @property-read int $completionexpected Set to a unix time if completion of this activity is expected at a
776 * particular time, 0 if no time set - from course_modules table
777 * @property-read string $availability Availability information as JSON string or null if none -
778 * from course_modules table
779 * @property-read int $showdescription Controls whether the description of the activity displays on the course main page (in
780 * addition to anywhere it might display within the activity itself). 0 = do not show
781 * on main page, 1 = show on main page.
782 * @property-read string $extra (deprecated) Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
783 * course page - from cached data in modinfo field. Deprecated, replaced by ->extraclasses and ->onclick
784 * @property-read string $icon Name of icon to use - from cached data in modinfo field
785 * @property-read string $iconcomponent Component that contains icon - from cached data in modinfo field
786 * @property-read string $modname Name of module e.g. 'forum' (this is the same name as the module's main database
787 * table) - from cached data in modinfo field
788 * @property-read int $module ID of module type - from course_modules table
789 * @property-read string $name Name of module instance for display on page e.g. 'General discussion forum' - from cached
790 * data in modinfo field
791 * @property-read int $sectionnum Section number that this course-module is in (section 0 = above the calendar, section 1
792 * = week/topic 1, etc) - from cached data in modinfo field
793 * @property-read int $section Section id - from course_modules table
794 * @property-read array $conditionscompletion Availability conditions for this course-module based on the completion of other
795 * course-modules (array from other course-module id to required completion state for that
796 * module) - from cached data in modinfo field
797 * @property-read array $conditionsgrade Availability conditions for this course-module based on course grades (array from
798 * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
799 * @property-read array $conditionsfield Availability conditions for this course-module based on user fields
800 * @property-read bool $available True if this course-module is available to students i.e. if all availability conditions
801 * are met - obtained dynamically
802 * @property-read string $availableinfo If course-module is not available to students, this string gives information about
803 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
804 * January 2010') for display on main page - obtained dynamically
805 * @property-read bool $uservisible True if this course-module is available to the CURRENT user (for example, if current user
806 * has viewhiddenactivities capability, they can access the course-module even if it is not
807 * visible or not available, so this would be true in that case)
808 * @property-read context_module $context Module context
809 * @property-read string $modfullname Returns a localised human-readable name of the module type - calculated on request
810 * @property-read string $modplural Returns a localised human-readable name of the module type in plural form - calculated on request
811 * @property-read string $content Content to display on main (view) page - calculated on request
812 * @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
813 * @property-read string $extraclasses Extra CSS classes to add to html output for this activity on main page - calculated on request
814 * @property-read string $onclick Content of HTML on-click attribute already escaped - calculated on request
815 * @property-read mixed $customdata Optional custom data stored in modinfo cache for this activity, or null if none
816 * @property-read string $afterlink Extra HTML code to display after link - calculated on request
817 * @property-read string $afterediticons Extra HTML code to display after editing icons (e.g. more icons) - calculated on request
818 * @property-read bool $deletioninprogress True if this course module is scheduled for deletion, false otherwise.
820 class cm_info
implements IteratorAggregate
{
822 * State: Only basic data from modinfo cache is available.
824 const STATE_BASIC
= 0;
827 * State: In the process of building dynamic data (to avoid recursive calls to obtain_dynamic_data())
829 const STATE_BUILDING_DYNAMIC
= 1;
832 * State: Dynamic data is available too.
834 const STATE_DYNAMIC
= 2;
837 * State: In the process of building view data (to avoid recursive calls to obtain_view_data())
839 const STATE_BUILDING_VIEW
= 3;
842 * State: View data (for course page) is available.
844 const STATE_VIEW
= 4;
848 * @var course_modinfo
853 * Level of information stored inside this object (STATE_xx constant)
859 * Course-module ID - from course_modules table
865 * Module instance (ID within module table) - from course_modules table
871 * 'ID number' from course-modules table (arbitrary text set by user) - from
872 * course_modules table
878 * Time that this course-module was added (unix time) - from course_modules table
884 * This variable is not used and is included here only so it can be documented.
885 * Once the database entry is removed from course_modules, it should be deleted
888 * @deprecated Do not use this variable
893 * Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
894 * course_modules table
900 * Visible on course page setting - from course_modules table
903 private $visibleoncoursepage;
906 * Old visible setting (if the entire section is hidden, the previous value for
907 * visible is stored in this field) - from course_modules table
913 * Group mode (one of the constants NONE, SEPARATEGROUPS, or VISIBLEGROUPS) - from
914 * course_modules table
920 * Grouping ID (0 = all groupings)
926 * Indent level on course page (0 = no indent) - from course_modules table
932 * Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
933 * course_modules table
939 * Set to the item number (usually 0) if completion depends on a particular
940 * grade of this activity, or null if completion does not depend on a grade - from
941 * course_modules table
944 private $completiongradeitemnumber;
947 * 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
950 private $completionview;
953 * Set to a unix time if completion of this activity is expected at a
954 * particular time, 0 if no time set - from course_modules table
957 private $completionexpected;
960 * Availability information as JSON string or null if none - from course_modules table
963 private $availability;
966 * Controls whether the description of the activity displays on the course main page (in
967 * addition to anywhere it might display within the activity itself). 0 = do not show
968 * on main page, 1 = show on main page.
971 private $showdescription;
974 * Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
975 * course page - from cached data in modinfo field
976 * @deprecated This is crazy, don't use it. Replaced by ->extraclasses and ->onclick
982 * Name of icon to use - from cached data in modinfo field
988 * Component that contains icon - from cached data in modinfo field
991 private $iconcomponent;
994 * Name of module e.g. 'forum' (this is the same name as the module's main database
995 * table) - from cached data in modinfo field
1001 * ID of module - from course_modules table
1007 * Name of module instance for display on page e.g. 'General discussion forum' - from cached
1008 * data in modinfo field
1014 * Section number that this course-module is in (section 0 = above the calendar, section 1
1015 * = week/topic 1, etc) - from cached data in modinfo field
1018 private $sectionnum;
1021 * Section id - from course_modules table
1027 * Availability conditions for this course-module based on the completion of other
1028 * course-modules (array from other course-module id to required completion state for that
1029 * module) - from cached data in modinfo field
1032 private $conditionscompletion;
1035 * Availability conditions for this course-module based on course grades (array from
1036 * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
1039 private $conditionsgrade;
1042 * Availability conditions for this course-module based on user fields
1045 private $conditionsfield;
1048 * True if this course-module is available to students i.e. if all availability conditions
1049 * are met - obtained dynamically
1055 * If course-module is not available to students, this string gives information about
1056 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
1057 * January 2010') for display on main page - obtained dynamically
1060 private $availableinfo;
1063 * True if this course-module is available to the CURRENT user (for example, if current user
1064 * has viewhiddenactivities capability, they can access the course-module even if it is not
1065 * visible or not available, so this would be true in that case)
1068 private $uservisible;
1071 * True if this course-module is visible to the CURRENT user on the course page
1074 private $uservisibleoncoursepage;
1089 private $contentisformatted;
1094 private $extraclasses;
1097 * @var moodle_url full external url pointing to icon image for activity
1109 private $customdata;
1119 private $afterediticons;
1122 * @var bool representing the deletion state of the module. True if the mod is scheduled for deletion.
1124 private $deletioninprogress;
1127 * List of class read-only properties and their getter methods.
1128 * Used by magic functions __get(), __isset(), __empty()
1131 private static $standardproperties = array(
1133 'content' => 'get_content',
1134 'extraclasses' => 'get_extra_classes',
1135 'onclick' => 'get_on_click',
1136 'customdata' => 'get_custom_data',
1137 'afterlink' => 'get_after_link',
1138 'afterediticons' => 'get_after_edit_icons',
1139 'modfullname' => 'get_module_type_name',
1140 'modplural' => 'get_module_type_name_plural',
1143 'availability' => false,
1144 'available' => 'get_available',
1145 'availableinfo' => 'get_available_info',
1146 'completion' => false,
1147 'completionexpected' => false,
1148 'completiongradeitemnumber' => false,
1149 'completionview' => false,
1150 'conditionscompletion' => false,
1151 'conditionsfield' => false,
1152 'conditionsgrade' => false,
1153 'context' => 'get_context',
1154 'course' => 'get_course_id',
1155 'coursegroupmode' => 'get_course_groupmode',
1156 'coursegroupmodeforce' => 'get_course_groupmodeforce',
1157 'effectivegroupmode' => 'get_effective_groupmode',
1159 'groupingid' => false,
1160 'groupmembersonly' => 'get_deprecated_group_members_only',
1161 'groupmode' => false,
1163 'iconcomponent' => false,
1164 'idnumber' => false,
1166 'instance' => false,
1169 'name' => 'get_name',
1172 'sectionnum' => false,
1173 'showdescription' => false,
1174 'uservisible' => 'get_user_visible',
1176 'visibleoncoursepage' => false,
1177 'visibleold' => false,
1178 'deletioninprogress' => false
1182 * List of methods with no arguments that were public prior to Moodle 2.6.
1184 * They can still be accessed publicly via magic __call() function with no warnings
1185 * but are not listed in the class methods list.
1186 * For the consistency of the code it is better to use corresponding properties.
1188 * These methods be deprecated completely in later versions.
1190 * @var array $standardmethods
1192 private static $standardmethods = array(
1193 // Following methods are not recommended to use because there have associated read-only properties.
1196 'get_extra_classes',
1200 'get_after_edit_icons',
1201 // Method obtain_dynamic_data() should not be called from outside of this class but it was public before Moodle 2.6.
1202 'obtain_dynamic_data',
1206 * Magic method to call functions that are now declared as private but were public in Moodle before 2.6.
1207 * These private methods can not be used anymore.
1209 * @param string $name
1210 * @param array $arguments
1212 * @throws coding_exception
1214 public function __call($name, $arguments) {
1215 if (in_array($name, self
::$standardmethods)) {
1216 $message = "cm_info::$name() can not be used anymore.";
1217 if ($alternative = array_search($name, self
::$standardproperties)) {
1218 $message .= " Please use the property cm_info->$alternative instead.";
1220 throw new coding_exception($message);
1222 throw new coding_exception("Method cm_info::{$name}() does not exist");
1226 * Magic method getter
1228 * @param string $name
1231 public function __get($name) {
1232 if (isset(self
::$standardproperties[$name])) {
1233 if ($method = self
::$standardproperties[$name]) {
1234 return $this->$method();
1236 return $this->$name;
1239 debugging('Invalid cm_info property accessed: '.$name);
1245 * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
1246 * and use {@link convert_to_array()}
1248 * @return ArrayIterator
1250 public function getIterator() {
1251 // Make sure dynamic properties are retrieved prior to view properties.
1252 $this->obtain_dynamic_data();
1255 // Do not iterate over deprecated properties.
1256 $props = self
::$standardproperties;
1257 unset($props['groupmembersonly']);
1259 foreach ($props as $key => $unused) {
1260 $ret[$key] = $this->__get($key);
1262 return new ArrayIterator($ret);
1266 * Magic method for function isset()
1268 * @param string $name
1271 public function __isset($name) {
1272 if (isset(self
::$standardproperties[$name])) {
1273 $value = $this->__get($name);
1274 return isset($value);
1280 * Magic method for function empty()
1282 * @param string $name
1285 public function __empty($name) {
1286 if (isset(self
::$standardproperties[$name])) {
1287 $value = $this->__get($name);
1288 return empty($value);
1294 * Magic method setter
1296 * Will display the developer warning when trying to set/overwrite property.
1298 * @param string $name
1299 * @param mixed $value
1301 public function __set($name, $value) {
1302 debugging("It is not allowed to set the property cm_info::\${$name}", DEBUG_DEVELOPER
);
1306 * @return bool True if this module has a 'view' page that should be linked to in navigation
1307 * etc (note: modules may still have a view.php file, but return false if this is not
1308 * intended to be linked to from 'normal' parts of the interface; this is what label does).
1310 public function has_view() {
1311 return !is_null($this->url
);
1315 * Gets the URL to link to for this module.
1317 * This method is normally called by the property ->url, but can be called directly if
1318 * there is a case when it might be called recursively (you can't call property values
1321 * @return moodle_url URL to link to for this module, or null if it doesn't have a view page
1323 public function get_url() {
1324 $this->obtain_dynamic_data();
1329 * Obtains content to display on main (view) page.
1330 * Note: Will collect view data, if not already obtained.
1331 * @return string Content to display on main page below link, or empty string if none
1333 private function get_content() {
1334 $this->obtain_view_data();
1335 return $this->content
;
1339 * Returns the content to display on course/overview page, formatted and passed through filters
1341 * if $options['context'] is not specified, the module context is used
1343 * @param array|stdClass $options formatting options, see {@link format_text()}
1346 public function get_formatted_content($options = array()) {
1347 $this->obtain_view_data();
1348 if (empty($this->content
)) {
1351 if ($this->contentisformatted
) {
1352 return $this->content
;
1355 // Improve filter performance by preloading filter setttings for all
1356 // activities on the course (this does nothing if called multiple
1358 filter_preload_activities($this->get_modinfo());
1360 $options = (array)$options;
1361 if (!isset($options['context'])) {
1362 $options['context'] = $this->get_context();
1364 return format_text($this->content
, FORMAT_HTML
, $options);
1368 * Getter method for property $name, ensures that dynamic data is obtained.
1370 * This method is normally called by the property ->name, but can be called directly if there
1371 * is a case when it might be called recursively (you can't call property values recursively).
1375 public function get_name() {
1376 $this->obtain_dynamic_data();
1381 * Returns the name to display on course/overview page, formatted and passed through filters
1383 * if $options['context'] is not specified, the module context is used
1385 * @param array|stdClass $options formatting options, see {@link format_string()}
1388 public function get_formatted_name($options = array()) {
1390 $options = (array)$options;
1391 if (!isset($options['context'])) {
1392 $options['context'] = $this->get_context();
1394 // Improve filter performance by preloading filter setttings for all
1395 // activities on the course (this does nothing if called multiple
1397 if (!empty($CFG->filterall
)) {
1398 filter_preload_activities($this->get_modinfo());
1400 return format_string($this->get_name(), true, $options);
1404 * Note: Will collect view data, if not already obtained.
1405 * @return string Extra CSS classes to add to html output for this activity on main page
1407 private function get_extra_classes() {
1408 $this->obtain_view_data();
1409 return $this->extraclasses
;
1413 * @return string Content of HTML on-click attribute. This string will be used literally
1414 * as a string so should be pre-escaped.
1416 private function get_on_click() {
1417 // Does not need view data; may be used by navigation
1418 $this->obtain_dynamic_data();
1419 return $this->onclick
;
1422 * @return mixed Optional custom data stored in modinfo cache for this activity, or null if none
1424 private function get_custom_data() {
1425 return $this->customdata
;
1429 * Note: Will collect view data, if not already obtained.
1430 * @return string Extra HTML code to display after link
1432 private function get_after_link() {
1433 $this->obtain_view_data();
1434 return $this->afterlink
;
1438 * Note: Will collect view data, if not already obtained.
1439 * @return string Extra HTML code to display after editing icons (e.g. more icons)
1441 private function get_after_edit_icons() {
1442 $this->obtain_view_data();
1443 return $this->afterediticons
;
1447 * @param moodle_core_renderer $output Output render to use, or null for default (global)
1448 * @return moodle_url Icon URL for a suitable icon to put beside this cm
1450 public function get_icon_url($output = null) {
1452 $this->obtain_dynamic_data();
1456 // Support modules setting their own, external, icon image
1457 if (!empty($this->iconurl
)) {
1458 $icon = $this->iconurl
;
1460 // Fallback to normal local icon + component procesing
1461 } else if (!empty($this->icon
)) {
1462 if (substr($this->icon
, 0, 4) === 'mod/') {
1463 list($modname, $iconname) = explode('/', substr($this->icon
, 4), 2);
1464 $icon = $output->image_url($iconname, $modname);
1466 if (!empty($this->iconcomponent
)) {
1467 // Icon has specified component
1468 $icon = $output->image_url($this->icon
, $this->iconcomponent
);
1470 // Icon does not have specified component, use default
1471 $icon = $output->image_url($this->icon
);
1475 $icon = $output->image_url('icon', $this->modname
);
1481 * @param string $textclasses additionnal classes for grouping label
1482 * @return string An empty string or HTML grouping label span tag
1484 public function get_grouping_label($textclasses = '') {
1485 $groupinglabel = '';
1486 if ($this->effectivegroupmode
!= NOGROUPS
&& !empty($this->groupingid
) &&
1487 has_capability('moodle/course:managegroups', context_course
::instance($this->course
))) {
1488 $groupings = groups_get_all_groupings($this->course
);
1489 $groupinglabel = html_writer
::tag('span', '('.format_string($groupings[$this->groupingid
]->name
).')',
1490 array('class' => 'groupinglabel '.$textclasses));
1492 return $groupinglabel;
1496 * Returns a localised human-readable name of the module type
1498 * @param bool $plural return plural form
1501 public function get_module_type_name($plural = false) {
1502 $modnames = get_module_types_names($plural);
1503 if (isset($modnames[$this->modname
])) {
1504 return $modnames[$this->modname
];
1511 * Returns a localised human-readable name of the module type in plural form - calculated on request
1515 private function get_module_type_name_plural() {
1516 return $this->get_module_type_name(true);
1520 * @return course_modinfo Modinfo object that this came from
1522 public function get_modinfo() {
1523 return $this->modinfo
;
1527 * Returns the section this module belongs to
1529 * @return section_info
1531 public function get_section_info() {
1532 return $this->modinfo
->get_section_info($this->sectionnum
);
1536 * Returns course object that was used in the first {@link get_fast_modinfo()} call.
1538 * It may not contain all fields from DB table {course} but always has at least the following:
1539 * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
1541 * If the course object lacks the field you need you can use the global
1542 * function {@link get_course()} that will save extra query if you access
1543 * current course or frontpage course.
1547 public function get_course() {
1548 return $this->modinfo
->get_course();
1552 * Returns course id for which the modinfo was generated.
1556 private function get_course_id() {
1557 return $this->modinfo
->get_course_id();
1561 * Returns group mode used for the course containing the module
1563 * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1565 private function get_course_groupmode() {
1566 return $this->modinfo
->get_course()->groupmode
;
1570 * Returns whether group mode is forced for the course containing the module
1574 private function get_course_groupmodeforce() {
1575 return $this->modinfo
->get_course()->groupmodeforce
;
1579 * Returns effective groupmode of the module that may be overwritten by forced course groupmode.
1581 * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1583 private function get_effective_groupmode() {
1584 $groupmode = $this->groupmode
;
1585 if ($this->modinfo
->get_course()->groupmodeforce
) {
1586 $groupmode = $this->modinfo
->get_course()->groupmode
;
1587 if ($groupmode != NOGROUPS
&& !plugin_supports('mod', $this->modname
, FEATURE_GROUPS
, false)) {
1588 $groupmode = NOGROUPS
;
1595 * @return context_module Current module context
1597 private function get_context() {
1598 return context_module
::instance($this->id
);
1602 * Returns itself in the form of stdClass.
1604 * The object includes all fields that table course_modules has and additionally
1605 * fields 'name', 'modname', 'sectionnum' (if requested).
1607 * This can be used as a faster alternative to {@link get_coursemodule_from_id()}
1609 * @param bool $additionalfields include additional fields 'name', 'modname', 'sectionnum'
1612 public function get_course_module_record($additionalfields = false) {
1613 $cmrecord = new stdClass();
1615 // Standard fields from table course_modules.
1616 static $cmfields = array('id', 'course', 'module', 'instance', 'section', 'idnumber', 'added',
1617 'score', 'indent', 'visible', 'visibleoncoursepage', 'visibleold', 'groupmode', 'groupingid',
1618 'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected',
1619 'showdescription', 'availability', 'deletioninprogress');
1620 foreach ($cmfields as $key) {
1621 $cmrecord->$key = $this->$key;
1624 // Additional fields that function get_coursemodule_from_id() adds.
1625 if ($additionalfields) {
1626 $cmrecord->name
= $this->name
;
1627 $cmrecord->modname
= $this->modname
;
1628 $cmrecord->sectionnum
= $this->sectionnum
;
1638 * Sets content to display on course view page below link (if present).
1639 * @param string $content New content as HTML string (empty string if none)
1640 * @param bool $isformatted Whether user content is already passed through format_text/format_string and should not
1641 * be formatted again. This can be useful when module adds interactive elements on top of formatted user text.
1644 public function set_content($content, $isformatted = false) {
1645 $this->content
= $content;
1646 $this->contentisformatted
= $isformatted;
1650 * Sets extra classes to include in CSS.
1651 * @param string $extraclasses Extra classes (empty string if none)
1654 public function set_extra_classes($extraclasses) {
1655 $this->extraclasses
= $extraclasses;
1659 * Sets the external full url that points to the icon being used
1660 * by the activity. Useful for external-tool modules (lti...)
1661 * If set, takes precedence over $icon and $iconcomponent
1663 * @param moodle_url $iconurl full external url pointing to icon image for activity
1666 public function set_icon_url(moodle_url
$iconurl) {
1667 $this->iconurl
= $iconurl;
1671 * Sets value of on-click attribute for JavaScript.
1672 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1673 * @param string $onclick New onclick attribute which should be HTML-escaped
1674 * (empty string if none)
1677 public function set_on_click($onclick) {
1678 $this->check_not_view_only();
1679 $this->onclick
= $onclick;
1683 * Sets HTML that displays after link on course view page.
1684 * @param string $afterlink HTML string (empty string if none)
1687 public function set_after_link($afterlink) {
1688 $this->afterlink
= $afterlink;
1692 * Sets HTML that displays after edit icons on course view page.
1693 * @param string $afterediticons HTML string (empty string if none)
1696 public function set_after_edit_icons($afterediticons) {
1697 $this->afterediticons
= $afterediticons;
1701 * Changes the name (text of link) for this module instance.
1702 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1703 * @param string $name Name of activity / link text
1706 public function set_name($name) {
1707 if ($this->state
< self
::STATE_BUILDING_DYNAMIC
) {
1708 $this->update_user_visible();
1710 $this->name
= $name;
1714 * Turns off the view link for this module instance.
1715 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1718 public function set_no_view_link() {
1719 $this->check_not_view_only();
1724 * Sets the 'uservisible' flag. This can be used (by setting false) to prevent access and
1725 * display of this module link for the current user.
1726 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1727 * @param bool $uservisible
1730 public function set_user_visible($uservisible) {
1731 $this->check_not_view_only();
1732 $this->uservisible
= $uservisible;
1736 * Sets the 'available' flag and related details. This flag is normally used to make
1737 * course modules unavailable until a certain date or condition is met. (When a course
1738 * module is unavailable, it is still visible to users who have viewhiddenactivities
1741 * When this is function is called, user-visible status is recalculated automatically.
1743 * The $showavailability flag does not really do anything any more, but is retained
1744 * for backward compatibility. Setting this to false will cause $availableinfo to
1747 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1748 * @param bool $available False if this item is not 'available'
1749 * @param int $showavailability 0 = do not show this item at all if it's not available,
1750 * 1 = show this item greyed out with the following message
1751 * @param string $availableinfo Information about why this is not available, or
1752 * empty string if not displaying
1755 public function set_available($available, $showavailability=0, $availableinfo='') {
1756 $this->check_not_view_only();
1757 $this->available
= $available;
1758 if (!$showavailability) {
1759 $availableinfo = '';
1761 $this->availableinfo
= $availableinfo;
1762 $this->update_user_visible();
1766 * Some set functions can only be called from _cm_info_dynamic and not _cm_info_view.
1767 * This is because they may affect parts of this object which are used on pages other
1768 * than the view page (e.g. in the navigation block, or when checking access on
1772 private function check_not_view_only() {
1773 if ($this->state
>= self
::STATE_DYNAMIC
) {
1774 throw new coding_exception('Cannot set this data from _cm_info_view because it may ' .
1775 'affect other pages as well as view');
1780 * Constructor should not be called directly; use {@link get_fast_modinfo()}
1782 * @param course_modinfo $modinfo Parent object
1783 * @param stdClass $notused1 Argument not used
1784 * @param stdClass $mod Module object from the modinfo field of course table
1785 * @param stdClass $notused2 Argument not used
1787 public function __construct(course_modinfo
$modinfo, $notused1, $mod, $notused2) {
1788 $this->modinfo
= $modinfo;
1790 $this->id
= $mod->cm
;
1791 $this->instance
= $mod->id
;
1792 $this->modname
= $mod->mod
;
1793 $this->idnumber
= isset($mod->idnumber
) ?
$mod->idnumber
: '';
1794 $this->name
= $mod->name
;
1795 $this->visible
= $mod->visible
;
1796 $this->visibleoncoursepage
= $mod->visibleoncoursepage
;
1797 $this->sectionnum
= $mod->section
; // Note weirdness with name here
1798 $this->groupmode
= isset($mod->groupmode
) ?
$mod->groupmode
: 0;
1799 $this->groupingid
= isset($mod->groupingid
) ?
$mod->groupingid
: 0;
1800 $this->indent
= isset($mod->indent
) ?
$mod->indent
: 0;
1801 $this->extra
= isset($mod->extra
) ?
$mod->extra
: '';
1802 $this->extraclasses
= isset($mod->extraclasses
) ?
$mod->extraclasses
: '';
1803 // iconurl may be stored as either string or instance of moodle_url.
1804 $this->iconurl
= isset($mod->iconurl
) ?
new moodle_url($mod->iconurl
) : '';
1805 $this->onclick
= isset($mod->onclick
) ?
$mod->onclick
: '';
1806 $this->content
= isset($mod->content
) ?
$mod->content
: '';
1807 $this->icon
= isset($mod->icon
) ?
$mod->icon
: '';
1808 $this->iconcomponent
= isset($mod->iconcomponent
) ?
$mod->iconcomponent
: '';
1809 $this->customdata
= isset($mod->customdata
) ?
$mod->customdata
: '';
1810 $this->showdescription
= isset($mod->showdescription
) ?
$mod->showdescription
: 0;
1811 $this->state
= self
::STATE_BASIC
;
1813 $this->section
= isset($mod->sectionid
) ?
$mod->sectionid
: 0;
1814 $this->module
= isset($mod->module
) ?
$mod->module
: 0;
1815 $this->added
= isset($mod->added
) ?
$mod->added
: 0;
1816 $this->score
= isset($mod->score
) ?
$mod->score
: 0;
1817 $this->visibleold
= isset($mod->visibleold
) ?
$mod->visibleold
: 0;
1818 $this->deletioninprogress
= isset($mod->deletioninprogress
) ?
$mod->deletioninprogress
: 0;
1820 // Note: it saves effort and database space to always include the
1821 // availability and completion fields, even if availability or completion
1822 // are actually disabled
1823 $this->completion
= isset($mod->completion
) ?
$mod->completion
: 0;
1824 $this->completiongradeitemnumber
= isset($mod->completiongradeitemnumber
)
1825 ?
$mod->completiongradeitemnumber
: null;
1826 $this->completionview
= isset($mod->completionview
)
1827 ?
$mod->completionview
: 0;
1828 $this->completionexpected
= isset($mod->completionexpected
)
1829 ?
$mod->completionexpected
: 0;
1830 $this->availability
= isset($mod->availability
) ?
$mod->availability
: null;
1831 $this->conditionscompletion
= isset($mod->conditionscompletion
)
1832 ?
$mod->conditionscompletion
: array();
1833 $this->conditionsgrade
= isset($mod->conditionsgrade
)
1834 ?
$mod->conditionsgrade
: array();
1835 $this->conditionsfield
= isset($mod->conditionsfield
)
1836 ?
$mod->conditionsfield
: array();
1838 static $modviews = array();
1839 if (!isset($modviews[$this->modname
])) {
1840 $modviews[$this->modname
] = !plugin_supports('mod', $this->modname
,
1841 FEATURE_NO_VIEW_LINK
);
1843 $this->url
= $modviews[$this->modname
]
1844 ?
new moodle_url('/mod/' . $this->modname
. '/view.php', array('id'=>$this->id
))
1849 * Creates a cm_info object from a database record (also accepts cm_info
1850 * in which case it is just returned unchanged).
1852 * @param stdClass|cm_info|null|bool $cm Stdclass or cm_info (or null or false)
1853 * @param int $userid Optional userid (default to current)
1854 * @return cm_info|null Object as cm_info, or null if input was null/false
1856 public static function create($cm, $userid = 0) {
1857 // Null, false, etc. gets passed through as null.
1861 // If it is already a cm_info object, just return it.
1862 if ($cm instanceof cm_info
) {
1865 // Otherwise load modinfo.
1866 if (empty($cm->id
) ||
empty($cm->course
)) {
1867 throw new coding_exception('$cm must contain ->id and ->course');
1869 $modinfo = get_fast_modinfo($cm->course
, $userid);
1870 return $modinfo->get_cm($cm->id
);
1874 * If dynamic data for this course-module is not yet available, gets it.
1876 * This function is automatically called when requesting any course_modinfo property
1877 * that can be modified by modules (have a set_xxx method).
1879 * Dynamic data is data which does not come directly from the cache but is calculated at
1880 * runtime based on the current user. Primarily this concerns whether the user can access
1881 * the module or not.
1883 * As part of this function, the module's _cm_info_dynamic function from its lib.php will
1884 * be called (if it exists).
1887 private function obtain_dynamic_data() {
1889 $userid = $this->modinfo
->get_user_id();
1890 if ($this->state
>= self
::STATE_BUILDING_DYNAMIC ||
$userid == -1) {
1893 $this->state
= self
::STATE_BUILDING_DYNAMIC
;
1895 if (!empty($CFG->enableavailability
)) {
1896 // Get availability information.
1897 $ci = new \core_availability\
info_module($this);
1899 // Note that the modinfo currently available only includes minimal details (basic data)
1900 // but we know that this function does not need anything more than basic data.
1901 $this->available
= $ci->is_available($this->availableinfo
, true,
1902 $userid, $this->modinfo
);
1904 $this->available
= true;
1907 // Check parent section.
1908 if ($this->available
) {
1909 $parentsection = $this->modinfo
->get_section_info($this->sectionnum
);
1910 if (!$parentsection->available
) {
1911 // Do not store info from section here, as that is already
1912 // presented from the section (if appropriate) - just change
1914 $this->available
= false;
1918 // Update visible state for current user.
1919 $this->update_user_visible();
1921 // Let module make dynamic changes at this point
1922 $this->call_mod_function('cm_info_dynamic');
1923 $this->state
= self
::STATE_DYNAMIC
;
1927 * Getter method for property $uservisible, ensures that dynamic data is retrieved.
1929 * This method is normally called by the property ->uservisible, but can be called directly if
1930 * there is a case when it might be called recursively (you can't call property values
1935 public function get_user_visible() {
1936 $this->obtain_dynamic_data();
1937 return $this->uservisible
;
1941 * Returns whether this module is visible to the current user on course page
1943 * Activity may be visible on the course page but not available, for example
1944 * when it is hidden conditionally but the condition information is displayed.
1948 public function is_visible_on_course_page() {
1949 $this->obtain_dynamic_data();
1950 return $this->uservisibleoncoursepage
;
1954 * Whether this module is available but hidden from course page
1956 * "Stealth" modules are the ones that are not shown on course page but available by following url.
1957 * They are normally also displayed in grade reports and other reports.
1958 * Module will be stealth either if visibleoncoursepage=0 or it is a visible module inside the hidden
1963 public function is_stealth() {
1964 return !$this->visibleoncoursepage ||
1965 ($this->visible
&& ($section = $this->get_section_info()) && !$section->visible
);
1969 * Getter method for property $available, ensures that dynamic data is retrieved
1972 private function get_available() {
1973 $this->obtain_dynamic_data();
1974 return $this->available
;
1978 * This method can not be used anymore.
1980 * @see \core_availability\info_module::filter_user_list()
1981 * @deprecated Since Moodle 2.8
1983 private function get_deprecated_group_members_only() {
1984 throw new coding_exception('$cm->groupmembersonly can not be used anymore. ' .
1985 'If used to restrict a list of enrolled users to only those who can ' .
1986 'access the module, consider \core_availability\info_module::filter_user_list.');
1990 * Getter method for property $availableinfo, ensures that dynamic data is retrieved
1992 * @return string Available info (HTML)
1994 private function get_available_info() {
1995 $this->obtain_dynamic_data();
1996 return $this->availableinfo
;
2000 * Works out whether activity is available to the current user
2002 * If the activity is unavailable, additional checks are required to determine if its hidden or greyed out
2006 private function update_user_visible() {
2007 $userid = $this->modinfo
->get_user_id();
2008 if ($userid == -1) {
2011 $this->uservisible
= true;
2013 // If the module is being deleted, set the uservisible state to false and return.
2014 if ($this->deletioninprogress
) {
2015 $this->uservisible
= false;
2019 // If the user cannot access the activity set the uservisible flag to false.
2020 // Additional checks are required to determine whether the activity is entirely hidden or just greyed out.
2021 if ((!$this->visible
&& !has_capability('moodle/course:viewhiddenactivities', $this->get_context(), $userid)) ||
2022 (!$this->get_available() &&
2023 !has_capability('moodle/course:ignoreavailabilityrestrictions', $this->get_context(), $userid))) {
2025 $this->uservisible
= false;
2028 // Check group membership.
2029 if ($this->is_user_access_restricted_by_capability()) {
2031 $this->uservisible
= false;
2032 // Ensure activity is completely hidden from the user.
2033 $this->availableinfo
= '';
2036 $this->uservisibleoncoursepage
= $this->uservisible
&&
2037 ($this->visibleoncoursepage ||
2038 has_capability('moodle/course:manageactivities', $this->get_context(), $userid) ||
2039 has_capability('moodle/course:activityvisibility', $this->get_context(), $userid));
2040 // Activity that is not available, not hidden from course page and has availability
2041 // info is actually visible on the course page (with availability info and without a link).
2042 if (!$this->uservisible
&& $this->visibleoncoursepage
&& $this->availableinfo
) {
2043 $this->uservisibleoncoursepage
= true;
2048 * This method has been deprecated and should not be used.
2051 * @deprecated Since Moodle 2.8
2053 public function is_user_access_restricted_by_group() {
2054 throw new coding_exception('cm_info::is_user_access_restricted_by_group() can not be used any more.' .
2055 ' Use $cm->uservisible to decide whether the current user can access an activity.');
2059 * Checks whether mod/...:view capability restricts the current user's access.
2061 * @return bool True if the user access is restricted.
2063 public function is_user_access_restricted_by_capability() {
2064 $userid = $this->modinfo
->get_user_id();
2065 if ($userid == -1) {
2068 $capability = 'mod/' . $this->modname
. ':view';
2069 $capabilityinfo = get_capability_info($capability);
2070 if (!$capabilityinfo) {
2071 // Capability does not exist, no one is prevented from seeing the activity.
2075 // You are blocked if you don't have the capability.
2076 return !has_capability($capability, $this->get_context(), $userid);
2080 * Checks whether the module's conditional access settings mean that the
2081 * user cannot see the activity at all
2083 * @deprecated since 2.7 MDL-44070
2085 public function is_user_access_restricted_by_conditional_access() {
2086 throw new coding_exception('cm_info::is_user_access_restricted_by_conditional_access() ' .
2087 'can not be used any more; this function is not needed (use $cm->uservisible ' .
2088 'and $cm->availableinfo to decide whether it should be available ' .
2093 * Calls a module function (if exists), passing in one parameter: this object.
2094 * @param string $type Name of function e.g. if this is 'grooblezorb' and the modname is
2095 * 'forum' then it will try to call 'mod_forum_grooblezorb' or 'forum_grooblezorb'
2098 private function call_mod_function($type) {
2100 $libfile = $CFG->dirroot
. '/mod/' . $this->modname
. '/lib.php';
2101 if (file_exists($libfile)) {
2102 include_once($libfile);
2103 $function = 'mod_' . $this->modname
. '_' . $type;
2104 if (function_exists($function)) {
2107 $function = $this->modname
. '_' . $type;
2108 if (function_exists($function)) {
2116 * If view data for this course-module is not yet available, obtains it.
2118 * This function is automatically called if any of the functions (marked) which require
2119 * view data are called.
2121 * View data is data which is needed only for displaying the course main page (& any similar
2122 * functionality on other pages) but is not needed in general. Obtaining view data may have
2123 * a performance cost.
2125 * As part of this function, the module's _cm_info_view function from its lib.php will
2126 * be called (if it exists).
2129 private function obtain_view_data() {
2130 if ($this->state
>= self
::STATE_BUILDING_VIEW ||
$this->modinfo
->get_user_id() == -1) {
2133 $this->obtain_dynamic_data();
2134 $this->state
= self
::STATE_BUILDING_VIEW
;
2136 // Let module make changes at this point
2137 $this->call_mod_function('cm_info_view');
2138 $this->state
= self
::STATE_VIEW
;
2144 * Returns reference to full info about modules in course (including visibility).
2145 * Cached and as fast as possible (0 or 1 db query).
2147 * use get_fast_modinfo($courseid, 0, true) to reset the static cache for particular course
2148 * use get_fast_modinfo(0, 0, true) to reset the static cache for all courses
2150 * use rebuild_course_cache($courseid, true) to reset the application AND static cache
2151 * for particular course when it's contents has changed
2153 * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
2154 * and recommended to have field 'cacherev') or just a course id. Just course id
2155 * is enough when calling get_fast_modinfo() for current course or site or when
2156 * calling for any other course for the second time.
2157 * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections.
2158 * Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
2159 * @param bool $resetonly whether we want to get modinfo or just reset the cache
2160 * @return course_modinfo|null Module information for course, or null if resetting
2161 * @throws moodle_exception when course is not found (nothing is thrown if resetting)
2163 function get_fast_modinfo($courseorid, $userid = 0, $resetonly = false) {
2164 // compartibility with syntax prior to 2.4:
2165 if ($courseorid === 'reset') {
2166 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
);
2171 // Function get_fast_modinfo() can never be called during upgrade unless it is used for clearing cache only.
2173 upgrade_ensure_not_running();
2176 // Function is called with $reset = true
2178 course_modinfo
::clear_instance_cache($courseorid);
2182 // Function is called with $reset = false, retrieve modinfo
2183 return course_modinfo
::instance($courseorid, $userid);
2187 * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given
2188 * a cmid. If module name is also provided, it will ensure the cm is of that type.
2191 * list($course, $cm) = get_course_and_cm_from_cmid($cmid, 'forum');
2193 * Using this method has a performance advantage because it works by loading
2194 * modinfo for the course - which will then be cached and it is needed later
2195 * in most requests. It also guarantees that the $cm object is a cm_info and
2198 * The $course object can be supplied if already known and will speed
2199 * up this function - although it is more efficient to use this function to
2200 * get the course if you are starting from a cmid.
2202 * To avoid security problems and obscure bugs, you should always specify
2203 * $modulename if the cmid value came from user input.
2205 * By default this obtains information (for example, whether user can access
2206 * the activity) for current user, but you can specify a userid if required.
2208 * @param stdClass|int $cmorid Id of course-module, or database object
2209 * @param string $modulename Optional modulename (improves security)
2210 * @param stdClass|int $courseorid Optional course object if already loaded
2211 * @param int $userid Optional userid (default = current)
2212 * @return array Array with 2 elements $course and $cm
2213 * @throws moodle_exception If the item doesn't exist or is of wrong module name
2215 function get_course_and_cm_from_cmid($cmorid, $modulename = '', $courseorid = 0, $userid = 0) {
2217 if (is_object($cmorid)) {
2218 $cmid = $cmorid->id
;
2219 if (isset($cmorid->course
)) {
2220 $courseid = (int)$cmorid->course
;
2225 $cmid = (int)$cmorid;
2229 // Validate module name if supplied.
2230 if ($modulename && !core_component
::is_valid_plugin_name('mod', $modulename)) {
2231 throw new coding_exception('Invalid modulename parameter');
2234 // Get course from last parameter if supplied.
2236 if (is_object($courseorid)) {
2237 $course = $courseorid;
2238 } else if ($courseorid) {
2239 $courseid = (int)$courseorid;
2244 // If course ID is known, get it using normal function.
2245 $course = get_course($courseid);
2247 // Get course record in a single query based on cmid.
2248 $course = $DB->get_record_sql("
2250 FROM {course_modules} cm
2251 JOIN {course} c ON c.id = cm.course
2252 WHERE cm.id = ?", array($cmid), MUST_EXIST
);
2256 // Get cm from get_fast_modinfo.
2257 $modinfo = get_fast_modinfo($course, $userid);
2258 $cm = $modinfo->get_cm($cmid);
2259 if ($modulename && $cm->modname
!== $modulename) {
2260 throw new moodle_exception('invalidcoursemodule', 'error');
2262 return array($course, $cm);
2266 * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given
2267 * an instance id or record and module name.
2270 * list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
2272 * Using this method has a performance advantage because it works by loading
2273 * modinfo for the course - which will then be cached and it is needed later
2274 * in most requests. It also guarantees that the $cm object is a cm_info and
2277 * The $course object can be supplied if already known and will speed
2278 * up this function - although it is more efficient to use this function to
2279 * get the course if you are starting from an instance id.
2281 * By default this obtains information (for example, whether user can access
2282 * the activity) for current user, but you can specify a userid if required.
2284 * @param stdclass|int $instanceorid Id of module instance, or database object
2285 * @param string $modulename Modulename (required)
2286 * @param stdClass|int $courseorid Optional course object if already loaded
2287 * @param int $userid Optional userid (default = current)
2288 * @return array Array with 2 elements $course and $cm
2289 * @throws moodle_exception If the item doesn't exist or is of wrong module name
2291 function get_course_and_cm_from_instance($instanceorid, $modulename, $courseorid = 0, $userid = 0) {
2294 // Get data from parameter.
2295 if (is_object($instanceorid)) {
2296 $instanceid = $instanceorid->id
;
2297 if (isset($instanceorid->course
)) {
2298 $courseid = (int)$instanceorid->course
;
2303 $instanceid = (int)$instanceorid;
2307 // Get course from last parameter if supplied.
2309 if (is_object($courseorid)) {
2310 $course = $courseorid;
2311 } else if ($courseorid) {
2312 $courseid = (int)$courseorid;
2315 // Validate module name if supplied.
2316 if (!core_component
::is_valid_plugin_name('mod', $modulename)) {
2317 throw new coding_exception('Invalid modulename parameter');
2322 // If course ID is known, get it using normal function.
2323 $course = get_course($courseid);
2325 // Get course record in a single query based on instance id.
2326 $pagetable = '{' . $modulename . '}';
2327 $course = $DB->get_record_sql("
2329 FROM $pagetable instance
2330 JOIN {course} c ON c.id = instance.course
2331 WHERE instance.id = ?", array($instanceid), MUST_EXIST
);
2335 // Get cm from get_fast_modinfo.
2336 $modinfo = get_fast_modinfo($course, $userid);
2337 $instances = $modinfo->get_instances_of($modulename);
2338 if (!array_key_exists($instanceid, $instances)) {
2339 throw new moodle_exception('invalidmoduleid', 'error', $instanceid);
2341 return array($course, $instances[$instanceid]);
2346 * Rebuilds or resets the cached list of course activities stored in MUC.
2348 * rebuild_course_cache() must NEVER be called from lib/db/upgrade.php.
2349 * At the same time course cache may ONLY be cleared using this function in
2350 * upgrade scripts of plugins.
2352 * During the bulk operations if it is necessary to reset cache of multiple
2353 * courses it is enough to call {@link increment_revision_number()} for the
2354 * table 'course' and field 'cacherev' specifying affected courses in select.
2356 * Cached course information is stored in MUC core/coursemodinfo and is
2357 * validated with the DB field {course}.cacherev
2359 * @global moodle_database $DB
2360 * @param int $courseid id of course to rebuild, empty means all
2361 * @param boolean $clearonly only clear the cache, gets rebuild automatically on the fly.
2362 * Recommended to set to true to avoid unnecessary multiple rebuilding.
2364 function rebuild_course_cache($courseid=0, $clearonly=false) {
2365 global $COURSE, $SITE, $DB, $CFG;
2367 // Function rebuild_course_cache() can not be called during upgrade unless it's clear only.
2368 if (!$clearonly && !upgrade_ensure_not_running(true)) {
2372 // Destroy navigation caches
2373 navigation_cache
::destroy_volatile_caches();
2375 core_course\course_format
::reset_course_cache($courseid);
2377 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
2378 if (empty($courseid)) {
2379 // Clearing caches for all courses.
2380 increment_revision_number('course', 'cacherev', '');
2381 $cachecoursemodinfo->purge();
2382 course_modinfo
::clear_instance_cache();
2383 // Update global values too.
2384 $sitecacherev = $DB->get_field('course', 'cacherev', array('id' => SITEID
));
2385 $SITE->cachrev
= $sitecacherev;
2386 if ($COURSE->id
== SITEID
) {
2387 $COURSE->cacherev
= $sitecacherev;
2389 $COURSE->cacherev
= $DB->get_field('course', 'cacherev', array('id' => $COURSE->id
));
2392 // Clearing cache for one course, make sure it is deleted from user request cache as well.
2393 increment_revision_number('course', 'cacherev', 'id = :id', array('id' => $courseid));
2394 $cachecoursemodinfo->delete($courseid);
2395 course_modinfo
::clear_instance_cache($courseid);
2396 // Update global values too.
2397 if ($courseid == $COURSE->id ||
$courseid == $SITE->id
) {
2398 $cacherev = $DB->get_field('course', 'cacherev', array('id' => $courseid));
2399 if ($courseid == $COURSE->id
) {
2400 $COURSE->cacherev
= $cacherev;
2402 if ($courseid == $SITE->id
) {
2403 $SITE->cachrev
= $cacherev;
2413 $select = array('id'=>$courseid);
2416 core_php_time_limit
::raise(); // this could take a while! MDL-10954
2419 $rs = $DB->get_recordset("course", $select,'','id,'.join(',', course_modinfo
::$cachedfields));
2420 // Rebuild cache for each course.
2421 foreach ($rs as $course) {
2422 course_modinfo
::build_course_cache($course);
2429 * Class that is the return value for the _get_coursemodule_info module API function.
2431 * Note: For backward compatibility, you can also return a stdclass object from that function.
2432 * The difference is that the stdclass object may contain an 'extra' field (deprecated,
2433 * use extraclasses and onclick instead). The stdclass object may not contain
2434 * the new fields defined here (content, extraclasses, customdata).
2436 class cached_cm_info
{
2438 * Name (text of link) for this activity; Leave unset to accept default name
2444 * Name of icon for this activity. Normally, this should be used together with $iconcomponent
2445 * to define the icon, as per image_url function.
2446 * For backward compatibility, if this value is of the form 'mod/forum/icon' then an icon
2447 * within that module will be used.
2448 * @see cm_info::get_icon_url()
2449 * @see renderer_base::image_url()
2455 * Component for icon for this activity, as per image_url; leave blank to use default 'moodle'
2457 * @see renderer_base::image_url()
2460 public $iconcomponent;
2463 * HTML content to be displayed on the main page below the link (if any) for this course-module
2469 * Custom data to be stored in modinfo for this activity; useful if there are cases when
2470 * internal information for this activity type needs to be accessible from elsewhere on the
2471 * course without making database queries. May be of any type but should be short.
2477 * Extra CSS class or classes to be added when this activity is displayed on the main page;
2478 * space-separated string
2481 public $extraclasses;
2484 * External URL image to be used by activity as icon, useful for some external-tool modules
2485 * like lti. If set, takes precedence over $icon and $iconcomponent
2491 * Content of onclick JavaScript; escaped HTML to be inserted as attribute value
2499 * Data about a single section on a course. This contains the fields from the
2500 * course_sections table, plus additional data when required.
2502 * @property-read int $id Section ID - from course_sections table
2503 * @property-read int $course Course ID - from course_sections table
2504 * @property-read int $section Section number - from course_sections table
2505 * @property-read string $name Section name if specified - from course_sections table
2506 * @property-read int $visible Section visibility (1 = visible) - from course_sections table
2507 * @property-read string $summary Section summary text if specified - from course_sections table
2508 * @property-read int $summaryformat Section summary text format (FORMAT_xx constant) - from course_sections table
2509 * @property-read string $availability Availability information as JSON string -
2510 * from course_sections table
2511 * @property-read array $conditionscompletion Availability conditions for this section based on the completion of
2512 * course-modules (array from course-module id to required completion state
2513 * for that module) - from cached data in sectioncache field
2514 * @property-read array $conditionsgrade Availability conditions for this section based on course grades (array from
2515 * grade item id to object with ->min, ->max fields) - from cached data in
2516 * sectioncache field
2517 * @property-read array $conditionsfield Availability conditions for this section based on user fields
2518 * @property-read bool $available True if this section is available to the given user i.e. if all availability conditions
2519 * are met - obtained dynamically
2520 * @property-read string $availableinfo If section is not available to some users, this string gives information about
2521 * availability which can be displayed to students and/or staff (e.g. 'Available from 3 January 2010')
2522 * for display on main page - obtained dynamically
2523 * @property-read bool $uservisible True if this section is available to the given user (for example, if current user
2524 * has viewhiddensections capability, they can access the section even if it is not
2525 * visible or not available, so this would be true in that case) - obtained dynamically
2526 * @property-read string $sequence Comma-separated list of all modules in the section. Note, this field may not exactly
2527 * match course_sections.sequence if later has references to non-existing modules or not modules of not available module types.
2528 * @property-read course_modinfo $modinfo
2530 class section_info
implements IteratorAggregate
{
2532 * Section ID - from course_sections table
2538 * Section number - from course_sections table
2544 * Section name if specified - from course_sections table
2550 * Section visibility (1 = visible) - from course_sections table
2556 * Section summary text if specified - from course_sections table
2562 * Section summary text format (FORMAT_xx constant) - from course_sections table
2565 private $_summaryformat;
2568 * Availability information as JSON string - from course_sections table
2571 private $_availability;
2574 * Availability conditions for this section based on the completion of
2575 * course-modules (array from course-module id to required completion state
2576 * for that module) - from cached data in sectioncache field
2579 private $_conditionscompletion;
2582 * Availability conditions for this section based on course grades (array from
2583 * grade item id to object with ->min, ->max fields) - from cached data in
2584 * sectioncache field
2587 private $_conditionsgrade;
2590 * Availability conditions for this section based on user fields
2593 private $_conditionsfield;
2596 * True if this section is available to students i.e. if all availability conditions
2597 * are met - obtained dynamically on request, see function {@link section_info::get_available()}
2600 private $_available;
2603 * If section is not available to some users, this string gives information about
2604 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
2605 * January 2010') for display on main page - obtained dynamically on request, see
2606 * function {@link section_info::get_availableinfo()}
2609 private $_availableinfo;
2612 * True if this section is available to the CURRENT user (for example, if current user
2613 * has viewhiddensections capability, they can access the section even if it is not
2614 * visible or not available, so this would be true in that case) - obtained dynamically
2615 * on request, see function {@link section_info::get_uservisible()}
2618 private $_uservisible;
2621 * Default values for sectioncache fields; if a field has this value, it won't
2622 * be stored in the sectioncache cache, to save space. Checks are done by ===
2623 * which means values must all be strings.
2626 private static $sectioncachedefaults = array(
2629 'summaryformat' => '1', // FORMAT_HTML, but must be a string
2631 'availability' => null
2635 * Stores format options that have been cached when building 'coursecache'
2636 * When the format option is requested we look first if it has been cached
2639 private $cachedformatoptions = array();
2642 * Stores the list of all possible section options defined in each used course format.
2645 static private $sectionformatoptions = array();
2648 * Stores the modinfo object passed in constructor, may be used when requesting
2649 * dynamically obtained attributes such as available, availableinfo, uservisible.
2650 * Also used to retrun information about current course or user.
2651 * @var course_modinfo
2656 * Constructs object from database information plus extra required data.
2657 * @param object $data Array entry from cached sectioncache
2658 * @param int $number Section number (array key)
2659 * @param int $notused1 argument not used (informaion is available in $modinfo)
2660 * @param int $notused2 argument not used (informaion is available in $modinfo)
2661 * @param course_modinfo $modinfo Owner (needed for checking availability)
2662 * @param int $notused3 argument not used (informaion is available in $modinfo)
2664 public function __construct($data, $number, $notused1, $notused2, $modinfo, $notused3) {
2666 require_once($CFG->dirroot
.'/course/lib.php');
2668 // Data that is always present
2669 $this->_id
= $data->id
;
2671 $defaults = self
::$sectioncachedefaults +
2672 array('conditionscompletion' => array(),
2673 'conditionsgrade' => array(),
2674 'conditionsfield' => array());
2676 // Data that may use default values to save cache size
2677 foreach ($defaults as $field => $value) {
2678 if (isset($data->{$field})) {
2679 $this->{'_'.$field} = $data->{$field};
2681 $this->{'_'.$field} = $value;
2685 // Other data from constructor arguments.
2686 $this->_section
= $number;
2687 $this->modinfo
= $modinfo;
2689 // Cached course format data.
2690 $course = $modinfo->get_course();
2691 if (!isset(self
::$sectionformatoptions[$course->format
])) {
2692 // Store list of section format options defined in each used course format.
2693 // They do not depend on particular course but only on its format.
2694 self
::$sectionformatoptions[$course->format
] =
2695 course_get_format($course)->section_format_options();
2697 foreach (self
::$sectionformatoptions[$course->format
] as $field => $option) {
2698 if (!empty($option['cache'])) {
2699 if (isset($data->{$field})) {
2700 $this->cachedformatoptions
[$field] = $data->{$field};
2701 } else if (array_key_exists('cachedefault', $option)) {
2702 $this->cachedformatoptions
[$field] = $option['cachedefault'];
2709 * Magic method to check if the property is set
2711 * @param string $name name of the property
2714 public function __isset($name) {
2715 if (method_exists($this, 'get_'.$name) ||
2716 property_exists($this, '_'.$name) ||
2717 array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
2718 $value = $this->__get($name);
2719 return isset($value);
2725 * Magic method to check if the property is empty
2727 * @param string $name name of the property
2730 public function __empty($name) {
2731 if (method_exists($this, 'get_'.$name) ||
2732 property_exists($this, '_'.$name) ||
2733 array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
2734 $value = $this->__get($name);
2735 return empty($value);
2741 * Magic method to retrieve the property, this is either basic section property
2742 * or availability information or additional properties added by course format
2744 * @param string $name name of the property
2747 public function __get($name) {
2748 if (method_exists($this, 'get_'.$name)) {
2749 return $this->{'get_'.$name}();
2751 if (property_exists($this, '_'.$name)) {
2752 return $this->{'_'.$name};
2754 if (array_key_exists($name, $this->cachedformatoptions
)) {
2755 return $this->cachedformatoptions
[$name];
2757 // precheck if the option is defined in format to avoid unnecessary DB queries in get_format_options()
2758 if (array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
2759 $formatoptions = course_get_format($this->modinfo
->get_course())->get_format_options($this);
2760 return $formatoptions[$name];
2762 debugging('Invalid section_info property accessed! '.$name);
2767 * Finds whether this section is available at the moment for the current user.
2769 * The value can be accessed publicly as $sectioninfo->available
2773 private function get_available() {
2775 $userid = $this->modinfo
->get_user_id();
2776 if ($this->_available
!== null ||
$userid == -1) {
2777 // Has already been calculated or does not need calculation.
2778 return $this->_available
;
2780 $this->_available
= true;
2781 $this->_availableinfo
= '';
2782 if (!empty($CFG->enableavailability
)) {
2783 // Get availability information.
2784 $ci = new \core_availability\
info_section($this);
2785 $this->_available
= $ci->is_available($this->_availableinfo
, true,
2786 $userid, $this->modinfo
);
2788 // Execute the hook from the course format that may override the available/availableinfo properties.
2789 $currentavailable = $this->_available
;
2790 course_get_format($this->modinfo
->get_course())->
2791 section_get_available_hook($this, $this->_available
, $this->_availableinfo
);
2792 if (!$currentavailable && $this->_available
) {
2793 debugging('section_get_available_hook() can not make unavailable section available', DEBUG_DEVELOPER
);
2794 $this->_available
= $currentavailable;
2796 return $this->_available
;
2800 * Returns the availability text shown next to the section on course page.
2804 private function get_availableinfo() {
2805 // Calling get_available() will also fill the availableinfo property
2806 // (or leave it null if there is no userid).
2807 $this->get_available();
2808 return $this->_availableinfo
;
2812 * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
2813 * and use {@link convert_to_array()}
2815 * @return ArrayIterator
2817 public function getIterator() {
2819 foreach (get_object_vars($this) as $key => $value) {
2820 if (substr($key, 0, 1) == '_') {
2821 if (method_exists($this, 'get'.$key)) {
2822 $ret[substr($key, 1)] = $this->{'get'.$key}();
2824 $ret[substr($key, 1)] = $this->$key;
2828 $ret['sequence'] = $this->get_sequence();
2829 $ret['course'] = $this->get_course();
2830 $ret = array_merge($ret, course_get_format($this->modinfo
->get_course())->get_format_options($this->_section
));
2831 return new ArrayIterator($ret);
2835 * Works out whether activity is visible *for current user* - if this is false, they
2836 * aren't allowed to access it.
2840 private function get_uservisible() {
2841 $userid = $this->modinfo
->get_user_id();
2842 if ($this->_uservisible
!== null ||
$userid == -1) {
2843 // Has already been calculated or does not need calculation.
2844 return $this->_uservisible
;
2846 $this->_uservisible
= true;
2847 if (!$this->_visible ||
!$this->get_available()) {
2848 $coursecontext = context_course
::instance($this->get_course());
2849 if (!$this->_visible
&& !has_capability('moodle/course:viewhiddensections', $coursecontext, $userid) ||
2850 (!$this->get_available() &&
2851 !has_capability('moodle/course:ignoreavailabilityrestrictions', $coursecontext, $userid))) {
2853 $this->_uservisible
= false;
2856 return $this->_uservisible
;
2860 * Restores the course_sections.sequence value
2864 private function get_sequence() {
2865 if (!empty($this->modinfo
->sections
[$this->_section
])) {
2866 return implode(',', $this->modinfo
->sections
[$this->_section
]);
2873 * Returns course ID - from course_sections table
2877 private function get_course() {
2878 return $this->modinfo
->get_course_id();
2884 * @return course_modinfo
2886 private function get_modinfo() {
2887 return $this->modinfo
;
2891 * Prepares section data for inclusion in sectioncache cache, removing items
2892 * that are set to defaults, and adding availability data if required.
2894 * Called by build_section_cache in course_modinfo only; do not use otherwise.
2895 * @param object $section Raw section data object
2897 public static function convert_for_section_cache($section) {
2900 // Course id stored in course table
2901 unset($section->course
);
2902 // Section number stored in array key
2903 unset($section->section
);
2904 // Sequence stored implicity in modinfo $sections array
2905 unset($section->sequence
);
2907 // Remove default data
2908 foreach (self
::$sectioncachedefaults as $field => $value) {
2909 // Exact compare as strings to avoid problems if some strings are set
2911 if (isset($section->{$field}) && $section->{$field} === $value) {
2912 unset($section->{$field});