C:/xampp/htdocs/moodle/admin/tool/uploaduser/locallib.php File Reference

Go to the source code of this file.

Data Structures
class	uu_progress_tracker
Namespaces
namespace	tool
namespace	core
Enumerations
enum	UU_USER_ADDNEW
enum	UU_USER_ADDINC
enum	UU_USER_ADD_UPDATE
enum	UU_USER_UPDATE
enum	UU_UPDATE_NOCHANGES
enum	UU_UPDATE_FILEOVERRIDE
enum	UU_UPDATE_ALLOVERRIDE
enum	UU_UPDATE_MISSING
enum	UU_BULK_NONE
enum	UU_BULK_NEW
enum	UU_BULK_UPDATED
enum	UU_BULK_ALL
enum	UU_PWRESET_NONE
enum	UU_PWRESET_WEAK
enum	UU_PWRESET_ALL
Functions
	uu_validate_user_upload_columns (csv_import_reader $cir, $stdfields, $profilefields, moodle_url $returnurl)
	uu_increment_username ($username)
	uu_process_template ($template, $user)
	uu_process_template_callback ($username, $firstname, $lastname, $block)
	uu_supported_auths ()
	uu_allowed_roles ()
	uu_allowed_roles_cache ()

---

Enumeration Type Documentation

enum UU_BULK_ALL

Definition at line 41 of file locallib.php.

enum UU_BULK_NEW

Definition at line 39 of file locallib.php.

enum UU_BULK_NONE

Definition at line 38 of file locallib.php.

enum UU_BULK_UPDATED

Definition at line 40 of file locallib.php.

enum UU_PWRESET_ALL

Definition at line 45 of file locallib.php.

enum UU_PWRESET_NONE

Definition at line 43 of file locallib.php.

enum UU_PWRESET_WEAK

Definition at line 44 of file locallib.php.

enum UU_UPDATE_ALLOVERRIDE

Definition at line 35 of file locallib.php.

enum UU_UPDATE_FILEOVERRIDE

Definition at line 34 of file locallib.php.

enum UU_UPDATE_MISSING

Definition at line 36 of file locallib.php.

enum UU_UPDATE_NOCHANGES

Definition at line 33 of file locallib.php.

enum UU_USER_ADD_UPDATE

Definition at line 30 of file locallib.php.

enum UU_USER_ADDINC

Definition at line 29 of file locallib.php.

enum UU_USER_ADDNEW

Definition at line 28 of file locallib.php.

enum UU_USER_UPDATE

Definition at line 31 of file locallib.php.

---

Function Documentation

uu_allowed_roles

(

)

Returns list of roles that are assignable in courses

Returns:

array

Definition at line 346 of file locallib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

uu_allowed_roles_cache

(

)

Returns mapping of all roles using short role name as index.

Returns:

array

Definition at line 356 of file locallib.php.

Here is the call graph for this function:

uu_increment_username

(

$

username

)

Increments username - increments trailing number or adds it if not present. Varifies that the new username does not exist yet

Parameters:

string

$username

Returns:

incremented username which does not exist yet

Definition at line 227 of file locallib.php.

uu_process_template	(	$	template,
		$	user
	)

Check if default field contains templates and apply them.

Parameters:

string	template - potential tempalte string
object	user object- we need username, firstname and lastname

Returns:

string field value

Definition at line 249 of file locallib.php.

Here is the call graph for this function:

uu_process_template_callback	(	$	username,
		$	firstname,
		$	lastname,
		$	block
	)

Internal callback function.

Definition at line 283 of file locallib.php.

Here is the call graph for this function:

uu_supported_auths

(

)

Returns list of auth plugins that are enabled and known to work.

If ppl want to use some other auth type they have to include it in the CSV file next on each line.

Returns:

array type=>name

Definition at line 327 of file locallib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

uu_validate_user_upload_columns	(	csv_import_reader $	cir,
		$	stdfields,
		$	profilefields,
		moodle_url $	returnurl
	)

Validation callback function - verified the column line of csv file. Converts standard column names to lowercase.

Parameters:

csv_import_reader	$cir
array	$stdfields	standard user fields
array	$profilefields	custom profile fields
moodle_url	$returnurl	return url in case of any error

Returns:

array list of fields

Definition at line 168 of file locallib.php.

Here is the call graph for this function: