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
{
58 * List of fields from DB table 'course' that are cached in MUC and are always present in course_modinfo::$course
61 public static $cachedfields = array('shortname', 'fullname', 'format',
62 'enablecompletion', 'groupmode', 'groupmodeforce', 'cacherev');
65 * For convenience we store the course object here as it is needed in other parts of code
71 * Array of section data from cache
83 * Array from int (section num, e.g. 0) => array of int (course-module id); this list only
84 * includes sections that actually contain at least one course-module
90 * Array from int (cm id) => cm_info object
96 * Array from string (modname) => int (instance id) => cm_info object
102 * Groups that the current user belongs to. This value is calculated on first
103 * request to the property or function.
104 * When set, it is an array of grouping id => array of group id => group id.
105 * Includes grouping id 0 for 'all groups'.
111 * List of class read-only properties and their getter methods.
112 * Used by magic functions __get(), __isset(), __empty()
115 private static $standardproperties = array(
116 'courseid' => 'get_course_id',
117 'userid' => 'get_user_id',
118 'sections' => 'get_sections',
120 'instances' => 'get_instances',
121 'groups' => 'get_groups_all',
125 * Magic method getter
127 * @param string $name
130 public function __get($name) {
131 if (isset(self
::$standardproperties[$name])) {
132 $method = self
::$standardproperties[$name];
133 return $this->$method();
135 debugging('Invalid course_modinfo property accessed: '.$name);
141 * Magic method for function isset()
143 * @param string $name
146 public function __isset($name) {
147 if (isset(self
::$standardproperties[$name])) {
148 $value = $this->__get($name);
149 return isset($value);
155 * Magic method for function empty()
157 * @param string $name
160 public function __empty($name) {
161 if (isset(self
::$standardproperties[$name])) {
162 $value = $this->__get($name);
163 return empty($value);
169 * Magic method setter
171 * Will display the developer warning when trying to set/overwrite existing property.
173 * @param string $name
174 * @param mixed $value
176 public function __set($name, $value) {
177 debugging("It is not allowed to set the property course_modinfo::\${$name}", DEBUG_DEVELOPER
);
181 * Returns course object that was used in the first {@link get_fast_modinfo()} call.
183 * It may not contain all fields from DB table {course} but always has at least the following:
184 * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
188 public function get_course() {
189 return $this->course
;
193 * @return int Course ID
195 public function get_course_id() {
196 return $this->course
->id
;
200 * @return int User ID
202 public function get_user_id() {
203 return $this->userid
;
207 * @return array Array from section number (e.g. 0) to array of course-module IDs in that
208 * section; this only includes sections that contain at least one course-module
210 public function get_sections() {
211 return $this->sections
;
215 * @return cm_info[] Array from course-module instance to cm_info object within this course, in
216 * order of appearance
218 public function get_cms() {
223 * Obtains a single course-module object (for a course-module that is on this course).
224 * @param int $cmid Course-module ID
225 * @return cm_info Information about that course-module
226 * @throws moodle_exception If the course-module does not exist
228 public function get_cm($cmid) {
229 if (empty($this->cms
[$cmid])) {
230 throw new moodle_exception('invalidcoursemodule', 'error');
232 return $this->cms
[$cmid];
236 * Obtains all module instances on this course.
237 * @return cm_info[][] Array from module name => array from instance id => cm_info
239 public function get_instances() {
240 return $this->instances
;
244 * Returns array of localised human-readable module names used in this course
246 * @param bool $plural if true returns the plural form of modules names
249 public function get_used_module_names($plural = false) {
250 $modnames = get_module_types_names($plural);
251 $modnamesused = array();
252 foreach ($this->get_cms() as $cmid => $mod) {
253 if (isset($modnames[$mod->modname
]) && $mod->uservisible
) {
254 $modnamesused[$mod->modname
] = $modnames[$mod->modname
];
257 core_collator
::asort($modnamesused);
258 return $modnamesused;
262 * Obtains all instances of a particular module on this course.
263 * @param $modname Name of module (not full frankenstyle) e.g. 'label'
264 * @return cm_info[] Array from instance id => cm_info for modules on this course; empty if none
266 public function get_instances_of($modname) {
267 if (empty($this->instances
[$modname])) {
270 return $this->instances
[$modname];
274 * Groups that the current user belongs to organised by grouping id. Calculated on the first request.
275 * @return int[][] array of grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'
277 private function get_groups_all() {
278 if (is_null($this->groups
)) {
279 // NOTE: Performance could be improved here. The system caches user groups
280 // in $USER->groupmember[$courseid] => array of groupid=>groupid. Unfortunately this
281 // structure does not include grouping information. It probably could be changed to
282 // do so, without a significant performance hit on login, thus saving this one query
284 $this->groups
= groups_get_user_groups($this->course
->id
, $this->userid
);
286 return $this->groups
;
290 * Returns groups that the current user belongs to on the course. Note: If not already
291 * available, this may make a database query.
292 * @param int $groupingid Grouping ID or 0 (default) for all groups
293 * @return int[] Array of int (group id) => int (same group id again); empty array if none
295 public function get_groups($groupingid = 0) {
296 $allgroups = $this->get_groups_all();
297 if (!isset($allgroups[$groupingid])) {
300 return $allgroups[$groupingid];
304 * Gets all sections as array from section number => data about section.
305 * @return section_info[] Array of section_info objects organised by section number
307 public function get_section_info_all() {
308 return $this->sectioninfo
;
312 * Gets data about specific numbered section.
313 * @param int $sectionnumber Number (not id) of section
314 * @param int $strictness Use MUST_EXIST to throw exception if it doesn't
315 * @return section_info Information for numbered section or null if not found
317 public function get_section_info($sectionnumber, $strictness = IGNORE_MISSING
) {
318 if (!array_key_exists($sectionnumber, $this->sectioninfo
)) {
319 if ($strictness === MUST_EXIST
) {
320 throw new moodle_exception('sectionnotexist');
325 return $this->sectioninfo
[$sectionnumber];
329 * Static cache for generated course_modinfo instances
331 * @see course_modinfo::instance()
332 * @see course_modinfo::clear_instance_cache()
333 * @var course_modinfo[]
335 protected static $instancecache = array();
338 * Timestamps (microtime) when the course_modinfo instances were last accessed
340 * It is used to remove the least recent accessed instances when static cache is full
344 protected static $cacheaccessed = array();
347 * Clears the cache used in course_modinfo::instance()
349 * Used in {@link get_fast_modinfo()} when called with argument $reset = true
350 * and in {@link rebuild_course_cache()}
352 * @param null|int|stdClass $courseorid if specified removes only cached value for this course
354 public static function clear_instance_cache($courseorid = null) {
355 if (empty($courseorid)) {
356 self
::$instancecache = array();
357 self
::$cacheaccessed = array();
360 if (is_object($courseorid)) {
361 $courseorid = $courseorid->id
;
363 if (isset(self
::$instancecache[$courseorid])) {
364 // Unsetting static variable in PHP is peculiar, it removes the reference,
365 // but data remain in memory. Prior to unsetting, the varable needs to be
366 // set to empty to remove its remains from memory.
367 self
::$instancecache[$courseorid] = '';
368 unset(self
::$instancecache[$courseorid]);
369 unset(self
::$cacheaccessed[$courseorid]);
374 * Returns the instance of course_modinfo for the specified course and specified user
376 * This function uses static cache for the retrieved instances. The cache
377 * size is limited by MAX_MODINFO_CACHE_SIZE. If instance is not found in
378 * the static cache or it was created for another user or the cacherev validation
379 * failed - a new instance is constructed and returned.
381 * Used in {@link get_fast_modinfo()}
383 * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
384 * and recommended to have field 'cacherev') or just a course id
385 * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections.
386 * Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
387 * @return course_modinfo
389 public static function instance($courseorid, $userid = 0) {
391 if (is_object($courseorid)) {
392 $course = $courseorid;
394 $course = (object)array('id' => $courseorid);
396 if (empty($userid)) {
400 if (!empty(self
::$instancecache[$course->id
])) {
401 if (self
::$instancecache[$course->id
]->userid
== $userid &&
402 (!isset($course->cacherev
) ||
403 $course->cacherev
== self
::$instancecache[$course->id
]->get_course()->cacherev
)) {
404 // This course's modinfo for the same user was recently retrieved, return cached.
405 self
::$cacheaccessed[$course->id
] = microtime(true);
406 return self
::$instancecache[$course->id
];
408 // Prevent potential reference problems when switching users.
409 self
::clear_instance_cache($course->id
);
412 $modinfo = new course_modinfo($course, $userid);
414 // We have a limit of MAX_MODINFO_CACHE_SIZE entries to store in static variable.
415 if (count(self
::$instancecache) >= MAX_MODINFO_CACHE_SIZE
) {
416 // Find the course that was the least recently accessed.
417 asort(self
::$cacheaccessed, SORT_NUMERIC
);
418 $courseidtoremove = key(array_reverse(self
::$cacheaccessed, true));
419 self
::clear_instance_cache($courseidtoremove);
422 // Add modinfo to the static cache.
423 self
::$instancecache[$course->id
] = $modinfo;
424 self
::$cacheaccessed[$course->id
] = microtime(true);
430 * Constructs based on course.
431 * Note: This constructor should not usually be called directly.
432 * Use get_fast_modinfo($course) instead as this maintains a cache.
433 * @param stdClass $course course object, only property id is required.
434 * @param int $userid User ID
435 * @throws moodle_exception if course is not found
437 public function __construct($course, $userid) {
438 global $CFG, $COURSE, $SITE, $DB;
440 if (!isset($course->cacherev
)) {
441 // We require presence of property cacherev to validate the course cache.
442 // No need to clone the $COURSE or $SITE object here because we clone it below anyway.
443 $course = get_course($course->id
, false);
446 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
448 // Retrieve modinfo from cache. If not present or cacherev mismatches, call rebuild and retrieve again.
449 $coursemodinfo = $cachecoursemodinfo->get($course->id
);
450 if ($coursemodinfo === false ||
($course->cacherev
!= $coursemodinfo->cacherev
)) {
451 $coursemodinfo = self
::build_course_cache($course);
454 // Set initial values
455 $this->userid
= $userid;
456 $this->sections
= array();
457 $this->cms
= array();
458 $this->instances
= array();
459 $this->groups
= null;
461 // If we haven't already preloaded contexts for the course, do it now
462 // Modules are also cached here as long as it's the first time this course has been preloaded.
463 context_helper
::preload_course($course->id
);
465 // Quick integrity check: as a result of race conditions modinfo may not be regenerated after the change.
466 // It is especially dangerous if modinfo contains the deleted course module, as it results in fatal error.
467 // We can check it very cheap by validating the existence of module context.
468 if ($course->id
== $COURSE->id ||
$course->id
== $SITE->id
) {
469 // Only verify current course (or frontpage) as pages with many courses may not have module contexts cached.
470 // (Uncached modules will result in a very slow verification).
471 foreach ($coursemodinfo->modinfo
as $mod) {
472 if (!context_module
::instance($mod->cm
, IGNORE_MISSING
)) {
473 debugging('Course cache integrity check failed: course module with id '. $mod->cm
.
474 ' does not have context. Rebuilding cache for course '. $course->id
);
475 // Re-request the course record from DB as well, don't use get_course() here.
476 $course = $DB->get_record('course', array('id' => $course->id
), '*', MUST_EXIST
);
477 $coursemodinfo = self
::build_course_cache($course);
483 // Overwrite unset fields in $course object with cached values, store the course object.
484 $this->course
= fullclone($course);
485 foreach ($coursemodinfo as $key => $value) {
486 if ($key !== 'modinfo' && $key !== 'sectioncache' &&
487 (!isset($this->course
->$key) ||
$key === 'cacherev')) {
488 $this->course
->$key = $value;
492 // Loop through each piece of module data, constructing it
493 static $modexists = array();
494 foreach ($coursemodinfo->modinfo
as $mod) {
495 if (empty($mod->name
)) {
496 // something is wrong here
500 // Skip modules which don't exist
501 if (!array_key_exists($mod->mod
, $modexists)) {
502 $modexists[$mod->mod
] = file_exists("$CFG->dirroot/mod/$mod->mod/lib.php");
504 if (!$modexists[$mod->mod
]) {
508 // Construct info for this module
509 $cm = new cm_info($this, null, $mod, null);
511 // Store module in instances and cms array
512 if (!isset($this->instances
[$cm->modname
])) {
513 $this->instances
[$cm->modname
] = array();
515 $this->instances
[$cm->modname
][$cm->instance
] = $cm;
516 $this->cms
[$cm->id
] = $cm;
518 // Reconstruct sections. This works because modules are stored in order
519 if (!isset($this->sections
[$cm->sectionnum
])) {
520 $this->sections
[$cm->sectionnum
] = array();
522 $this->sections
[$cm->sectionnum
][] = $cm->id
;
525 // Expand section objects
526 $this->sectioninfo
= array();
527 foreach ($coursemodinfo->sectioncache
as $number => $data) {
528 $this->sectioninfo
[$number] = new section_info($data, $number, null, null,
534 * Builds a list of information about sections on a course to be stored in
535 * the course cache. (Does not include information that is already cached
536 * in some other way.)
538 * This function will be removed in 2.7
540 * @deprecated since 2.6
541 * @param int $courseid Course ID
542 * @return array Information about sections, indexed by section number (not id)
544 public static function build_section_cache($courseid) {
546 debugging('Function course_modinfo::build_section_cache() is deprecated. It can only be used internally to build course cache.');
547 $course = $DB->get_record('course', array('id' => $course->id
),
548 array_merge(array('id'), self
::$cachedfields), MUST_EXIST
);
549 return self
::build_course_section_cache($course);
553 * Builds a list of information about sections on a course to be stored in
554 * the course cache. (Does not include information that is already cached
555 * in some other way.)
557 * @param stdClass $course Course object (must contain fields
558 * @return array Information about sections, indexed by section number (not id)
560 protected static function build_course_section_cache($course) {
564 $sections = $DB->get_records('course_sections', array('course' => $course->id
), 'section',
565 'section, id, course, name, summary, summaryformat, sequence, visible, ' .
567 $compressedsections = array();
569 $formatoptionsdef = course_get_format($course)->section_format_options();
570 // Remove unnecessary data and add availability
571 foreach ($sections as $number => $section) {
572 // Add cached options from course format to $section object
573 foreach ($formatoptionsdef as $key => $option) {
574 if (!empty($option['cache'])) {
575 $formatoptions = course_get_format($course)->get_format_options($section);
576 if (!array_key_exists('cachedefault', $option) ||
$option['cachedefault'] !== $formatoptions[$key]) {
577 $section->$key = $formatoptions[$key];
581 // Clone just in case it is reused elsewhere
582 $compressedsections[$number] = clone($section);
583 section_info
::convert_for_section_cache($compressedsections[$number]);
586 return $compressedsections;
590 * Builds and stores in MUC object containing information about course
591 * modules and sections together with cached fields from table course.
593 * @param stdClass $course object from DB table course. Must have property 'id'
594 * but preferably should have all cached fields.
595 * @return stdClass object with all cached keys of the course plus fields modinfo and sectioncache.
596 * The same object is stored in MUC
597 * @throws moodle_exception if course is not found (if $course object misses some of the
598 * necessary fields it is re-requested from database)
600 public static function build_course_cache($course) {
602 require_once("$CFG->dirroot/course/lib.php");
603 if (empty($course->id
)) {
604 throw new coding_exception('Object $course is missing required property \id\'');
606 // Ensure object has all necessary fields.
607 foreach (self
::$cachedfields as $key) {
608 if (!isset($course->$key)) {
609 $course = $DB->get_record('course', array('id' => $course->id
),
610 implode(',', array_merge(array('id'), self
::$cachedfields)), MUST_EXIST
);
614 // Retrieve all information about activities and sections.
615 // This may take time on large courses and it is possible that another user modifies the same course during this process.
616 // Field cacherev stored in both DB and cache will ensure that cached data matches the current course state.
617 $coursemodinfo = new stdClass();
618 $coursemodinfo->modinfo
= get_array_of_activities($course->id
);
619 $coursemodinfo->sectioncache
= self
::build_course_section_cache($course);
620 foreach (self
::$cachedfields as $key) {
621 $coursemodinfo->$key = $course->$key;
623 // Set the accumulated activities and sections information in cache, together with cacherev.
624 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
625 $cachecoursemodinfo->set($course->id
, $coursemodinfo);
626 return $coursemodinfo;
632 * Data about a single module on a course. This contains most of the fields in the course_modules
633 * table, plus additional data when required.
635 * The object can be accessed by core or any plugin (i.e. course format, block, filter, etc.) as
636 * get_fast_modinfo($courseorid)->cms[$coursemoduleid]
638 * get_fast_modinfo($courseorid)->instances[$moduletype][$instanceid]
640 * There are three stages when activity module can add/modify data in this object:
642 * <b>Stage 1 - during building the cache.</b>
643 * Allows to add to the course cache static user-independent information about the module.
644 * Modules should try to include only absolutely necessary information that may be required
645 * when displaying course view page. The information is stored in application-level cache
646 * and reset when {@link rebuild_course_cache()} is called or cache is purged by admin.
648 * Modules can implement callback XXX_get_coursemodule_info() returning instance of object
649 * {@link cached_cm_info}
651 * <b>Stage 2 - dynamic data.</b>
652 * Dynamic data is user-dependend, it is stored in request-level cache. To reset this cache
653 * {@link get_fast_modinfo()} with $reset argument may be called.
655 * Dynamic data is obtained when any of the following properties/methods is requested:
656 * - {@link cm_info::$url}
657 * - {@link cm_info::$name}
658 * - {@link cm_info::$onclick}
659 * - {@link cm_info::get_icon_url()}
660 * - {@link cm_info::$uservisible}
661 * - {@link cm_info::$available}
662 * - {@link cm_info::$availableinfo}
663 * - plus any of the properties listed in Stage 3.
665 * Modules can implement callback <b>XXX_cm_info_dynamic()</b> and inside this callback they
666 * are allowed to use any of the following set methods:
667 * - {@link cm_info::set_available()}
668 * - {@link cm_info::set_name()}
669 * - {@link cm_info::set_no_view_link()}
670 * - {@link cm_info::set_user_visible()}
671 * - {@link cm_info::set_on_click()}
672 * - {@link cm_info::set_icon_url()}
673 * Any methods affecting view elements can also be set in this callback.
675 * <b>Stage 3 (view data).</b>
676 * Also user-dependend data stored in request-level cache. Second stage is created
677 * because populating the view data can be expensive as it may access much more
678 * Moodle APIs such as filters, user information, output renderers and we
679 * don't want to request it until necessary.
680 * View data is obtained when any of the following properties/methods is requested:
681 * - {@link cm_info::$afterediticons}
682 * - {@link cm_info::$content}
683 * - {@link cm_info::get_formatted_content()}
684 * - {@link cm_info::$extraclasses}
685 * - {@link cm_info::$afterlink}
687 * Modules can implement callback <b>XXX_cm_info_view()</b> and inside this callback they
688 * are allowed to use any of the following set methods:
689 * - {@link cm_info::set_after_edit_icons()}
690 * - {@link cm_info::set_after_link()}
691 * - {@link cm_info::set_content()}
692 * - {@link cm_info::set_extra_classes()}
694 * @property-read int $id Course-module ID - from course_modules table
695 * @property-read int $instance Module instance (ID within module table) - from course_modules table
696 * @property-read int $course Course ID - from course_modules table
697 * @property-read string $idnumber 'ID number' from course-modules table (arbitrary text set by user) - from
698 * course_modules table
699 * @property-read int $added Time that this course-module was added (unix time) - from course_modules table
700 * @property-read int $visible Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
701 * course_modules table
702 * @property-read int $visibleold Old visible setting (if the entire section is hidden, the previous value for
703 * visible is stored in this field) - from course_modules table
704 * @property-read int $groupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
705 * course_modules table. Use {@link cm_info::$effectivegroupmode} to find the actual group mode that may be forced by course.
706 * @property-read int $groupingid Grouping ID (0 = all groupings)
707 * @property-read bool $coursegroupmodeforce Indicates whether the course containing the module has forced the groupmode
708 * This means that cm_info::$groupmode should be ignored and cm_info::$coursegroupmode be used instead
709 * @property-read int $coursegroupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from
710 * course table - as specified for the course containing the module
711 * Effective only if {@link cm_info::$coursegroupmodeforce} is set
712 * @property-read int $effectivegroupmode Effective group mode for this module (one of the constants NOGROUPS, SEPARATEGROUPS,
713 * or VISIBLEGROUPS). This can be different from groupmode set for the module if the groupmode is forced for the course.
714 * This value will always be NOGROUPS if module type does not support group mode.
715 * @property-read int $indent Indent level on course page (0 = no indent) - from course_modules table
716 * @property-read int $completion Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
717 * course_modules table
718 * @property-read mixed $completiongradeitemnumber Set to the item number (usually 0) if completion depends on a particular
719 * grade of this activity, or null if completion does not depend on a grade - from course_modules table
720 * @property-read int $completionview 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
721 * @property-read int $completionexpected Set to a unix time if completion of this activity is expected at a
722 * particular time, 0 if no time set - from course_modules table
723 * @property-read string $availability Availability information as JSON string or null if none -
724 * from course_modules table
725 * @property-read int $showdescription Controls whether the description of the activity displays on the course main page (in
726 * addition to anywhere it might display within the activity itself). 0 = do not show
727 * on main page, 1 = show on main page.
728 * @property-read string $extra (deprecated) Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
729 * course page - from cached data in modinfo field. Deprecated, replaced by ->extraclasses and ->onclick
730 * @property-read string $icon Name of icon to use - from cached data in modinfo field
731 * @property-read string $iconcomponent Component that contains icon - from cached data in modinfo field
732 * @property-read string $modname Name of module e.g. 'forum' (this is the same name as the module's main database
733 * table) - from cached data in modinfo field
734 * @property-read int $module ID of module type - from course_modules table
735 * @property-read string $name Name of module instance for display on page e.g. 'General discussion forum' - from cached
736 * data in modinfo field
737 * @property-read int $sectionnum Section number that this course-module is in (section 0 = above the calendar, section 1
738 * = week/topic 1, etc) - from cached data in modinfo field
739 * @property-read int $section Section id - from course_modules table
740 * @property-read array $conditionscompletion Availability conditions for this course-module based on the completion of other
741 * course-modules (array from other course-module id to required completion state for that
742 * module) - from cached data in modinfo field
743 * @property-read array $conditionsgrade Availability conditions for this course-module based on course grades (array from
744 * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
745 * @property-read array $conditionsfield Availability conditions for this course-module based on user fields
746 * @property-read bool $available True if this course-module is available to students i.e. if all availability conditions
747 * are met - obtained dynamically
748 * @property-read string $availableinfo If course-module is not available to students, this string gives information about
749 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
750 * January 2010') for display on main page - obtained dynamically
751 * @property-read bool $uservisible True if this course-module is available to the CURRENT user (for example, if current user
752 * has viewhiddenactivities capability, they can access the course-module even if it is not
753 * visible or not available, so this would be true in that case)
754 * @property-read context_module $context Module context
755 * @property-read string $modfullname Returns a localised human-readable name of the module type - calculated on request
756 * @property-read string $modplural Returns a localised human-readable name of the module type in plural form - calculated on request
757 * @property-read string $content Content to display on main (view) page - calculated on request
758 * @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
759 * @property-read string $extraclasses Extra CSS classes to add to html output for this activity on main page - calculated on request
760 * @property-read string $onclick Content of HTML on-click attribute already escaped - calculated on request
761 * @property-read mixed $customdata Optional custom data stored in modinfo cache for this activity, or null if none
762 * @property-read string $afterlink Extra HTML code to display after link - calculated on request
763 * @property-read string $afterediticons Extra HTML code to display after editing icons (e.g. more icons) - calculated on request
765 class cm_info
implements IteratorAggregate
{
767 * State: Only basic data from modinfo cache is available.
769 const STATE_BASIC
= 0;
772 * State: In the process of building dynamic data (to avoid recursive calls to obtain_dynamic_data())
774 const STATE_BUILDING_DYNAMIC
= 1;
777 * State: Dynamic data is available too.
779 const STATE_DYNAMIC
= 2;
782 * State: In the process of building view data (to avoid recursive calls to obtain_view_data())
784 const STATE_BUILDING_VIEW
= 3;
787 * State: View data (for course page) is available.
789 const STATE_VIEW
= 4;
793 * @var course_modinfo
798 * Level of information stored inside this object (STATE_xx constant)
804 * Course-module ID - from course_modules table
810 * Module instance (ID within module table) - from course_modules table
816 * 'ID number' from course-modules table (arbitrary text set by user) - from
817 * course_modules table
823 * Time that this course-module was added (unix time) - from course_modules table
829 * This variable is not used and is included here only so it can be documented.
830 * Once the database entry is removed from course_modules, it should be deleted
833 * @deprecated Do not use this variable
838 * Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
839 * course_modules table
845 * Old visible setting (if the entire section is hidden, the previous value for
846 * visible is stored in this field) - from course_modules table
852 * Group mode (one of the constants NONE, SEPARATEGROUPS, or VISIBLEGROUPS) - from
853 * course_modules table
859 * Grouping ID (0 = all groupings)
865 * Indent level on course page (0 = no indent) - from course_modules table
871 * Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
872 * course_modules table
878 * Set to the item number (usually 0) if completion depends on a particular
879 * grade of this activity, or null if completion does not depend on a grade - from
880 * course_modules table
883 private $completiongradeitemnumber;
886 * 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
889 private $completionview;
892 * Set to a unix time if completion of this activity is expected at a
893 * particular time, 0 if no time set - from course_modules table
896 private $completionexpected;
899 * Availability information as JSON string or null if none - from course_modules table
902 private $availability;
905 * Controls whether the description of the activity displays on the course main page (in
906 * addition to anywhere it might display within the activity itself). 0 = do not show
907 * on main page, 1 = show on main page.
910 private $showdescription;
913 * Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
914 * course page - from cached data in modinfo field
915 * @deprecated This is crazy, don't use it. Replaced by ->extraclasses and ->onclick
921 * Name of icon to use - from cached data in modinfo field
927 * Component that contains icon - from cached data in modinfo field
930 private $iconcomponent;
933 * Name of module e.g. 'forum' (this is the same name as the module's main database
934 * table) - from cached data in modinfo field
940 * ID of module - from course_modules table
946 * Name of module instance for display on page e.g. 'General discussion forum' - from cached
947 * data in modinfo field
953 * Section number that this course-module is in (section 0 = above the calendar, section 1
954 * = week/topic 1, etc) - from cached data in modinfo field
960 * Section id - from course_modules table
966 * Availability conditions for this course-module based on the completion of other
967 * course-modules (array from other course-module id to required completion state for that
968 * module) - from cached data in modinfo field
971 private $conditionscompletion;
974 * Availability conditions for this course-module based on course grades (array from
975 * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
978 private $conditionsgrade;
981 * Availability conditions for this course-module based on user fields
984 private $conditionsfield;
987 * True if this course-module is available to students i.e. if all availability conditions
988 * are met - obtained dynamically
994 * If course-module is not available to students, this string gives information about
995 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
996 * January 2010') for display on main page - obtained dynamically
999 private $availableinfo;
1002 * True if this course-module is available to the CURRENT user (for example, if current user
1003 * has viewhiddenactivities capability, they can access the course-module even if it is not
1004 * visible or not available, so this would be true in that case)
1007 private $uservisible;
1022 private $extraclasses;
1025 * @var moodle_url full external url pointing to icon image for activity
1037 private $customdata;
1047 private $afterediticons;
1050 * List of class read-only properties and their getter methods.
1051 * Used by magic functions __get(), __isset(), __empty()
1054 private static $standardproperties = array(
1056 'content' => 'get_content',
1057 'extraclasses' => 'get_extra_classes',
1058 'onclick' => 'get_on_click',
1059 'customdata' => 'get_custom_data',
1060 'afterlink' => 'get_after_link',
1061 'afterediticons' => 'get_after_edit_icons',
1062 'modfullname' => 'get_module_type_name',
1063 'modplural' => 'get_module_type_name_plural',
1066 'availability' => false,
1067 'available' => 'get_available',
1068 'availablefrom' => 'get_deprecated_available_date',
1069 'availableinfo' => 'get_available_info',
1070 'availableuntil' => 'get_deprecated_available_date',
1071 'completion' => false,
1072 'completionexpected' => false,
1073 'completiongradeitemnumber' => false,
1074 'completionview' => false,
1075 'conditionscompletion' => false,
1076 'conditionsfield' => false,
1077 'conditionsgrade' => false,
1078 'context' => 'get_context',
1079 'course' => 'get_course_id',
1080 'coursegroupmode' => 'get_course_groupmode',
1081 'coursegroupmodeforce' => 'get_course_groupmodeforce',
1082 'effectivegroupmode' => 'get_effective_groupmode',
1084 'groupingid' => false,
1085 'groupmembersonly' => 'get_deprecated_group_members_only',
1086 'groupmode' => false,
1088 'iconcomponent' => false,
1089 'idnumber' => false,
1091 'instance' => false,
1094 'name' => 'get_name',
1097 'sectionnum' => false,
1098 'showavailability' => 'get_show_availability',
1099 'showdescription' => false,
1100 'uservisible' => 'get_user_visible',
1102 'visibleold' => false,
1106 * List of methods with no arguments that were public prior to Moodle 2.6.
1108 * They can still be accessed publicly via magic __call() function with no warnings
1109 * but are not listed in the class methods list.
1110 * For the consistency of the code it is better to use corresponding properties.
1112 * These methods be deprecated completely in later versions.
1114 * @var array $standardmethods
1116 private static $standardmethods = array(
1117 // Following methods are not recommended to use because there have associated read-only properties.
1120 'get_extra_classes',
1124 'get_after_edit_icons',
1125 // Method obtain_dynamic_data() should not be called from outside of this class but it was public before Moodle 2.6.
1126 'obtain_dynamic_data',
1130 * Magic method to call functions that are now declared as private now but
1131 * were public in Moodle before 2.6. Developers can access them without
1132 * any warnings but they are not listed in the class methods list.
1134 * @param string $name
1135 * @param array $arguments
1138 public function __call($name, $arguments) {
1141 if (in_array($name, self
::$standardmethods)) {
1142 if ($CFG->debugdeveloper
) {
1143 if ($alternative = array_search($name, self
::$standardproperties)) {
1144 // All standard methods do not have arguments anyway.
1145 debugging("cm_info::$name() is deprecated, please use the property cm_info->$alternative instead.", DEBUG_DEVELOPER
);
1147 debugging("cm_info::$name() is deprecated and should not be used.", DEBUG_DEVELOPER
);
1150 // All standard methods do not have arguments anyway.
1151 return $this->$name();
1153 throw new coding_exception("Method cm_info::{$name}() does not exist");
1157 * Magic method getter
1159 * @param string $name
1162 public function __get($name) {
1163 if (isset(self
::$standardproperties[$name])) {
1164 if ($method = self
::$standardproperties[$name]) {
1165 return $this->$method();
1167 return $this->$name;
1170 debugging('Invalid cm_info property accessed: '.$name);
1176 * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
1177 * and use {@link convert_to_array()}
1179 * @return ArrayIterator
1181 public function getIterator() {
1182 // Make sure dynamic properties are retrieved prior to view properties.
1183 $this->obtain_dynamic_data();
1186 // Do not iterate over deprecated properties.
1187 $props = self
::$standardproperties;
1188 unset($props['showavailability']);
1189 unset($props['availablefrom']);
1190 unset($props['availableuntil']);
1192 foreach ($props as $key => $unused) {
1193 $ret[$key] = $this->__get($key);
1195 return new ArrayIterator($ret);
1199 * Magic method for function isset()
1201 * @param string $name
1204 public function __isset($name) {
1205 if (isset(self
::$standardproperties[$name])) {
1206 $value = $this->__get($name);
1207 return isset($value);
1213 * Magic method for function empty()
1215 * @param string $name
1218 public function __empty($name) {
1219 if (isset(self
::$standardproperties[$name])) {
1220 $value = $this->__get($name);
1221 return empty($value);
1227 * Magic method setter
1229 * Will display the developer warning when trying to set/overwrite property.
1231 * @param string $name
1232 * @param mixed $value
1234 public function __set($name, $value) {
1235 debugging("It is not allowed to set the property cm_info::\${$name}", DEBUG_DEVELOPER
);
1239 * @return bool True if this module has a 'view' page that should be linked to in navigation
1240 * etc (note: modules may still have a view.php file, but return false if this is not
1241 * intended to be linked to from 'normal' parts of the interface; this is what label does).
1243 public function has_view() {
1244 return !is_null($this->url
);
1248 * @return moodle_url URL to link to for this module, or null if it doesn't have a view page
1250 private function get_url() {
1251 $this->obtain_dynamic_data();
1256 * Obtains content to display on main (view) page.
1257 * Note: Will collect view data, if not already obtained.
1258 * @return string Content to display on main page below link, or empty string if none
1260 private function get_content() {
1261 $this->obtain_view_data();
1262 return $this->content
;
1266 * Returns the content to display on course/overview page, formatted and passed through filters
1268 * if $options['context'] is not specified, the module context is used
1270 * @param array|stdClass $options formatting options, see {@link format_text()}
1273 public function get_formatted_content($options = array()) {
1274 $this->obtain_view_data();
1275 if (empty($this->content
)) {
1278 // Improve filter performance by preloading filter setttings for all
1279 // activities on the course (this does nothing if called multiple
1281 filter_preload_activities($this->get_modinfo());
1283 $options = (array)$options;
1284 if (!isset($options['context'])) {
1285 $options['context'] = $this->get_context();
1287 return format_text($this->content
, FORMAT_HTML
, $options);
1291 * Getter method for property $name, ensures that dynamic data is obtained.
1294 private function get_name() {
1295 $this->obtain_dynamic_data();
1300 * Returns the name to display on course/overview page, formatted and passed through filters
1302 * if $options['context'] is not specified, the module context is used
1304 * @param array|stdClass $options formatting options, see {@link format_string()}
1307 public function get_formatted_name($options = array()) {
1309 $options = (array)$options;
1310 if (!isset($options['context'])) {
1311 $options['context'] = $this->get_context();
1313 // Improve filter performance by preloading filter setttings for all
1314 // activities on the course (this does nothing if called multiple
1316 if (!empty($CFG->filterall
)) {
1317 filter_preload_activities($this->get_modinfo());
1319 return format_string($this->get_name(), true, $options);
1323 * Note: Will collect view data, if not already obtained.
1324 * @return string Extra CSS classes to add to html output for this activity on main page
1326 private function get_extra_classes() {
1327 $this->obtain_view_data();
1328 return $this->extraclasses
;
1332 * @return string Content of HTML on-click attribute. This string will be used literally
1333 * as a string so should be pre-escaped.
1335 private function get_on_click() {
1336 // Does not need view data; may be used by navigation
1337 $this->obtain_dynamic_data();
1338 return $this->onclick
;
1341 * @return mixed Optional custom data stored in modinfo cache for this activity, or null if none
1343 private function get_custom_data() {
1344 return $this->customdata
;
1348 * Note: Will collect view data, if not already obtained.
1349 * @return string Extra HTML code to display after link
1351 private function get_after_link() {
1352 $this->obtain_view_data();
1353 return $this->afterlink
;
1357 * Note: Will collect view data, if not already obtained.
1358 * @return string Extra HTML code to display after editing icons (e.g. more icons)
1360 private function get_after_edit_icons() {
1361 $this->obtain_view_data();
1362 return $this->afterediticons
;
1366 * @param moodle_core_renderer $output Output render to use, or null for default (global)
1367 * @return moodle_url Icon URL for a suitable icon to put beside this cm
1369 public function get_icon_url($output = null) {
1371 $this->obtain_dynamic_data();
1375 // Support modules setting their own, external, icon image
1376 if (!empty($this->iconurl
)) {
1377 $icon = $this->iconurl
;
1379 // Fallback to normal local icon + component procesing
1380 } else if (!empty($this->icon
)) {
1381 if (substr($this->icon
, 0, 4) === 'mod/') {
1382 list($modname, $iconname) = explode('/', substr($this->icon
, 4), 2);
1383 $icon = $output->pix_url($iconname, $modname);
1385 if (!empty($this->iconcomponent
)) {
1386 // Icon has specified component
1387 $icon = $output->pix_url($this->icon
, $this->iconcomponent
);
1389 // Icon does not have specified component, use default
1390 $icon = $output->pix_url($this->icon
);
1394 $icon = $output->pix_url('icon', $this->modname
);
1400 * Returns a localised human-readable name of the module type
1402 * @param bool $plural return plural form
1405 public function get_module_type_name($plural = false) {
1406 $modnames = get_module_types_names($plural);
1407 if (isset($modnames[$this->modname
])) {
1408 return $modnames[$this->modname
];
1415 * Returns a localised human-readable name of the module type in plural form - calculated on request
1419 private function get_module_type_name_plural() {
1420 return $this->get_module_type_name(true);
1424 * @return course_modinfo Modinfo object that this came from
1426 public function get_modinfo() {
1427 return $this->modinfo
;
1431 * Returns course object that was used in the first {@link get_fast_modinfo()} call.
1433 * It may not contain all fields from DB table {course} but always has at least the following:
1434 * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
1436 * If the course object lacks the field you need you can use the global
1437 * function {@link get_course()} that will save extra query if you access
1438 * current course or frontpage course.
1442 public function get_course() {
1443 return $this->modinfo
->get_course();
1447 * Returns course id for which the modinfo was generated.
1451 private function get_course_id() {
1452 return $this->modinfo
->get_course_id();
1456 * Returns group mode used for the course containing the module
1458 * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1460 private function get_course_groupmode() {
1461 return $this->modinfo
->get_course()->groupmode
;
1465 * Returns whether group mode is forced for the course containing the module
1469 private function get_course_groupmodeforce() {
1470 return $this->modinfo
->get_course()->groupmodeforce
;
1474 * Returns effective groupmode of the module that may be overwritten by forced course groupmode.
1476 * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS
1478 private function get_effective_groupmode() {
1479 $groupmode = $this->groupmode
;
1480 if ($this->modinfo
->get_course()->groupmodeforce
) {
1481 $groupmode = $this->modinfo
->get_course()->groupmode
;
1482 if ($groupmode != NOGROUPS
&& !plugin_supports('mod', $this->modname
, FEATURE_GROUPS
, 0)) {
1483 $groupmode = NOGROUPS
;
1490 * @return context_module Current module context
1492 private function get_context() {
1493 return context_module
::instance($this->id
);
1497 * Returns itself in the form of stdClass.
1499 * The object includes all fields that table course_modules has and additionally
1500 * fields 'name', 'modname', 'sectionnum' (if requested).
1502 * This can be used as a faster alternative to {@link get_coursemodule_from_id()}
1504 * @param bool $additionalfields include additional fields 'name', 'modname', 'sectionnum'
1507 public function get_course_module_record($additionalfields = false) {
1508 $cmrecord = new stdClass();
1510 // Standard fields from table course_modules.
1511 static $cmfields = array('id', 'course', 'module', 'instance', 'section', 'idnumber', 'added',
1512 'score', 'indent', 'visible', 'visibleold', 'groupmode', 'groupingid',
1513 'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected',
1514 'showdescription', 'availability');
1515 foreach ($cmfields as $key) {
1516 $cmrecord->$key = $this->$key;
1519 // Additional fields that function get_coursemodule_from_id() adds.
1520 if ($additionalfields) {
1521 $cmrecord->name
= $this->name
;
1522 $cmrecord->modname
= $this->modname
;
1523 $cmrecord->sectionnum
= $this->sectionnum
;
1533 * Sets content to display on course view page below link (if present).
1534 * @param string $content New content as HTML string (empty string if none)
1537 public function set_content($content) {
1538 $this->content
= $content;
1542 * Sets extra classes to include in CSS.
1543 * @param string $extraclasses Extra classes (empty string if none)
1546 public function set_extra_classes($extraclasses) {
1547 $this->extraclasses
= $extraclasses;
1551 * Sets the external full url that points to the icon being used
1552 * by the activity. Useful for external-tool modules (lti...)
1553 * If set, takes precedence over $icon and $iconcomponent
1555 * @param moodle_url $iconurl full external url pointing to icon image for activity
1558 public function set_icon_url(moodle_url
$iconurl) {
1559 $this->iconurl
= $iconurl;
1563 * Sets value of on-click attribute for JavaScript.
1564 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1565 * @param string $onclick New onclick attribute which should be HTML-escaped
1566 * (empty string if none)
1569 public function set_on_click($onclick) {
1570 $this->check_not_view_only();
1571 $this->onclick
= $onclick;
1575 * Sets HTML that displays after link on course view page.
1576 * @param string $afterlink HTML string (empty string if none)
1579 public function set_after_link($afterlink) {
1580 $this->afterlink
= $afterlink;
1584 * Sets HTML that displays after edit icons on course view page.
1585 * @param string $afterediticons HTML string (empty string if none)
1588 public function set_after_edit_icons($afterediticons) {
1589 $this->afterediticons
= $afterediticons;
1593 * Changes the name (text of link) for this module instance.
1594 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1595 * @param string $name Name of activity / link text
1598 public function set_name($name) {
1599 if ($this->state
< self
::STATE_BUILDING_DYNAMIC
) {
1600 $this->update_user_visible();
1602 $this->name
= $name;
1606 * Turns off the view link for this module instance.
1607 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1610 public function set_no_view_link() {
1611 $this->check_not_view_only();
1616 * Sets the 'uservisible' flag. This can be used (by setting false) to prevent access and
1617 * display of this module link for the current user.
1618 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1619 * @param bool $uservisible
1622 public function set_user_visible($uservisible) {
1623 $this->check_not_view_only();
1624 $this->uservisible
= $uservisible;
1628 * Sets the 'available' flag and related details. This flag is normally used to make
1629 * course modules unavailable until a certain date or condition is met. (When a course
1630 * module is unavailable, it is still visible to users who have viewhiddenactivities
1633 * When this is function is called, user-visible status is recalculated automatically.
1635 * The $showavailability flag does not really do anything any more, but is retained
1636 * for backward compatibility. Setting this to false will cause $availableinfo to
1639 * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1640 * @param bool $available False if this item is not 'available'
1641 * @param int $showavailability 0 = do not show this item at all if it's not available,
1642 * 1 = show this item greyed out with the following message
1643 * @param string $availableinfo Information about why this is not available, or
1644 * empty string if not displaying
1647 public function set_available($available, $showavailability=0, $availableinfo='') {
1648 $this->check_not_view_only();
1649 $this->available
= $available;
1650 if (!$showavailability) {
1651 $availableinfo = '';
1653 $this->availableinfo
= $availableinfo;
1654 $this->update_user_visible();
1658 * Some set functions can only be called from _cm_info_dynamic and not _cm_info_view.
1659 * This is because they may affect parts of this object which are used on pages other
1660 * than the view page (e.g. in the navigation block, or when checking access on
1664 private function check_not_view_only() {
1665 if ($this->state
>= self
::STATE_DYNAMIC
) {
1666 throw new coding_exception('Cannot set this data from _cm_info_view because it may ' .
1667 'affect other pages as well as view');
1672 * Constructor should not be called directly; use {@link get_fast_modinfo()}
1674 * @param course_modinfo $modinfo Parent object
1675 * @param stdClass $notused1 Argument not used
1676 * @param stdClass $mod Module object from the modinfo field of course table
1677 * @param stdClass $notused2 Argument not used
1679 public function __construct(course_modinfo
$modinfo, $notused1, $mod, $notused2) {
1680 $this->modinfo
= $modinfo;
1682 $this->id
= $mod->cm
;
1683 $this->instance
= $mod->id
;
1684 $this->modname
= $mod->mod
;
1685 $this->idnumber
= isset($mod->idnumber
) ?
$mod->idnumber
: '';
1686 $this->name
= $mod->name
;
1687 $this->visible
= $mod->visible
;
1688 $this->sectionnum
= $mod->section
; // Note weirdness with name here
1689 $this->groupmode
= isset($mod->groupmode
) ?
$mod->groupmode
: 0;
1690 $this->groupingid
= isset($mod->groupingid
) ?
$mod->groupingid
: 0;
1691 $this->indent
= isset($mod->indent
) ?
$mod->indent
: 0;
1692 $this->extra
= isset($mod->extra
) ?
$mod->extra
: '';
1693 $this->extraclasses
= isset($mod->extraclasses
) ?
$mod->extraclasses
: '';
1694 // iconurl may be stored as either string or instance of moodle_url.
1695 $this->iconurl
= isset($mod->iconurl
) ?
new moodle_url($mod->iconurl
) : '';
1696 $this->onclick
= isset($mod->onclick
) ?
$mod->onclick
: '';
1697 $this->content
= isset($mod->content
) ?
$mod->content
: '';
1698 $this->icon
= isset($mod->icon
) ?
$mod->icon
: '';
1699 $this->iconcomponent
= isset($mod->iconcomponent
) ?
$mod->iconcomponent
: '';
1700 $this->customdata
= isset($mod->customdata
) ?
$mod->customdata
: '';
1701 $this->showdescription
= isset($mod->showdescription
) ?
$mod->showdescription
: 0;
1702 $this->state
= self
::STATE_BASIC
;
1704 $this->section
= isset($mod->sectionid
) ?
$mod->sectionid
: 0;
1705 $this->module
= isset($mod->module
) ?
$mod->module
: 0;
1706 $this->added
= isset($mod->added
) ?
$mod->added
: 0;
1707 $this->score
= isset($mod->score
) ?
$mod->score
: 0;
1708 $this->visibleold
= isset($mod->visibleold
) ?
$mod->visibleold
: 0;
1710 // Note: it saves effort and database space to always include the
1711 // availability and completion fields, even if availability or completion
1712 // are actually disabled
1713 $this->completion
= isset($mod->completion
) ?
$mod->completion
: 0;
1714 $this->completiongradeitemnumber
= isset($mod->completiongradeitemnumber
)
1715 ?
$mod->completiongradeitemnumber
: null;
1716 $this->completionview
= isset($mod->completionview
)
1717 ?
$mod->completionview
: 0;
1718 $this->completionexpected
= isset($mod->completionexpected
)
1719 ?
$mod->completionexpected
: 0;
1720 $this->availability
= isset($mod->availability
) ?
$mod->availability
: null;
1721 $this->conditionscompletion
= isset($mod->conditionscompletion
)
1722 ?
$mod->conditionscompletion
: array();
1723 $this->conditionsgrade
= isset($mod->conditionsgrade
)
1724 ?
$mod->conditionsgrade
: array();
1725 $this->conditionsfield
= isset($mod->conditionsfield
)
1726 ?
$mod->conditionsfield
: array();
1728 static $modviews = array();
1729 if (!isset($modviews[$this->modname
])) {
1730 $modviews[$this->modname
] = !plugin_supports('mod', $this->modname
,
1731 FEATURE_NO_VIEW_LINK
);
1733 $this->url
= $modviews[$this->modname
]
1734 ?
new moodle_url('/mod/' . $this->modname
. '/view.php', array('id'=>$this->id
))
1739 * Creates a cm_info object from a database record (also accepts cm_info
1740 * in which case it is just returned unchanged).
1742 * @param stdClass|cm_info|null|bool $cm Stdclass or cm_info (or null or false)
1743 * @param int $userid Optional userid (default to current)
1744 * @return cm_info|null Object as cm_info, or null if input was null/false
1746 public static function create($cm, $userid = 0) {
1747 // Null, false, etc. gets passed through as null.
1751 // If it is already a cm_info object, just return it.
1752 if ($cm instanceof cm_info
) {
1755 // Otherwise load modinfo.
1756 if (empty($cm->id
) ||
empty($cm->course
)) {
1757 throw new coding_exception('$cm must contain ->id and ->course');
1759 $modinfo = get_fast_modinfo($cm->course
, $userid);
1760 return $modinfo->get_cm($cm->id
);
1764 * If dynamic data for this course-module is not yet available, gets it.
1766 * This function is automatically called when requesting any course_modinfo property
1767 * that can be modified by modules (have a set_xxx method).
1769 * Dynamic data is data which does not come directly from the cache but is calculated at
1770 * runtime based on the current user. Primarily this concerns whether the user can access
1771 * the module or not.
1773 * As part of this function, the module's _cm_info_dynamic function from its lib.php will
1774 * be called (if it exists).
1777 private function obtain_dynamic_data() {
1779 $userid = $this->modinfo
->get_user_id();
1780 if ($this->state
>= self
::STATE_BUILDING_DYNAMIC ||
$userid == -1) {
1783 $this->state
= self
::STATE_BUILDING_DYNAMIC
;
1785 if (!empty($CFG->enableavailability
)) {
1786 require_once($CFG->libdir
. '/conditionlib.php');
1787 // Get availability information.
1788 $ci = new \core_availability\
info_module($this);
1790 // Note that the modinfo currently available only includes minimal details (basic data)
1791 // but we know that this function does not need anything more than basic data.
1792 $this->available
= $ci->is_available($this->availableinfo
, true,
1793 $userid, $this->modinfo
);
1795 $this->available
= true;
1798 // Check parent section.
1799 if ($this->available
) {
1800 $parentsection = $this->modinfo
->get_section_info($this->sectionnum
);
1801 if (!$parentsection->available
) {
1802 // Do not store info from section here, as that is already
1803 // presented from the section (if appropriate) - just change
1805 $this->available
= false;
1809 // Update visible state for current user.
1810 $this->update_user_visible();
1812 // Let module make dynamic changes at this point
1813 $this->call_mod_function('cm_info_dynamic');
1814 $this->state
= self
::STATE_DYNAMIC
;
1818 * Getter method for property $uservisible, ensures that dynamic data is retrieved.
1821 private function get_user_visible() {
1822 $this->obtain_dynamic_data();
1823 return $this->uservisible
;
1827 * Getter method for property $available, ensures that dynamic data is retrieved
1830 private function get_available() {
1831 $this->obtain_dynamic_data();
1832 return $this->available
;
1836 * Getter method for property $showavailability. Works by checking the
1837 * availableinfo property to see if it's empty or not.
1840 * @deprecated Since Moodle 2.7
1842 private function get_show_availability() {
1843 debugging('$cm->showavailability property has been deprecated. You ' .
1844 'can replace it by checking if $cm->availableinfo has content.',
1846 return ($this->get_available_info() !== '') ?
1 : 0;
1850 * Getter method for $availablefrom and $availableuntil. Just returns zero
1851 * as these are no longer supported.
1854 * @deprecated Since Moodle 2.7
1856 private function get_deprecated_available_date() {
1857 debugging('$cm->availablefrom and $cm->availableuntil have been deprecated. This ' .
1858 'information is no longer available as the system provides more complex ' .
1859 'options (for example, there might be different dates for different users).',
1865 * Getter method for $availablefrom and $availableuntil. Just returns zero
1866 * as these are no longer supported.
1869 * @deprecated Since Moodle 2.8
1871 private function get_deprecated_group_members_only() {
1872 debugging('$cm->groupmembersonly has been deprecated and always returns zero. ' .
1873 'If used to restrict a list of enrolled users to only those who can ' .
1874 'access the module, consider \core_availability\info_module::filter_user_list.',
1880 * Getter method for property $availableinfo, ensures that dynamic data is retrieved
1882 * @return string Available info (HTML)
1884 private function get_available_info() {
1885 $this->obtain_dynamic_data();
1886 return $this->availableinfo
;
1890 * Works out whether activity is available to the current user
1892 * If the activity is unavailable, additional checks are required to determine if its hidden or greyed out
1894 * @see is_user_access_restricted_by_conditional_access()
1897 private function update_user_visible() {
1898 $userid = $this->modinfo
->get_user_id();
1899 if ($userid == -1) {
1902 $this->uservisible
= true;
1904 // If the user cannot access the activity set the uservisible flag to false.
1905 // Additional checks are required to determine whether the activity is entirely hidden or just greyed out.
1906 if ((!$this->visible
or !$this->get_available()) and
1907 !has_capability('moodle/course:viewhiddenactivities', $this->get_context(), $userid)) {
1909 $this->uservisible
= false;
1912 // Check group membership.
1913 if ($this->is_user_access_restricted_by_capability()) {
1915 $this->uservisible
= false;
1916 // Ensure activity is completely hidden from the user.
1917 $this->availableinfo
= '';
1922 * Checks whether the module's group settings restrict the current user's
1923 * access. This function is not necessary now that all access restrictions
1924 * are handled by the availability API. You can use $cm->uservisible to
1925 * find out if the current user can access an activity, or $cm->availableinfo
1926 * to get information about why not.
1928 * @return bool False
1929 * @deprecated Since Moodle 2.8
1931 public function is_user_access_restricted_by_group() {
1932 debugging('cm_info::is_user_access_restricted_by_group() ' .
1933 'is deprecated and always returns false; use $cm->uservisible ' .
1934 'to decide whether the current user can access an activity', DEBUG_DEVELOPER
);
1939 * Checks whether mod/...:view capability restricts the current user's access.
1941 * @return bool True if the user access is restricted.
1943 public function is_user_access_restricted_by_capability() {
1944 $userid = $this->modinfo
->get_user_id();
1945 if ($userid == -1) {
1948 $capability = 'mod/' . $this->modname
. ':view';
1949 $capabilityinfo = get_capability_info($capability);
1950 if (!$capabilityinfo) {
1951 // Capability does not exist, no one is prevented from seeing the activity.
1955 // You are blocked if you don't have the capability.
1956 return !has_capability($capability, $this->get_context(), $userid);
1960 * Checks whether the module's conditional access settings mean that the
1961 * user cannot see the activity at all
1963 * This is deprecated because it is confusing (name sounds like it's about
1964 * access restriction but it is actually about display), is not used
1965 * anywhere, and is not necessary. Nobody (outside conditional libraries)
1966 * should care what it is that restricted something.
1968 * @return bool True if the user cannot see the module. False if the activity is either available or should be greyed out.
1969 * @deprecated since 2.7
1971 public function is_user_access_restricted_by_conditional_access() {
1973 debugging('cm_info::is_user_access_restricted_by_conditional_access() ' .
1974 'is deprecated; this function is not needed (use $cm->uservisible ' .
1975 'and $cm->availableinfo to decide whether it should be available ' .
1976 'or appear)', DEBUG_DEVELOPER
);
1978 if (empty($CFG->enableavailability
)) {
1982 $userid = $this->modinfo
->get_user_id();
1983 if ($userid == -1) {
1987 // Return false if user can access the activity, or if its availability
1988 // info is set (= should be displayed even though not accessible).
1989 return !$this->get_user_visible() && !$this->get_available_info();
1993 * Calls a module function (if exists), passing in one parameter: this object.
1994 * @param string $type Name of function e.g. if this is 'grooblezorb' and the modname is
1995 * 'forum' then it will try to call 'mod_forum_grooblezorb' or 'forum_grooblezorb'
1998 private function call_mod_function($type) {
2000 $libfile = $CFG->dirroot
. '/mod/' . $this->modname
. '/lib.php';
2001 if (file_exists($libfile)) {
2002 include_once($libfile);
2003 $function = 'mod_' . $this->modname
. '_' . $type;
2004 if (function_exists($function)) {
2007 $function = $this->modname
. '_' . $type;
2008 if (function_exists($function)) {
2016 * If view data for this course-module is not yet available, obtains it.
2018 * This function is automatically called if any of the functions (marked) which require
2019 * view data are called.
2021 * View data is data which is needed only for displaying the course main page (& any similar
2022 * functionality on other pages) but is not needed in general. Obtaining view data may have
2023 * a performance cost.
2025 * As part of this function, the module's _cm_info_view function from its lib.php will
2026 * be called (if it exists).
2029 private function obtain_view_data() {
2030 if ($this->state
>= self
::STATE_BUILDING_VIEW ||
$this->modinfo
->get_user_id() == -1) {
2033 $this->obtain_dynamic_data();
2034 $this->state
= self
::STATE_BUILDING_VIEW
;
2036 // Let module make changes at this point
2037 $this->call_mod_function('cm_info_view');
2038 $this->state
= self
::STATE_VIEW
;
2044 * Returns reference to full info about modules in course (including visibility).
2045 * Cached and as fast as possible (0 or 1 db query).
2047 * use get_fast_modinfo($courseid, 0, true) to reset the static cache for particular course
2048 * use get_fast_modinfo(0, 0, true) to reset the static cache for all courses
2050 * use rebuild_course_cache($courseid, true) to reset the application AND static cache
2051 * for particular course when it's contents has changed
2053 * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
2054 * and recommended to have field 'cacherev') or just a course id. Just course id
2055 * is enough when calling get_fast_modinfo() for current course or site or when
2056 * calling for any other course for the second time.
2057 * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections.
2058 * Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
2059 * @param bool $resetonly whether we want to get modinfo or just reset the cache
2060 * @return course_modinfo|null Module information for course, or null if resetting
2061 * @throws moodle_exception when course is not found (nothing is thrown if resetting)
2063 function get_fast_modinfo($courseorid, $userid = 0, $resetonly = false) {
2064 // compartibility with syntax prior to 2.4:
2065 if ($courseorid === 'reset') {
2066 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
);
2071 // Function get_fast_modinfo() can never be called during upgrade unless it is used for clearing cache only.
2073 upgrade_ensure_not_running();
2076 // Function is called with $reset = true
2078 course_modinfo
::clear_instance_cache($courseorid);
2082 // Function is called with $reset = false, retrieve modinfo
2083 return course_modinfo
::instance($courseorid, $userid);
2087 * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given
2088 * a cmid. If module name is also provided, it will ensure the cm is of that type.
2091 * list($course, $cm) = get_course_and_cm_from_cmid($cmid, 'forum');
2093 * Using this method has a performance advantage because it works by loading
2094 * modinfo for the course - which will then be cached and it is needed later
2095 * in most requests. It also guarantees that the $cm object is a cm_info and
2098 * The $course object can be supplied if already known and will speed
2099 * up this function - although it is more efficient to use this function to
2100 * get the course if you are starting from a cmid.
2102 * To avoid security problems and obscure bugs, you should always specify
2103 * $modulename if the cmid value came from user input.
2105 * By default this obtains information (for example, whether user can access
2106 * the activity) for current user, but you can specify a userid if required.
2108 * @param stdClass|int $cmorid Id of course-module, or database object
2109 * @param string $modulename Optional modulename (improves security)
2110 * @param stdClass|int $courseorid Optional course object if already loaded
2111 * @param int $userid Optional userid (default = current)
2112 * @return array Array with 2 elements $course and $cm
2113 * @throws moodle_exception If the item doesn't exist or is of wrong module name
2115 function get_course_and_cm_from_cmid($cmorid, $modulename = '', $courseorid = 0, $userid = 0) {
2117 if (is_object($cmorid)) {
2118 $cmid = $cmorid->id
;
2119 if (isset($cmorid->course
)) {
2120 $courseid = (int)$cmorid->course
;
2125 $cmid = (int)$cmorid;
2129 // Validate module name if supplied.
2130 if ($modulename && !core_component
::is_valid_plugin_name('mod', $modulename)) {
2131 throw new coding_exception('Invalid modulename parameter');
2134 // Get course from last parameter if supplied.
2136 if (is_object($courseorid)) {
2137 $course = $courseorid;
2138 } else if ($courseorid) {
2139 $courseid = (int)$courseorid;
2144 // If course ID is known, get it using normal function.
2145 $course = get_course($courseid);
2147 // Get course record in a single query based on cmid.
2148 $course = $DB->get_record_sql("
2150 FROM {course_modules} cm
2151 JOIN {course} c ON c.id = cm.course
2152 WHERE cm.id = ?", array($cmid), MUST_EXIST
);
2156 // Get cm from get_fast_modinfo.
2157 $modinfo = get_fast_modinfo($course, $userid);
2158 $cm = $modinfo->get_cm($cmid);
2159 if ($modulename && $cm->modname
!== $modulename) {
2160 throw new moodle_exception('invalidcoursemodule', 'error');
2162 return array($course, $cm);
2166 * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given
2167 * an instance id or record and module name.
2170 * list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
2172 * Using this method has a performance advantage because it works by loading
2173 * modinfo for the course - which will then be cached and it is needed later
2174 * in most requests. It also guarantees that the $cm object is a cm_info and
2177 * The $course object can be supplied if already known and will speed
2178 * up this function - although it is more efficient to use this function to
2179 * get the course if you are starting from an instance id.
2181 * By default this obtains information (for example, whether user can access
2182 * the activity) for current user, but you can specify a userid if required.
2184 * @param stdclass|int $instanceorid Id of module instance, or database object
2185 * @param string $modulename Modulename (required)
2186 * @param stdClass|int $courseorid Optional course object if already loaded
2187 * @param int $userid Optional userid (default = current)
2188 * @return array Array with 2 elements $course and $cm
2189 * @throws moodle_exception If the item doesn't exist or is of wrong module name
2191 function get_course_and_cm_from_instance($instanceorid, $modulename, $courseorid = 0, $userid = 0) {
2194 // Get data from parameter.
2195 if (is_object($instanceorid)) {
2196 $instanceid = $instanceorid->id
;
2197 if (isset($instanceorid->course
)) {
2198 $courseid = (int)$instanceorid->course
;
2203 $instanceid = (int)$instanceorid;
2207 // Get course from last parameter if supplied.
2209 if (is_object($courseorid)) {
2210 $course = $courseorid;
2211 } else if ($courseorid) {
2212 $courseid = (int)$courseorid;
2215 // Validate module name if supplied.
2216 if (!core_component
::is_valid_plugin_name('mod', $modulename)) {
2217 throw new coding_exception('Invalid modulename parameter');
2222 // If course ID is known, get it using normal function.
2223 $course = get_course($courseid);
2225 // Get course record in a single query based on instance id.
2226 $pagetable = '{' . $modulename . '}';
2227 $course = $DB->get_record_sql("
2229 FROM $pagetable instance
2230 JOIN {course} c ON c.id = instance.course
2231 WHERE instance.id = ?", array($instanceid), MUST_EXIST
);
2235 // Get cm from get_fast_modinfo.
2236 $modinfo = get_fast_modinfo($course, $userid);
2237 $instances = $modinfo->get_instances_of($modulename);
2238 if (!array_key_exists($instanceid, $instances)) {
2239 throw new moodle_exception('invalidmoduleid', 'error', $instanceid);
2241 return array($course, $instances[$instanceid]);
2246 * Rebuilds or resets the cached list of course activities stored in MUC.
2248 * rebuild_course_cache() must NEVER be called from lib/db/upgrade.php.
2249 * At the same time course cache may ONLY be cleared using this function in
2250 * upgrade scripts of plugins.
2252 * During the bulk operations if it is necessary to reset cache of multiple
2253 * courses it is enough to call {@link increment_revision_number()} for the
2254 * table 'course' and field 'cacherev' specifying affected courses in select.
2256 * Cached course information is stored in MUC core/coursemodinfo and is
2257 * validated with the DB field {course}.cacherev
2259 * @global moodle_database $DB
2260 * @param int $courseid id of course to rebuild, empty means all
2261 * @param boolean $clearonly only clear the cache, gets rebuild automatically on the fly.
2262 * Recommended to set to true to avoid unnecessary multiple rebuilding.
2264 function rebuild_course_cache($courseid=0, $clearonly=false) {
2265 global $COURSE, $SITE, $DB, $CFG;
2267 // Function rebuild_course_cache() can not be called during upgrade unless it's clear only.
2268 if (!$clearonly && !upgrade_ensure_not_running(true)) {
2272 // Destroy navigation caches
2273 navigation_cache
::destroy_volatile_caches();
2275 if (class_exists('format_base')) {
2276 // if file containing class is not loaded, there is no cache there anyway
2277 format_base
::reset_course_cache($courseid);
2280 $cachecoursemodinfo = cache
::make('core', 'coursemodinfo');
2281 if (empty($courseid)) {
2282 // Clearing caches for all courses.
2283 increment_revision_number('course', 'cacherev', '');
2284 $cachecoursemodinfo->purge();
2285 course_modinfo
::clear_instance_cache();
2286 // Update global values too.
2287 $sitecacherev = $DB->get_field('course', 'cacherev', array('id' => SITEID
));
2288 $SITE->cachrev
= $sitecacherev;
2289 if ($COURSE->id
== SITEID
) {
2290 $COURSE->cacherev
= $sitecacherev;
2292 $COURSE->cacherev
= $DB->get_field('course', 'cacherev', array('id' => $COURSE->id
));
2295 // Clearing cache for one course, make sure it is deleted from user request cache as well.
2296 increment_revision_number('course', 'cacherev', 'id = :id', array('id' => $courseid));
2297 $cachecoursemodinfo->delete($courseid);
2298 course_modinfo
::clear_instance_cache($courseid);
2299 // Update global values too.
2300 if ($courseid == $COURSE->id ||
$courseid == $SITE->id
) {
2301 $cacherev = $DB->get_field('course', 'cacherev', array('id' => $courseid));
2302 if ($courseid == $COURSE->id
) {
2303 $COURSE->cacherev
= $cacherev;
2305 if ($courseid == $SITE->id
) {
2306 $SITE->cachrev
= $cacherev;
2316 $select = array('id'=>$courseid);
2319 core_php_time_limit
::raise(); // this could take a while! MDL-10954
2322 $rs = $DB->get_recordset("course", $select,'','id,'.join(',', course_modinfo
::$cachedfields));
2323 // Rebuild cache for each course.
2324 foreach ($rs as $course) {
2325 course_modinfo
::build_course_cache($course);
2332 * Class that is the return value for the _get_coursemodule_info module API function.
2334 * Note: For backward compatibility, you can also return a stdclass object from that function.
2335 * The difference is that the stdclass object may contain an 'extra' field (deprecated,
2336 * use extraclasses and onclick instead). The stdclass object may not contain
2337 * the new fields defined here (content, extraclasses, customdata).
2339 class cached_cm_info
{
2341 * Name (text of link) for this activity; Leave unset to accept default name
2347 * Name of icon for this activity. Normally, this should be used together with $iconcomponent
2348 * to define the icon, as per pix_url function.
2349 * For backward compatibility, if this value is of the form 'mod/forum/icon' then an icon
2350 * within that module will be used.
2351 * @see cm_info::get_icon_url()
2352 * @see renderer_base::pix_url()
2358 * Component for icon for this activity, as per pix_url; leave blank to use default 'moodle'
2360 * @see renderer_base::pix_url()
2363 public $iconcomponent;
2366 * HTML content to be displayed on the main page below the link (if any) for this course-module
2372 * Custom data to be stored in modinfo for this activity; useful if there are cases when
2373 * internal information for this activity type needs to be accessible from elsewhere on the
2374 * course without making database queries. May be of any type but should be short.
2380 * Extra CSS class or classes to be added when this activity is displayed on the main page;
2381 * space-separated string
2384 public $extraclasses;
2387 * External URL image to be used by activity as icon, useful for some external-tool modules
2388 * like lti. If set, takes precedence over $icon and $iconcomponent
2394 * Content of onclick JavaScript; escaped HTML to be inserted as attribute value
2402 * Data about a single section on a course. This contains the fields from the
2403 * course_sections table, plus additional data when required.
2405 * @property-read int $id Section ID - from course_sections table
2406 * @property-read int $course Course ID - from course_sections table
2407 * @property-read int $section Section number - from course_sections table
2408 * @property-read string $name Section name if specified - from course_sections table
2409 * @property-read int $visible Section visibility (1 = visible) - from course_sections table
2410 * @property-read string $summary Section summary text if specified - from course_sections table
2411 * @property-read int $summaryformat Section summary text format (FORMAT_xx constant) - from course_sections table
2412 * @property-read string $availability Availability information as JSON string -
2413 * from course_sections table
2414 * @property-read array $conditionscompletion Availability conditions for this section based on the completion of
2415 * course-modules (array from course-module id to required completion state
2416 * for that module) - from cached data in sectioncache field
2417 * @property-read array $conditionsgrade Availability conditions for this section based on course grades (array from
2418 * grade item id to object with ->min, ->max fields) - from cached data in
2419 * sectioncache field
2420 * @property-read array $conditionsfield Availability conditions for this section based on user fields
2421 * @property-read bool $available True if this section is available to the given user i.e. if all availability conditions
2422 * are met - obtained dynamically
2423 * @property-read string $availableinfo If section is not available to some users, this string gives information about
2424 * availability which can be displayed to students and/or staff (e.g. 'Available from 3 January 2010')
2425 * for display on main page - obtained dynamically
2426 * @property-read bool $uservisible True if this section is available to the given user (for example, if current user
2427 * has viewhiddensections capability, they can access the section even if it is not
2428 * visible or not available, so this would be true in that case) - obtained dynamically
2429 * @property-read string $sequence Comma-separated list of all modules in the section. Note, this field may not exactly
2430 * match course_sections.sequence if later has references to non-existing modules or not modules of not available module types.
2431 * @property-read course_modinfo $modinfo
2433 class section_info
implements IteratorAggregate
{
2435 * Section ID - from course_sections table
2441 * Section number - from course_sections table
2447 * Section name if specified - from course_sections table
2453 * Section visibility (1 = visible) - from course_sections table
2459 * Section summary text if specified - from course_sections table
2465 * Section summary text format (FORMAT_xx constant) - from course_sections table
2468 private $_summaryformat;
2471 * Availability information as JSON string - from course_sections table
2474 private $_availability;
2477 * Availability conditions for this section based on the completion of
2478 * course-modules (array from course-module id to required completion state
2479 * for that module) - from cached data in sectioncache field
2482 private $_conditionscompletion;
2485 * Availability conditions for this section based on course grades (array from
2486 * grade item id to object with ->min, ->max fields) - from cached data in
2487 * sectioncache field
2490 private $_conditionsgrade;
2493 * Availability conditions for this section based on user fields
2496 private $_conditionsfield;
2499 * True if this section is available to students i.e. if all availability conditions
2500 * are met - obtained dynamically on request, see function {@link section_info::get_available()}
2503 private $_available;
2506 * If section is not available to some users, this string gives information about
2507 * availability which can be displayed to students and/or staff (e.g. 'Available from 3
2508 * January 2010') for display on main page - obtained dynamically on request, see
2509 * function {@link section_info::get_availableinfo()}
2512 private $_availableinfo;
2515 * True if this section is available to the CURRENT user (for example, if current user
2516 * has viewhiddensections capability, they can access the section even if it is not
2517 * visible or not available, so this would be true in that case) - obtained dynamically
2518 * on request, see function {@link section_info::get_uservisible()}
2521 private $_uservisible;
2524 * Default values for sectioncache fields; if a field has this value, it won't
2525 * be stored in the sectioncache cache, to save space. Checks are done by ===
2526 * which means values must all be strings.
2529 private static $sectioncachedefaults = array(
2532 'summaryformat' => '1', // FORMAT_HTML, but must be a string
2534 'availability' => null,
2538 * Stores format options that have been cached when building 'coursecache'
2539 * When the format option is requested we look first if it has been cached
2542 private $cachedformatoptions = array();
2545 * Stores the list of all possible section options defined in each used course format.
2548 static private $sectionformatoptions = array();
2551 * Stores the modinfo object passed in constructor, may be used when requesting
2552 * dynamically obtained attributes such as available, availableinfo, uservisible.
2553 * Also used to retrun information about current course or user.
2554 * @var course_modinfo
2559 * Constructs object from database information plus extra required data.
2560 * @param object $data Array entry from cached sectioncache
2561 * @param int $number Section number (array key)
2562 * @param int $notused1 argument not used (informaion is available in $modinfo)
2563 * @param int $notused2 argument not used (informaion is available in $modinfo)
2564 * @param course_modinfo $modinfo Owner (needed for checking availability)
2565 * @param int $notused3 argument not used (informaion is available in $modinfo)
2567 public function __construct($data, $number, $notused1, $notused2, $modinfo, $notused3) {
2569 require_once($CFG->dirroot
.'/course/lib.php');
2571 // Data that is always present
2572 $this->_id
= $data->id
;
2574 $defaults = self
::$sectioncachedefaults +
2575 array('conditionscompletion' => array(),
2576 'conditionsgrade' => array(),
2577 'conditionsfield' => array());
2579 // Data that may use default values to save cache size
2580 foreach ($defaults as $field => $value) {
2581 if (isset($data->{$field})) {
2582 $this->{'_'.$field} = $data->{$field};
2584 $this->{'_'.$field} = $value;
2588 // Other data from constructor arguments.
2589 $this->_section
= $number;
2590 $this->modinfo
= $modinfo;
2592 // Cached course format data.
2593 $course = $modinfo->get_course();
2594 if (!isset(self
::$sectionformatoptions[$course->format
])) {
2595 // Store list of section format options defined in each used course format.
2596 // They do not depend on particular course but only on its format.
2597 self
::$sectionformatoptions[$course->format
] =
2598 course_get_format($course)->section_format_options();
2600 foreach (self
::$sectionformatoptions[$course->format
] as $field => $option) {
2601 if (!empty($option['cache'])) {
2602 if (isset($data->{$field})) {
2603 $this->cachedformatoptions
[$field] = $data->{$field};
2604 } else if (array_key_exists('cachedefault', $option)) {
2605 $this->cachedformatoptions
[$field] = $option['cachedefault'];
2612 * Magic method to check if the property is set
2614 * @param string $name name of the property
2617 public function __isset($name) {
2618 if (method_exists($this, 'get_'.$name) ||
2619 property_exists($this, '_'.$name) ||
2620 array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
2621 $value = $this->__get($name);
2622 return isset($value);
2628 * Magic method to check if the property is empty
2630 * @param string $name name of the property
2633 public function __empty($name) {
2634 if (method_exists($this, 'get_'.$name) ||
2635 property_exists($this, '_'.$name) ||
2636 array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
2637 $value = $this->__get($name);
2638 return empty($value);
2644 * Magic method to retrieve the property, this is either basic section property
2645 * or availability information or additional properties added by course format
2647 * @param string $name name of the property
2650 public function __get($name) {
2651 if (method_exists($this, 'get_'.$name)) {
2652 return $this->{'get_'.$name}();
2654 if (property_exists($this, '_'.$name)) {
2655 return $this->{'_'.$name};
2657 if (array_key_exists($name, $this->cachedformatoptions
)) {
2658 return $this->cachedformatoptions
[$name];
2660 // precheck if the option is defined in format to avoid unnecessary DB queries in get_format_options()
2661 if (array_key_exists($name, self
::$sectionformatoptions[$this->modinfo
->get_course()->format
])) {
2662 $formatoptions = course_get_format($this->modinfo
->get_course())->get_format_options($this);
2663 return $formatoptions[$name];
2665 debugging('Invalid section_info property accessed! '.$name);
2670 * Finds whether this section is available at the moment for the current user.
2672 * The value can be accessed publicly as $sectioninfo->available
2676 private function get_available() {
2678 $userid = $this->modinfo
->get_user_id();
2679 if ($this->_available
!== null ||
$userid == -1) {
2680 // Has already been calculated or does not need calculation.
2681 return $this->_available
;
2683 $this->_available
= true;
2684 $this->_availableinfo
= '';
2685 if (!empty($CFG->enableavailability
)) {
2686 require_once($CFG->libdir
. '/conditionlib.php');
2687 // Get availability information.
2688 $ci = new \core_availability\
info_section($this);
2689 $this->_available
= $ci->is_available($this->_availableinfo
, true,
2690 $userid, $this->modinfo
);
2692 // Execute the hook from the course format that may override the available/availableinfo properties.
2693 $currentavailable = $this->_available
;
2694 course_get_format($this->modinfo
->get_course())->
2695 section_get_available_hook($this, $this->_available
, $this->_availableinfo
);
2696 if (!$currentavailable && $this->_available
) {
2697 debugging('section_get_available_hook() can not make unavailable section available', DEBUG_DEVELOPER
);
2698 $this->_available
= $currentavailable;
2700 return $this->_available
;
2704 * Returns the availability text shown next to the section on course page.
2708 private function get_availableinfo() {
2709 // Calling get_available() will also fill the availableinfo property
2710 // (or leave it null if there is no userid).
2711 $this->get_available();
2712 return $this->_availableinfo
;
2716 * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
2717 * and use {@link convert_to_array()}
2719 * @return ArrayIterator
2721 public function getIterator() {
2723 foreach (get_object_vars($this) as $key => $value) {
2724 if (substr($key, 0, 1) == '_') {
2725 if (method_exists($this, 'get'.$key)) {
2726 $ret[substr($key, 1)] = $this->{'get'.$key}();
2728 $ret[substr($key, 1)] = $this->$key;
2732 $ret['sequence'] = $this->get_sequence();
2733 $ret['course'] = $this->get_course();
2734 $ret = array_merge($ret, course_get_format($this->modinfo
->get_course())->get_format_options($this->_section
));
2735 return new ArrayIterator($ret);
2739 * Works out whether activity is visible *for current user* - if this is false, they
2740 * aren't allowed to access it.
2744 private function get_uservisible() {
2745 $userid = $this->modinfo
->get_user_id();
2746 if ($this->_uservisible
!== null ||
$userid == -1) {
2747 // Has already been calculated or does not need calculation.
2748 return $this->_uservisible
;
2750 $this->_uservisible
= true;
2751 if (!$this->_visible ||
!$this->get_available()) {
2752 $coursecontext = context_course
::instance($this->get_course());
2753 if (!has_capability('moodle/course:viewhiddensections', $coursecontext, $userid)) {
2754 $this->_uservisible
= false;
2757 return $this->_uservisible
;
2761 * Getter method for property $showavailability. Works by checking the
2762 * availableinfo property to see if it's empty or not.
2765 * @deprecated Since Moodle 2.7
2767 private function get_showavailability() {
2768 debugging('$section->showavailability property has been deprecated. You ' .
2769 'can replace it by checking if $section->availableinfo has content.',
2771 return ($this->get_availableinfo() !== '') ?
1 : 0;
2775 * Getter method for $availablefrom. Just returns zero as no longer supported.
2778 * @deprecated Since Moodle 2.7
2780 private function get_availablefrom() {
2781 debugging('$section->availablefrom has been deprecated. This ' .
2782 'information is no longer available as the system provides more complex ' .
2783 'options (for example, there might be different dates for different users).',
2789 * Getter method for $availablefrom. Just returns zero as no longer supported.
2792 * @deprecated Since Moodle 2.7
2794 private function get_availableuntil() {
2795 debugging('$section->availableuntil has been deprecated. This ' .
2796 'information is no longer available as the system provides more complex ' .
2797 'options (for example, there might be different dates for different users).',
2803 * Getter method for $groupingid. Just returns zero as no longer supported.
2806 * @deprecated Since Moodle 2.7
2808 private function get_groupingid() {
2809 debugging('$section->groupingid has been deprecated. This ' .
2810 'information is no longer available as the system provides more complex ' .
2811 'options (for example, combining multiple groupings).',
2817 * Restores the course_sections.sequence value
2821 private function get_sequence() {
2822 if (!empty($this->modinfo
->sections
[$this->_section
])) {
2823 return implode(',', $this->modinfo
->sections
[$this->_section
]);
2830 * Returns course ID - from course_sections table
2834 private function get_course() {
2835 return $this->modinfo
->get_course_id();
2841 * @return course_modinfo
2843 private function get_modinfo() {
2844 return $this->modinfo
;
2848 * Prepares section data for inclusion in sectioncache cache, removing items
2849 * that are set to defaults, and adding availability data if required.
2851 * Called by build_section_cache in course_modinfo only; do not use otherwise.
2852 * @param object $section Raw section data object
2854 public static function convert_for_section_cache($section) {
2857 // Course id stored in course table
2858 unset($section->course
);
2859 // Section number stored in array key
2860 unset($section->section
);
2861 // Sequence stored implicity in modinfo $sections array
2862 unset($section->sequence
);
2864 // Remove default data
2865 foreach (self
::$sectioncachedefaults as $field => $value) {
2866 // Exact compare as strings to avoid problems if some strings are set
2868 if (isset($section->{$field}) && $section->{$field} === $value) {
2869 unset($section->{$field});