Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/lib/ -> modinfolib.php (source)
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * modinfolib.php - Functions/classes relating to cached information about module instances on
 * a course.
 * @package    core
 * @subpackage lib
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @author     sam marshall
 */


// Maximum number of modinfo items to keep in memory cache. Do not increase this to a large
// number because:
// a) modinfo can be big (megabyte range) for some courses
// b) performance of cache will deteriorate if there are very many items in it
if (!defined('MAX_MODINFO_CACHE_SIZE')) {
    define('MAX_MODINFO_CACHE_SIZE', 10);
}


/**
 * Information about a course that is cached in the course table 'modinfo' field (and then in
 * memory) in order to reduce the need for other database queries.
 *
 * This includes information about the course-modules and the sections on the course. It can also
 * include dynamic data that has been updated for the current user.
 *
 * Use {@link get_fast_modinfo()} to retrieve the instance of the object for particular course
 * and particular user.
 *
 * @property-read int $courseid Course ID
 * @property-read int $userid User ID
 * @property-read array $sections Array from section number (e.g. 0) to array of course-module IDs in that
 *     section; this only includes sections that contain at least one course-module
 * @property-read cm_info[] $cms Array from course-module instance to cm_info object within this course, in
 *     order of appearance
 * @property-read cm_info[][] $instances Array from string (modname) => int (instance id) => cm_info object
 * @property-read array $groups Groups that the current user belongs to. Calculated on the first request.
 *     Is an array of grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'
 */
class course_modinfo {
    /** @var int Maximum time the course cache building lock can be held */
    const COURSE_CACHE_LOCK_EXPIRY = 180;

    /** @var int Time to wait for the course cache building lock before throwing an exception */
    const COURSE_CACHE_LOCK_WAIT = 60;

    /**
     * List of fields from DB table 'course' that are cached in MUC and are always present in course_modinfo::$course
     * @var array
     */
    public static $cachedfields = array('shortname', 'fullname', 'format',
            'enablecompletion', 'groupmode', 'groupmodeforce', 'cacherev');

    /**
     * For convenience we store the course object here as it is needed in other parts of code
     * @var stdClass
     */
    private $course;

    /**
     * Array of section data from cache
     * @var section_info[]
     */
    private $sectioninfo;

    /**
     * User ID
     * @var int
     */
    private $userid;

    /**
     * Array from int (section num, e.g. 0) => array of int (course-module id); this list only
     * includes sections that actually contain at least one course-module
     * @var array
     */
    private $sections;

    /**
     * Array from int (cm id) => cm_info object
     * @var cm_info[]
     */
    private $cms;

    /**
     * Array from string (modname) => int (instance id) => cm_info object
     * @var cm_info[][]
     */
    private $instances;

    /**
     * Groups that the current user belongs to. This value is calculated on first
     * request to the property or function.
     * When set, it is an array of grouping id => array of group id => group id.
     * Includes grouping id 0 for 'all groups'.
     * @var int[][]
     */
    private $groups;

    /**
     * List of class read-only properties and their getter methods.
     * Used by magic functions __get(), __isset(), __empty()
     * @var array
     */
    private static $standardproperties = array(
        'courseid' => 'get_course_id',
        'userid' => 'get_user_id',
        'sections' => 'get_sections',
        'cms' => 'get_cms',
        'instances' => 'get_instances',
        'groups' => 'get_groups_all',
    );

    /**
     * Magic method getter
     *
     * @param string $name
     * @return mixed
     */
    public function __get($name) {
        if (isset(self::$standardproperties[$name])) {
            $method = self::$standardproperties[$name];
            return $this->$method();
        } else {
            debugging('Invalid course_modinfo property accessed: '.$name);
            return null;
        }
    }

    /**
     * Magic method for function isset()
     *
     * @param string $name
     * @return bool
     */
    public function __isset($name) {
        if (isset(self::$standardproperties[$name])) {
            $value = $this->__get($name);
            return isset($value);
        }
        return false;
    }

    /**
     * Magic method for function empty()
     *
     * @param string $name
     * @return bool
     */
    public function __empty($name) {
        if (isset(self::$standardproperties[$name])) {
            $value = $this->__get($name);
            return empty($value);
        }
        return true;
    }

    /**
     * Magic method setter
     *
     * Will display the developer warning when trying to set/overwrite existing property.
     *
     * @param string $name
     * @param mixed $value
     */
    public function __set($name, $value) {
        debugging("It is not allowed to set the property course_modinfo::\${$name}", DEBUG_DEVELOPER);
    }

    /**
     * Returns course object that was used in the first {@link get_fast_modinfo()} call.
     *
     * It may not contain all fields from DB table {course} but always has at least the following:
     * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev
     *
     * @return stdClass
     */
    public function get_course() {
        return $this->course;
    }

    /**
     * @return int Course ID
     */
    public function get_course_id() {
        return $this->course->id;
    }

    /**
     * @return int User ID
     */
    public function get_user_id() {
        return $this->userid;
    }

    /**
     * @return array Array from section number (e.g. 0) to array of course-module IDs in that
     *   section; this only includes sections that contain at least one course-module
     */
    public function get_sections() {
        return $this->sections;
    }

    /**
     * @return cm_info[] Array from course-module instance to cm_info object within this course, in
     *   order of appearance
     */
    public function get_cms() {
        return $this->cms;
    }

    /**
     * Obtains a single course-module object (for a course-module that is on this course).
     * @param int $cmid Course-module ID
     * @return cm_info Information about that course-module
     * @throws moodle_exception If the course-module does not exist
     */
    public function get_cm($cmid) {
        if (empty($this->cms[$cmid])) {
            throw new moodle_exception('invalidcoursemodule', 'error');
        }
        return $this->cms[$cmid];
    }

    /**
     * Obtains all module instances on this course.
     * @return cm_info[][] Array from module name => array from instance id => cm_info
     */
    public function get_instances() {
        return $this->instances;
    }

    /**
     * Returns array of localised human-readable module names used in this course
     *
     * @param bool $plural if true returns the plural form of modules names
     * @return array
     */
    public function get_used_module_names($plural = false) {
        $modnames = get_module_types_names($plural);
        $modnamesused = array();
        foreach ($this->get_cms() as $cmid => $mod) {
            if (!isset($modnamesused[$mod->modname]) && isset($modnames[$mod->modname]) && $mod->uservisible) {
                $modnamesused[$mod->modname] = $modnames[$mod->modname];
            }
        }
        return $modnamesused;
    }

    /**
     * Obtains all instances of a particular module on this course.
     * @param $modname Name of module (not full frankenstyle) e.g. 'label'
     * @return cm_info[] Array from instance id => cm_info for modules on this course; empty if none
     */
    public function get_instances_of($modname) {
        if (empty($this->instances[$modname])) {
            return array();
        }
        return $this->instances[$modname];
    }

    /**
     * Groups that the current user belongs to organised by grouping id. Calculated on the first request.
     * @return int[][] array of grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'
     */
    private function get_groups_all() {
        if (is_null($this->groups)) {
            // NOTE: Performance could be improved here. The system caches user groups
            // in $USER->groupmember[$courseid] => array of groupid=>groupid. Unfortunately this
            // structure does not include grouping information. It probably could be changed to
            // do so, without a significant performance hit on login, thus saving this one query
            // each request.
            $this->groups = groups_get_user_groups($this->course->id, $this->userid);
        }
        return $this->groups;
    }

    /**
     * Returns groups that the current user belongs to on the course. Note: If not already
     * available, this may make a database query.
     * @param int $groupingid Grouping ID or 0 (default) for all groups
     * @return int[] Array of int (group id) => int (same group id again); empty array if none
     */
    public function get_groups($groupingid = 0) {
        $allgroups = $this->get_groups_all();
        if (!isset($allgroups[$groupingid])) {
            return array();
        }
        return $allgroups[$groupingid];
    }

    /**
     * Gets all sections as array from section number => data about section.
     * @return section_info[] Array of section_info objects organised by section number
     */
    public function get_section_info_all() {
        return $this->sectioninfo;
    }

    /**
     * Gets data about specific numbered section.
     * @param int $sectionnumber Number (not id) of section
     * @param int $strictness Use MUST_EXIST to throw exception if it doesn't
     * @return section_info Information for numbered section or null if not found
     */
    public function get_section_info($sectionnumber, $strictness = IGNORE_MISSING) {
        if (!array_key_exists($sectionnumber, $this->sectioninfo)) {
            if ($strictness === MUST_EXIST) {
                throw new moodle_exception('sectionnotexist');
            } else {
                return null;
            }
        }
        return $this->sectioninfo[$sectionnumber];
    }

    /**
     * Static cache for generated course_modinfo instances
     *
     * @see course_modinfo::instance()
     * @see course_modinfo::clear_instance_cache()
     * @var course_modinfo[]
     */
    protected static $instancecache = array();

    /**
     * Timestamps (microtime) when the course_modinfo instances were last accessed
     *
     * It is used to remove the least recent accessed instances when static cache is full
     *
     * @var float[]
     */
    protected static $cacheaccessed = array();

    /**
     * Clears the cache used in course_modinfo::instance()
     *
     * Used in {@link get_fast_modinfo()} when called with argument $reset = true
     * and in {@link rebuild_course_cache()}
     *
     * @param null|int|stdClass $courseorid if specified removes only cached value for this course
     */
    public static function clear_instance_cache($courseorid = null) {
        if (empty($courseorid)) {
            self::$instancecache = array();
            self::$cacheaccessed = array();
            return;
        }
        if (is_object($courseorid)) {
            $courseorid = $courseorid->id;
        }
        if (isset(self::$instancecache[$courseorid])) {
            // Unsetting static variable in PHP is peculiar, it removes the reference,
            // but data remain in memory. Prior to unsetting, the varable needs to be
            // set to empty to remove its remains from memory.
            self::$instancecache[$courseorid] = '';
            unset(self::$instancecache[$courseorid]);
            unset(self::$cacheaccessed[$courseorid]);
        }
    }

    /**
     * Returns the instance of course_modinfo for the specified course and specified user
     *
     * This function uses static cache for the retrieved instances. The cache
     * size is limited by MAX_MODINFO_CACHE_SIZE. If instance is not found in
     * the static cache or it was created for another user or the cacherev validation
     * failed - a new instance is constructed and returned.
     *
     * Used in {@link get_fast_modinfo()}
     *
     * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id'
     *     and recommended to have field 'cacherev') or just a course id
     * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections.
     *     Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
     * @return course_modinfo
     */
    public static function instance($courseorid, $userid = 0) {
        global $USER;
        if (is_object($courseorid)) {
            $course = $courseorid;
        } else {
            $course = (object)array('id' => $courseorid);
        }
        if (empty($userid)) {
            $userid = $USER->id;
        }

        if (!empty(self::$instancecache[$course->id])) {
            if (self::$instancecache[$course->id]->userid == $userid &&
                    (!isset($course->cacherev) ||
                    $course->cacherev == self::$instancecache[$course->id]->get_course()->cacherev)) {
                // This course's modinfo for the same user was recently retrieved, return cached.
                self::$cacheaccessed[$course->id] = microtime(true);
                return self::$instancecache[$course->id];
            } else {
                // Prevent potential reference problems when switching users.
                self::clear_instance_cache($course->id);
            }
        }
        $modinfo = new course_modinfo($course, $userid);

        // We have a limit of MAX_MODINFO_CACHE_SIZE entries to store in static variable.
        if (count(self::$instancecache) >= MAX_MODINFO_CACHE_SIZE) {
            // Find the course that was the least recently accessed.
            asort(self::$cacheaccessed, SORT_NUMERIC);
            $courseidtoremove = key(array_reverse(self::$cacheaccessed, true));
            self::clear_instance_cache($courseidtoremove);
        }

        // Add modinfo to the static cache.
        self::$instancecache[$course->id] = $modinfo;
        self::$cacheaccessed[$course->id] = microtime(true);

        return $modinfo;
    }

    /**
     * Constructs based on course.
     * Note: This constructor should not usually be called directly.
     * Use get_fast_modinfo($course) instead as this maintains a cache.
     * @param stdClass $course course object, only property id is required.
     * @param int $userid User ID
     * @throws moodle_exception if course is not found
     */
    public function __construct($course, $userid) {
        global $CFG, $COURSE, $SITE, $DB;

        if (!isset($course->cacherev)) {
            // We require presence of property cacherev to validate the course cache.
            // No need to clone the $COURSE or $SITE object here because we clone it below anyway.
            $course = get_course($course->id, false);
        }

        $cachecoursemodinfo = cache::make('core', 'coursemodinfo');

        // Retrieve modinfo from cache. If not present or cacherev mismatches, call rebuild and retrieve again.
        $coursemodinfo = $cachecoursemodinfo->get($course->id);
        if ($coursemodinfo === false || ($course->cacherev != $coursemodinfo->cacherev)) {
            $lock = self::get_course_cache_lock($course->id);
            try {
                // Only actually do the build if it's still needed after getting the lock (not if
                // somebody else, who might have been holding the lock, built it already).
                $coursemodinfo = $cachecoursemodinfo->get($course->id);
                if ($coursemodinfo === false || ($course->cacherev != $coursemodinfo->cacherev)) {
                    $coursemodinfo = self::inner_build_course_cache($course, $lock);
                }
            } finally {
                $lock->release();
            }
        }

        // Set initial values
        $this->userid = $userid;
        $this->sections = array();
        $this->cms = array();
        $this->instances = array();
        $this->groups = null;

        // If we haven't already preloaded contexts for the course, do it now
        // Modules are also cached here as long as it's the first time this course has been preloaded.
        context_helper::preload_course($course->id);

        // Quick integrity check: as a result of race conditions modinfo may not be regenerated after the change.
        // It is especially dangerous if modinfo contains the deleted course module, as it results in fatal error.
        // We can check it very cheap by validating the existence of module context.
        if ($course->id == $COURSE->id || $course->id == $SITE->id) {
            // Only verify current course (or frontpage) as pages with many courses may not have module contexts cached.
            // (Uncached modules will result in a very slow verification).
            foreach ($coursemodinfo->modinfo as $mod) {
                if (!context_module::instance($mod->cm, IGNORE_MISSING)) {
                    debugging('Course cache integrity check failed: course module with id '. $mod->cm.
                            ' does not have context. Rebuilding cache for course '. $course->id);
                    // Re-request the course record from DB as well, don't use get_course() here.
                    $course = $DB->get_record('course', array('id' => $course->id), '*', MUST_EXIST);
                    $coursemodinfo = self::build_course_cache($course);
                    break;
                }
            }
        }

        // Overwrite unset fields in $course object with cached values, store the course object.
        $this->course = fullclone($course);
        foreach ($coursemodinfo as $key => $value) {
            if ($key !== 'modinfo' && $key !== 'sectioncache' &&
                    (!isset($this->course->$key) || $key === 'cacherev')) {
                $this->course->$key = $value;
            }
        }

        // Loop through each piece of module data, constructing it
        static $modexists = array();
        foreach ($coursemodinfo->modinfo as $mod) {
            if (!isset($mod->name) || strval($mod->name) === '') {
                // something is wrong here
                continue;
            }

            // Skip modules which don't exist
            if (!array_key_exists($mod->mod, $modexists)) {
                $modexists[$mod->mod] = file_exists("$CFG->dirroot/mod/$mod->mod/lib.php");
            }
            if (!$modexists[$mod->mod]) {
                continue;
            }

            // Construct info for this module
            $cm = new cm_info($this, null, $mod, null);

            // Store module in instances and cms array
            if (!isset($this->instances[$cm->modname])) {
                $this->instances[$cm->modname] = array();
            }
            $this->instances[$cm->modname][$cm->instance] = $cm;
            $this->cms[$cm->id] = $cm;

            // Reconstruct sections. This works because modules are stored in order
            if (!isset($this->sections[$cm->sectionnum])) {
                $this->sections[$cm->sectionnum] = array();
            }
            $this->sections[$cm->sectionnum][] = $cm->id;
        }

        // Expand section objects
        $this->sectioninfo = array();
        foreach ($coursemodinfo->sectioncache as $number => $data) {
            $this->sectioninfo[$number] = new section_info($data, $number, null, null,
                    $this, null);
        }
    }

    /**
     * This method can not be used anymore.
     *
     * @see course_modinfo::build_course_cache()
     * @deprecated since 2.6
     */
    public static function build_section_cache($courseid) {
        throw new coding_exception('Function course_modinfo::build_section_cache() can not be used anymore.' .
            ' Please use course_modinfo::build_course_cache() whenever applicable.');
    }

    /**
     * Builds a list of information about sections on a course to be stored in
     * the course cache. (Does not include information that is already cached
     * in some other way.)
     *
     * @param stdClass $course Course object (must contain fields
     * @return array Information about sections, indexed by section number (not id)
     */
    protected static function build_course_section_cache($course) {
        global $DB;

        // Get section data
        $sections = $DB->get_records('course_sections', array('course' => $course->id), 'section',
                'section, id, course, name, summary, summaryformat, sequence, visible, availability');
        $compressedsections = array();

        $formatoptionsdef = course_get_format($course)->section_format_options();
        // Remove unnecessary data and add availability
        foreach ($sections as $number => $section) {
            // Add cached options from course format to $section object
            foreach ($formatoptionsdef as $key => $option) {
                if (!empty($option['cache'])) {
                    $formatoptions = course_get_format($course)->get_format_options($section);
                    if (!array_key_exists('cachedefault', $option) || $option['cachedefault'] !== $formatoptions[$key]) {
                        $section->$key = $formatoptions[$key];
                    }
                }
            }
            // Clone just in case it is reused elsewhere
            $compressedsections[$number] = clone($section);
            section_info::convert_for_section_cache($compressedsections[$number]);
        }

        return $compressedsections;
    }

    /**
     * Gets a lock for rebuilding the cache of a single course.
     *
     * Caller must release the returned lock.
     *
     * This is used to ensure that the cache rebuild doesn't happen multiple times in parallel.
     * This function will wait up to 1 minute for the lock to be obtained. If the lock cannot
     * be obtained, it throws an exception.
     *
     * @param int $courseid Course id
     * @return \core\lock\lock Lock (must be released!)
     * @throws moodle_exception If the lock cannot be obtained
     */
    protected static function get_course_cache_lock($courseid) {
        // Get database lock to ensure this doesn't happen multiple times in parallel. Wait a
        // reasonable time for the lock to be released, so we can give a suitable error message.
        // In case the system crashes while building the course cache, the lock will automatically
        // expire after a (slightly longer) period.
        $lockfactory = \core\lock\lock_config::get_lock_factory('core_modinfo');
        $lock = $lockfactory->get_lock('build_course_cache_' . $courseid,
                self::COURSE_CACHE_LOCK_WAIT, self::COURSE_CACHE_LOCK_EXPIRY);
        if (!$lock) {
            throw new moodle_exception('locktimeout', '', '', null,
                    'core_modinfo/build_course_cache_' . $courseid);
        }
        return $lock;
    }

    /**
     * Builds and stores in MUC object containing information about course
     * modules and sections together with cached fields from table course.
     *
     * @param stdClass $course object from DB table course. Must have property 'id'
     *     but preferably should have all cached fields.
     * @return stdClass object with all cached keys of the course plus fields modinfo and sectioncache.
     *     The same object is stored in MUC
     * @throws moodle_exception if course is not found (if $course object misses some of the
     *     necessary fields it is re-requested from database)
     */
    public static function build_course_cache($course) {
        if (empty($course->id)) {
            throw new coding_exception('Object $course is missing required property \id\'');
        }

        $lock = self::get_course_cache_lock($course->id);
        try {
            return self::inner_build_course_cache($course, $lock);
        } finally {
            $lock->release();
        }
    }

    /**
     * Called to build course cache when there is already a lock obtained.
     *
     * @param stdClass $course object from DB table course
     * @param \core\lock\lock $lock Lock object - not actually used, just there to indicate you have a lock
     * @return stdClass Course object that has been stored in MUC
     */
    protected static function inner_build_course_cache($course, \core\lock\lock $lock) {
        global $DB, $CFG;
        require_once("{$CFG->dirroot}/course/lib.php");

        // Ensure object has all necessary fields.
        foreach (self::$cachedfields as $key) {
            if (!isset($course->$key)) {
                $course = $DB->get_record('course', array('id' => $course->id),
                        implode(',', array_merge(array('id'), self::$cachedfields)), MUST_EXIST);
                break;
            }
        }
        // Retrieve all information about activities and sections.
        // This may take time on large courses and it is possible that another user modifies the same course during this process.
        // Field cacherev stored in both DB and cache will ensure that cached data matches the current course state.
        $coursemodinfo = new stdClass();
< $coursemodinfo->modinfo = get_array_of_activities($course->id);
> $coursemodinfo->modinfo = self::get_array_of_activities($course);
$coursemodinfo->sectioncache = self::build_course_section_cache($course); foreach (self::$cachedfields as $key) { $coursemodinfo->$key = $course->$key; } // Set the accumulated activities and sections information in cache, together with cacherev. $cachecoursemodinfo = cache::make('core', 'coursemodinfo'); $cachecoursemodinfo->set($course->id, $coursemodinfo); return $coursemodinfo; }
> } > /** > * For a given course, returns an array of course activity objects > * /** > * @param stdClass $course Course object * Data about a single module on a course. This contains most of the fields in the course_modules > * @return array list of activities * table, plus additional data when required. > */ * > public static function get_array_of_activities(stdClass $course): array { * The object can be accessed by core or any plugin (i.e. course format, block, filter, etc.) as > global $CFG, $DB; * get_fast_modinfo($courseorid)->cms[$coursemoduleid] > * or > if (empty($course)) { * get_fast_modinfo($courseorid)->instances[$moduletype][$instanceid] > throw new moodle_exception('courseidnotfound'); * > } * There are three stages when activity module can add/modify data in this object: > * > $mod = []; * <b>Stage 1 - during building the cache.</b> > * Allows to add to the course cache static user-independent information about the module. > $rawmods = get_course_mods($course->id); * Modules should try to include only absolutely necessary information that may be required > if (empty($rawmods)) { * when displaying course view page. The information is stored in application-level cache > return $mod; // always return array * and reset when {@link rebuild_course_cache()} is called or cache is purged by admin. > } * > $courseformat = course_get_format($course); * Modules can implement callback XXX_get_coursemodule_info() returning instance of object > * {@link cached_cm_info} > if ($sections = $DB->get_records('course_sections', ['course' => $course->id], * > 'section ASC', 'id,section,sequence,visible')) { * <b>Stage 2 - dynamic data.</b> > // First check and correct obvious mismatches between course_sections.sequence and course_modules.section. * Dynamic data is user-dependend, it is stored in request-level cache. To reset this cache > if ($errormessages = course_integrity_check($course->id, $rawmods, $sections)) { * {@link get_fast_modinfo()} with $reset argument may be called. > debugging(join('<br>', $errormessages)); * > $rawmods = get_course_mods($course->id); * Dynamic data is obtained when any of the following properties/methods is requested: > $sections = $DB->get_records('course_sections', ['course' => $course->id], * - {@link cm_info::$url} > 'section ASC', 'id,section,sequence,visible'); * - {@link cm_info::$name} > } * - {@link cm_info::$onclick} > // Build array of activities. * - {@link cm_info::get_icon_url()} > foreach ($sections as $section) { * - {@link cm_info::$uservisible} > if (!empty($section->sequence)) { * - {@link cm_info::$available} > $sequence = explode(",", $section->sequence); * - {@link cm_info::$availableinfo} > foreach ($sequence as $seq) { * - plus any of the properties listed in Stage 3. > if (empty($rawmods[$seq])) { * > continue; * Modules can implement callback <b>XXX_cm_info_dynamic()</b> and inside this callback they > } * are allowed to use any of the following set methods: > // Adjust visibleoncoursepage, value in DB may not respect format availability. * - {@link cm_info::set_available()} > $rawmods[$seq]->visibleoncoursepage = (!$rawmods[$seq]->visible * - {@link cm_info::set_name()} > || $rawmods[$seq]->visibleoncoursepage * - {@link cm_info::set_no_view_link()} > || empty($CFG->allowstealth) * - {@link cm_info::set_user_visible()} > || !$courseformat->allow_stealth_module_visibility($rawmods[$seq], $section)) ? 1 : 0; * - {@link cm_info::set_on_click()} > * - {@link cm_info::set_icon_url()} > // Create an object that will be cached. * Any methods affecting view elements can also be set in this callback. > $mod[$seq] = new stdClass(); * > $mod[$seq]->id = $rawmods[$seq]->instance; * <b>Stage 3 (view data).</b> > $mod[$seq]->cm = $rawmods[$seq]->id; * Also user-dependend data stored in request-level cache. Second stage is created > $mod[$seq]->mod = $rawmods[$seq]->modname; * because populating the view data can be expensive as it may access much more > * Moodle APIs such as filters, user information, output renderers and we > // Oh dear. Inconsistent names left here for backward compatibility. * don't want to request it until necessary. > $mod[$seq]->section = $section->section; * View data is obtained when any of the following properties/methods is requested: > $mod[$seq]->sectionid = $rawmods[$seq]->section; * - {@link cm_info::$afterediticons} > * - {@link cm_info::$content} > $mod[$seq]->module = $rawmods[$seq]->module; * - {@link cm_info::get_formatted_content()} > $mod[$seq]->added = $rawmods[$seq]->added; * - {@link cm_info::$extraclasses} > $mod[$seq]->score = $rawmods[$seq]->score; * - {@link cm_info::$afterlink} > $mod[$seq]->idnumber = $rawmods[$seq]->idnumber; * > $mod[$seq]->visible = $rawmods[$seq]->visible; * Modules can implement callback <b>XXX_cm_info_view()</b> and inside this callback they > $mod[$seq]->visibleoncoursepage = $rawmods[$seq]->visibleoncoursepage; * are allowed to use any of the following set methods: > $mod[$seq]->visibleold = $rawmods[$seq]->visibleold; * - {@link cm_info::set_after_edit_icons()} > $mod[$seq]->groupmode = $rawmods[$seq]->groupmode; * - {@link cm_info::set_after_link()} > $mod[$seq]->groupingid = $rawmods[$seq]->groupingid; * - {@link cm_info::set_content()} > $mod[$seq]->indent = $rawmods[$seq]->indent; * - {@link cm_info::set_extra_classes()} > $mod[$seq]->completion = $rawmods[$seq]->completion; * > $mod[$seq]->extra = ""; * @property-read int $id Course-module ID - from course_modules table > $mod[$seq]->completiongradeitemnumber = * @property-read int $instance Module instance (ID within module table) - from course_modules table > $rawmods[$seq]->completiongradeitemnumber; * @property-read int $course Course ID - from course_modules table > $mod[$seq]->completionview = $rawmods[$seq]->completionview; * @property-read string $idnumber 'ID number' from course-modules table (arbitrary text set by user) - from > $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected; * course_modules table > $mod[$seq]->showdescription = $rawmods[$seq]->showdescription; * @property-read int $added Time that this course-module was added (unix time) - from course_modules table > $mod[$seq]->availability = $rawmods[$seq]->availability; * @property-read int $visible Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from > $mod[$seq]->deletioninprogress = $rawmods[$seq]->deletioninprogress; * course_modules table > * @property-read int $visibleoncoursepage Visible on course page setting - from course_modules table, adjusted to > $modname = $mod[$seq]->mod; * whether course format allows this module to have the "stealth" mode > $functionname = $modname . "_get_coursemodule_info"; * @property-read int $visibleold Old visible setting (if the entire section is hidden, the previous value for > * visible is stored in this field) - from course_modules table > if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) { * @property-read int $groupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from > continue; * course_modules table. Use {@link cm_info::$effectivegroupmode} to find the actual group mode that may be forced by course. > } * @property-read int $groupingid Grouping ID (0 = all groupings) > * @property-read bool $coursegroupmodeforce Indicates whether the course containing the module has forced the groupmode > include_once("$CFG->dirroot/mod/$modname/lib.php"); * This means that cm_info::$groupmode should be ignored and cm_info::$coursegroupmode be used instead > * @property-read int $coursegroupmode Group mode (one of the constants NOGROUPS, SEPARATEGROUPS, or VISIBLEGROUPS) - from > if ($hasfunction = function_exists($functionname)) { * course table - as specified for the course containing the module > if ($info = $functionname($rawmods[$seq])) { * Effective only if {@link cm_info::$coursegroupmodeforce} is set > if (!empty($info->icon)) { * @property-read int $effectivegroupmode Effective group mode for this module (one of the constants NOGROUPS, SEPARATEGROUPS, > $mod[$seq]->icon = $info->icon; * or VISIBLEGROUPS). This can be different from groupmode set for the module if the groupmode is forced for the course. > } * This value will always be NOGROUPS if module type does not support group mode. > if (!empty($info->iconcomponent)) { * @property-read int $indent Indent level on course page (0 = no indent) - from course_modules table > $mod[$seq]->iconcomponent = $info->iconcomponent; * @property-read int $completion Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from > } * course_modules table > if (!empty($info->name)) { * @property-read mixed $completiongradeitemnumber Set to the item number (usually 0) if completion depends on a particular > $mod[$seq]->name = $info->name; * grade of this activity, or null if completion does not depend on a grade - from course_modules table > } * @property-read int $completionview 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table > if ($info instanceof cached_cm_info) { * @property-read int $completionexpected Set to a unix time if completion of this activity is expected at a > // When using cached_cm_info you can include three new fields * particular time, 0 if no time set - from course_modules table > // that aren't available for legacy code * @property-read string $availability Availability information as JSON string or null if none - > if (!empty($info->content)) { * from course_modules table > $mod[$seq]->content = $info->content; * @property-read int $showdescription Controls whether the description of the activity displays on the course main page (in > } * addition to anywhere it might display within the activity itself). 0 = do not show > if (!empty($info->extraclasses)) { * on main page, 1 = show on main page. > $mod[$seq]->extraclasses = $info->extraclasses; * @property-read string $extra (deprecated) Extra HTML that is put in an unhelpful part of the HTML when displaying this module in > } * course page - from cached data in modinfo field. Deprecated, replaced by ->extraclasses and ->onclick > if (!empty($info->iconurl)) { * @property-read string $icon Name of icon to use - from cached data in modinfo field > // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB. * @property-read string $iconcomponent Component that contains icon - from cached data in modinfo field > $url = new moodle_url($info->iconurl); * @property-read string $modname Name of module e.g. 'forum' (this is the same name as the module's main database > $mod[$seq]->iconurl = $url->out(false); * table) - from cached data in modinfo field > } * @property-read int $module ID of module type - from course_modules table > if (!empty($info->onclick)) { * @property-read string $name Name of module instance for display on page e.g. 'General discussion forum' - from cached > $mod[$seq]->onclick = $info->onclick; * data in modinfo field > } * @property-read int $sectionnum Section number that this course-module is in (section 0 = above the calendar, section 1 > if (!empty($info->customdata)) { * = week/topic 1, etc) - from cached data in modinfo field > $mod[$seq]->customdata = $info->customdata; * @property-read int $section Section id - from course_modules table > } * @property-read array $conditionscompletion Availability conditions for this course-module based on the completion of other > } else { * course-modules (array from other course-module id to required completion state for that > // When using a stdclass, the (horrible) deprecated ->extra field * module) - from cached data in modinfo field > // is available for BC * @property-read array $conditionsgrade Availability conditions for this course-module based on course grades (array from > if (!empty($info->extra)) { * grade item id to object with ->min, ->max fields) - from cached data in modinfo field > $mod[$seq]->extra = $info->extra; * @property-read array $conditionsfield Availability conditions for this course-module based on user fields > } * @property-read bool $available True if this course-module is available to students i.e. if all availability conditions > } * are met - obtained dynamically > } * @property-read string $availableinfo If course-module is not available to students, this string gives information about > } * availability which can be displayed to students and/or staff (e.g. 'Available from 3 > // When there is no modname_get_coursemodule_info function, * January 2010') for display on main page - obtained dynamically > // but showdescriptions is enabled, then we use the 'intro' * @property-read bool $uservisible True if this course-module is available to the CURRENT user (for example, if current user > // and 'introformat' fields in the module table * has viewhiddenactivities capability, they can access the course-module even if it is not > if (!$hasfunction && $rawmods[$seq]->showdescription) { * visible or not available, so this would be true in that case) > if ($modvalues = $DB->get_record($rawmods[$seq]->modname, * @property-read context_module $context Module context > ['id' => $rawmods[$seq]->instance], 'name, intro, introformat')) { * @property-read string $modfullname Returns a localised human-readable name of the module type - calculated on request > // Set content from intro and introformat. Filters are disabled * @property-read string $modplural Returns a localised human-readable name of the module type in plural form - calculated on request > // because we filter it with format_text at display time * @property-read string $content Content to display on main (view) page - calculated on request > $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname, * @property-read moodle_url $url URL to link to for this module, or null if it doesn't have a view page - calculated on request > $modvalues, $rawmods[$seq]->id, false); * @property-read string $extraclasses Extra CSS classes to add to html output for this activity on main page - calculated on request > * @property-read string $onclick Content of HTML on-click attribute already escaped - calculated on request > // To save making another query just below, put name in here * @property-read mixed $customdata Optional custom data stored in modinfo cache for this activity, or null if none > $mod[$seq]->name = $modvalues->name; * @property-read string $afterlink Extra HTML code to display after link - calculated on request > } * @property-read string $afterediticons Extra HTML code to display after editing icons (e.g. more icons) - calculated on request > } * @property-read bool $deletioninprogress True if this course module is scheduled for deletion, false otherwise. > if (!isset($mod[$seq]->name)) { */ > $mod[$seq]->name = class cm_info implements IteratorAggregate { > $DB->get_field($rawmods[$seq]->modname, "name", ["id" => $rawmods[$seq]->instance]); /** > } * State: Only basic data from modinfo cache is available. > */ > // Minimise the database size by unsetting default options when they are const STATE_BASIC = 0; > // 'empty'. This list corresponds to code in the cm_info constructor. > foreach (['idnumber', 'groupmode', 'groupingid', /** > 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content', * State: In the process of building dynamic data (to avoid recursive calls to obtain_dynamic_data()) > 'icon', 'iconcomponent', 'customdata', 'availability', 'completionview', */ > 'completionexpected', 'score', 'showdescription', 'deletioninprogress'] as $property) { const STATE_BUILDING_DYNAMIC = 1; > if (property_exists($mod[$seq], $property) && > empty($mod[$seq]->{$property})) { /** > unset($mod[$seq]->{$property}); * State: Dynamic data is available too. > } */ > } const STATE_DYNAMIC = 2; > // Special case: this value is usually set to null, but may be 0 > if (property_exists($mod[$seq], 'completiongradeitemnumber') && /** > is_null($mod[$seq]->completiongradeitemnumber)) { * State: In the process of building view data (to avoid recursive calls to obtain_view_data()) > unset($mod[$seq]->completiongradeitemnumber); */ > } const STATE_BUILDING_VIEW = 3; > } > } /** > } * State: View data (for course page) is available. > } */ > return $mod; const STATE_VIEW = 4; > } > /** > /** * Parent object > * Purge the cache of a given course * @var course_modinfo > * */ > * @param int $courseid Course id private $modinfo; > */ > public static function purge_course_cache(int $courseid): void { /** > $cachemodinfo = cache::make('core', 'coursemodinfo'); * Level of information stored inside this object (STATE_xx constant) > $cachemodinfo->delete($courseid); * @var int > }
< * Dynamic data is user-dependend, it is stored in request-level cache. To reset this cache
> * Dynamic data is user-dependent, it is stored in request-level cache. To reset this cache
private $state;
> * - {@link cm_info::override_customdata()}
/** * Course-module ID - from course_modules table * @var int */ private $id; /** * Module instance (ID within module table) - from course_modules table * @var int */ private $instance; /** * 'ID number' from course-modules table (arbitrary text set by user) - from * course_modules table * @var string */ private $idnumber; /** * Time that this course-module was added (unix time) - from course_modules table * @var int */ private $added; /** * This variable is not used and is included here only so it can be documented. * Once the database entry is removed from course_modules, it should be deleted * here too. * @var int * @deprecated Do not use this variable */ private $score; /** * Visible setting (0 or 1; if this is 0, students cannot see/access the activity) - from * course_modules table * @var int */ private $visible; /** * Visible on course page setting - from course_modules table * @var int */ private $visibleoncoursepage; /** * Old visible setting (if the entire section is hidden, the previous value for * visible is stored in this field) - from course_modules table * @var int */ private $visibleold; /** * Group mode (one of the constants NONE, SEPARATEGROUPS, or VISIBLEGROUPS) - from * course_modules table * @var int */ private $groupmode; /** * Grouping ID (0 = all groupings) * @var int */ private $groupingid; /** * Indent level on course page (0 = no indent) - from course_modules table * @var int */ private $indent; /** * Activity completion setting for this activity, COMPLETION_TRACKING_xx constant - from * course_modules table * @var int */ private $completion; /** * Set to the item number (usually 0) if completion depends on a particular * grade of this activity, or null if completion does not depend on a grade - from * course_modules table * @var mixed */ private $completiongradeitemnumber; /** * 1 if 'on view' completion is enabled, 0 otherwise - from course_modules table * @var int */ private $completionview; /** * Set to a unix time if completion of this activity is expected at a * particular time, 0 if no time set - from course_modules table * @var int */ private $completionexpected; /** * Availability information as JSON string or null if none - from course_modules table * @var string */ private $availability; /** * Controls whether the description of the activity displays on the course main page (in * addition to anywhere it might display within the activity itself). 0 = do not show * on main page, 1 = show on main page. * @var int */ private $showdescription; /** * Extra HTML that is put in an unhelpful part of the HTML when displaying this module in * course page - from cached data in modinfo field * @deprecated This is crazy, don't use it. Replaced by ->extraclasses and ->onclick * @var string */ private $extra; /** * Name of icon to use - from cached data in modinfo field * @var string */ private $icon; /** * Component that contains icon - from cached data in modinfo field * @var string */ private $iconcomponent; /** * Name of module e.g. 'forum' (this is the same name as the module's main database * table) - from cached data in modinfo field * @var string */ private $modname; /** * ID of module - from course_modules table * @var int */ private $module; /** * Name of module instance for display on page e.g. 'General discussion forum' - from cached * data in modinfo field * @var string */ private $name; /** * Section number that this course-module is in (section 0 = above the calendar, section 1 * = week/topic 1, etc) - from cached data in modinfo field * @var int */ private $sectionnum; /** * Section id - from course_modules table * @var int */ private $section; /** * Availability conditions for this course-module based on the completion of other * course-modules (array from other course-module id to required completion state for that * module) - from cached data in modinfo field * @var array */ private $conditionscompletion; /** * Availability conditions for this course-module based on course grades (array from * grade item id to object with ->min, ->max fields) - from cached data in modinfo field * @var array */ private $conditionsgrade; /** * Availability conditions for this course-module based on user fields * @var array */ private $conditionsfield; /** * True if this course-module is available to students i.e. if all availability conditions * are met - obtained dynamically * @var bool */ private $available; /** * If course-module is not available to students, this string gives information about * availability which can be displayed to students and/or staff (e.g. 'Available from 3 * January 2010') for display on main page - obtained dynamically * @var string */ private $availableinfo; /** * True if this course-module is available to the CURRENT user (for example, if current user * has viewhiddenactivities capability, they can access the course-module even if it is not * visible or not available, so this would be true in that case) * @var bool */ private $uservisible; /** * True if this course-module is visible to the CURRENT user on the course page * @var bool */ private $uservisibleoncoursepage; /** * @var moodle_url */ private $url; /** * @var string */ private $content; /** * @var bool */ private $contentisformatted; /** * @var string */ private $extraclasses; /** * @var moodle_url full external url pointing to icon image for activity */ private $iconurl; /** * @var string */ private $onclick; /** * @var mixed */ private $customdata; /** * @var string */ private $afterlink; /** * @var string */ private $afterediticons; /** * @var bool representing the deletion state of the module. True if the mod is scheduled for deletion. */ private $deletioninprogress; /** * List of class read-only properties and their getter methods. * Used by magic functions __get(), __isset(), __empty() * @var array */ private static $standardproperties = array( 'url' => 'get_url', 'content' => 'get_content', 'extraclasses' => 'get_extra_classes', 'onclick' => 'get_on_click', 'customdata' => 'get_custom_data', 'afterlink' => 'get_after_link', 'afterediticons' => 'get_after_edit_icons', 'modfullname' => 'get_module_type_name', 'modplural' => 'get_module_type_name_plural', 'id' => false, 'added' => false, 'availability' => false, 'available' => 'get_available', 'availableinfo' => 'get_available_info', 'completion' => false, 'completionexpected' => false, 'completiongradeitemnumber' => false, 'completionview' => false, 'conditionscompletion' => false, 'conditionsfield' => false, 'conditionsgrade' => false, 'context' => 'get_context', 'course' => 'get_course_id', 'coursegroupmode' => 'get_course_groupmode', 'coursegroupmodeforce' => 'get_course_groupmodeforce', 'effectivegroupmode' => 'get_effective_groupmode', 'extra' => false, 'groupingid' => false, 'groupmembersonly' => 'get_deprecated_group_members_only', 'groupmode' => false, 'icon' => false, 'iconcomponent' => false, 'idnumber' => false, 'indent' => false, 'instance' => false, 'modname' => false, 'module' => false, 'name' => 'get_name', 'score' => false, 'section' => false, 'sectionnum' => false, 'showdescription' => false, 'uservisible' => 'get_user_visible', 'visible' => false, 'visibleoncoursepage' => false, 'visibleold' => false, 'deletioninprogress' => false ); /** * List of methods with no arguments that were public prior to Moodle 2.6. * * They can still be accessed publicly via magic __call() function with no warnings * but are not listed in the class methods list. * For the consistency of the code it is better to use corresponding properties. * * These methods be deprecated completely in later versions. * * @var array $standardmethods */ private static $standardmethods = array( // Following methods are not recommended to use because there have associated read-only properties. 'get_url', 'get_content', 'get_extra_classes', 'get_on_click', 'get_custom_data', 'get_after_link', 'get_after_edit_icons', // Method obtain_dynamic_data() should not be called from outside of this class but it was public before Moodle 2.6. 'obtain_dynamic_data', ); /** * Magic method to call functions that are now declared as private but were public in Moodle before 2.6. * These private methods can not be used anymore. * * @param string $name * @param array $arguments * @return mixed * @throws coding_exception */ public function __call($name, $arguments) { if (in_array($name, self::$standardmethods)) { $message = "cm_info::$name() can not be used anymore."; if ($alternative = array_search($name, self::$standardproperties)) { $message .= " Please use the property cm_info->$alternative instead."; } throw new coding_exception($message); } throw new coding_exception("Method cm_info::{$name}() does not exist"); } /** * Magic method getter * * @param string $name * @return mixed */ public function __get($name) { if (isset(self::$standardproperties[$name])) { if ($method = self::$standardproperties[$name]) { return $this->$method(); } else { return $this->$name; } } else { debugging('Invalid cm_info property accessed: '.$name); return null; } } /** * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties * and use {@link convert_to_array()} * * @return ArrayIterator */ public function getIterator() { // Make sure dynamic properties are retrieved prior to view properties. $this->obtain_dynamic_data(); $ret = array(); // Do not iterate over deprecated properties. $props = self::$standardproperties; unset($props['groupmembersonly']); foreach ($props as $key => $unused) { $ret[$key] = $this->__get($key); } return new ArrayIterator($ret); } /** * Magic method for function isset() * * @param string $name * @return bool */ public function __isset($name) { if (isset(self::$standardproperties[$name])) { $value = $this->__get($name); return isset($value); } return false; } /** * Magic method for function empty() * * @param string $name * @return bool */ public function __empty($name) { if (isset(self::$standardproperties[$name])) { $value = $this->__get($name); return empty($value); } return true; } /** * Magic method setter * * Will display the developer warning when trying to set/overwrite property. * * @param string $name * @param mixed $value */ public function __set($name, $value) { debugging("It is not allowed to set the property cm_info::\${$name}", DEBUG_DEVELOPER); } /** * @return bool True if this module has a 'view' page that should be linked to in navigation * etc (note: modules may still have a view.php file, but return false if this is not * intended to be linked to from 'normal' parts of the interface; this is what label does). */ public function has_view() { return !is_null($this->url); } /** * Gets the URL to link to for this module. * * This method is normally called by the property ->url, but can be called directly if * there is a case when it might be called recursively (you can't call property values * recursively). * * @return moodle_url URL to link to for this module, or null if it doesn't have a view page */ public function get_url() { $this->obtain_dynamic_data(); return $this->url; } /** * Obtains content to display on main (view) page. * Note: Will collect view data, if not already obtained. * @return string Content to display on main page below link, or empty string if none */ private function get_content() { $this->obtain_view_data(); return $this->content; } /** * Returns the content to display on course/overview page, formatted and passed through filters * * if $options['context'] is not specified, the module context is used * * @param array|stdClass $options formatting options, see {@link format_text()} * @return string */ public function get_formatted_content($options = array()) { $this->obtain_view_data(); if (empty($this->content)) { return ''; } if ($this->contentisformatted) { return $this->content; } // Improve filter performance by preloading filter setttings for all // activities on the course (this does nothing if called multiple // times) filter_preload_activities($this->get_modinfo()); $options = (array)$options; if (!isset($options['context'])) { $options['context'] = $this->get_context(); } return format_text($this->content, FORMAT_HTML, $options); } /** * Getter method for property $name, ensures that dynamic data is obtained. * * This method is normally called by the property ->name, but can be called directly if there * is a case when it might be called recursively (you can't call property values recursively). * * @return string */ public function get_name() { $this->obtain_dynamic_data(); return $this->name; } /** * Returns the name to display on course/overview page, formatted and passed through filters * * if $options['context'] is not specified, the module context is used * * @param array|stdClass $options formatting options, see {@link format_string()} * @return string */ public function get_formatted_name($options = array()) { global $CFG; $options = (array)$options; if (!isset($options['context'])) { $options['context'] = $this->get_context(); } // Improve filter performance by preloading filter setttings for all // activities on the course (this does nothing if called multiple // times). if (!empty($CFG->filterall)) { filter_preload_activities($this->get_modinfo()); } return format_string($this->get_name(), true, $options); } /** * Note: Will collect view data, if not already obtained. * @return string Extra CSS classes to add to html output for this activity on main page */ private function get_extra_classes() { $this->obtain_view_data(); return $this->extraclasses; } /** * @return string Content of HTML on-click attribute. This string will be used literally * as a string so should be pre-escaped. */ private function get_on_click() { // Does not need view data; may be used by navigation $this->obtain_dynamic_data(); return $this->onclick; } /**
> * Getter method for property $customdata, ensures that dynamic data is retrieved. * @return mixed Optional custom data stored in modinfo cache for this activity, or null if none > * */ > * This method is normally called by the property ->customdata, but can be called directly if there private function get_custom_data() { > * is a case when it might be called recursively (you can't call property values recursively). return $this->customdata; > *
< private function get_custom_data() {
> public function get_custom_data() { > $this->obtain_dynamic_data();
/** * Note: Will collect view data, if not already obtained. * @return string Extra HTML code to display after link */ private function get_after_link() { $this->obtain_view_data(); return $this->afterlink; } /** * Note: Will collect view data, if not already obtained. * @return string Extra HTML code to display after editing icons (e.g. more icons) */ private function get_after_edit_icons() { $this->obtain_view_data(); return $this->afterediticons; } /** * @param moodle_core_renderer $output Output render to use, or null for default (global) * @return moodle_url Icon URL for a suitable icon to put beside this cm */ public function get_icon_url($output = null) { global $OUTPUT; $this->obtain_dynamic_data(); if (!$output) { $output = $OUTPUT; } // Support modules setting their own, external, icon image if (!empty($this->iconurl)) { $icon = $this->iconurl; // Fallback to normal local icon + component procesing } else if (!empty($this->icon)) { if (substr($this->icon, 0, 4) === 'mod/') { list($modname, $iconname) = explode('/', substr($this->icon, 4), 2); $icon = $output->image_url($iconname, $modname); } else { if (!empty($this->iconcomponent)) { // Icon has specified component $icon = $output->image_url($this->icon, $this->iconcomponent); } else { // Icon does not have specified component, use default $icon = $output->image_url($this->icon); } } } else { $icon = $output->image_url('icon', $this->modname); } return $icon; } /** * @param string $textclasses additionnal classes for grouping label * @return string An empty string or HTML grouping label span tag */ public function get_grouping_label($textclasses = '') { $groupinglabel = ''; if ($this->effectivegroupmode != NOGROUPS && !empty($this->groupingid) && has_capability('moodle/course:managegroups', context_course::instance($this->course))) { $groupings = groups_get_all_groupings($this->course); $groupinglabel = html_writer::tag('span', '('.format_string($groupings[$this->groupingid]->name).')', array('class' => 'groupinglabel '.$textclasses)); } return $groupinglabel; } /**
< * Returns a localised human-readable name of the module type
> * Returns a localised human-readable name of the module type.
*
< * @param bool $plural return plural form < * @return string
> * @param bool $plural If true, the function returns the plural form of the name. > * @return lang_string
*/ public function get_module_type_name($plural = false) { $modnames = get_module_types_names($plural); if (isset($modnames[$this->modname])) { return $modnames[$this->modname]; } else { return null; } } /** * Returns a localised human-readable name of the module type in plural form - calculated on request * * @return string */ private function get_module_type_name_plural() { return $this->get_module_type_name(true); } /** * @return course_modinfo Modinfo object that this came from */ public function get_modinfo() { return $this->modinfo; } /** * Returns the section this module belongs to * * @return section_info */ public function get_section_info() { return $this->modinfo->get_section_info($this->sectionnum); } /** * Returns course object that was used in the first {@link get_fast_modinfo()} call. * * It may not contain all fields from DB table {course} but always has at least the following: * id,shortname,fullname,format,enablecompletion,groupmode,groupmodeforce,cacherev * * If the course object lacks the field you need you can use the global * function {@link get_course()} that will save extra query if you access * current course or frontpage course. * * @return stdClass */ public function get_course() { return $this->modinfo->get_course(); } /** * Returns course id for which the modinfo was generated. * * @return int */ private function get_course_id() { return $this->modinfo->get_course_id(); } /** * Returns group mode used for the course containing the module * * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS */ private function get_course_groupmode() { return $this->modinfo->get_course()->groupmode; } /** * Returns whether group mode is forced for the course containing the module * * @return bool */ private function get_course_groupmodeforce() { return $this->modinfo->get_course()->groupmodeforce; } /** * Returns effective groupmode of the module that may be overwritten by forced course groupmode. * * @return int one of constants NOGROUPS, SEPARATEGROUPS, VISIBLEGROUPS */ private function get_effective_groupmode() { $groupmode = $this->groupmode; if ($this->modinfo->get_course()->groupmodeforce) { $groupmode = $this->modinfo->get_course()->groupmode; if ($groupmode != NOGROUPS && !plugin_supports('mod', $this->modname, FEATURE_GROUPS, false)) { $groupmode = NOGROUPS; } } return $groupmode; } /** * @return context_module Current module context */ private function get_context() { return context_module::instance($this->id); } /** * Returns itself in the form of stdClass. * * The object includes all fields that table course_modules has and additionally * fields 'name', 'modname', 'sectionnum' (if requested). * * This can be used as a faster alternative to {@link get_coursemodule_from_id()} * * @param bool $additionalfields include additional fields 'name', 'modname', 'sectionnum' * @return stdClass */ public function get_course_module_record($additionalfields = false) { $cmrecord = new stdClass(); // Standard fields from table course_modules. static $cmfields = array('id', 'course', 'module', 'instance', 'section', 'idnumber', 'added', 'score', 'indent', 'visible', 'visibleoncoursepage', 'visibleold', 'groupmode', 'groupingid', 'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected', 'showdescription', 'availability', 'deletioninprogress'); foreach ($cmfields as $key) { $cmrecord->$key = $this->$key; } // Additional fields that function get_coursemodule_from_id() adds. if ($additionalfields) { $cmrecord->name = $this->name; $cmrecord->modname = $this->modname; $cmrecord->sectionnum = $this->sectionnum; } return $cmrecord; } // Set functions //////////////// /** * Sets content to display on course view page below link (if present). * @param string $content New content as HTML string (empty string if none) * @param bool $isformatted Whether user content is already passed through format_text/format_string and should not * be formatted again. This can be useful when module adds interactive elements on top of formatted user text. * @return void */ public function set_content($content, $isformatted = false) { $this->content = $content; $this->contentisformatted = $isformatted; } /** * Sets extra classes to include in CSS. * @param string $extraclasses Extra classes (empty string if none) * @return void */ public function set_extra_classes($extraclasses) { $this->extraclasses = $extraclasses; } /** * Sets the external full url that points to the icon being used * by the activity. Useful for external-tool modules (lti...) * If set, takes precedence over $icon and $iconcomponent * * @param moodle_url $iconurl full external url pointing to icon image for activity * @return void */ public function set_icon_url(moodle_url $iconurl) { $this->iconurl = $iconurl; } /** * Sets value of on-click attribute for JavaScript. * Note: May not be called from _cm_info_view (only _cm_info_dynamic). * @param string $onclick New onclick attribute which should be HTML-escaped * (empty string if none) * @return void */ public function set_on_click($onclick) { $this->check_not_view_only(); $this->onclick = $onclick; } /**
> * Overrides the value of an element in the customdata array. * Sets HTML that displays after link on course view page. > * * @param string $afterlink HTML string (empty string if none) > * @param string $name The key in the customdata array * @return void > * @param mixed $value The value */ > */ public function set_after_link($afterlink) { > public function override_customdata($name, $value) { $this->afterlink = $afterlink; > if (!is_array($this->customdata)) { } > $this->customdata = []; > } /** > $this->customdata[$name] = $value; * Sets HTML that displays after edit icons on course view page. > } * @param string $afterediticons HTML string (empty string if none) > * @return void > /**
*/ public function set_after_edit_icons($afterediticons) { $this->afterediticons = $afterediticons; } /** * Changes the name (text of link) for this module instance. * Note: May not be called from _cm_info_view (only _cm_info_dynamic). * @param string $name Name of activity / link text * @return void */ public function set_name($name) { if ($this->state < self::STATE_BUILDING_DYNAMIC) { $this->update_user_visible(); } $this->name = $name; } /** * Turns off the view link for this module instance. * Note: May not be called from _cm_info_view (only _cm_info_dynamic). * @return void */ public function set_no_view_link() { $this->check_not_view_only(); $this->url = null; } /** * Sets the 'uservisible' flag. This can be used (by setting false) to prevent access and * display of this module link for the current user. * Note: May not be called from _cm_info_view (only _cm_info_dynamic). * @param bool $uservisible * @return void */ public function set_user_visible($uservisible) { $this->check_not_view_only(); $this->uservisible = $uservisible; } /** * Sets the 'available' flag and related details. This flag is normally used to make * course modules unavailable until a certain date or condition is met. (When a course * module is unavailable, it is still visible to users who have viewhiddenactivities * permission.) * * When this is function is called, user-visible status is recalculated automatically. * * The $showavailability flag does not really do anything any more, but is retained * for backward compatibility. Setting this to false will cause $availableinfo to * be ignored. * * Note: May not be called from _cm_info_view (only _cm_info_dynamic). * @param bool $available False if this item is not 'available' * @param int $showavailability 0 = do not show this item at all if it's not available, * 1 = show this item greyed out with the following message * @param string $availableinfo Information about why this is not available, or * empty string if not displaying * @return void */ public function set_available($available, $showavailability=0, $availableinfo='') { $this->check_not_view_only(); $this->available = $available; if (!$showavailability) { $availableinfo = ''; } $this->availableinfo = $availableinfo; $this->update_user_visible(); } /** * Some set functions can only be called from _cm_info_dynamic and not _cm_info_view. * This is because they may affect parts of this object which are used on pages other * than the view page (e.g. in the navigation block, or when checking access on * module pages). * @return void */ private function check_not_view_only() { if ($this->state >= self::STATE_DYNAMIC) { throw new coding_exception('Cannot set this data from _cm_info_view because it may ' . 'affect other pages as well as view'); } } /** * Constructor should not be called directly; use {@link get_fast_modinfo()} * * @param course_modinfo $modinfo Parent object * @param stdClass $notused1 Argument not used * @param stdClass $mod Module object from the modinfo field of course table * @param stdClass $notused2 Argument not used */ public function __construct(course_modinfo $modinfo, $notused1, $mod, $notused2) { $this->modinfo = $modinfo; $this->id = $mod->cm; $this->instance = $mod->id; $this->modname = $mod->mod; $this->idnumber = isset($mod->idnumber) ? $mod->idnumber : ''; $this->name = $mod->name; $this->visible = $mod->visible; $this->visibleoncoursepage = $mod->visibleoncoursepage; $this->sectionnum = $mod->section; // Note weirdness with name here $this->groupmode = isset($mod->groupmode) ? $mod->groupmode : 0; $this->groupingid = isset($mod->groupingid) ? $mod->groupingid : 0; $this->indent = isset($mod->indent) ? $mod->indent : 0; $this->extra = isset($mod->extra) ? $mod->extra : ''; $this->extraclasses = isset($mod->extraclasses) ? $mod->extraclasses : ''; // iconurl may be stored as either string or instance of moodle_url. $this->iconurl = isset($mod->iconurl) ? new moodle_url($mod->iconurl) : ''; $this->onclick = isset($mod->onclick) ? $mod->onclick : ''; $this->content = isset($mod->content) ? $mod->content : ''; $this->icon = isset($mod->icon) ? $mod->icon : ''; $this->iconcomponent = isset($mod->iconcomponent) ? $mod->iconcomponent : ''; $this->customdata = isset($mod->customdata) ? $mod->customdata : ''; $this->showdescription = isset($mod->showdescription) ? $mod->showdescription : 0; $this->state = self::STATE_BASIC; $this->section = isset($mod->sectionid) ? $mod->sectionid : 0; $this->module = isset($mod->module) ? $mod->module : 0; $this->added = isset($mod->added) ? $mod->added : 0; $this->score = isset($mod->score) ? $mod->score : 0; $this->visibleold = isset($mod->visibleold) ? $mod->visibleold : 0; $this->deletioninprogress = isset($mod->deletioninprogress) ? $mod->deletioninprogress : 0; // Note: it saves effort and database space to always include the // availability and completion fields, even if availability or completion // are actually disabled $this->completion = isset($mod->completion) ? $mod->completion : 0; $this->completiongradeitemnumber = isset($mod->completiongradeitemnumber) ? $mod->completiongradeitemnumber : null; $this->completionview = isset($mod->completionview) ? $mod->completionview : 0; $this->completionexpected = isset($mod->completionexpected) ? $mod->completionexpected : 0; $this->availability = isset($mod->availability) ? $mod->availability : null; $this->conditionscompletion = isset($mod->conditionscompletion) ? $mod->conditionscompletion : array(); $this->conditionsgrade = isset($mod->conditionsgrade) ? $mod->conditionsgrade : array(); $this->conditionsfield = isset($mod->conditionsfield) ? $mod->conditionsfield : array(); static $modviews = array(); if (!isset($modviews[$this->modname])) { $modviews[$this->modname] = !plugin_supports('mod', $this->modname, FEATURE_NO_VIEW_LINK); } $this->url = $modviews[$this->modname] ? new moodle_url('/mod/' . $this->modname . '/view.php', array('id'=>$this->id)) : null; } /** * Creates a cm_info object from a database record (also accepts cm_info * in which case it is just returned unchanged). * * @param stdClass|cm_info|null|bool $cm Stdclass or cm_info (or null or false) * @param int $userid Optional userid (default to current) * @return cm_info|null Object as cm_info, or null if input was null/false */ public static function create($cm, $userid = 0) { // Null, false, etc. gets passed through as null. if (!$cm) { return null; } // If it is already a cm_info object, just return it. if ($cm instanceof cm_info) { return $cm; } // Otherwise load modinfo. if (empty($cm->id) || empty($cm->course)) { throw new coding_exception('$cm must contain ->id and ->course'); } $modinfo = get_fast_modinfo($cm->course, $userid); return $modinfo->get_cm($cm->id); } /** * If dynamic data for this course-module is not yet available, gets it. * * This function is automatically called when requesting any course_modinfo property * that can be modified by modules (have a set_xxx method). * * Dynamic data is data which does not come directly from the cache but is calculated at * runtime based on the current user. Primarily this concerns whether the user can access * the module or not. * * As part of this function, the module's _cm_info_dynamic function from its lib.php will
< * be called (if it exists).
> * be called (if it exists). Make sure that the functions that are called here do not use > * any getter magic method from cm_info.
* @return void */ private function obtain_dynamic_data() { global $CFG; $userid = $this->modinfo->get_user_id(); if ($this->state >= self::STATE_BUILDING_DYNAMIC || $userid == -1) { return; } $this->state = self::STATE_BUILDING_DYNAMIC; if (!empty($CFG->enableavailability)) { // Get availability information. $ci = new \core_availability\info_module($this); // Note that the modinfo currently available only includes minimal details (basic data) // but we know that this function does not need anything more than basic data. $this->available = $ci->is_available($this->availableinfo, true, $userid, $this->modinfo); } else { $this->available = true; } // Check parent section. if ($this->available) { $parentsection = $this->modinfo->get_section_info($this->sectionnum);
< if (!$parentsection->available) {
> if (!$parentsection->get_available()) {
// Do not store info from section here, as that is already // presented from the section (if appropriate) - just change // the flag $this->available = false; } } // Update visible state for current user. $this->update_user_visible(); // Let module make dynamic changes at this point $this->call_mod_function('cm_info_dynamic'); $this->state = self::STATE_DYNAMIC; } /** * Getter method for property $uservisible, ensures that dynamic data is retrieved. * * This method is normally called by the property ->uservisible, but can be called directly if * there is a case when it might be called recursively (you can't call property values * recursively). * * @return bool */ public function get_user_visible() { $this->obtain_dynamic_data(); return $this->uservisible; } /** * Returns whether this module is visible to the current user on course page * * Activity may be visible on the course page but not available, for example * when it is hidden conditionally but the condition information is displayed. * * @return bool */ public function is_visible_on_course_page() { $this->obtain_dynamic_data(); return $this->uservisibleoncoursepage; } /** * Whether this module is available but hidden from course page * * "Stealth" modules are the ones that are not shown on course page but available by following url. * They are normally also displayed in grade reports and other reports. * Module will be stealth either if visibleoncoursepage=0 or it is a visible module inside the hidden * section. * * @return bool */ public function is_stealth() { return !$this->visibleoncoursepage || ($this->visible && ($section = $this->get_section_info()) && !$section->visible); } /** * Getter method for property $available, ensures that dynamic data is retrieved * @return bool */ private function get_available() { $this->obtain_dynamic_data(); return $this->available; } /** * This method can not be used anymore. * * @see \core_availability\info_module::filter_user_list() * @deprecated Since Moodle 2.8 */ private function get_deprecated_group_members_only() { throw new coding_exception('$cm->groupmembersonly can not be used anymore. ' . 'If used to restrict a list of enrolled users to only those who can ' . 'access the module, consider \core_availability\info_module::filter_user_list.'); } /** * Getter method for property $availableinfo, ensures that dynamic data is retrieved * * @return string Available info (HTML) */ private function get_available_info() { $this->obtain_dynamic_data(); return $this->availableinfo; } /** * Works out whether activity is available to the current user * * If the activity is unavailable, additional checks are required to determine if its hidden or greyed out * * @return void */ private function update_user_visible() { $userid = $this->modinfo->get_user_id(); if ($userid == -1) { return null; } $this->uservisible = true; // If the module is being deleted, set the uservisible state to false and return. if ($this->deletioninprogress) { $this->uservisible = false; return null; } // If the user cannot access the activity set the uservisible flag to false. // Additional checks are required to determine whether the activity is entirely hidden or just greyed out. if ((!$this->visible && !has_capability('moodle/course:viewhiddenactivities', $this->get_context(), $userid)) || (!$this->get_available() && !has_capability('moodle/course:ignoreavailabilityrestrictions', $this->get_context(), $userid))) { $this->uservisible = false; } // Check group membership. if ($this->is_user_access_restricted_by_capability()) { $this->uservisible = false; // Ensure activity is completely hidden from the user. $this->availableinfo = ''; } $this->uservisibleoncoursepage = $this->uservisible && ($this->visibleoncoursepage || has_capability('moodle/course:manageactivities', $this->get_context(), $userid) || has_capability('moodle/course:activityvisibility', $this->get_context(), $userid)); // Activity that is not available, not hidden from course page and has availability // info is actually visible on the course page (with availability info and without a link). if (!$this->uservisible && $this->visibleoncoursepage && $this->availableinfo) { $this->uservisibleoncoursepage = true; } } /** * This method has been deprecated and should not be used. * * @see $uservisible * @deprecated Since Moodle 2.8 */ public function is_user_access_restricted_by_group() { throw new coding_exception('cm_info::is_user_access_restricted_by_group() can not be used any more.' . ' Use $cm->uservisible to decide whether the current user can access an activity.'); } /** * Checks whether mod/...:view capability restricts the current user's access. * * @return bool True if the user access is restricted. */ public function is_user_access_restricted_by_capability() { $userid = $this->modinfo->get_user_id(); if ($userid == -1) { return null; } $capability = 'mod/' . $this->modname . ':view'; $capabilityinfo = get_capability_info($capability); if (!$capabilityinfo) { // Capability does not exist, no one is prevented from seeing the activity. return false; } // You are blocked if you don't have the capability. return !has_capability($capability, $this->get_context(), $userid); } /** * Checks whether the module's conditional access settings mean that the * user cannot see the activity at all * * @deprecated since 2.7 MDL-44070 */ public function is_user_access_restricted_by_conditional_access() { throw new coding_exception('cm_info::is_user_access_restricted_by_conditional_access() ' . 'can not be used any more; this function is not needed (use $cm->uservisible ' . 'and $cm->availableinfo to decide whether it should be available ' . 'or appear)'); } /** * Calls a module function (if exists), passing in one parameter: this object. * @param string $type Name of function e.g. if this is 'grooblezorb' and the modname is * 'forum' then it will try to call 'mod_forum_grooblezorb' or 'forum_grooblezorb' * @return void */ private function call_mod_function($type) { global $CFG; $libfile = $CFG->dirroot . '/mod/' . $this->modname . '/lib.php'; if (file_exists($libfile)) { include_once($libfile); $function = 'mod_' . $this->modname . '_' . $type; if (function_exists($function)) { $function($this); } else { $function = $this->modname . '_' . $type; if (function_exists($function)) { $function($this); } } } } /** * If view data for this course-module is not yet available, obtains it. * * This function is automatically called if any of the functions (marked) which require * view data are called. * * View data is data which is needed only for displaying the course main page (& any similar * functionality on other pages) but is not needed in general. Obtaining view data may have * a performance cost. * * As part of this function, the module's _cm_info_view function from its lib.php will * be called (if it exists). * @return void */ private function obtain_view_data() { if ($this->state >= self::STATE_BUILDING_VIEW || $this->modinfo->get_user_id() == -1) { return; } $this->obtain_dynamic_data(); $this->state = self::STATE_BUILDING_VIEW; // Let module make changes at this point $this->call_mod_function('cm_info_view'); $this->state = self::STATE_VIEW; } } /** * Returns reference to full info about modules in course (including visibility). * Cached and as fast as possible (0 or 1 db query). * * use get_fast_modinfo($courseid, 0, true) to reset the static cache for particular course * use get_fast_modinfo(0, 0, true) to reset the static cache for all courses * * use rebuild_course_cache($courseid, true) to reset the application AND static cache * for particular course when it's contents has changed * * @param int|stdClass $courseorid object from DB table 'course' (must have field 'id' * and recommended to have field 'cacherev') or just a course id. Just course id * is enough when calling get_fast_modinfo() for current course or site or when * calling for any other course for the second time. * @param int $userid User id to populate 'availble' and 'uservisible' attributes of modules and sections. * Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data. * @param bool $resetonly whether we want to get modinfo or just reset the cache * @return course_modinfo|null Module information for course, or null if resetting * @throws moodle_exception when course is not found (nothing is thrown if resetting) */ function get_fast_modinfo($courseorid, $userid = 0, $resetonly = false) { // compartibility with syntax prior to 2.4: if ($courseorid === 'reset') { 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); $courseorid = 0; $resetonly = true; } // Function get_fast_modinfo() can never be called during upgrade unless it is used for clearing cache only. if (!$resetonly) { upgrade_ensure_not_running(); } // Function is called with $reset = true if ($resetonly) { course_modinfo::clear_instance_cache($courseorid); return null; } // Function is called with $reset = false, retrieve modinfo return course_modinfo::instance($courseorid, $userid); } /** * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given * a cmid. If module name is also provided, it will ensure the cm is of that type. * * Usage: * list($course, $cm) = get_course_and_cm_from_cmid($cmid, 'forum'); * * Using this method has a performance advantage because it works by loading * modinfo for the course - which will then be cached and it is needed later * in most requests. It also guarantees that the $cm object is a cm_info and * not a stdclass. * * The $course object can be supplied if already known and will speed * up this function - although it is more efficient to use this function to * get the course if you are starting from a cmid. * * To avoid security problems and obscure bugs, you should always specify * $modulename if the cmid value came from user input. * * By default this obtains information (for example, whether user can access * the activity) for current user, but you can specify a userid if required. * * @param stdClass|int $cmorid Id of course-module, or database object * @param string $modulename Optional modulename (improves security) * @param stdClass|int $courseorid Optional course object if already loaded * @param int $userid Optional userid (default = current) * @return array Array with 2 elements $course and $cm * @throws moodle_exception If the item doesn't exist or is of wrong module name */ function get_course_and_cm_from_cmid($cmorid, $modulename = '', $courseorid = 0, $userid = 0) { global $DB; if (is_object($cmorid)) { $cmid = $cmorid->id; if (isset($cmorid->course)) { $courseid = (int)$cmorid->course; } else { $courseid = 0; } } else { $cmid = (int)$cmorid; $courseid = 0; } // Validate module name if supplied. if ($modulename && !core_component::is_valid_plugin_name('mod', $modulename)) { throw new coding_exception('Invalid modulename parameter'); } // Get course from last parameter if supplied. $course = null; if (is_object($courseorid)) { $course = $courseorid; } else if ($courseorid) { $courseid = (int)$courseorid; } if (!$course) { if ($courseid) { // If course ID is known, get it using normal function. $course = get_course($courseid); } else { // Get course record in a single query based on cmid. $course = $DB->get_record_sql(" SELECT c.* FROM {course_modules} cm JOIN {course} c ON c.id = cm.course WHERE cm.id = ?", array($cmid), MUST_EXIST); } } // Get cm from get_fast_modinfo. $modinfo = get_fast_modinfo($course, $userid); $cm = $modinfo->get_cm($cmid); if ($modulename && $cm->modname !== $modulename) { throw new moodle_exception('invalidcoursemodule', 'error'); } return array($course, $cm); } /** * Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given * an instance id or record and module name. * * Usage: * list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum'); * * Using this method has a performance advantage because it works by loading * modinfo for the course - which will then be cached and it is needed later * in most requests. It also guarantees that the $cm object is a cm_info and * not a stdclass. * * The $course object can be supplied if already known and will speed * up this function - although it is more efficient to use this function to * get the course if you are starting from an instance id. * * By default this obtains information (for example, whether user can access * the activity) for current user, but you can specify a userid if required. * * @param stdclass|int $instanceorid Id of module instance, or database object * @param string $modulename Modulename (required) * @param stdClass|int $courseorid Optional course object if already loaded * @param int $userid Optional userid (default = current) * @return array Array with 2 elements $course and $cm * @throws moodle_exception If the item doesn't exist or is of wrong module name */ function get_course_and_cm_from_instance($instanceorid, $modulename, $courseorid = 0, $userid = 0) { global $DB; // Get data from parameter. if (is_object($instanceorid)) { $instanceid = $instanceorid->id; if (isset($instanceorid->course)) { $courseid = (int)$instanceorid->course; } else { $courseid = 0; } } else { $instanceid = (int)$instanceorid; $courseid = 0; } // Get course from last parameter if supplied. $course = null; if (is_object($courseorid)) { $course = $courseorid; } else if ($courseorid) { $courseid = (int)$courseorid; } // Validate module name if supplied. if (!core_component::is_valid_plugin_name('mod', $modulename)) { throw new coding_exception('Invalid modulename parameter'); } if (!$course) { if ($courseid) { // If course ID is known, get it using normal function. $course = get_course($courseid); } else { // Get course record in a single query based on instance id. $pagetable = '{' . $modulename . '}'; $course = $DB->get_record_sql(" SELECT c.* FROM $pagetable instance JOIN {course} c ON c.id = instance.course WHERE instance.id = ?", array($instanceid), MUST_EXIST); } } // Get cm from get_fast_modinfo. $modinfo = get_fast_modinfo($course, $userid); $instances = $modinfo->get_instances_of($modulename); if (!array_key_exists($instanceid, $instances)) { throw new moodle_exception('invalidmoduleid', 'error', $instanceid); } return array($course, $instances[$instanceid]); } /** * Rebuilds or resets the cached list of course activities stored in MUC. * * rebuild_course_cache() must NEVER be called from lib/db/upgrade.php. * At the same time course cache may ONLY be cleared using this function in * upgrade scripts of plugins. * * During the bulk operations if it is necessary to reset cache of multiple * courses it is enough to call {@link increment_revision_number()} for the * table 'course' and field 'cacherev' specifying affected courses in select. * * Cached course information is stored in MUC core/coursemodinfo and is * validated with the DB field {course}.cacherev * * @global moodle_database $DB * @param int $courseid id of course to rebuild, empty means all * @param boolean $clearonly only clear the cache, gets rebuild automatically on the fly. * Recommended to set to true to avoid unnecessary multiple rebuilding. */ function rebuild_course_cache($courseid=0, $clearonly=false) { global $COURSE, $SITE, $DB, $CFG; // Function rebuild_course_cache() can not be called during upgrade unless it's clear only. if (!$clearonly && !upgrade_ensure_not_running(true)) { $clearonly = true; } // Destroy navigation caches navigation_cache::destroy_volatile_caches(); if (class_exists('format_base')) { // if file containing class is not loaded, there is no cache there anyway format_base::reset_course_cache($courseid); } $cachecoursemodinfo = cache::make('core', 'coursemodinfo'); if (empty($courseid)) { // Clearing caches for all courses. increment_revision_number('course', 'cacherev', ''); $cachecoursemodinfo->purge(); course_modinfo::clear_instance_cache(); // Update global values too. $sitecacherev = $DB->get_field('course', 'cacherev', array('id' => SITEID)); $SITE->cachrev = $sitecacherev; if ($COURSE->id == SITEID) { $COURSE->cacherev = $sitecacherev; } else { $COURSE->cacherev = $DB->get_field('course', 'cacherev', array('id' => $COURSE->id)); } } else { // Clearing cache for one course, make sure it is deleted from user request cache as well. increment_revision_number('course', 'cacherev', 'id = :id', array('id' => $courseid)); $cachecoursemodinfo->delete($courseid); course_modinfo::clear_instance_cache($courseid); // Update global values too. if ($courseid == $COURSE->id || $courseid == $SITE->id) { $cacherev = $DB->get_field('course', 'cacherev', array('id' => $courseid)); if ($courseid == $COURSE->id) { $COURSE->cacherev = $cacherev; } if ($courseid == $SITE->id) { $SITE->cachrev = $cacherev; } } } if ($clearonly) { return; } if ($courseid) { $select = array('id'=>$courseid); } else { $select = array(); core_php_time_limit::raise(); // this could take a while! MDL-10954 } $rs = $DB->get_recordset("course", $select,'','id,'.join(',', course_modinfo::$cachedfields)); // Rebuild cache for each course. foreach ($rs as $course) { course_modinfo::build_course_cache($course); } $rs->close(); } /** * Class that is the return value for the _get_coursemodule_info module API function. * * Note: For backward compatibility, you can also return a stdclass object from that function. * The difference is that the stdclass object may contain an 'extra' field (deprecated, * use extraclasses and onclick instead). The stdclass object may not contain * the new fields defined here (content, extraclasses, customdata). */ class cached_cm_info { /** * Name (text of link) for this activity; Leave unset to accept default name * @var string */ public $name; /** * Name of icon for this activity. Normally, this should be used together with $iconcomponent * to define the icon, as per image_url function. * For backward compatibility, if this value is of the form 'mod/forum/icon' then an icon * within that module will be used. * @see cm_info::get_icon_url() * @see renderer_base::image_url() * @var string */ public $icon; /** * Component for icon for this activity, as per image_url; leave blank to use default 'moodle' * component * @see renderer_base::image_url() * @var string */ public $iconcomponent; /** * HTML content to be displayed on the main page below the link (if any) for this course-module * @var string */ public $content; /** * Custom data to be stored in modinfo for this activity; useful if there are cases when * internal information for this activity type needs to be accessible from elsewhere on the * course without making database queries. May be of any type but should be short. * @var mixed */ public $customdata; /** * Extra CSS class or classes to be added when this activity is displayed on the main page; * space-separated string * @var string */ public $extraclasses; /** * External URL image to be used by activity as icon, useful for some external-tool modules * like lti. If set, takes precedence over $icon and $iconcomponent * @var $moodle_url */ public $iconurl; /** * Content of onclick JavaScript; escaped HTML to be inserted as attribute value * @var string */ public $onclick; } /** * Data about a single section on a course. This contains the fields from the * course_sections table, plus additional data when required. * * @property-read int $id Section ID - from course_sections table * @property-read int $course Course ID - from course_sections table * @property-read int $section Section number - from course_sections table * @property-read string $name Section name if specified - from course_sections table * @property-read int $visible Section visibility (1 = visible) - from course_sections table * @property-read string $summary Section summary text if specified - from course_sections table * @property-read int $summaryformat Section summary text format (FORMAT_xx constant) - from course_sections table * @property-read string $availability Availability information as JSON string - * from course_sections table * @property-read array $conditionscompletion Availability conditions for this section based on the completion of * course-modules (array from course-module id to required completion state * for that module) - from cached data in sectioncache field * @property-read array $conditionsgrade Availability conditions for this section based on course grades (array from * grade item id to object with ->min, ->max fields) - from cached data in * sectioncache field * @property-read array $conditionsfield Availability conditions for this section based on user fields * @property-read bool $available True if this section is available to the given user i.e. if all availability conditions * are met - obtained dynamically * @property-read string $availableinfo If section is not available to some users, this string gives information about * availability which can be displayed to students and/or staff (e.g. 'Available from 3 January 2010') * for display on main page - obtained dynamically * @property-read bool $uservisible True if this section is available to the given user (for example, if current user * has viewhiddensections capability, they can access the section even if it is not * visible or not available, so this would be true in that case) - obtained dynamically * @property-read string $sequence Comma-separated list of all modules in the section. Note, this field may not exactly * match course_sections.sequence if later has references to non-existing modules or not modules of not available module types. * @property-read course_modinfo $modinfo */ class section_info implements IteratorAggregate { /** * Section ID - from course_sections table * @var int */ private $_id; /** * Section number - from course_sections table * @var int */ private $_section; /** * Section name if specified - from course_sections table * @var string */ private $_name; /** * Section visibility (1 = visible) - from course_sections table * @var int */ private $_visible; /** * Section summary text if specified - from course_sections table * @var string */ private $_summary; /** * Section summary text format (FORMAT_xx constant) - from course_sections table * @var int */ private $_summaryformat; /** * Availability information as JSON string - from course_sections table * @var string */ private $_availability; /** * Availability conditions for this section based on the completion of * course-modules (array from course-module id to required completion state * for that module) - from cached data in sectioncache field * @var array */ private $_conditionscompletion; /** * Availability conditions for this section based on course grades (array from * grade item id to object with ->min, ->max fields) - from cached data in * sectioncache field * @var array */ private $_conditionsgrade; /** * Availability conditions for this section based on user fields * @var array */ private $_conditionsfield; /** * True if this section is available to students i.e. if all availability conditions * are met - obtained dynamically on request, see function {@link section_info::get_available()} * @var bool|null */ private $_available; /** * If section is not available to some users, this string gives information about * availability which can be displayed to students and/or staff (e.g. 'Available from 3 * January 2010') for display on main page - obtained dynamically on request, see * function {@link section_info::get_availableinfo()} * @var string */ private $_availableinfo; /** * True if this section is available to the CURRENT user (for example, if current user * has viewhiddensections capability, they can access the section even if it is not * visible or not available, so this would be true in that case) - obtained dynamically * on request, see function {@link section_info::get_uservisible()} * @var bool|null */ private $_uservisible; /** * Default values for sectioncache fields; if a field has this value, it won't * be stored in the sectioncache cache, to save space. Checks are done by === * which means values must all be strings. * @var array */ private static $sectioncachedefaults = array( 'name' => null, 'summary' => '', 'summaryformat' => '1', // FORMAT_HTML, but must be a string 'visible' => '1', 'availability' => null ); /** * Stores format options that have been cached when building 'coursecache' * When the format option is requested we look first if it has been cached * @var array */ private $cachedformatoptions = array(); /** * Stores the list of all possible section options defined in each used course format. * @var array */ static private $sectionformatoptions = array(); /** * Stores the modinfo object passed in constructor, may be used when requesting * dynamically obtained attributes such as available, availableinfo, uservisible. * Also used to retrun information about current course or user. * @var course_modinfo */ private $modinfo; /** * Constructs object from database information plus extra required data. * @param object $data Array entry from cached sectioncache * @param int $number Section number (array key) * @param int $notused1 argument not used (informaion is available in $modinfo) * @param int $notused2 argument not used (informaion is available in $modinfo) * @param course_modinfo $modinfo Owner (needed for checking availability) * @param int $notused3 argument not used (informaion is available in $modinfo) */ public function __construct($data, $number, $notused1, $notused2, $modinfo, $notused3) { global $CFG; require_once($CFG->dirroot.'/course/lib.php'); // Data that is always present $this->_id = $data->id; $defaults = self::$sectioncachedefaults + array('conditionscompletion' => array(), 'conditionsgrade' => array(), 'conditionsfield' => array()); // Data that may use default values to save cache size foreach ($defaults as $field => $value) { if (isset($data->{$field})) { $this->{'_'.$field} = $data->{$field}; } else { $this->{'_'.$field} = $value; } } // Other data from constructor arguments. $this->_section = $number; $this->modinfo = $modinfo; // Cached course format data. $course = $modinfo->get_course(); if (!isset(self::$sectionformatoptions[$course->format])) { // Store list of section format options defined in each used course format. // They do not depend on particular course but only on its format. self::$sectionformatoptions[$course->format] = course_get_format($course)->section_format_options(); } foreach (self::$sectionformatoptions[$course->format] as $field => $option) { if (!empty($option['cache'])) { if (isset($data->{$field})) { $this->cachedformatoptions[$field] = $data->{$field}; } else if (array_key_exists('cachedefault', $option)) { $this->cachedformatoptions[$field] = $option['cachedefault']; } } } } /** * Magic method to check if the property is set * * @param string $name name of the property * @return bool */ public function __isset($name) { if (method_exists($this, 'get_'.$name) || property_exists($this, '_'.$name) || array_key_exists($name, self::$sectionformatoptions[$this->modinfo->get_course()->format])) { $value = $this->__get($name); return isset($value); } return false; } /** * Magic method to check if the property is empty * * @param string $name name of the property * @return bool */ public function __empty($name) { if (method_exists($this, 'get_'.$name) || property_exists($this, '_'.$name) || array_key_exists($name, self::$sectionformatoptions[$this->modinfo->get_course()->format])) { $value = $this->__get($name); return empty($value); } return true; } /** * Magic method to retrieve the property, this is either basic section property * or availability information or additional properties added by course format * * @param string $name name of the property * @return bool */ public function __get($name) { if (method_exists($this, 'get_'.$name)) { return $this->{'get_'.$name}(); } if (property_exists($this, '_'.$name)) { return $this->{'_'.$name}; } if (array_key_exists($name, $this->cachedformatoptions)) { return $this->cachedformatoptions[$name]; } // precheck if the option is defined in format to avoid unnecessary DB queries in get_format_options() if (array_key_exists($name, self::$sectionformatoptions[$this->modinfo->get_course()->format])) { $formatoptions = course_get_format($this->modinfo->get_course())->get_format_options($this); return $formatoptions[$name]; } debugging('Invalid section_info property accessed! '.$name); return null; } /** * Finds whether this section is available at the moment for the current user. *
< * The value can be accessed publicly as $sectioninfo->available
> * The value can be accessed publicly as $sectioninfo->available, but can be called directly if there > * is a case when it might be called recursively (you can't call property values recursively).
* * @return bool */
< private function get_available() {
> public function get_available() {
global $CFG; $userid = $this->modinfo->get_user_id(); if ($this->_available !== null || $userid == -1) { // Has already been calculated or does not need calculation. return $this->_available; } $this->_available = true; $this->_availableinfo = ''; if (!empty($CFG->enableavailability)) { // Get availability information. $ci = new \core_availability\info_section($this); $this->_available = $ci->is_available($this->_availableinfo, true, $userid, $this->modinfo); } // Execute the hook from the course format that may override the available/availableinfo properties. $currentavailable = $this->_available; course_get_format($this->modinfo->get_course())-> section_get_available_hook($this, $this->_available, $this->_availableinfo); if (!$currentavailable && $this->_available) { debugging('section_get_available_hook() can not make unavailable section available', DEBUG_DEVELOPER); $this->_available = $currentavailable; } return $this->_available; } /** * Returns the availability text shown next to the section on course page. * * @return string */ private function get_availableinfo() { // Calling get_available() will also fill the availableinfo property // (or leave it null if there is no userid). $this->get_available(); return $this->_availableinfo; } /** * Implementation of IteratorAggregate::getIterator(), allows to cycle through properties * and use {@link convert_to_array()} * * @return ArrayIterator */ public function getIterator() { $ret = array(); foreach (get_object_vars($this) as $key => $value) { if (substr($key, 0, 1) == '_') { if (method_exists($this, 'get'.$key)) { $ret[substr($key, 1)] = $this->{'get'.$key}(); } else { $ret[substr($key, 1)] = $this->$key; } } } $ret['sequence'] = $this->get_sequence(); $ret['course'] = $this->get_course(); $ret = array_merge($ret, course_get_format($this->modinfo->get_course())->get_format_options($this->_section)); return new ArrayIterator($ret); } /** * Works out whether activity is visible *for current user* - if this is false, they * aren't allowed to access it. * * @return bool */ private function get_uservisible() { $userid = $this->modinfo->get_user_id(); if ($this->_uservisible !== null || $userid == -1) { // Has already been calculated or does not need calculation. return $this->_uservisible; } $this->_uservisible = true; if (!$this->_visible || !$this->get_available()) { $coursecontext = context_course::instance($this->get_course()); if (!$this->_visible && !has_capability('moodle/course:viewhiddensections', $coursecontext, $userid) || (!$this->get_available() && !has_capability('moodle/course:ignoreavailabilityrestrictions', $coursecontext, $userid))) { $this->_uservisible = false; } } return $this->_uservisible; } /** * Restores the course_sections.sequence value * * @return string */ private function get_sequence() { if (!empty($this->modinfo->sections[$this->_section])) { return implode(',', $this->modinfo->sections[$this->_section]); } else { return ''; } } /** * Returns course ID - from course_sections table * * @return int */ private function get_course() { return $this->modinfo->get_course_id(); } /** * Modinfo object * * @return course_modinfo */ private function get_modinfo() { return $this->modinfo; } /** * Prepares section data for inclusion in sectioncache cache, removing items * that are set to defaults, and adding availability data if required. * * Called by build_section_cache in course_modinfo only; do not use otherwise. * @param object $section Raw section data object */ public static function convert_for_section_cache($section) { global $CFG; // Course id stored in course table unset($section->course); // Section number stored in array key unset($section->section); // Sequence stored implicity in modinfo $sections array unset($section->sequence); // Remove default data foreach (self::$sectioncachedefaults as $field => $value) { // Exact compare as strings to avoid problems if some strings are set // to "0" etc. if (isset($section->{$field}) && $section->{$field} === $value) { unset($section->{$field}); } } } }