From 043f1005560699b6387d2f2e23187bcb2935685d Mon Sep 17 00:00:00 2001 From: Rajesh Taneja Date: Tue, 12 Mar 2013 10:00:55 +0800 Subject: [PATCH] MDL-38332 Administration: Updated update.txt and php doc for get_users_listing --- lib/datalib.php | 4 ++-- lib/upgrade.txt | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/datalib.php b/lib/datalib.php index 97c51325e90..b390e72daec 100644 --- a/lib/datalib.php +++ b/lib/datalib.php @@ -357,7 +357,7 @@ function get_users($get=true, $search='', $confirmed=false, array $exceptions=nu /** - * @todo Finish documenting this function + * Return filtered (if provided) list of users in site, except guest and deleted users. * * @param string $sort An SQL field to sort by * @param string $dir The sort direction ASC|DESC @@ -368,7 +368,7 @@ function get_users($get=true, $search='', $confirmed=false, array $exceptions=nu * @param string $lastinitial Users whose last name starts with $lastinitial * @param string $extraselect An additional SQL select statement to append to the query * @param array $extraparams Additional parameters to use for the above $extraselect - * @param object $extracontext If specified, will include user 'extra fields' + * @param stdClass $extracontext If specified, will include user 'extra fields' * as appropriate for current user and given context * @return array Array of {@link $USER} records */ diff --git a/lib/upgrade.txt b/lib/upgrade.txt index 4a83493609b..6c31eca8f2b 100644 --- a/lib/upgrade.txt +++ b/lib/upgrade.txt @@ -21,7 +21,9 @@ information provided here is intended especially for developers. * curl::setopt() does not accept constant values any more. As it never worked properly, we decided to make the type check stricter. Now, the keys of the array pass must be a string corresponding to the curl constant name. - +* Function get_users_listing now return list of users except guest and deleted users. Previously + deleted users were excluded by get_users_listing. As guest user is not expected while browsing users, + and not included in get_user function, it will not be returned by get_users_listing. YUI changes: * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp