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

MDL-39004 improve role docs

Browse Source
This commit is contained in:
Petr Škoda 2013-04-07 17:39:29 +02:00
parent 422f68fb86
commit fa0ad435f5
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lib/accesslib.php
View File

@ -2990,6 +2990,9 @@ function user_can_assign(context $context, $targetroleid) {
/**
* Returns all site roles in correct sort order.
*
* Note: this method does not localise role names or descriptions,
* use role_get_names() if you need role names.
*
* @param context $context optional context for course role name aliases
* @return array of role records with optional coursealias property
*/
@ -4249,7 +4252,7 @@ function user_has_role_assignment($userid, $roleid, $contextid = 0) {
}
/**
* Get role name or alias if exists and format the text.
* Get localised role name or alias if exists and format the text.
*
* @param stdClass $role role object
* - optional 'coursealias' property should be included for performance reasons if course context used
@ -4363,6 +4366,9 @@ function role_get_description(stdClass $role) {
/**
* Get all the localised role names for a context.
*
* In new installs default roles have empty names, this function
* add localised role names using current language pack.
*
* @param context $context the context, null means system context
* @param array of role objects with a ->localname field containing the context-specific role name.
* @param int $rolenamedisplay
@ -4374,7 +4380,7 @@ function role_get_names(context $context = null, $rolenamedisplay = ROLENAME_ALI
}
/**
* Prepare list of roles for display, apply aliases and format text
* Prepare list of roles for display, apply aliases and localise default role names.
*
* @param array $roleoptions array roleid => roleobject (with optional coursealias), strings are accepted for backwards compatibility only
* @param context $context the context, null means system context