MDL-35762 core_grade: adding unit tests for modinfolib.php
[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         collatorlib::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;
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) || empty($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         preload_course_contexts($course->id);
293         // Loop through each piece of module data, constructing it
294         $modexists = array();
295         foreach ($info as $mod) {
296             if (empty($mod->name)) {
297                 // something is wrong here
298                 continue;
299             }
301             // Skip modules which don't exist
302             if (empty($modexists[$mod->mod])) {
303                 if (!file_exists("$CFG->dirroot/mod/$mod->mod/lib.php")) {
304                     continue;
305                 }
306                 $modexists[$mod->mod] = true;
307             }
309             // Construct info for this module
310             $cm = new cm_info($this, $course, $mod, $info);
312             // Store module in instances and cms array
313             if (!isset($this->instances[$cm->modname])) {
314                 $this->instances[$cm->modname] = array();
315             }
316             $this->instances[$cm->modname][$cm->instance] = $cm;
317             $this->cms[$cm->id] = $cm;
319             // Reconstruct sections. This works because modules are stored in order
320             if (!isset($this->sections[$cm->sectionnum])) {
321                 $this->sections[$cm->sectionnum] = array();
322             }
323             $this->sections[$cm->sectionnum][] = $cm->id;
324         }
326         // Expand section objects
327         $this->sectioninfo = array();
328         foreach ($sectioncache as $number => $data) {
329             // Calculate sequence
330             if (isset($this->sections[$number])) {
331                 $sequence = implode(',', $this->sections[$number]);
332             } else {
333                 $sequence = '';
334             }
335             // Expand
336             $this->sectioninfo[$number] = new section_info($data, $number, $course->id, $sequence,
337                     $this, $userid);
338         }
340         // We need at least 'dynamic' data from each course-module (this is basically the remaining
341         // data which was always present in previous version of get_fast_modinfo, so it's required
342         // for BC). Creating it in a second pass is necessary because obtain_dynamic_data sometimes
343         // needs to be able to refer to a 'complete' (with basic data) modinfo.
344         foreach ($this->cms as $cm) {
345             $cm->obtain_dynamic_data();
346         }
347     }
349     /**
350      * Builds a list of information about sections on a course to be stored in
351      * the course cache. (Does not include information that is already cached
352      * in some other way.)
353      *
354      * Used internally by rebuild_course_cache function; do not use otherwise.
355      * @param int $courseid Course ID
356      * @return array Information about sections, indexed by section number (not id)
357      */
358     public static function build_section_cache($courseid) {
359         global $DB;
361         // Get section data
362         $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section',
363                 'section, id, course, name, summary, summaryformat, sequence, visible, ' .
364                 'availablefrom, availableuntil, showavailability, groupingid');
365         $compressedsections = array();
367         // Remove unnecessary data and add availability
368         foreach ($sections as $number => $section) {
369             // Clone just in case it is reused elsewhere
370             $compressedsections[$number] = clone($section);
371             section_info::convert_for_section_cache($compressedsections[$number]);
372         }
374         return $compressedsections;
375     }
379 /**
380  * Data about a single module on a course. This contains most of the fields in the course_modules
381  * table, plus additional data when required.
382  *
383  * This object has many public fields; code should treat all these fields as read-only and set
384  * data only using the supplied set functions. Setting the fields directly is not supported
385  * and may cause problems later.
386  */
387 class cm_info extends stdClass {
388     /**
389      * State: Only basic data from modinfo cache is available.
390      */
391     const STATE_BASIC = 0;
393     /**
394      * State: Dynamic data is available too.
395      */
396     const STATE_DYNAMIC = 1;
398     /**
399      * State: View data (for course page) is available.
400      */
401     const STATE_VIEW = 2;
403     /**
404      * Parent object
405      * @var course_modinfo
406      */
407     private $modinfo;
409     /**
410      * Level of information stored inside this object (STATE_xx constant)
411      * @var int
412      */
413     private $state;
415     // Existing data fields
416     ///////////////////////
418     /**
419      * Course-module ID - from course_modules table
420      * @var int
421      */
422     public $id;
424     /**
425      * Module instance (ID within module table) - from course_modules table
426      * @var int
427      */
428     public $instance;
430     /**
431      * Course ID - from course_modules table
432      * @var int
433      */
434     public $course;
436     /**
437      * 'ID number' from course-modules table (arbitrary text set by user) - from
438      * course_modules table
439      * @var string
440      */
441     public $idnumber;
443     /**
444      * Time that this course-module was added (unix time) - from course_modules table
445      * @var int
446      */
447     public $added;
449     /**
450      * This variable is not used and is included here only so it can be documented.
451      * Once the database entry is removed from course_modules, it should be deleted
452      * here too.
453      * @var int
454      * @deprecated Do not use this variable
455      */
456     public $score;
458     /**
459      * Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from
460      * course_modules table
461      * @var int
462      */
463     public $visible;
465     /**
466      * Old visible setting (if the entire section is hidden, the previous value for
467      * visible is stored in this field) - from course_modules table
468      * @var int
469      */
470     public $visibleold;
472     /**
473      * Group mode (one of the constants NONE, SEPARATEGROUPS, or VISIBLEGROUPS) - from
474      * course_modules table
475      * @var int
476      */
477     public $groupmode;
479     /**
480      * Grouping ID (0 = all groupings)
481      * @var int
482      */
483     public $groupingid;
485     /**
486      * Group members only (if set to 1, only members of a suitable group see this link on the
487      * course page; 0 = everyone sees it even if they don't belong to a suitable group)  - from
488      * course_modules table
489      * @var int
490      */
491     public $groupmembersonly;
493     /**
494      * Indent level on course page (0 = no indent) - from course_modules table
495      * @var int
496      */
497     public $indent;
499     /**
500      * Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from
501      * course_modules table
502      * @var int
503      */
504     public $completion;
506     /**
507      * Set to the item number (usually 0) if completion depends on a particular
508      * grade of this activity, or null if completion does not depend on a grade - from
509      * course_modules table
510      * @var mixed
511      */
512     public $completiongradeitemnumber;
514     /**
515      * 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table
516      * @var int
517      */
518     public $completionview;
520     /**
521      * Set to a unix time if completion of this activity is expected at a
522      * particular time, 0 if no time set - from course_modules table
523      * @var int
524      */
525     public $completionexpected;
527     /**
528      * Available date for this activity (0 if not set, or set to seconds since epoch; before this
529      * date, activity does not display to students) - from course_modules table
530      * @var int
531      */
532     public $availablefrom;
534     /**
535      * Available until date for this activity (0 if not set, or set to seconds since epoch; from
536      * this date, activity does not display to students) - from course_modules table
537      * @var int
538      */
539     public $availableuntil;
541     /**
542      * When activity is unavailable, this field controls whether it is shown to students (0 =
543      * hide completely, 1 = show greyed out with information about when it will be available) -
544      * from course_modules table
545      * @var int
546      */
547     public $showavailability;
549     /**
550      * Controls whether the description of the activity displays on the course main page (in
551      * addition to anywhere it might display within the activity itself). 0 = do not show
552      * on main page, 1 = show on main page.
553      * @var int
554      */
555     public $showdescription;
557     /**
558      * Extra HTML that is put in an unhelpful part of the HTML when displaying this module in
559      * course page - from cached data in modinfo field
560      * @deprecated This is crazy, don't use it. Replaced by ->extraclasses and ->onclick
561      * @var string
562      */
563     public $extra;
565     /**
566      * Name of icon to use - from cached data in modinfo field
567      * @var string
568      */
569     public $icon;
571     /**
572      * Component that contains icon - from cached data in modinfo field
573      * @var string
574      */
575     public $iconcomponent;
577     /**
578      * Name of module e.g. 'forum' (this is the same name as the module's main database
579      * table) - from cached data in modinfo field
580      * @var string
581      */
582     public $modname;
584     /**
585      * ID of module - from course_modules table
586      * @var int
587      */
588     public $module;
590     /**
591      * Name of module instance for display on page e.g. 'General discussion forum' - from cached
592      * data in modinfo field
593      * @var string
594      */
595     public $name;
597     /**
598      * Section number that this course-module is in (section 0 = above the calendar, section 1
599      * = week/topic 1, etc) - from cached data in modinfo field
600      * @var string
601      */
602     public $sectionnum;
604     /**
605      * Section id - from course_modules table
606      * @var int
607      */
608     public $section;
610     /**
611      * Availability conditions for this course-module based on the completion of other
612      * course-modules (array from other course-module id to required completion state for that
613      * module) - from cached data in modinfo field
614      * @var array
615      */
616     public $conditionscompletion;
618     /**
619      * Availability conditions for this course-module based on course grades (array from
620      * grade item id to object with ->min, ->max fields) - from cached data in modinfo field
621      * @var array
622      */
623     public $conditionsgrade;
625     /**
626      * Availability conditions for this course-module based on user fields
627      * @var array
628      */
629     public $conditionsfield;
631     /**
632      * True if this course-module is available to students i.e. if all availability conditions
633      * are met - obtained dynamically
634      * @var bool
635      */
636     public $available;
638     /**
639      * If course-module is not available to students, this string gives information about
640      * availability which can be displayed to students and/or staff (e.g. 'Available from 3
641      * January 2010') for display on main page - obtained dynamically
642      * @var string
643      */
644     public $availableinfo;
646     /**
647      * True if this course-module is available to the CURRENT user (for example, if current user
648      * has viewhiddenactivities capability, they can access the course-module even if it is not
649      * visible or not available, so this would be true in that case)
650      * @var bool
651      */
652     public $uservisible;
654     /**
655      * Module context - hacky shortcut
656      * @deprecated
657      * @var stdClass
658      */
659     public $context;
662     // New data available only via functions
663     ////////////////////////////////////////
665     /**
666      * @var moodle_url
667      */
668     private $url;
670     /**
671      * @var string
672      */
673     private $content;
675     /**
676      * @var string
677      */
678     private $extraclasses;
680     /**
681      * @var moodle_url full external url pointing to icon image for activity
682      */
683     private $iconurl;
685     /**
686      * @var string
687      */
688     private $onclick;
690     /**
691      * @var mixed
692      */
693     private $customdata;
695     /**
696      * @var string
697      */
698     private $afterlink;
700     /**
701      * @var string
702      */
703     private $afterediticons;
705     /**
706      * Magic method getter
707      *
708      * @param string $name
709      * @return mixed
710      */
711     public function __get($name) {
712         switch ($name) {
713             case 'modplural':
714                 return $this->get_module_type_name(true);
715             case 'modfullname':
716                 return $this->get_module_type_name();
717             default:
718                 debugging('Invalid cm_info property accessed: '.$name);
719                 return null;
720         }
721     }
723     /**
724      * @return bool True if this module has a 'view' page that should be linked to in navigation
725      *   etc (note: modules may still have a view.php file, but return false if this is not
726      *   intended to be linked to from 'normal' parts of the interface; this is what label does).
727      */
728     public function has_view() {
729         return !is_null($this->url);
730     }
732     /**
733      * @return moodle_url URL to link to for this module, or null if it doesn't have a view page
734      */
735     public function get_url() {
736         return $this->url;
737     }
739     /**
740      * Obtains content to display on main (view) page.
741      * Note: Will collect view data, if not already obtained.
742      * @return string Content to display on main page below link, or empty string if none
743      */
744     public function get_content() {
745         $this->obtain_view_data();
746         return $this->content;
747     }
749     /**
750      * Note: Will collect view data, if not already obtained.
751      * @return string Extra CSS classes to add to html output for this activity on main page
752      */
753     public function get_extra_classes() {
754         $this->obtain_view_data();
755         return $this->extraclasses;
756     }
758     /**
759      * @return string Content of HTML on-click attribute. This string will be used literally
760      * as a string so should be pre-escaped.
761      */
762     public function get_on_click() {
763         // Does not need view data; may be used by navigation
764         return $this->onclick;
765     }
766     /**
767      * @return mixed Optional custom data stored in modinfo cache for this activity, or null if none
768      */
769     public function get_custom_data() {
770         return $this->customdata;
771     }
773     /**
774      * Note: Will collect view data, if not already obtained.
775      * @return string Extra HTML code to display after link
776      */
777     public function get_after_link() {
778         $this->obtain_view_data();
779         return $this->afterlink;
780     }
782     /**
783      * Note: Will collect view data, if not already obtained.
784      * @return string Extra HTML code to display after editing icons (e.g. more icons)
785      */
786     public function get_after_edit_icons() {
787         $this->obtain_view_data();
788         return $this->afterediticons;
789     }
791     /**
792      * @param moodle_core_renderer $output Output render to use, or null for default (global)
793      * @return moodle_url Icon URL for a suitable icon to put beside this cm
794      */
795     public function get_icon_url($output = null) {
796         global $OUTPUT;
797         if (!$output) {
798             $output = $OUTPUT;
799         }
800         // Support modules setting their own, external, icon image
801         if (!empty($this->iconurl)) {
802             $icon = $this->iconurl;
804         // Fallback to normal local icon + component procesing
805         } else if (!empty($this->icon)) {
806             if (substr($this->icon, 0, 4) === 'mod/') {
807                 list($modname, $iconname) = explode('/', substr($this->icon, 4), 2);
808                 $icon = $output->pix_url($iconname, $modname);
809             } else {
810                 if (!empty($this->iconcomponent)) {
811                     // Icon  has specified component
812                     $icon = $output->pix_url($this->icon, $this->iconcomponent);
813                 } else {
814                     // Icon does not have specified component, use default
815                     $icon = $output->pix_url($this->icon);
816                 }
817             }
818         } else {
819             $icon = $output->pix_url('icon', $this->modname);
820         }
821         return $icon;
822     }
824     /**
825      * Returns a localised human-readable name of the module type
826      *
827      * @param bool $plural return plural form
828      * @return string
829      */
830     public function get_module_type_name($plural = false) {
831         $modnames = get_module_types_names($plural);
832         if (isset($modnames[$this->modname])) {
833             return $modnames[$this->modname];
834         } else {
835             return null;
836         }
837     }
839     /**
840      * @return course_modinfo Modinfo object that this came from
841      */
842     public function get_modinfo() {
843         return $this->modinfo;
844     }
846     /**
847      * @return object Moodle course object that was used to construct this data
848      */
849     public function get_course() {
850         return $this->modinfo->get_course();
851     }
853     // Set functions
854     ////////////////
856     /**
857      * Sets content to display on course view page below link (if present).
858      * @param string $content New content as HTML string (empty string if none)
859      * @return void
860      */
861     public function set_content($content) {
862         $this->content = $content;
863     }
865     /**
866      * Sets extra classes to include in CSS.
867      * @param string $extraclasses Extra classes (empty string if none)
868      * @return void
869      */
870     public function set_extra_classes($extraclasses) {
871         $this->extraclasses = $extraclasses;
872     }
874     /**
875      * Sets the external full url that points to the icon being used
876      * by the activity. Useful for external-tool modules (lti...)
877      * If set, takes precedence over $icon and $iconcomponent
878      *
879      * @param moodle_url $iconurl full external url pointing to icon image for activity
880      * @return void
881      */
882     public function set_icon_url(moodle_url $iconurl) {
883         $this->iconurl = $iconurl;
884     }
886     /**
887      * Sets value of on-click attribute for JavaScript.
888      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
889      * @param string $onclick New onclick attribute which should be HTML-escaped
890      *   (empty string if none)
891      * @return void
892      */
893     public function set_on_click($onclick) {
894         $this->check_not_view_only();
895         $this->onclick = $onclick;
896     }
898     /**
899      * Sets HTML that displays after link on course view page.
900      * @param string $afterlink HTML string (empty string if none)
901      * @return void
902      */
903     public function set_after_link($afterlink) {
904         $this->afterlink = $afterlink;
905     }
907     /**
908      * Sets HTML that displays after edit icons on course view page.
909      * @param string $afterediticons HTML string (empty string if none)
910      * @return void
911      */
912     public function set_after_edit_icons($afterediticons) {
913         $this->afterediticons = $afterediticons;
914     }
916     /**
917      * Changes the name (text of link) for this module instance.
918      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
919      * @param string $name Name of activity / link text
920      * @return void
921      */
922     public function set_name($name) {
923         $this->update_user_visible();
924         $this->name = $name;
925     }
927     /**
928      * Turns off the view link for this module instance.
929      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
930      * @return void
931      */
932     public function set_no_view_link() {
933         $this->check_not_view_only();
934         $this->url = null;
935     }
937     /**
938      * Sets the 'uservisible' flag. This can be used (by setting false) to prevent access and
939      * display of this module link for the current user.
940      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
941      * @param bool $uservisible
942      * @return void
943      */
944     public function set_user_visible($uservisible) {
945         $this->check_not_view_only();
946         $this->uservisible = $uservisible;
947     }
949     /**
950      * Sets the 'available' flag and related details. This flag is normally used to make
951      * course modules unavailable until a certain date or condition is met. (When a course
952      * module is unavailable, it is still visible to users who have viewhiddenactivities
953      * permission.)
954      *
955      * When this is function is called, user-visible status is recalculated automatically.
956      *
957      * Note: May not be called from _cm_info_view (only _cm_info_dynamic).
958      * @param bool $available False if this item is not 'available'
959      * @param int $showavailability 0 = do not show this item at all if it's not available,
960      *   1 = show this item greyed out with the following message
961      * @param string $availableinfo Information about why this is not available which displays
962      *   to those who have viewhiddenactivities, and to everyone if showavailability is set;
963      *   note that this function replaces the existing data (if any)
964      * @return void
965      */
966     public function set_available($available, $showavailability=0, $availableinfo='') {
967         $this->check_not_view_only();
968         $this->available = $available;
969         $this->showavailability = $showavailability;
970         $this->availableinfo = $availableinfo;
971         $this->update_user_visible();
972     }
974     /**
975      * Some set functions can only be called from _cm_info_dynamic and not _cm_info_view.
976      * This is because they may affect parts of this object which are used on pages other
977      * than the view page (e.g. in the navigation block, or when checking access on
978      * module pages).
979      * @return void
980      */
981     private function check_not_view_only() {
982         if ($this->state >= self::STATE_DYNAMIC) {
983             throw new coding_exception('Cannot set this data from _cm_info_view because it may ' .
984                     'affect other pages as well as view');
985         }
986     }
988     /**
989      * Constructor should not be called directly; use get_fast_modinfo.
990      * @param course_modinfo $modinfo Parent object
991      * @param object $course Course row
992      * @param object $mod Module object from the modinfo field of course table
993      * @param object $info Entire object from modinfo field of course table
994      */
995     public function __construct(course_modinfo $modinfo, $course, $mod, $info) {
996         global $CFG;
997         $this->modinfo = $modinfo;
999         $this->id               = $mod->cm;
1000         $this->instance         = $mod->id;
1001         $this->course           = $course->id;
1002         $this->modname          = $mod->mod;
1003         $this->idnumber         = isset($mod->idnumber) ? $mod->idnumber : '';
1004         $this->name             = $mod->name;
1005         $this->visible          = $mod->visible;
1006         $this->sectionnum       = $mod->section; // Note weirdness with name here
1007         $this->groupmode        = isset($mod->groupmode) ? $mod->groupmode : 0;
1008         $this->groupingid       = isset($mod->groupingid) ? $mod->groupingid : 0;
1009         $this->groupmembersonly = isset($mod->groupmembersonly) ? $mod->groupmembersonly : 0;
1010         $this->indent           = isset($mod->indent) ? $mod->indent : 0;
1011         $this->extra            = isset($mod->extra) ? $mod->extra : '';
1012         $this->extraclasses     = isset($mod->extraclasses) ? $mod->extraclasses : '';
1013         $this->iconurl          = isset($mod->iconurl) ? $mod->iconurl : '';
1014         $this->onclick          = isset($mod->onclick) ? $mod->onclick : '';
1015         $this->content          = isset($mod->content) ? $mod->content : '';
1016         $this->icon             = isset($mod->icon) ? $mod->icon : '';
1017         $this->iconcomponent    = isset($mod->iconcomponent) ? $mod->iconcomponent : '';
1018         $this->customdata       = isset($mod->customdata) ? $mod->customdata : '';
1019         $this->context          = context_module::instance($mod->cm);
1020         $this->showdescription  = isset($mod->showdescription) ? $mod->showdescription : 0;
1021         $this->state = self::STATE_BASIC;
1023         // This special case handles old label data. Labels used to use the 'name' field for
1024         // content
1025         if ($this->modname === 'label' && $this->content === '') {
1026             $this->content = $this->extra;
1027             $this->extra = '';
1028         }
1030         // Note: These fields from $cm were not present in cm_info in Moodle
1031         // 2.0.2 and prior. They may not be available if course cache hasn't
1032         // been rebuilt since then.
1033         $this->section = isset($mod->sectionid) ? $mod->sectionid : 0;
1034         $this->module = isset($mod->module) ? $mod->module : 0;
1035         $this->added = isset($mod->added) ? $mod->added : 0;
1036         $this->score = isset($mod->score) ? $mod->score : 0;
1037         $this->visibleold = isset($mod->visibleold) ? $mod->visibleold : 0;
1039         // Note: it saves effort and database space to always include the
1040         // availability and completion fields, even if availability or completion
1041         // are actually disabled
1042         $this->completion = isset($mod->completion) ? $mod->completion : 0;
1043         $this->completiongradeitemnumber = isset($mod->completiongradeitemnumber)
1044                 ? $mod->completiongradeitemnumber : null;
1045         $this->completionview = isset($mod->completionview)
1046                 ? $mod->completionview : 0;
1047         $this->completionexpected = isset($mod->completionexpected)
1048                 ? $mod->completionexpected : 0;
1049         $this->showavailability = isset($mod->showavailability) ? $mod->showavailability : 0;
1050         $this->availablefrom = isset($mod->availablefrom) ? $mod->availablefrom : 0;
1051         $this->availableuntil = isset($mod->availableuntil) ? $mod->availableuntil : 0;
1052         $this->conditionscompletion = isset($mod->conditionscompletion)
1053                 ? $mod->conditionscompletion : array();
1054         $this->conditionsgrade = isset($mod->conditionsgrade)
1055                 ? $mod->conditionsgrade : array();
1056         $this->conditionsfield = isset($mod->conditionsfield)
1057                 ? $mod->conditionsfield : array();
1059         static $modviews;
1060         if (!isset($modviews[$this->modname])) {
1061             $modviews[$this->modname] = !plugin_supports('mod', $this->modname,
1062                     FEATURE_NO_VIEW_LINK);
1063         }
1064         $this->url = $modviews[$this->modname]
1065                 ? new moodle_url('/mod/' . $this->modname . '/view.php', array('id'=>$this->id))
1066                 : null;
1067     }
1069     /**
1070      * If dynamic data for this course-module is not yet available, gets it.
1071      *
1072      * This function is automatically called when constructing course_modinfo, so users don't
1073      * need to call it.
1074      *
1075      * Dynamic data is data which does not come directly from the cache but is calculated at
1076      * runtime based on the current user. Primarily this concerns whether the user can access
1077      * the module or not.
1078      *
1079      * As part of this function, the module's _cm_info_dynamic function from its lib.php will
1080      * be called (if it exists).
1081      * @return void
1082      */
1083     public function obtain_dynamic_data() {
1084         global $CFG;
1085         if ($this->state >= self::STATE_DYNAMIC) {
1086             return;
1087         }
1088         $userid = $this->modinfo->get_user_id();
1090         if (!empty($CFG->enableavailability)) {
1091             // Get availability information
1092             $ci = new condition_info($this);
1093             // Note that the modinfo currently available only includes minimal details (basic data)
1094             // so passing it to this function is a bit dangerous as it would cause infinite
1095             // recursion if it tried to get dynamic data, however we know that this function only
1096             // uses basic data.
1097             $this->available = $ci->is_available($this->availableinfo, true,
1098                     $userid, $this->modinfo);
1100             // Check parent section
1101             $parentsection = $this->modinfo->get_section_info($this->sectionnum);
1102             if (!$parentsection->available) {
1103                 // Do not store info from section here, as that is already
1104                 // presented from the section (if appropriate) - just change
1105                 // the flag
1106                 $this->available = false;
1107             }
1108         } else {
1109             $this->available = true;
1110         }
1112         // Update visible state for current user
1113         $this->update_user_visible();
1115         // Let module make dynamic changes at this point
1116         $this->call_mod_function('cm_info_dynamic');
1117         $this->state = self::STATE_DYNAMIC;
1118     }
1120     /**
1121      * Works out whether activity is available to the current user
1122      *
1123      * If the activity is unavailable, additional checks are required to determine if its hidden or greyed out
1124      *
1125      * @see is_user_access_restricted_by_group()
1126      * @see is_user_access_restricted_by_conditional_access()
1127      * @return void
1128      */
1129     private function update_user_visible() {
1130         global $CFG;
1131         $modcontext = context_module::instance($this->id);
1132         $userid = $this->modinfo->get_user_id();
1133         $this->uservisible = true;
1135         // If the user cannot access the activity set the uservisible flag to false.
1136         // Additional checks are required to determine whether the activity is entirely hidden or just greyed out.
1137         if ((!$this->visible or !$this->available) and
1138                 !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
1140             $this->uservisible = false;
1141         }
1143         // Check group membership.
1144         if ($this->is_user_access_restricted_by_group()) {
1146              $this->uservisible = false;
1147             // Ensure activity is completely hidden from the user.
1148             $this->showavailability = 0;
1149         }
1150     }
1152     /**
1153      * Checks whether the module's group settings restrict the current user's access
1154      *
1155      * @return bool True if the user access is restricted
1156      */
1157     public function is_user_access_restricted_by_group() {
1158         global $CFG;
1160         if (!empty($CFG->enablegroupmembersonly) and !empty($this->groupmembersonly)) {
1161             $modcontext = context_module::instance($this->id);
1162             $userid = $this->modinfo->get_user_id();
1163             if (!has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
1164                 // If the activity has 'group members only' and you don't have accessallgroups...
1165                 $groups = $this->modinfo->get_groups($this->groupingid);
1166                 if (empty($groups)) {
1167                     // ...and you don't belong to a group, then set it so you can't see/access it
1168                     return true;
1169                 }
1170             }
1171         }
1172         return false;
1173     }
1175     /**
1176      * Checks whether the module's conditional access settings mean that the user cannot see the activity at all
1177      *
1178      * @return bool True if the user cannot see the module. False if the activity is either available or should be greyed out.
1179      */
1180     public function is_user_access_restricted_by_conditional_access() {
1181         global $CFG, $USER;
1183         if (empty($CFG->enableavailability)) {
1184             return false;
1185         }
1187         // If module will always be visible anyway (but greyed out), don't bother checking anything else
1188         if ($this->showavailability == CONDITION_STUDENTVIEW_SHOW) {
1189             return false;
1190         }
1192         // Can the user see hidden modules?
1193         $modcontext = context_module::instance($this->id);
1194         $userid = $this->modinfo->get_user_id();
1195         if (has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
1196             return false;
1197         }
1199         // Is the module hidden due to unmet conditions?
1200         if (!$this->available) {
1201             return true;
1202         }
1204         return false;
1205     }
1207     /**
1208      * Calls a module function (if exists), passing in one parameter: this object.
1209      * @param string $type Name of function e.g. if this is 'grooblezorb' and the modname is
1210      *   'forum' then it will try to call 'mod_forum_grooblezorb' or 'forum_grooblezorb'
1211      * @return void
1212      */
1213     private function call_mod_function($type) {
1214         global $CFG;
1215         $libfile = $CFG->dirroot . '/mod/' . $this->modname . '/lib.php';
1216         if (file_exists($libfile)) {
1217             include_once($libfile);
1218             $function = 'mod_' . $this->modname . '_' . $type;
1219             if (function_exists($function)) {
1220                 $function($this);
1221             } else {
1222                 $function = $this->modname . '_' . $type;
1223                 if (function_exists($function)) {
1224                     $function($this);
1225                 }
1226             }
1227         }
1228     }
1230     /**
1231      * If view data for this course-module is not yet available, obtains it.
1232      *
1233      * This function is automatically called if any of the functions (marked) which require
1234      * view data are called.
1235      *
1236      * View data is data which is needed only for displaying the course main page (& any similar
1237      * functionality on other pages) but is not needed in general. Obtaining view data may have
1238      * a performance cost.
1239      *
1240      * As part of this function, the module's _cm_info_view function from its lib.php will
1241      * be called (if it exists).
1242      * @return void
1243      */
1244     private function obtain_view_data() {
1245         if ($this->state >= self::STATE_VIEW) {
1246             return;
1247         }
1249         // Let module make changes at this point
1250         $this->call_mod_function('cm_info_view');
1251         $this->state = self::STATE_VIEW;
1252     }
1256 /**
1257  * Returns reference to full info about modules in course (including visibility).
1258  * Cached and as fast as possible (0 or 1 db query).
1259  *
1260  * @uses MAX_MODINFO_CACHE_SIZE
1261  * @param int|stdClass $courseorid object or 'reset' string to reset caches, modinfo may be updated in db
1262  * @param int $userid Set 0 (default) for current user
1263  * @param bool $resetonly whether we want to get modinfo or just reset the cache
1264  * @return course_modinfo|null Module information for course, or null if resetting
1265  */
1266 function get_fast_modinfo($courseorid, $userid = 0, $resetonly = false) {
1267     global $CFG, $USER;
1268     require_once($CFG->dirroot.'/course/lib.php');
1270     if (!empty($CFG->enableavailability)) {
1271         require_once($CFG->libdir.'/conditionlib.php');
1272     }
1274     static $cache = array();
1276     // compartibility with syntax prior to 2.4:
1277     if ($courseorid === 'reset') {
1278         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);
1279         $courseorid = 0;
1280         $resetonly = true;
1281     }
1283     if (is_object($courseorid)) {
1284         $course = $courseorid;
1285     } else {
1286         $course = (object)array('id' => $courseorid, 'modinfo' => null, 'sectioncache' => null);
1287     }
1289     // Function is called with $reset = true
1290     if ($resetonly) {
1291         if (isset($course->id) && $course->id > 0) {
1292             $cache[$course->id] = false;
1293         } else {
1294             foreach (array_keys($cache) as $key) {
1295                 $cache[$key] = false;
1296             }
1297         }
1298         return null;
1299     }
1301     // Function is called with $reset = false, retrieve modinfo
1302     if (empty($userid)) {
1303         $userid = $USER->id;
1304     }
1306     if (array_key_exists($course->id, $cache)) {
1307         if ($cache[$course->id] === false) {
1308             // this course has been recently reset, do not rely on modinfo and sectioncache in $course
1309             $course->modinfo = null;
1310             $course->sectioncache = null;
1311         } else if ($cache[$course->id]->userid == $userid) {
1312             // this course's modinfo for the same user was recently retrieved, return cached
1313             return $cache[$course->id];
1314         }
1315     }
1317     if (!property_exists($course, 'modinfo')) {
1318         debugging('Coding problem - missing course modinfo property in get_fast_modinfo() call');
1319     }
1321     if (!property_exists($course, 'sectioncache')) {
1322         debugging('Coding problem - missing course sectioncache property in get_fast_modinfo() call');
1323     }
1325     unset($cache[$course->id]); // prevent potential reference problems when switching users
1327     $cache[$course->id] = new course_modinfo($course, $userid);
1329     // Ensure cache does not use too much RAM
1330     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
1331         reset($cache);
1332         $key = key($cache);
1333         unset($cache[$key]->instances);
1334         unset($cache[$key]->cms);
1335         unset($cache[$key]);
1336     }
1338     return $cache[$course->id];
1341 /**
1342  * Rebuilds the cached list of course activities stored in the database
1343  * @param int $courseid - id of course to rebuild, empty means all
1344  * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1345  */
1346 function rebuild_course_cache($courseid=0, $clearonly=false) {
1347     global $COURSE, $DB, $CFG;
1349     // Destroy navigation caches
1350     navigation_cache::destroy_volatile_caches();
1352     if (class_exists('format_base')) {
1353         // if file containing class is not loaded, there is no cache there anyway
1354         format_base::reset_course_cache($courseid);
1355     }
1357     if ($clearonly) {
1358         if (empty($courseid)) {
1359             $DB->set_field('course', 'modinfo', null);
1360             $DB->set_field('course', 'sectioncache', null);
1361         } else {
1362             // Clear both fields in one update
1363             $resetobj = (object)array('id' => $courseid, 'modinfo' => null, 'sectioncache' => null);
1364             $DB->update_record('course', $resetobj);
1365         }
1366         // update cached global COURSE too ;-)
1367         if ($courseid == $COURSE->id or empty($courseid)) {
1368             $COURSE->modinfo = null;
1369             $COURSE->sectioncache = null;
1370         }
1371         // reset the fast modinfo cache
1372         get_fast_modinfo($courseid, 0, true);
1373         return;
1374     }
1376     require_once("$CFG->dirroot/course/lib.php");
1378     if ($courseid) {
1379         $select = array('id'=>$courseid);
1380     } else {
1381         $select = array();
1382         @set_time_limit(0);  // this could take a while!   MDL-10954
1383     }
1385     $rs = $DB->get_recordset("course", $select,'','id,fullname');
1386     foreach ($rs as $course) {
1387         $modinfo = serialize(get_array_of_activities($course->id));
1388         $sectioncache = serialize(course_modinfo::build_section_cache($course->id));
1389         $updateobj = (object)array('id' => $course->id,
1390                 'modinfo' => $modinfo, 'sectioncache' => $sectioncache);
1391         $DB->update_record("course", $updateobj);
1392         // update cached global COURSE too ;-)
1393         if ($course->id == $COURSE->id) {
1394             $COURSE->modinfo = $modinfo;
1395             $COURSE->sectioncache = $sectioncache;
1396         }
1397     }
1398     $rs->close();
1399     // reset the fast modinfo cache
1400     get_fast_modinfo($courseid, 0, true);
1404 /**
1405  * Class that is the return value for the _get_coursemodule_info module API function.
1406  *
1407  * Note: For backward compatibility, you can also return a stdclass object from that function.
1408  * The difference is that the stdclass object may contain an 'extra' field (deprecated because
1409  * it was crazy, except for label which uses it differently). The stdclass object may not contain
1410  * the new fields defined here (content, extraclasses, customdata).
1411  */
1412 class cached_cm_info {
1413     /**
1414      * Name (text of link) for this activity; Leave unset to accept default name
1415      * @var string
1416      */
1417     public $name;
1419     /**
1420      * Name of icon for this activity. Normally, this should be used together with $iconcomponent
1421      * to define the icon, as per pix_url function.
1422      * For backward compatibility, if this value is of the form 'mod/forum/icon' then an icon
1423      * within that module will be used.
1424      * @see cm_info::get_icon_url()
1425      * @see renderer_base::pix_url()
1426      * @var string
1427      */
1428     public $icon;
1430     /**
1431      * Component for icon for this activity, as per pix_url; leave blank to use default 'moodle'
1432      * component
1433      * @see renderer_base::pix_url()
1434      * @var string
1435      */
1436     public $iconcomponent;
1438     /**
1439      * HTML content to be displayed on the main page below the link (if any) for this course-module
1440      * @var string
1441      */
1442     public $content;
1444     /**
1445      * Custom data to be stored in modinfo for this activity; useful if there are cases when
1446      * internal information for this activity type needs to be accessible from elsewhere on the
1447      * course without making database queries. May be of any type but should be short.
1448      * @var mixed
1449      */
1450     public $customdata;
1452     /**
1453      * Extra CSS class or classes to be added when this activity is displayed on the main page;
1454      * space-separated string
1455      * @var string
1456      */
1457     public $extraclasses;
1459     /**
1460      * External URL image to be used by activity as icon, useful for some external-tool modules
1461      * like lti. If set, takes precedence over $icon and $iconcomponent
1462      * @var $moodle_url
1463      */
1464     public $iconurl;
1466     /**
1467      * Content of onclick JavaScript; escaped HTML to be inserted as attribute value
1468      * @var string
1469      */
1470     public $onclick;
1474 /**
1475  * Data about a single section on a course. This contains the fields from the
1476  * course_sections table, plus additional data when required.
1477  */
1478 class section_info extends stdClass {
1479     /**
1480      * Section ID - from course_sections table
1481      * @var int
1482      */
1483     public $id;
1485     /**
1486      * Course ID - from course_sections table
1487      * @var int
1488      */
1489     public $course;
1491     /**
1492      * Section number - from course_sections table
1493      * @var int
1494      */
1495     public $section;
1497     /**
1498      * Section name if specified - from course_sections table
1499      * @var string
1500      */
1501     public $name;
1503     /**
1504      * Section visibility (1 = visible) - from course_sections table
1505      * @var int
1506      */
1507     public $visible;
1509     /**
1510      * Section summary text if specified - from course_sections table
1511      * @var string
1512      */
1513     public $summary;
1515     /**
1516      * Section summary text format (FORMAT_xx constant) - from course_sections table
1517      * @var int
1518      */
1519     public $summaryformat;
1521     /**
1522      * When section is unavailable, this field controls whether it is shown to students (0 =
1523      * hide completely, 1 = show greyed out with information about when it will be available) -
1524      * from course_sections table
1525      * @var int
1526      */
1527     public $showavailability;
1529     /**
1530      * Available date for this section (0 if not set, or set to seconds since epoch; before this
1531      * date, section does not display to students) - from course_sections table
1532      * @var int
1533      */
1534     public $availablefrom;
1536     /**
1537      * Available until date for this section  (0 if not set, or set to seconds since epoch; from
1538      * this date, section does not display to students) - from course_sections table
1539      * @var int
1540      */
1541     public $availableuntil;
1543     /**
1544      * If section is restricted to users of a particular grouping, this is its id
1545      * (0 if not set) - from course_sections table
1546      * @var int
1547      */
1548     public $groupingid;
1550     /**
1551      * Availability conditions for this section based on the completion of
1552      * course-modules (array from course-module id to required completion state
1553      * for that module) - from cached data in sectioncache field
1554      * @var array
1555      */
1556     public $conditionscompletion;
1558     /**
1559      * Availability conditions for this section based on course grades (array from
1560      * grade item id to object with ->min, ->max fields) - from cached data in
1561      * sectioncache field
1562      * @var array
1563      */
1564     public $conditionsgrade;
1566     /**
1567      * True if this section is available to students i.e. if all availability conditions
1568      * are met - obtained dynamically
1569      * @var bool
1570      */
1571     public $available;
1573     /**
1574      * If section is not available to students, this string gives information about
1575      * availability which can be displayed to students and/or staff (e.g. 'Available from 3
1576      * January 2010') for display on main page - obtained dynamically
1577      * @var string
1578      */
1579     public $availableinfo;
1581     /**
1582      * True if this section is available to the CURRENT user (for example, if current user
1583      * has viewhiddensections capability, they can access the section even if it is not
1584      * visible or not available, so this would be true in that case)
1585      * @var bool
1586      */
1587     public $uservisible;
1589     /**
1590      * Default values for sectioncache fields; if a field has this value, it won't
1591      * be stored in the sectioncache cache, to save space. Checks are done by ===
1592      * which means values must all be strings.
1593      * @var array
1594      */
1595     private static $sectioncachedefaults = array(
1596         'name' => null,
1597         'summary' => '',
1598         'summaryformat' => '1', // FORMAT_HTML, but must be a string
1599         'visible' => '1',
1600         'showavailability' => '0',
1601         'availablefrom' => '0',
1602         'availableuntil' => '0',
1603         'groupingid' => '0',
1604     );
1606     /**
1607      * Constructs object from database information plus extra required data.
1608      * @param object $data Array entry from cached sectioncache
1609      * @param int $number Section number (array key)
1610      * @param int $courseid Course ID
1611      * @param int $sequence Sequence of course-module ids contained within
1612      * @param course_modinfo $modinfo Owner (needed for checking availability)
1613      * @param int $userid User ID
1614      */
1615     public function __construct($data, $number, $courseid, $sequence, $modinfo, $userid) {
1616         global $CFG;
1618         // Data that is always present
1619         $this->id = $data->id;
1621         // Data that may use default values to save cache size
1622         foreach (self::$sectioncachedefaults as $field => $value) {
1623             if (isset($data->{$field})) {
1624                 $this->{$field} = $data->{$field};
1625             } else {
1626                 $this->{$field} = $value;
1627             }
1628         }
1630         // Data with array defaults
1631         $this->conditionscompletion = isset($data->conditionscompletion)
1632                 ? $data->conditionscompletion : array();
1633         $this->conditionsgrade = isset($data->conditionsgrade)
1634                 ? $data->conditionsgrade : array();
1635         $this->conditionsfield = isset($data->conditionsfield)
1636                 ? $data->conditionsfield : array();
1638         // Other data from other places
1639         $this->course = $courseid;
1640         $this->section = $number;
1641         $this->sequence = $sequence;
1643         // Availability data
1644         if (!empty($CFG->enableavailability)) {
1645             // Get availability information
1646             $ci = new condition_info_section($this);
1647             $this->available = $ci->is_available($this->availableinfo, true,
1648                     $userid, $modinfo);
1649             // Display grouping info if available & not already displaying
1650             // (it would already display if current user doesn't have access)
1651             // for people with managegroups - same logic/class as grouping label
1652             // on individual activities.
1653             $context = context_course::instance($courseid);
1654             if ($this->availableinfo === '' && $this->groupingid &&
1655                     has_capability('moodle/course:managegroups', $context)) {
1656                 $groupings = groups_get_all_groupings($courseid);
1657                 $this->availableinfo = html_writer::tag('span', '(' . format_string(
1658                         $groupings[$this->groupingid]->name, true, array('context' => $context)) .
1659                         ')', array('class' => 'groupinglabel'));
1660             }
1661         } else {
1662             $this->available = true;
1663         }
1665         // Update visibility for current user
1666         $this->update_user_visible($userid);
1667     }
1669     /**
1670      * Works out whether activity is visible *for current user* - if this is false, they
1671      * aren't allowed to access it.
1672      * @param int $userid User ID
1673      * @return void
1674      */
1675     private function update_user_visible($userid) {
1676         global $CFG;
1677         $coursecontext = context_course::instance($this->course);
1678         $this->uservisible = true;
1679         if ((!$this->visible || !$this->available) &&
1680                 !has_capability('moodle/course:viewhiddensections', $coursecontext, $userid)) {
1681             $this->uservisible = false;
1682         }
1683     }
1685     /**
1686      * Prepares section data for inclusion in sectioncache cache, removing items
1687      * that are set to defaults, and adding availability data if required.
1688      *
1689      * Called by build_section_cache in course_modinfo only; do not use otherwise.
1690      * @param object $section Raw section data object
1691      */
1692     public static function convert_for_section_cache($section) {
1693         global $CFG;
1695         // Course id stored in course table
1696         unset($section->course);
1697         // Section number stored in array key
1698         unset($section->section);
1699         // Sequence stored implicity in modinfo $sections array
1700         unset($section->sequence);
1702         // Add availability data if turned on
1703         if ($CFG->enableavailability) {
1704             require_once($CFG->dirroot . '/lib/conditionlib.php');
1705             condition_info_section::fill_availability_conditions($section);
1706             if (count($section->conditionscompletion) == 0) {
1707                 unset($section->conditionscompletion);
1708             }
1709             if (count($section->conditionsgrade) == 0) {
1710                 unset($section->conditionsgrade);
1711             }
1712         }
1714         // Remove default data
1715         foreach (self::$sectioncachedefaults as $field => $value) {
1716             // Exact compare as strings to avoid problems if some strings are set
1717             // to "0" etc.
1718             if (isset($section->{$field}) && $section->{$field} === $value) {
1719                 unset($section->{$field});
1720             }
1721         }
1722     }