Fossology\UI\Api\Models\User Class Reference

Model to hold user information. More...

Collaboration diagram for Fossology\UI\Api\Models\User:

Public Member Functions
	__construct ($id, $name, $description, $email, $accessLevel, $root_folder_id, $emailNotification, $agents)
	getId ()
	getName ()
	getDescription ()
	getEmail ()
	getAccessLevel ()
	getRootFolderId ()
	getEmailNotification ()
	getAgents ()
	getJSON ()
	getArray ()

Private Attributes
	$id
	$name
	$description
	$email
	$accessLevel
	$rootFolderId
	$emailNotification
	$agents
	$analysis

Detailed Description

Model to hold user information.

Definition at line 31 of file User.php.

Constructor & Destructor Documentation

Fossology\UI\Api\Models\User::__construct	(		$id,
			$name,
			$description,
			$email,
			$accessLevel,
			$root_folder_id,
			$emailNotification,
			$agents
	)

User constructor.

Parameters

integer	$id
string	$name
string	$description
string	$email
integer	$accessLevel
integer	$root_folder_id
boolean	$emailNotification
object	$agents

Definition at line 90 of file User.php.

Member Function Documentation

Fossology\UI\Api\Models\User::getAccessLevel

(

)

Returns

string

Definition at line 152 of file User.php.

Fossology\UI\Api\Models\User::getAgents

(

)

Returns

object

Definition at line 176 of file User.php.

Fossology\UI\Api\Models\User::getArray

(

)

Get user element as an associative array

Returns

array

Definition at line 194 of file User.php.

Fossology\UI\Api\Models\User::getDescription

(

)

Returns

string

Definition at line 136 of file User.php.

Fossology\UI\Api\Models\User::getEmail

(

)

Returns

string

Definition at line 144 of file User.php.

Fossology\UI\Api\Models\User::getEmailNotification

(

)

Returns

boolean

Definition at line 168 of file User.php.

Fossology\UI\Api\Models\User::getId

(

)

Returns

integer

Definition at line 120 of file User.php.

Fossology\UI\Api\Models\User::getJSON

(

)

Get current user in JSON representation

Returns

string

Definition at line 185 of file User.php.

Fossology\UI\Api\Models\User::getName

(

)

Returns

string

Definition at line 128 of file User.php.

Fossology\UI\Api\Models\User::getRootFolderId

(

)

Returns

integer

Definition at line 160 of file User.php.

Member Data Documentation

string Fossology\UI\Api\Models\User::$accessLevel

private

Current user access level

Definition at line 57 of file User.php.

array Fossology\UI\Api\Models\User::$agents

private

Current user's agent preference

Definition at line 72 of file User.php.

Analysis Fossology\UI\Api\Models\User::$analysis

private

Current user's analysis from $agents

Definition at line 77 of file User.php.

string Fossology\UI\Api\Models\User::$description

private

Current user description

Definition at line 47 of file User.php.

string Fossology\UI\Api\Models\User::$email

private

Current user email

Definition at line 52 of file User.php.

boolean Fossology\UI\Api\Models\User::$emailNotification

private

Current user's email preference

Definition at line 67 of file User.php.

integer Fossology\UI\Api\Models\User::$id

private

Current user id

Definition at line 37 of file User.php.

string Fossology\UI\Api\Models\User::$name

private

Current user's name

Definition at line 42 of file User.php.

integer Fossology\UI\Api\Models\User::$rootFolderId

private

Current user's root folder id

Definition at line 62 of file User.php.

---

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

• src/www/ui/api/Models/User.php