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, $default_group_fk=null, $defaultBucketPool=null)
	getId ()
	getName ()
	getDescription ()
	getEmail ()
	getAccessLevel ()
	getRootFolderId ()
	getDefaultGroupId ()
	getEmailNotification ()
	getAgents ()
	getDefaultBucketPool ()
	getJSON ()
	getArray ($version=ApiVersion::V1)

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

Detailed Description

Model to hold user information.

Definition at line 20 of file User.php.

Constructor & Destructor Documentation

__construct()

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

User constructor.

Parameters

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

Definition at line 91 of file User.php.

Member Function Documentation

getAccessLevel()

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

(

)

Returns

string

Definition at line 163 of file User.php.

getAgents()

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

(

)

Returns

object

Definition at line 195 of file User.php.

getArray()

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

(

$version = ApiVersion::V1

)

Get user element as an associative array

Returns

array

Definition at line 221 of file User.php.

getDefaultBucketPool()

Fossology\UI\Api\Models\User::getDefaultBucketPool

(

)

Returns

int

Definition at line 203 of file User.php.

getDefaultGroupId()

Fossology\UI\Api\Models\User::getDefaultGroupId

(

)

Returns

integer

Definition at line 179 of file User.php.

getDescription()

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

(

)

Returns

string

Definition at line 147 of file User.php.

getEmail()

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

(

)

Returns

string

Definition at line 155 of file User.php.

getEmailNotification()

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

(

)

Returns

boolean

Definition at line 187 of file User.php.

getId()

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

(

)

Returns

integer

Definition at line 131 of file User.php.

getJSON()

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

(

)

Get current user in JSON representation

Returns

string

Definition at line 212 of file User.php.

getName()

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

(

)

Returns

string

Definition at line 139 of file User.php.

getRootFolderId()

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

(

)

Returns

integer

Definition at line 171 of file User.php.

Member Data Documentation

$accessLevel

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

private

Current user access level

Definition at line 46 of file User.php.

$agents

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

private

Current user's agent preference

Definition at line 66 of file User.php.

$analysis

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

private

Current user's analysis from $agents

Definition at line 71 of file User.php.

$defaultBucketPool

int Fossology\UI\Api\Models\User::$defaultBucketPool

private

Default bucket pool of the user

Definition at line 76 of file User.php.

$defaultGroup

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

private

Current user's default group id

Definition at line 56 of file User.php.

$description

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

private

Current user description

Definition at line 36 of file User.php.

$email

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

private

Current user email

Definition at line 41 of file User.php.

$emailNotification

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

private

Current user's email preference

Definition at line 61 of file User.php.

$id

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

private

Current user id

Definition at line 26 of file User.php.

$name

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

private

Current user's name

Definition at line 31 of file User.php.

$rootFolderId

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

private

Current user's root folder id

Definition at line 51 of file User.php.

---

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

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