User Class Reference

Class to represent a tool consumer user. More...

Inheritance diagram for User:

Public Member Functions
	__construct ()
	Class constructor. More...
	initialize ()
	Initialise the user. More...
	initialise ()
	Initialise the user. More...
	setNames ($firstname, $lastname, $fullname)
	Set the user's name. More...
	setEmail ($email, $defaultEmail=null)
	Set the user's email address. More...
	isAdmin ()
	Check if the user is an administrator (at any of the system, institution or context levels). More...
	isStaff ()
	Check if the user is staff. More...
	isLearner ()
	Check if the user is a learner. More...

Data Fields
	$firstname = ''
	UserResult's first name. More...
	$lastname = ''
	UserResult's last name (surname or family name). More...
	$fullname = ''
	UserResult's fullname. More...
	$email = ''
	UserResult's email address. More...
	$image = ''
	UserResult's image URI. More...
	$roles = array()
	Roles for user. More...
	$groups = array()
	Groups for user. More...
	$ltiUserId = null
	user ID as supplied in the last connection request. More...

Static Public Attributes
static	$allowEmptyName = false
	Allow user name field to be empty? More...

Detailed Description

Class to represent a tool consumer user.

Author

Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright

SPV Software Products

Version

3.1.0

Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 13 of file User.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Class constructor.

Definition at line 82 of file User.php.

References User\initialize().

Member Function Documentation

initialise()

initialise

(

)

Initialise the user.

Pseudonym for initialize().

Definition at line 106 of file User.php.

References User\initialize().

initialize()

initialize

(

)

Initialise the user.

Definition at line 90 of file User.php.

Referenced by User\__construct(), and User\initialise().

isAdmin()

isAdmin

(

)

Check if the user is an administrator (at any of the system, institution or context levels).

Returns

bool True if the user has a role of administrator

Definition at line 175 of file User.php.

isLearner()

isLearner

(

)

Check if the user is a learner.

Returns

bool True if the user has a role of learner

Definition at line 196 of file User.php.

isStaff()

isStaff

(

)

Check if the user is staff.

Returns

bool True if the user has a role of instructor, contentdeveloper or teachingassistant

Definition at line 186 of file User.php.

setEmail()

setEmail	(		$email,
			$defaultEmail = null
	)

Set the user's email address.

Parameters

string	$email	Email address value
string	$defaultEmail	Value to use if no email is provided (optional, default is none)

Definition at line 156 of file User.php.

References User\$email.

setNames()

setNames	(		$firstname,
			$lastname,
			$fullname
	)

Set the user's name.

Parameters

string	$firstname	UserResult's first name.
string	$lastname	UserResult's last name.
string	$fullname	UserResult's full name.

Definition at line 118 of file User.php.

References User\$firstname, User\$fullname, User\$lastname, and User\$ltiUserId.

Field Documentation

$allowEmptyName

bool $allowEmptyName = false

static

Allow user name field to be empty?

Definition at line 42 of file User.php.

$email

string $email = ''

UserResult's email address.

Definition at line 49 of file User.php.

Referenced by User\setEmail().

$firstname

string $firstname = ''

UserResult's first name.

Definition at line 21 of file User.php.

Referenced by User\setNames().

$fullname

string $fullname = ''

UserResult's fullname.

Definition at line 35 of file User.php.

Referenced by User\setNames().

$groups

array $groups = array()

Groups for user.

Definition at line 70 of file User.php.

$image

string $image = ''

UserResult's image URI.

Definition at line 56 of file User.php.

$lastname

string $lastname = ''

UserResult's last name (surname or family name).

Definition at line 28 of file User.php.

Referenced by User\setNames().

$ltiUserId

string null $ltiUserId = null

user ID as supplied in the last connection request.

Definition at line 77 of file User.php.

Referenced by UserResult\fromResourceLink(), UserResult\getId(), and User\setNames().

$roles

array $roles = array()

Roles for user.

Definition at line 63 of file User.php.

---

The documentation for this class was generated from the following file:

• User.php