mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-19 06:18:28 +01:00
Code Issues Projects Releases Wiki Activity

accesslib: require_capability() phpdoc notes

Browse Source
This commit is contained in:
martinlanghoff 2007-09-19 07:24:43 +00:00
parent 0315aeb02f
commit efd6fce585
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/accesslib.php
View File

@ -31,6 +31,7 @@
*
* - get_context_instance()
* - has_capability()
* - require_capability()
* - get_user_courses_bycap()
* - get_context_users_bycap()
* - get_parent_contexts()
@ -619,8 +620,15 @@ function aggr_roles_fad($context, $ad) {
}
/**
* This function checks for a capability assertion being true. If it isn't
* then the page is terminated neatly with a standard error message
* This is an easy to use function, combining has_capability() with require_course_login().
* And will call those where needed.
*
* It checks for a capability assertion being true. If it isn't
* then the page is terminated neatly with a standard error message.
*
* If the user is not logged in, or is using 'guest' access or other special "users,
* it provides a logon prompt.
*
* @param string $capability - name of the capability
* @param object $context - a context object (record from context table)
* @param integer $userid - a userid number