From 9428a1545d80f3c9bf27a5fd3e93987c627869f7 Mon Sep 17 00:00:00 2001 From: Marina Glancy Date: Wed, 14 Nov 2012 09:52:52 +0800 Subject: [PATCH] MDL-36267 corrected phpdocs for get_fast_modinfo() --- lib/modinfolib.php | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/modinfolib.php b/lib/modinfolib.php index 884d72a7b518d..ffe26a7222a85 100644 --- a/lib/modinfolib.php +++ b/lib/modinfolib.php @@ -1267,9 +1267,13 @@ private function obtain_view_data() { * 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 + * * @uses MAX_MODINFO_CACHE_SIZE - * @param int|stdClass $courseorid object or 'reset' string to reset caches, modinfo may be updated in db - * @param int $userid Set 0 (default) for current user + * @param int|stdClass $courseorid object from DB table 'course' or just a course id + * @param int $userid User id to populate 'uservisible' attributes of modules and sections. + * Set to 0 for current user (default) * @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 */