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