User Class Reference

Class to represent a platform user. More...

Inheritance diagram for User:

Public Member Functions
	__construct ()
	Class constructor.
	initialize ()
	Initialise the user.
	initialise ()
	Initialise the user.
	setNames ($firstname, $lastname, $fullname, $middlename=null)
	Set the user's name.
	setEmail ($email, $defaultEmail=null)
	Set the user's email address.
bool	isLearner ()
	Check if the user is a learner.
bool	isInstructor ()
	Check if the user is an instructor.
bool	isContentDeveloper ()
	Check if the user is a content developer.
bool	isTeachingAssistant ()
	Check if the user is a teaching assistant.
bool	isManager ()
	Check if the user is a manager.
bool	isMember ()
	Check if the user is a member.
bool	isOfficer ()
	Check if the user is an officer.
bool	isStaff ()
	Check if the user is staff.
bool	isMentor ()
	Check if the user is a mentor.
bool	isAdmin ()
	Check if the user is an administrator (at any of the system, institution or context levels).

Public Attributes
const	PRINCIPAL_ROLES
	List of principal roles for LTI 1.3.
string	$firstname = ''
	User's first name.
string	$middlename = ''
	User's middle name.
string	$lastname = ''
	User's last name (surname or family name).
string	$fullname = ''
	User's fullname.
string	$sourcedId = null
	User's sourcedId.
string	$username = null
	User's username.
string	$email = ''
	User's email address.
string	$image = ''
	User's image URI.
array	$roles = array()
	Roles for user.
array	$groups = array()
	Groups for user.
string null	$ltiUserId = null
	user ID as supplied in the last connection request.

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

Detailed Description

Class to represent a platform 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

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

Constructor & Destructor Documentation

__construct()

__construct

(

)

Class constructor.

Reimplemented in UserResult.

Member Function Documentation

initialise()

initialise

(

)

Initialise the user.

Synonym for initialize().

initialize()

initialize

(

)

Initialise the user.

Reimplemented in UserResult.

References User\initialize().

Referenced by User\initialize(), and User\setNames().

isAdmin()

bool 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

isContentDeveloper()

bool isContentDeveloper

(

)

Check if the user is a content developer.

Returns

bool True if the user has a context role of ContentDeveloper

isInstructor()

bool isInstructor

(

)

Check if the user is an instructor.

Returns

bool True if the user has a context role of Instructor

isLearner()

bool isLearner

(

)

Check if the user is a learner.

Returns

bool True if the user has a context role of Learner

isManager()

bool isManager

(

)

Check if the user is a manager.

Returns

bool True if the user has a context role of Manager

isMember()

bool isMember

(

)

Check if the user is a member.

Returns

bool True if the user has a context role of Member

isMentor()

bool isMentor

(

)

Check if the user is a mentor.

Returns

bool True if the user has a context role of Mentor

isOfficer()

bool isOfficer

(

)

Check if the user is an officer.

Returns

bool True if the user has a context role of Officer

isStaff()

bool isStaff

(

)

Check if the user is staff.

Returns

bool True if the user has a context role of Instructor, ContentDeveloper or TeachingAssistant

isTeachingAssistant()

bool isTeachingAssistant

(

)

Check if the user is a teaching assistant.

Returns

bool True if the user has a context role of TeachingAssistant

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)

setNames()

setNames	(		$firstname,
			$lastname,
			$fullname,
			$middlename = null
	)

Set the user's name.

Parameters

string	$firstname	User's first name.
string	$lastname	User's last name.
string	$fullname	User's full name.
string	$middlename	User's middle name (optional, default is none).

References User\initialize().

Member Data Documentation

$allowEmptyName

bool $allowEmptyName = false

static

Allow user name field to be empty?

$allowEmptyName

$email

string $email = ''

User's email address.

$email

$firstname

string $firstname = ''

User's first name.

$firstname

$fullname

string $fullname = ''

User's fullname.

$fullname

$groups

array $groups = array()

Groups for user.

$groups

$image

string $image = ''

User's image URI.

$image

$lastname

string $lastname = ''

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

$lastname

$ltiUserId

string null $ltiUserId = null

user ID as supplied in the last connection request.

$ltiUserId

$middlename

string $middlename = ''

User's middle name.

$middlename

$roles

array $roles = array()

Roles for user.

$roles

$sourcedId

string $sourcedId = null

User's sourcedId.

$sourcedId

$username

string $username = null

User's username.

$username

---

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

• User.php