Merge branch 'wip-MDL-41106-m26' of git://github.com/samhemelryk/moodle
[moodle.git] / lib / modinfolib.php
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/>.
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  */
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
31 if (!defined('MAX_MODINFO_CACHE_SIZE')) {
32     define('MAX_MODINFO_CACHE_SIZE', 10);
33 }
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.
42  */
43 class course_modinfo extends stdClass {
44     // For convenience we store the course object here as it is needed in other parts of code
45     private $course;
46     // Array of section data from cache
47     private $sectioninfo;
49     // Existing data fields
50     ///////////////////////
52     // These are public for backward compatibility. Note: it is not possible to retain BC
53     // using PHP magic get methods because behaviour is different with regard to empty().
55     /**
56      * Course ID
57      * @var int
58      * @deprecated For new code, use get_course_id instead.
59      */
60     public $courseid;
62     /**
63      * User ID
64      * @var int
65      * @deprecated For new code, use get_user_id instead.
66      */
67     public $userid;
69     /**
70      * Array from int (section num, e.g. 0) => array of int (course-module id); this list only
71      * includes sections that actually contain at least one course-module
72      * @var array
73      * @deprecated For new code, use get_sections instead
74      */
75     public $sections;
77     /**
78      * Array from int (cm id) => cm_info object
79      * @var array
80      * @deprecated For new code, use get_cms or get_cm instead.
81      */
82     public $cms;
84     /**
85      * Array from string (modname) => int (instance id) => cm_info object
86      * @var array
87      * @deprecated For new code, use get_instances or get_instances_of instead.
88      */
89     public $instances;
91     /**
92      * Groups that the current user belongs to. This value is usually not available (set to null)
93      * unless the course has activities set to groupmembersonly. When set, it is an array of
94      * grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'.
95      * @var array
96      * @deprecated Don't use this! For new code, use get_groups.
97      */
98     public $groups;
100     // Get methods for data
101     ///////////////////////
103     /**
104      * @return object Moodle course object that was used to construct this data
105      */
106     public function get_course() {
107         return $this->course;
108     }
110     /**
111      * @return int Course ID
112      */
113     public function get_course_id() {
114         return $this->courseid;
115     }
117     /**
118      * @return int User ID
119      */
120     public function get_user_id() {
121         return $this->userid;
122     }
124     /**
125      * @return array Array from section number (e.g. 0) to array of course-module IDs in that
126      *   section; this only includes sections that contain at least one course-module
127      */
128     public function get_sections() {
129         return $this->sections;
130     }
132     /**
133      * @return array Array from course-module instance to cm_info object within this course, in
134      *   order of appearance
135      */
136     public function get_cms() {
137         return $this->cms;
138     }
140     /**
141      * Obtains a single course-module object (for a course-module that is on this course).
142      * @param int $cmid Course-module ID
143      * @return cm_info Information about that course-module
144      * @throws moodle_exception If the course-module does not exist
145      */
146     public function get_cm($cmid) {
147         if (empty($this->cms[$cmid])) {
148             throw new moodle_exception('invalidcoursemodule', 'error');
149         }
150         return $this->cms[$cmid];
151     }
153     /**
154      * Obtains all module instances on this course.
155      * @return array Array from module name => array from instance id => cm_info
156      */
157     public function get_instances() {
158         return $this->instances;
159     }
161     /**
162      * Returns array of localised human-readable module names used in this course
163      *
164      * @param bool $plural if true returns the plural form of modules names
165      * @return array
166      */
167     public function get_used_module_names($plural = false) {
168         $modnames = get_module_types_names($plural);
169         $modnamesused = array();
170         foreach ($this->get_cms() as $cmid => $mod) {
171             if (isset($modnames[$mod->modname]) && $mod->uservisible) {
172                 $modnamesused[$mod->modname] = $modnames[$mod->modname];
173             }
174         }
175         core_collator::asort($modnamesused);
176         return $modnamesused;
177     }
179     /**
180      * Obtains all instances of a particular module on this course.
181      * @param $modname Name of module (not full frankenstyle) e.g. 'label'
182      * @return array Array from instance id => cm_info for modules on this course; empty if none
183      */
184     public function get_instances_of($modname) {
185         if (empty($this->instances[$modname])) {
186             return array();
187         }
188         return $this->instances[$modname];
189     }
191     /**
192      * Returns groups that the current user belongs to on the course. Note: If not already
193      * available, this may make a database query.
194      * @param int $groupingid Grouping ID or 0 (default) for all groups
195      * @return array Array of int (group id) => int (same group id again); empty array if none
196      */
197     public function get_groups($groupingid=0) {
198         if (is_null($this->groups)) {
199             // NOTE: Performance could be improved here. The system caches user groups
200             // in $USER->groupmember[$courseid] => array of groupid=>groupid. Unfortunately this
201             // structure does not include grouping information. It probably could be changed to
202             // do so, without a significant performance hit on login, thus saving this one query
203             // each request.
204             $this->groups = groups_get_user_groups($this->courseid, $this->userid);
205         }
206         if (!isset($this->groups[$groupingid])) {
207             return array();
208         }
209         return $this->groups[$groupingid];
210     }
212     /**
213      * Gets all sections as array from section number => data about section.
214      * @return array Array of section_info objects organised by section number
215      */
216     public function get_section_info_all() {
217         return $this->sectioninfo;
218     }
220     /**
221      * Gets data about specific numbered section.
222      * @param int $sectionnumber Number (not id) of section
223      * @param int $strictness Use MUST_EXIST to throw exception if it doesn't
224      * @return section_info Information for numbered section or null if not found
225      */
226     public function get_section_info($sectionnumber, $strictness = IGNORE_MISSING) {
227         if (!array_key_exists($sectionnumber, $this->sectioninfo)) {
228             if ($strictness === MUST_EXIST) {
229                 throw new moodle_exception('sectionnotexist');
230             } else {
231                 return null;
232             }
233         }
234         return $this->sectioninfo[$sectionnumber];
235     }
237     /**
238      * Constructs based on course.
239      * Note: This constructor should not usually be called directly.
240      * Use get_fast_modinfo($course) instead as this maintains a cache.
241      * @param object $course Moodle course object, which may include modinfo
242      * @param int $userid User ID
243      */
244     public function __construct($course, $userid) {
245         global $CFG, $DB, $COURSE, $SITE;
247         // Check modinfo field is set. If not, build and load it.
248         if (empty($course->modinfo) || empty($course->sectioncache)) {
249             rebuild_course_cache($course->id);
250             $course = $DB->get_record('course', array('id'=>$course->id), '*', MUST_EXIST);
251         }
253         // Set initial values
254         $this->courseid = $course->id;
255         $this->userid = $userid;
256         $this->sections = array();
257         $this->cms = array();
258         $this->instances = array();
259         $this->groups = null;
260         $this->course = $course;
262         // Load modinfo field into memory as PHP object and check it's valid
263         $info = unserialize($course->modinfo);
264         if (!is_array($info)) {
265             // hmm, something is wrong - lets try to fix it
266             rebuild_course_cache($course->id);
267             $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
268             $info = unserialize($course->modinfo);
269             if (!is_array($info)) {
270                 // If it still fails, abort
271                 debugging('Problem with "modinfo" data for this course');
272                 return;
273             }
274         }
276         // Load sectioncache field into memory as PHP object and check it's valid
277         $sectioncache = unserialize($course->sectioncache);
278         if (!is_array($sectioncache)) {
279             // hmm, something is wrong - let's fix it
280             rebuild_course_cache($course->id);
281             $course->sectioncache = $DB->get_field('course', 'sectioncache', array('id'=>$course->id));
282             $sectioncache = unserialize($course->sectioncache);
283             if (!is_array($sectioncache)) {
284                 // If it still fails, abort
285                 debugging('Problem with "sectioncache" data for this course');
286                 return;
287             }
288         }
290         // If we haven't already preloaded contexts for the course, do it now
291         // Modules are also cached here as long as it's the first time this course has been preloaded.
292         context_helper::preload_course($course->id);
294         // Quick integrity check: as a result of race conditions modinfo may not be regenerated after the change.
295         // It is especially dangerous if modinfo contains the deleted course module, as it results in fatal error.
296         // We can check it very cheap by validating the existence of module context.
297         if ($course->id == $COURSE->id || $course->id == $SITE->id) {
298             // Only verify current course (or frontpage) as pages with many courses may not have module contexts cached.
299             // (Uncached modules will result in a very slow verification).
300             foreach ($info as $mod) {
301                 if (!context_module::instance($mod->cm, IGNORE_MISSING)) {
302                     debugging('Course cache integrity check failed: course module with id '. $mod->cm.
303                             ' does not have context. Rebuilding cache for course '. $course->id);
304                     rebuild_course_cache($course->id);
305                     $this->course = $DB->get_record('course', array('id' => $course->id), '*', MUST_EXIST);
306                     $info = unserialize($this->course->modinfo);
307                     $sectioncache = unserialize($this->course->sectioncache);
308                     break;
309                 }
310             }
311         }
313         // Loop through each piece of module data, constructing it
314         $modexists = array();
315         foreach ($info as $mod) {
316             if (empty($mod->name)) {
317                 // something is wrong here
318                 continue;
319             }
321             // Skip modules which don't exist
322             if (empty($modexists[$mod->mod])) {
323                 if (!file_exists("$CFG->dirroot/mod/$mod->mod/lib.php")) {
324                     continue;
325                 }
326                 $modexists[$mod->mod] = true;
327             }
329             // Construct info for this module
330             $cm = new cm_info($this, $course, $mod, $info);
332             // Store module in instances and cms array
333             if (!isset($this->instances[$cm->modname])) {
334                 $this->instances[$cm->modname] = array();
335             }
336             $this->instances[$cm->modname][$cm->instance] = $cm;
337             $this->cms[$cm->id] = $cm;
339             // Reconstruct sections. This works because modules are stored in order
340             if (!isset($this->sections[$cm->sectionnum])) {
341                 $this->sections[$cm->sectionnum] = array();
342             }
343             $this->sections[$cm->sectionnum][] = $cm->id;
344         }
346         // Expand section objects
347         $this->sectioninfo = array();
348         foreach ($sectioncache as $number => $data) {
349             // Calculate sequence
350             if (isset($this->sections[$number])) {
351                 $sequence = implode(',', $this->sections[$number]);
352             } else {
353                 $sequence = '';
354             }
355             // Expand
356             $this->sectioninfo[$number] = new section_info($data, $number, $course->id, $sequence,
357                     $this, $userid);
358         }
360         // We need at least 'dynamic' data from each course-module (this is basically the remaining
361         // data which was always present in previous version of get_fast_modinfo, so it's required
362         // for BC). Creating it in a second pass is necessary because obtain_dynamic_data sometimes
363         // needs to be able to refer to a 'complete' (with basic data) modinfo.
364         foreach ($this->cms as $cm) {
365             $cm->obtain_dynamic_data();
366         }
367     }
369     /**
370      * Builds a list of information about sections on a course to be stored in
371      * the course cache. (Does not include information that is already cached
372      * in some other way.)
373      *
374      * Used internally by rebuild_course_cache function; do not use otherwise.
375      * @param int $courseid Course ID
376      * @return array Information about sections, indexed by section number (not id)
377      */
378     public static function build_section_cache($courseid) {
379         global $DB;
381         // Get section data
382         $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section',
383                 'section, id, course, name, summary, summaryformat, sequence, visible, ' .
384                 'availablefrom, availableuntil, showavailability, groupingid');
385         $compressedsections = array();
387         $formatoptionsdef = course_get_format($courseid)->section_format_options();
388         // Remove unnecessary data and add availability
389         foreach ($sections as $number => $section) {
390             // Add cached options from course format to $section object
391             foreach ($formatoptionsdef as $key => $option) {
392                 if (!empty($option['cache'])) {
393                     $formatoptions = course_get_format($courseid)->get_format_options($section);
394                     if (!array_key_exists('cachedefault', $option) || $option['cachedefault'] !== $formatoptions[$key]) {
395                         $section->$key = $formatoptions[$key];
396                     }
397                 }
398             }
399             // Clone just in case it is reused elsewhere
400             $compressedsections[$number] = clone($section);
401             section_info::convert_for_section_cache($compressedsections[$number]);
402         }
404         return $compressedsections;
405     }
409 /**
410  * Data about a single module on a course. This contains most of the fields in the course_modules
411  * table, plus additional data when required.
412  *
413  * This object has many public fields; code should treat all these fields as read-only and set
414  * data only using the supplied set functions. Setting the fields directly is not supported
415  * and may cause problems later.
416  */
417 class cm_info extends stdClass {
418     /**
419      * State: Only basic data from modinfo cache is available.
420      */
421     const STATE_BASIC = 0;
423     /**
424      * State: Dynamic data is available too.
425      */
426     const STATE_DYNAMIC = 1;
428     /**
429      * State: View data (for course page) is available.
430      */
431     const STATE_VIEW = 2;
433     /**
434      * Parent object
435      * @var course_modinfo
436      */
437     private $modinfo;
439     /**
440      * Level of information stored inside this object (STATE_xx constant)
441      * @var int
442      */
443     private $state;
445     // Existing data fields
446     ///////////////////////
448     /**
449      * Course-module ID - from course_modules table
450      * @var int
451      */
452     public $id;
454     /**
455      * Module instance (ID within module table) - from course_modules table
456      * @var int
457      */
458     public $instance;
460     /**
461      * Course ID - from course_modules table
462      * @var int
463      */
464     public $course;
466     /**
467      * 'ID number' from course-modules table (arbitrary text set by user) - from
468      * course_modules table
469      * @var string
470      */
471     public $idnumber;
473     /**
474      * Time that this course-module was added (unix time) - from course_modules table
475      * @var int
476      */
477     public $added;
479     /**
480      * This variable is not used and is included here only so it can be documented.
481      * Once the database entry is removed from course_modules, it should be deleted
482      * here too.
483      * @var int
484      * @deprecated Do not use this variable
485      */
486     public $score;
488     /**
489      * Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
490      * course_modules table
491      * @var int
492      */
493     public $visible;
495     /**
496      * Old visible setting (if the entire section is hidden, the previous value for
497      * visible is stored in this field) - from course_modules table
498      * @var int
499      */
500     public $visibleold;
502     /**
503      * Group mode (one of the constants NONE, SEPARATEGROUPS, or VISIBLEGROUPS) - from
504      * course_modules table
505      * @var int
506      */
507     public $groupmode;
509     /**
510      * Grouping ID (0 = all groupings)
511      * @var int
512      */
513     public $groupingid;
515     /**
516      * Group members only (if set to 1, only members of a suitable group see this link on the
517      * course page; 0 = everyone sees it even if they don't belong to a suitable group)  - from
518      * course_modules table
519      * @var int
520      */
521     public $groupmembersonly;
523     /**
524      * Indicates whether the course containing the module has forced the groupmode
525      * This means that cm_info::$groupmode should be ignored and cm_info::$coursegroupmode be
526      * used instead
527      * @var bool
528      */
529     public $coursegroupmodeforce;
531     /**
532      * Group mode (one of the constants NONE, SEPARATEGROUPS, or VISIBLEGROUPS) - from
533      * course table - as specified for the course containing the module
534      * Effective only if cm_info::$coursegroupmodeforce is set
535      * @var int
536      */
537     public $coursegroupmode;
539     /**
540      * Indent level on course page (0 = no indent) - from course_modules table
541      * @var int
542      */
543     public $indent;
545     /**
546      * Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
547      * course_modules table
548      * @var int
549      */
550     public $completion;
552     /**
553      * Set to the item number (usually 0) if completion depends on a particular
554      * grade of this activity, or null if completion does not depend on a grade - from
555      * course_modules table
556      * @var mixed
557      */
558     public $completiongradeitemnumber;
560     /**
561      * 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
562      * @var int
563      */
564     public $completionview;
566     /**
567      * Set to a unix time if completion of this activity is expected at a
568      * particular time, 0 if no time set - from course_modules table
569      * @var int
570      */
571     public $completionexpected;
573     /**
574      * Available date for this activity (0 if not set, or set to seconds since epoch; before this
575      * date, activity does not display to students) - from course_modules table
576      * @var int
577      */
578     public $availablefrom;
580     /**
581      * Available until date for this activity (0 if not set, or set to seconds since epoch; from
582      * this date, activity does not display to students) - from course_modules table
583      * @var int
584      */
585     public $availableuntil;
587     /**
588      * When activity is unavailable, this field controls whether it is shown to students (0 =
589      * hide completely, 1 = show greyed out with information about when it will be available) -
590      * from course_modules table
591      * @var int
592      */
593     public $showavailability;
595     /**
596      * Controls whether the description of the activity displays on the course main page (in
597      * addition to anywhere it might display within the activity itself). 0 = do not show
598      * on main page, 1 = show on main page.
599      * @var int
600      */
601     public $showdescription;
603     /**
604      * Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
605      * course page - from cached data in modinfo field
606      * @deprecated This is crazy, don't use it. Replaced by ->extraclasses and ->onclick
607      * @var string
608      */
609     public $extra;
611     /**
612      * Name of icon to use - from cached data in modinfo field
613      * @var string
614      */
615     public $icon;
617     /**
618      * Component that contains icon - from cached data in modinfo field
619      * @var string
620      */
621     public $iconcomponent;
623     /**
624      * Name of module e.g. 'forum' (this is the same name as the module's main database
625      * table) - from cached data in modinfo field
626      * @var string
627      */
628     public $modname;
630     /**
631      * ID of module - from course_modules table
632      * @var int
633      */
634     public $module;
636     /**
637      * Name of module instance for display on page e.g. 'General discussion forum' - from cached
638      * data in modinfo field
639      * @var string
640      */
641     public $name;
643     /**
644      * Section number that this course-module is in (section 0 = above the calendar, section 1
645      * = week/topic 1, etc) - from cached data in modinfo field
646      * @var string
647      */
648     public $sectionnum;
650     /**
651      * Section id - from course_modules table
652      * @var int
653      */
654     public $section;
656     /**
657      * Availability conditions for this course-module based on the completion of other
658      * course-modules (array from other course-module id to required completion state for that
659      * module) - from cached data in modinfo field
660      * @var array
661      */
662     public $conditionscompletion;
664     /**
665      * Availability conditions for this course-module based on course grades (array from
666      * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
667      * @var array
668      */
669     public $conditionsgrade;
671     /**
672      * Availability conditions for this course-module based on user fields
673      * @var array
674      */
675     public $conditionsfield;
677     /**
678      * True if this course-module is available to students i.e. if all availability conditions
679      * are met - obtained dynamically
680      * @var bool
681      */
682     public $available;
684     /**
685      * If course-module is not available to students, this string gives information about
686      * availability which can be displayed to students and/or staff (e.g. 'Available from 3
687      * January 2010') for display on main page - obtained dynamically
688      * @var string
689      */
690     public $availableinfo;
692     /**
693      * True if this course-module is available to the CURRENT user (for example, if current user
694      * has viewhiddenactivities capability, they can access the course-module even if it is not
695      * visible or not available, so this would be true in that case)
696      * @var bool
697      */
698     public $uservisible;
700     /**
701      * Module context - hacky shortcut
702      * @deprecated
703      * @var stdClass
704      */
705     public $context;
708     // New data available only via functions
709     ////////////////////////////////////////
711     /**
712      * @var moodle_url
713      */
714     private $url;
716     /**
717      * @var string
718      */
719     private $content;
721     /**
722      * @var string
723      */
724     private $extraclasses;
726     /**
727      * @var moodle_url full external url pointing to icon image for activity
728      */
729     private $iconurl;
731     /**
732      * @var string
733      */
734     private $onclick;
736     /**
737      * @var mixed
738      */
739     private $customdata;
741     /**
742      * @var string
743      */
744     private $afterlink;
746     /**
747      * @var string
748      */
749     private $afterediticons;
751     /**
752      * Magic method getter
753      *
754      * @param string $name
755      * @return mixed
756      */
757     public function __get($name) {
758         switch ($name) {
759             case 'modplural':
760                 return $this->get_module_type_name(true);
761             case 'modfullname':
762                 return $this->get_module_type_name();
763             default:
764                 debugging('Invalid cm_info property accessed: '.$name);
765                 return null;
766         }
767     }
769     /**
770      * @return bool True if this module has a 'view' page that should be linked to in navigation
771      *   etc (note: modules may still have a view.php file, but return false if this is not
772      *   intended to be linked to from 'normal' parts of the interface; this is what label does).
773      */
774     public function has_view() {
775         return !is_null($this->url);
776     }
778     /**
779      * @return moodle_url URL to link to for this module, or null if it doesn't have a view page
780      */
781     public function get_url() {
782         return $this->url;
783     }
785     /**
786      * Obtains content to display on main (view) page.
787      * Note: Will collect view data, if not already obtained.
788      * @return string Content to display on main page below link, or empty string if none
789      */
790     public function get_content() {
791         $this->obtain_view_data();
792         return $this->content;
793     }
795     /**
796      * Returns the content to display on course/overview page, formatted and passed through filters
797      *
798      * if $options['context'] is not specified, the module context is used
799      *
800      * @param array|stdClass $options formatting options, see {@link format_text()}
801      * @return string
802      */
803     public function get_formatted_content($options = array()) {
804         $this->obtain_view_data();
805         if (empty($this->content)) {
806             return '';
807         }
808         // Improve filter performance by preloading filter setttings for all
809         // activities on the course (this does nothing if called multiple
810         // times)
811         filter_preload_activities($this->get_modinfo());
813         $options = (array)$options;
814         if (!isset($options['context'])) {
815             $options['context'] = context_module::instance($this->id);
816         }
817         return format_text($this->content, FORMAT_HTML, $options);
818     }
820     /**
821      * Returns the name to display on course/overview page, formatted and passed through filters
822      *
823      * if $options['context'] is not specified, the module context is used
824      *
825      * @param array|stdClass $options formatting options, see {@link format_string()}
826      * @return string
827      */
828     public function get_formatted_name($options = array()) {
829         $options = (array)$options;
830         if (!isset($options['context'])) {
831             $options['context'] = context_module::instance($this->id);
832         }
833         return format_string($this->name, true,  $options);
834     }
836     /**
837      * Note: Will collect view data, if not already obtained.
838      * @return string Extra CSS classes to add to html output for this activity on main page
839      */
840     public function get_extra_classes() {
841         $this->obtain_view_data();
842         return $this->extraclasses;
843     }
845     /**
846      * @return string Content of HTML on-click attribute. This string will be used literally
847      * as a string so should be pre-escaped.
848      */
849     public function get_on_click() {
850         // Does not need view data; may be used by navigation
851         return $this->onclick;
852     }
853     /**
854      * @return mixed Optional custom data stored in modinfo cache for this activity, or null if none
855      */
856     public function get_custom_data() {
857         return $this->customdata;
858     }
860     /**
861      * Note: Will collect view data, if not already obtained.
862      * @return string Extra HTML code to display after link
863      */
864     public function get_after_link() {
865         $this->obtain_view_data();
866         return $this->afterlink;
867     }
869     /**
870      * Note: Will collect view data, if not already obtained.
871      * @return string Extra HTML code to display after editing icons (e.g. more icons)
872      */
873     public function get_after_edit_icons() {
874         $this->obtain_view_data();
875         return $this->afterediticons;
876     }
878     /**
879      * @param moodle_core_renderer $output Output render to use, or null for default (global)
880      * @return moodle_url Icon URL for a suitable icon to put beside this cm
881      */
882     public function get_icon_url($output = null) {
883         global $OUTPUT;
884         if (!$output) {
885             $output = $OUTPUT;
886         }
887         // Support modules setting their own, external, icon image
888         if (!empty($this->iconurl)) {
889             $icon = $this->iconurl;
891         // Fallback to normal local icon + component procesing
892         } else if (!empty($this->icon)) {
893             if (substr($this->icon, 0, 4) === 'mod/') {
894                 list($modname, $iconname) = explode('/', substr($this->icon, 4), 2);
895                 $icon = $output->pix_url($iconname, $modname);
896             } else {
897                 if (!empty($this->iconcomponent)) {
898                     // Icon  has specified component
899                     $icon = $output->pix_url($this->icon, $this->iconcomponent);
900                 } else {
901                     // Icon does not have specified component, use default
902                     $icon = $output->pix_url($this->icon);
903                 }
904             }
905         } else {
906             $icon = $output->pix_url('icon', $this->modname);
907         }
908         return $icon;
909     }
911     /**
912      * Returns a localised human-readable name of the module type
913      *
914      * @param bool $plural return plural form
915      * @return string
916      */
917     public function get_module_type_name($plural = false) {
918         $modnames = get_module_types_names($plural);
919         if (isset($modnames[$this->modname])) {
920             return $modnames[$this->modname];
921         } else {
922             return null;
923         }
924     }
926     /**
927      * @return course_modinfo Modinfo object that this came from
928      */
929     public function get_modinfo() {
930         return $this->modinfo;
931     }
933     /**
934      * @return object Moodle course object that was used to construct this data
935      */
936     public function get_course() {
937         return $this->modinfo->get_course();
938     }
940     // Set functions
941     ////////////////
943     /**
944      * Sets content to display on course view page below link (if present).
945      * @param string $content New content as HTML string (empty string if none)
946      * @return void
947      */
948     public function set_content($content) {
949         $this->content = $content;
950     }
952     /**
953      * Sets extra classes to include in CSS.
954      * @param string $extraclasses Extra classes (empty string if none)
955      * @return void
956      */
957     public function set_extra_classes($extraclasses) {
958         $this->extraclasses = $extraclasses;
959     }
961     /**
962      * Sets the external full url that points to the icon being used
963      * by the activity. Useful for external-tool modules (lti...)
964      * If set, takes precedence over $icon and $iconcomponent
965      *
966      * @param moodle_url $iconurl full external url pointing to icon image for activity
967      * @return void
968      */
969     public function set_icon_url(moodle_url $iconurl) {
970         $this->iconurl = $iconurl;
971     }
973     /**
974      * Sets value of on-click attribute for JavaScript.
975      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
976      * @param string $onclick New onclick attribute which should be HTML-escaped
977      *   (empty string if none)
978      * @return void
979      */
980     public function set_on_click($onclick) {
981         $this->check_not_view_only();
982         $this->onclick = $onclick;
983     }
985     /**
986      * Sets HTML that displays after link on course view page.
987      * @param string $afterlink HTML string (empty string if none)
988      * @return void
989      */
990     public function set_after_link($afterlink) {
991         $this->afterlink = $afterlink;
992     }
994     /**
995      * Sets HTML that displays after edit icons on course view page.
996      * @param string $afterediticons HTML string (empty string if none)
997      * @return void
998      */
999     public function set_after_edit_icons($afterediticons) {
1000         $this->afterediticons = $afterediticons;
1001     }
1003     /**
1004      * Changes the name (text of link) for this module instance.
1005      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1006      * @param string $name Name of activity / link text
1007      * @return void
1008      */
1009     public function set_name($name) {
1010         $this->update_user_visible();
1011         $this->name = $name;
1012     }
1014     /**
1015      * Turns off the view link for this module instance.
1016      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1017      * @return void
1018      */
1019     public function set_no_view_link() {
1020         $this->check_not_view_only();
1021         $this->url = null;
1022     }
1024     /**
1025      * Sets the 'uservisible' flag. This can be used (by setting false) to prevent access and
1026      * display of this module link for the current user.
1027      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1028      * @param bool $uservisible
1029      * @return void
1030      */
1031     public function set_user_visible($uservisible) {
1032         $this->check_not_view_only();
1033         $this->uservisible = $uservisible;
1034     }
1036     /**
1037      * Sets the 'available' flag and related details. This flag is normally used to make
1038      * course modules unavailable until a certain date or condition is met. (When a course
1039      * module is unavailable, it is still visible to users who have viewhiddenactivities
1040      * permission.)
1041      *
1042      * When this is function is called, user-visible status is recalculated automatically.
1043      *
1044      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
1045      * @param bool $available False if this item is not 'available'
1046      * @param int $showavailability 0 = do not show this item at all if it's not available,
1047      *   1 = show this item greyed out with the following message
1048      * @param string $availableinfo Information about why this is not available which displays
1049      *   to those who have viewhiddenactivities, and to everyone if showavailability is set;
1050      *   note that this function replaces the existing data (if any)
1051      * @return void
1052      */
1053     public function set_available($available, $showavailability=0, $availableinfo='') {
1054         $this->check_not_view_only();
1055         $this->available = $available;
1056         $this->showavailability = $showavailability;
1057         $this->availableinfo = $availableinfo;
1058         $this->update_user_visible();
1059     }
1061     /**
1062      * Some set functions can only be called from _cm_info_dynamic and not _cm_info_view.
1063      * This is because they may affect parts of this object which are used on pages other
1064      * than the view page (e.g. in the navigation block, or when checking access on
1065      * module pages).
1066      * @return void
1067      */
1068     private function check_not_view_only() {
1069         if ($this->state >= self::STATE_DYNAMIC) {
1070             throw new coding_exception('Cannot set this data from _cm_info_view because it may ' .
1071                     'affect other pages as well as view');
1072         }
1073     }
1075     /**
1076      * Constructor should not be called directly; use get_fast_modinfo.
1077      * @param course_modinfo $modinfo Parent object
1078      * @param object $course Course row
1079      * @param object $mod Module object from the modinfo field of course table
1080      * @param object $info Entire object from modinfo field of course table
1081      */
1082     public function __construct(course_modinfo $modinfo, $course, $mod, $info) {
1083         global $CFG;
1084         $this->modinfo = $modinfo;
1086         $this->id               = $mod->cm;
1087         $this->instance         = $mod->id;
1088         $this->course           = $course->id;
1089         $this->modname          = $mod->mod;
1090         $this->idnumber         = isset($mod->idnumber) ? $mod->idnumber : '';
1091         $this->name             = $mod->name;
1092         $this->visible          = $mod->visible;
1093         $this->sectionnum       = $mod->section; // Note weirdness with name here
1094         $this->groupmode        = isset($mod->groupmode) ? $mod->groupmode : 0;
1095         $this->groupingid       = isset($mod->groupingid) ? $mod->groupingid : 0;
1096         $this->groupmembersonly = isset($mod->groupmembersonly) ? $mod->groupmembersonly : 0;
1097         $this->coursegroupmodeforce = $course->groupmodeforce;
1098         $this->coursegroupmode  = $course->groupmode;
1099         $this->indent           = isset($mod->indent) ? $mod->indent : 0;
1100         $this->extra            = isset($mod->extra) ? $mod->extra : '';
1101         $this->extraclasses     = isset($mod->extraclasses) ? $mod->extraclasses : '';
1102         $this->iconurl          = isset($mod->iconurl) ? $mod->iconurl : '';
1103         $this->onclick          = isset($mod->onclick) ? $mod->onclick : '';
1104         $this->content          = isset($mod->content) ? $mod->content : '';
1105         $this->icon             = isset($mod->icon) ? $mod->icon : '';
1106         $this->iconcomponent    = isset($mod->iconcomponent) ? $mod->iconcomponent : '';
1107         $this->customdata       = isset($mod->customdata) ? $mod->customdata : '';
1108         $this->context          = context_module::instance($mod->cm);
1109         $this->showdescription  = isset($mod->showdescription) ? $mod->showdescription : 0;
1110         $this->state = self::STATE_BASIC;
1112         // Note: These fields from $cm were not present in cm_info in Moodle
1113         // 2.0.2 and prior. They may not be available if course cache hasn't
1114         // been rebuilt since then.
1115         $this->section = isset($mod->sectionid) ? $mod->sectionid : 0;
1116         $this->module = isset($mod->module) ? $mod->module : 0;
1117         $this->added = isset($mod->added) ? $mod->added : 0;
1118         $this->score = isset($mod->score) ? $mod->score : 0;
1119         $this->visibleold = isset($mod->visibleold) ? $mod->visibleold : 0;
1121         // Note: it saves effort and database space to always include the
1122         // availability and completion fields, even if availability or completion
1123         // are actually disabled
1124         $this->completion = isset($mod->completion) ? $mod->completion : 0;
1125         $this->completiongradeitemnumber = isset($mod->completiongradeitemnumber)
1126                 ? $mod->completiongradeitemnumber : null;
1127         $this->completionview = isset($mod->completionview)
1128                 ? $mod->completionview : 0;
1129         $this->completionexpected = isset($mod->completionexpected)
1130                 ? $mod->completionexpected : 0;
1131         $this->showavailability = isset($mod->showavailability) ? $mod->showavailability : 0;
1132         $this->availablefrom = isset($mod->availablefrom) ? $mod->availablefrom : 0;
1133         $this->availableuntil = isset($mod->availableuntil) ? $mod->availableuntil : 0;
1134         $this->conditionscompletion = isset($mod->conditionscompletion)
1135                 ? $mod->conditionscompletion : array();
1136         $this->conditionsgrade = isset($mod->conditionsgrade)
1137                 ? $mod->conditionsgrade : array();
1138         $this->conditionsfield = isset($mod->conditionsfield)
1139                 ? $mod->conditionsfield : array();
1141         static $modviews;
1142         if (!isset($modviews[$this->modname])) {
1143             $modviews[$this->modname] = !plugin_supports('mod', $this->modname,
1144                     FEATURE_NO_VIEW_LINK);
1145         }
1146         $this->url = $modviews[$this->modname]
1147                 ? new moodle_url('/mod/' . $this->modname . '/view.php', array('id'=>$this->id))
1148                 : null;
1149     }
1151     /**
1152      * If dynamic data for this course-module is not yet available, gets it.
1153      *
1154      * This function is automatically called when constructing course_modinfo, so users don't
1155      * need to call it.
1156      *
1157      * Dynamic data is data which does not come directly from the cache but is calculated at
1158      * runtime based on the current user. Primarily this concerns whether the user can access
1159      * the module or not.
1160      *
1161      * As part of this function, the module's _cm_info_dynamic function from its lib.php will
1162      * be called (if it exists).
1163      * @return void
1164      */
1165     public function obtain_dynamic_data() {
1166         global $CFG;
1167         if ($this->state >= self::STATE_DYNAMIC) {
1168             return;
1169         }
1170         $userid = $this->modinfo->get_user_id();
1172         if (!empty($CFG->enableavailability)) {
1173             // Get availability information
1174             $ci = new condition_info($this);
1175             // Note that the modinfo currently available only includes minimal details (basic data)
1176             // so passing it to this function is a bit dangerous as it would cause infinite
1177             // recursion if it tried to get dynamic data, however we know that this function only
1178             // uses basic data.
1179             $this->available = $ci->is_available($this->availableinfo, true,
1180                     $userid, $this->modinfo);
1182             // Check parent section
1183             $parentsection = $this->modinfo->get_section_info($this->sectionnum);
1184             if (!$parentsection->available) {
1185                 // Do not store info from section here, as that is already
1186                 // presented from the section (if appropriate) - just change
1187                 // the flag
1188                 $this->available = false;
1189             }
1190         } else {
1191             $this->available = true;
1192         }
1194         // Update visible state for current user
1195         $this->update_user_visible();
1197         // Let module make dynamic changes at this point
1198         $this->call_mod_function('cm_info_dynamic');
1199         $this->state = self::STATE_DYNAMIC;
1200     }
1202     /**
1203      * Works out whether activity is available to the current user
1204      *
1205      * If the activity is unavailable, additional checks are required to determine if its hidden or greyed out
1206      *
1207      * @see is_user_access_restricted_by_group()
1208      * @see is_user_access_restricted_by_conditional_access()
1209      * @return void
1210      */
1211     private function update_user_visible() {
1212         global $CFG;
1213         $modcontext = context_module::instance($this->id);
1214         $userid = $this->modinfo->get_user_id();
1215         $this->uservisible = true;
1217         // If the user cannot access the activity set the uservisible flag to false.
1218         // Additional checks are required to determine whether the activity is entirely hidden or just greyed out.
1219         if ((!$this->visible or !$this->available) and
1220                 !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
1222             $this->uservisible = false;
1223         }
1225         // Check group membership.
1226         if ($this->is_user_access_restricted_by_group() ||
1227                 $this->is_user_access_restricted_by_capability()) {
1229              $this->uservisible = false;
1230             // Ensure activity is completely hidden from the user.
1231             $this->showavailability = 0;
1232         }
1233     }
1235     /**
1236      * Checks whether the module's group settings restrict the current user's access
1237      *
1238      * @return bool True if the user access is restricted
1239      */
1240     public function is_user_access_restricted_by_group() {
1241         global $CFG;
1243         if (!empty($CFG->enablegroupmembersonly) and !empty($this->groupmembersonly)) {
1244             $modcontext = context_module::instance($this->id);
1245             $userid = $this->modinfo->get_user_id();
1246             if (!has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
1247                 // If the activity has 'group members only' and you don't have accessallgroups...
1248                 $groups = $this->modinfo->get_groups($this->groupingid);
1249                 if (empty($groups)) {
1250                     // ...and you don't belong to a group, then set it so you can't see/access it
1251                     return true;
1252                 }
1253             }
1254         }
1255         return false;
1256     }
1258     /**
1259      * Checks whether mod/...:view capability restricts the current user's access.
1260      *
1261      * @return bool True if the user access is restricted.
1262      */
1263     public function is_user_access_restricted_by_capability() {
1264         $capability = 'mod/' . $this->modname . ':view';
1265         $capabilityinfo = get_capability_info($capability);
1266         if (!$capabilityinfo) {
1267             // Capability does not exist, no one is prevented from seeing the activity.
1268             return false;
1269         }
1271         // You are blocked if you don't have the capability.
1272         return !has_capability($capability, context_module::instance($this->id));
1273     }
1275     /**
1276      * Checks whether the module's conditional access settings mean that the user cannot see the activity at all
1277      *
1278      * @return bool True if the user cannot see the module. False if the activity is either available or should be greyed out.
1279      */
1280     public function is_user_access_restricted_by_conditional_access() {
1281         global $CFG, $USER;
1283         if (empty($CFG->enableavailability)) {
1284             return false;
1285         }
1287         // If module will always be visible anyway (but greyed out), don't bother checking anything else
1288         if ($this->showavailability == CONDITION_STUDENTVIEW_SHOW) {
1289             return false;
1290         }
1292         // Can the user see hidden modules?
1293         $modcontext = context_module::instance($this->id);
1294         $userid = $this->modinfo->get_user_id();
1295         if (has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
1296             return false;
1297         }
1299         // Is the module hidden due to unmet conditions?
1300         if (!$this->available) {
1301             return true;
1302         }
1304         return false;
1305     }
1307     /**
1308      * Calls a module function (if exists), passing in one parameter: this object.
1309      * @param string $type Name of function e.g. if this is 'grooblezorb' and the modname is
1310      *   'forum' then it will try to call 'mod_forum_grooblezorb' or 'forum_grooblezorb'
1311      * @return void
1312      */
1313     private function call_mod_function($type) {
1314         global $CFG;
1315         $libfile = $CFG->dirroot . '/mod/' . $this->modname . '/lib.php';
1316         if (file_exists($libfile)) {
1317             include_once($libfile);
1318             $function = 'mod_' . $this->modname . '_' . $type;
1319             if (function_exists($function)) {
1320                 $function($this);
1321             } else {
1322                 $function = $this->modname . '_' . $type;
1323                 if (function_exists($function)) {
1324                     $function($this);
1325                 }
1326             }
1327         }
1328     }
1330     /**
1331      * If view data for this course-module is not yet available, obtains it.
1332      *
1333      * This function is automatically called if any of the functions (marked) which require
1334      * view data are called.
1335      *
1336      * View data is data which is needed only for displaying the course main page (& any similar
1337      * functionality on other pages) but is not needed in general. Obtaining view data may have
1338      * a performance cost.
1339      *
1340      * As part of this function, the module's _cm_info_view function from its lib.php will
1341      * be called (if it exists).
1342      * @return void
1343      */
1344     private function obtain_view_data() {
1345         if ($this->state >= self::STATE_VIEW) {
1346             return;
1347         }
1349         // Let module make changes at this point
1350         $this->call_mod_function('cm_info_view');
1351         $this->state = self::STATE_VIEW;
1352     }
1356 /**
1357  * Returns reference to full info about modules in course (including visibility).
1358  * Cached and as fast as possible (0 or 1 db query).
1359  *
1360  * use get_fast_modinfo($courseid, 0, true) to reset the static cache for particular course
1361  * use get_fast_modinfo(0, 0, true) to reset the static cache for all courses
1362  *
1363  * @uses MAX_MODINFO_CACHE_SIZE
1364  * @param int|stdClass $courseorid object from DB table 'course' or just a course id
1365  * @param int $userid User id to populate 'uservisible' attributes of modules and sections.
1366  *     Set to 0 for current user (default)
1367  * @param bool $resetonly whether we want to get modinfo or just reset the cache
1368  * @return course_modinfo|null Module information for course, or null if resetting
1369  */
1370 function get_fast_modinfo($courseorid, $userid = 0, $resetonly = false) {
1371     global $CFG, $USER;
1373     static $cache = array();
1375     // compartibility with syntax prior to 2.4:
1376     if ($courseorid === 'reset') {
1377         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);
1378         $courseorid = 0;
1379         $resetonly = true;
1380     }
1382     // Function get_fast_modinfo() can never be called during upgrade unless it is used for clearing cache only.
1383     if (!$resetonly) {
1384         upgrade_ensure_not_running();
1385     }
1387     if (is_object($courseorid)) {
1388         $course = $courseorid;
1389     } else {
1390         $course = (object)array('id' => $courseorid, 'modinfo' => null, 'sectioncache' => null);
1391     }
1393     // Function is called with $reset = true
1394     if ($resetonly) {
1395         if (isset($course->id) && $course->id > 0) {
1396             $cache[$course->id] = false;
1397         } else {
1398             foreach (array_keys($cache) as $key) {
1399                 $cache[$key] = false;
1400             }
1401         }
1402         return null;
1403     }
1405     // Function is called with $reset = false, retrieve modinfo
1406     if (empty($userid)) {
1407         $userid = $USER->id;
1408     }
1410     if (array_key_exists($course->id, $cache)) {
1411         if ($cache[$course->id] === false) {
1412             // this course has been recently reset, do not rely on modinfo and sectioncache in $course
1413             $course->modinfo = null;
1414             $course->sectioncache = null;
1415         } else if ($cache[$course->id]->userid == $userid) {
1416             // this course's modinfo for the same user was recently retrieved, return cached
1417             return $cache[$course->id];
1418         }
1419     }
1421     if (!property_exists($course, 'modinfo')) {
1422         debugging('Coding problem - missing course modinfo property in get_fast_modinfo() call');
1423     }
1425     if (!property_exists($course, 'sectioncache')) {
1426         debugging('Coding problem - missing course sectioncache property in get_fast_modinfo() call');
1427     }
1429     unset($cache[$course->id]); // prevent potential reference problems when switching users
1431     $cache[$course->id] = new course_modinfo($course, $userid);
1433     // Ensure cache does not use too much RAM
1434     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
1435         reset($cache);
1436         $key = key($cache);
1437         // Unsetting static variable in PHP is percular, it removes the reference,
1438         // but data remain in memory. Prior to unsetting, the varable needs to be
1439         // set to empty to remove its remains from memory.
1440         $cache[$key] = '';
1441         unset($cache[$key]);
1442     }
1444     return $cache[$course->id];
1447 /**
1448  * Rebuilds the cached list of course activities stored in the database
1449  * @param int $courseid - id of course to rebuild, empty means all
1450  * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1451  */
1452 function rebuild_course_cache($courseid=0, $clearonly=false) {
1453     global $COURSE, $SITE, $DB, $CFG;
1455     // Function rebuild_course_cache() can not be called during upgrade unless it's clear only.
1456     if (!$clearonly && !upgrade_ensure_not_running(true)) {
1457         $clearonly = true;
1458     }
1460     // Destroy navigation caches
1461     navigation_cache::destroy_volatile_caches();
1463     if (class_exists('format_base')) {
1464         // if file containing class is not loaded, there is no cache there anyway
1465         format_base::reset_course_cache($courseid);
1466     }
1468     if ($clearonly) {
1469         if (empty($courseid)) {
1470             $DB->execute('UPDATE {course} set modinfo = ?, sectioncache = ?', array(null, null));
1471         } else {
1472             // Clear both fields in one update
1473             $resetobj = (object)array('id' => $courseid, 'modinfo' => null, 'sectioncache' => null);
1474             $DB->update_record('course', $resetobj);
1475         }
1476         // update cached global COURSE too ;-)
1477         if ($courseid == $COURSE->id or empty($courseid)) {
1478             $COURSE->modinfo = null;
1479             $COURSE->sectioncache = null;
1480         }
1481         if ($courseid == $SITE->id) {
1482             $SITE->modinfo = null;
1483             $SITE->sectioncache = null;
1484         }
1485         // reset the fast modinfo cache
1486         get_fast_modinfo($courseid, 0, true);
1487         return;
1488     }
1490     require_once("$CFG->dirroot/course/lib.php");
1492     if ($courseid) {
1493         $select = array('id'=>$courseid);
1494     } else {
1495         $select = array();
1496         @set_time_limit(0);  // this could take a while!   MDL-10954
1497     }
1499     $rs = $DB->get_recordset("course", $select,'','id,fullname');
1500     foreach ($rs as $course) {
1501         $modinfo = serialize(get_array_of_activities($course->id));
1502         $sectioncache = serialize(course_modinfo::build_section_cache($course->id));
1503         $updateobj = (object)array('id' => $course->id,
1504                 'modinfo' => $modinfo, 'sectioncache' => $sectioncache);
1505         $DB->update_record("course", $updateobj);
1506         // update cached global COURSE too ;-)
1507         if ($course->id == $COURSE->id) {
1508             $COURSE->modinfo = $modinfo;
1509             $COURSE->sectioncache = $sectioncache;
1510         }
1511         if ($course->id == $SITE->id) {
1512             $SITE->modinfo = $modinfo;
1513             $SITE->sectioncache = $sectioncache;
1514         }
1515     }
1516     $rs->close();
1517     // reset the fast modinfo cache
1518     get_fast_modinfo($courseid, 0, true);
1522 /**
1523  * Class that is the return value for the _get_coursemodule_info module API function.
1524  *
1525  * Note: For backward compatibility, you can also return a stdclass object from that function.
1526  * The difference is that the stdclass object may contain an 'extra' field (deprecated,
1527  * use extraclasses and onclick instead). The stdclass object may not contain
1528  * the new fields defined here (content, extraclasses, customdata).
1529  */
1530 class cached_cm_info {
1531     /**
1532      * Name (text of link) for this activity; Leave unset to accept default name
1533      * @var string
1534      */
1535     public $name;
1537     /**
1538      * Name of icon for this activity. Normally, this should be used together with $iconcomponent
1539      * to define the icon, as per pix_url function.
1540      * For backward compatibility, if this value is of the form 'mod/forum/icon' then an icon
1541      * within that module will be used.
1542      * @see cm_info::get_icon_url()
1543      * @see renderer_base::pix_url()
1544      * @var string
1545      */
1546     public $icon;
1548     /**
1549      * Component for icon for this activity, as per pix_url; leave blank to use default 'moodle'
1550      * component
1551      * @see renderer_base::pix_url()
1552      * @var string
1553      */
1554     public $iconcomponent;
1556     /**
1557      * HTML content to be displayed on the main page below the link (if any) for this course-module
1558      * @var string
1559      */
1560     public $content;
1562     /**
1563      * Custom data to be stored in modinfo for this activity; useful if there are cases when
1564      * internal information for this activity type needs to be accessible from elsewhere on the
1565      * course without making database queries. May be of any type but should be short.
1566      * @var mixed
1567      */
1568     public $customdata;
1570     /**
1571      * Extra CSS class or classes to be added when this activity is displayed on the main page;
1572      * space-separated string
1573      * @var string
1574      */
1575     public $extraclasses;
1577     /**
1578      * External URL image to be used by activity as icon, useful for some external-tool modules
1579      * like lti. If set, takes precedence over $icon and $iconcomponent
1580      * @var $moodle_url
1581      */
1582     public $iconurl;
1584     /**
1585      * Content of onclick JavaScript; escaped HTML to be inserted as attribute value
1586      * @var string
1587      */
1588     public $onclick;
1592 /**
1593  * Data about a single section on a course. This contains the fields from the
1594  * course_sections table, plus additional data when required.
1595  */
1596 class section_info implements IteratorAggregate {
1597     /**
1598      * Section ID - from course_sections table
1599      * @var int
1600      */
1601     private $_id;
1603     /**
1604      * Course ID - from course_sections table
1605      * @var int
1606      */
1607     private $_course;
1609     /**
1610      * Section number - from course_sections table
1611      * @var int
1612      */
1613     private $_section;
1615     /**
1616      * Section name if specified - from course_sections table
1617      * @var string
1618      */
1619     private $_name;
1621     /**
1622      * Section visibility (1 = visible) - from course_sections table
1623      * @var int
1624      */
1625     private $_visible;
1627     /**
1628      * Section summary text if specified - from course_sections table
1629      * @var string
1630      */
1631     private $_summary;
1633     /**
1634      * Section summary text format (FORMAT_xx constant) - from course_sections table
1635      * @var int
1636      */
1637     private $_summaryformat;
1639     /**
1640      * When section is unavailable, this field controls whether it is shown to students (0 =
1641      * hide completely, 1 = show greyed out with information about when it will be available) -
1642      * from course_sections table
1643      * @var int
1644      */
1645     private $_showavailability;
1647     /**
1648      * Available date for this section (0 if not set, or set to seconds since epoch; before this
1649      * date, section does not display to students) - from course_sections table
1650      * @var int
1651      */
1652     private $_availablefrom;
1654     /**
1655      * Available until date for this section  (0 if not set, or set to seconds since epoch; from
1656      * this date, section does not display to students) - from course_sections table
1657      * @var int
1658      */
1659     private $_availableuntil;
1661     /**
1662      * If section is restricted to users of a particular grouping, this is its id
1663      * (0 if not set) - from course_sections table
1664      * @var int
1665      */
1666     private $_groupingid;
1668     /**
1669      * Availability conditions for this section based on the completion of
1670      * course-modules (array from course-module id to required completion state
1671      * for that module) - from cached data in sectioncache field
1672      * @var array
1673      */
1674     private $_conditionscompletion;
1676     /**
1677      * Availability conditions for this section based on course grades (array from
1678      * grade item id to object with ->min, ->max fields) - from cached data in
1679      * sectioncache field
1680      * @var array
1681      */
1682     private $_conditionsgrade;
1684     /**
1685      * Availability conditions for this section based on user fields
1686      * @var array
1687      */
1688     private $_conditionsfield;
1690     /**
1691      * True if this section is available to students i.e. if all availability conditions
1692      * are met - obtained dynamically
1693      * @var bool
1694      */
1695     private $_available;
1697     /**
1698      * If section is not available to students, this string gives information about
1699      * availability which can be displayed to students and/or staff (e.g. 'Available from 3
1700      * January 2010') for display on main page - obtained dynamically
1701      * @var string
1702      */
1703     private $_availableinfo;
1705     /**
1706      * True if this section is available to the CURRENT user (for example, if current user
1707      * has viewhiddensections capability, they can access the section even if it is not
1708      * visible or not available, so this would be true in that case)
1709      * @var bool
1710      */
1711     private $_uservisible;
1713     /**
1714      * Default values for sectioncache fields; if a field has this value, it won't
1715      * be stored in the sectioncache cache, to save space. Checks are done by ===
1716      * which means values must all be strings.
1717      * @var array
1718      */
1719     private static $sectioncachedefaults = array(
1720         'name' => null,
1721         'summary' => '',
1722         'summaryformat' => '1', // FORMAT_HTML, but must be a string
1723         'visible' => '1',
1724         'showavailability' => '0',
1725         'availablefrom' => '0',
1726         'availableuntil' => '0',
1727         'groupingid' => '0',
1728     );
1730     /**
1731      * Stores format options that have been cached when building 'coursecache'
1732      * When the format option is requested we look first if it has been cached
1733      * @var array
1734      */
1735     private $cachedformatoptions = array();
1737     /**
1738      * Constructs object from database information plus extra required data.
1739      * @param object $data Array entry from cached sectioncache
1740      * @param int $number Section number (array key)
1741      * @param int $courseid Course ID
1742      * @param int $sequence Sequence of course-module ids contained within
1743      * @param course_modinfo $modinfo Owner (needed for checking availability)
1744      * @param int $userid User ID
1745      */
1746     public function __construct($data, $number, $courseid, $sequence, $modinfo, $userid) {
1747         global $CFG;
1748         require_once($CFG->dirroot.'/course/lib.php');
1750         // Data that is always present
1751         $this->_id = $data->id;
1753         $defaults = self::$sectioncachedefaults +
1754                 array('conditionscompletion' => array(),
1755                     'conditionsgrade' => array(),
1756                     'conditionsfield' => array());
1758         // Data that may use default values to save cache size
1759         foreach ($defaults as $field => $value) {
1760             if (isset($data->{$field})) {
1761                 $this->{'_'.$field} = $data->{$field};
1762             } else {
1763                 $this->{'_'.$field} = $value;
1764             }
1765         }
1767         // cached course format data
1768         $formatoptionsdef = course_get_format($courseid)->section_format_options();
1769         foreach ($formatoptionsdef as $field => $option) {
1770             if (!empty($option['cache'])) {
1771                 if (isset($data->{$field})) {
1772                     $this->cachedformatoptions[$field] = $data->{$field};
1773                 } else if (array_key_exists('cachedefault', $option)) {
1774                     $this->cachedformatoptions[$field] = $option['cachedefault'];
1775                 }
1776             }
1777         }
1779         // Other data from other places
1780         $this->_course = $courseid;
1781         $this->_section = $number;
1782         $this->_sequence = $sequence;
1784         // Availability data
1785         if (!empty($CFG->enableavailability)) {
1786             require_once($CFG->libdir. '/conditionlib.php');
1787             // Get availability information
1788             $ci = new condition_info_section($this);
1789             $this->_available = $ci->is_available($this->_availableinfo, true,
1790                     $userid, $modinfo);
1791             // Display grouping info if available & not already displaying
1792             // (it would already display if current user doesn't have access)
1793             // for people with managegroups - same logic/class as grouping label
1794             // on individual activities.
1795             $context = context_course::instance($courseid);
1796             if ($this->_availableinfo === '' && $this->_groupingid &&
1797                     has_capability('moodle/course:managegroups', $context)) {
1798                 $groupings = groups_get_all_groupings($courseid);
1799                 $this->_availableinfo = html_writer::tag('span', '(' . format_string(
1800                         $groupings[$this->_groupingid]->name, true, array('context' => $context)) .
1801                         ')', array('class' => 'groupinglabel'));
1802             }
1803         } else {
1804             $this->_available = true;
1805         }
1807         // Update visibility for current user
1808         $this->update_user_visible($userid);
1809     }
1811     /**
1812      * Magic method to check if the property is set
1813      *
1814      * @param string $name name of the property
1815      * @return bool
1816      */
1817     public function __isset($name) {
1818         if (property_exists($this, '_'.$name)) {
1819             return isset($this->{'_'.$name});
1820         }
1821         $defaultformatoptions = course_get_format($this->_course)->section_format_options();
1822         if (array_key_exists($name, $defaultformatoptions)) {
1823             $value = $this->__get($name);
1824             return isset($value);
1825         }
1826         return false;
1827     }
1829     /**
1830      * Magic method to check if the property is empty
1831      *
1832      * @param string $name name of the property
1833      * @return bool
1834      */
1835     public function __empty($name) {
1836         if (property_exists($this, '_'.$name)) {
1837             return empty($this->{'_'.$name});
1838         }
1839         $defaultformatoptions = course_get_format($this->_course)->section_format_options();
1840         if (array_key_exists($name, $defaultformatoptions)) {
1841             $value = $this->__get($name);
1842             return empty($value);
1843         }
1844         return true;
1845     }
1847     /**
1848      * Magic method to retrieve the property, this is either basic section property
1849      * or availability information or additional properties added by course format
1850      *
1851      * @param string $name name of the property
1852      * @return bool
1853      */
1854     public function __get($name) {
1855         if (property_exists($this, '_'.$name)) {
1856             return $this->{'_'.$name};
1857         }
1858         if (array_key_exists($name, $this->cachedformatoptions)) {
1859             return $this->cachedformatoptions[$name];
1860         }
1861         $defaultformatoptions = course_get_format($this->_course)->section_format_options();
1862         // precheck if the option is defined in format to avoid unnecessary DB queries in get_format_options()
1863         if (array_key_exists($name, $defaultformatoptions)) {
1864             $formatoptions = course_get_format($this->_course)->get_format_options($this);
1865             return $formatoptions[$name];
1866         }
1867         debugging('Invalid section_info property accessed! '.$name);
1868         return null;
1869     }
1871     /**
1872      * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties
1873      * and use {@link convert_to_array()}
1874      *
1875      * @return ArrayIterator
1876      */
1877     public function getIterator() {
1878         $ret = array();
1879         foreach (get_object_vars($this) as $key => $value) {
1880             if (substr($key, 0, 1) == '_') {
1881                 $ret[substr($key, 1)] = $this->$key;
1882             }
1883         }
1884         $ret = array_merge($ret, course_get_format($this->_course)->get_format_options($this));
1885         return new ArrayIterator($ret);
1886     }
1888     /**
1889      * Works out whether activity is visible *for current user* - if this is false, they
1890      * aren't allowed to access it.
1891      * @param int $userid User ID
1892      * @return void
1893      */
1894     private function update_user_visible($userid) {
1895         global $CFG;
1896         $coursecontext = context_course::instance($this->_course);
1897         $this->_uservisible = true;
1898         if ((!$this->_visible || !$this->_available) &&
1899                 !has_capability('moodle/course:viewhiddensections', $coursecontext, $userid)) {
1900             $this->_uservisible = false;
1901         }
1902     }
1904     /**
1905      * Prepares section data for inclusion in sectioncache cache, removing items
1906      * that are set to defaults, and adding availability data if required.
1907      *
1908      * Called by build_section_cache in course_modinfo only; do not use otherwise.
1909      * @param object $section Raw section data object
1910      */
1911     public static function convert_for_section_cache($section) {
1912         global $CFG;
1914         // Course id stored in course table
1915         unset($section->course);
1916         // Section number stored in array key
1917         unset($section->section);
1918         // Sequence stored implicity in modinfo $sections array
1919         unset($section->sequence);
1921         // Add availability data if turned on
1922         if ($CFG->enableavailability) {
1923             require_once($CFG->dirroot . '/lib/conditionlib.php');
1924             condition_info_section::fill_availability_conditions($section);
1925             if (count($section->conditionscompletion) == 0) {
1926                 unset($section->conditionscompletion);
1927             }
1928             if (count($section->conditionsgrade) == 0) {
1929                 unset($section->conditionsgrade);
1930             }
1931         }
1933         // Remove default data
1934         foreach (self::$sectioncachedefaults as $field => $value) {
1935             // Exact compare as strings to avoid problems if some strings are set
1936             // to "0" etc.
1937             if (isset($section->{$field}) && $section->{$field} === $value) {
1938                 unset($section->{$field});
1939             }
1940         }
1941     }