RightProfile Class Reference

Public Member Functions
	RightProfile ()
	load ($id)
	save ()
	delete ()
	validate ()
	getId ()
	getLabel ()
	getName ()
	getType ()
	getDescription ()
	isRequired ()
	isLocked ()
	isCourseManager ()
	isUserPublic ()
	isMailNotify ()
	setLabel ($value)
	setName ($value)
	setDescription ($value)
	setType ($value)
	setIsLocked ($value)
	setIsRequired ($value)
	setIsCourseManager ($value)
	setIsTutor ($value)
	setIsUserPublic ($value)
	setIsEmailNotify ($value)
	displayProfileForm ()
	validateForm ()
Data Fields
	$id
	$label
	$name
	$type
	$description
	$isLocked
	$isRequired
	$isCourseManager
	$isTutor
	$isUserPublic
	$isEmailNotify
	$tbl = array()

---

Detailed Description

Class right profile

Definition at line 26 of file profile.class.php.

---

Member Function Documentation

delete

(

)

delete profile from DB

Todo:

TODO Possibility to delete used profile ?

Returns:

boolean

Definition at line 246 of file profile.class.php.

displayProfileForm

(

)

Display form profile

Returns:

string

Definition at line 516 of file profile.class.php.

getDescription

(

)

Get profile description

Returns:

string

Definition at line 348 of file profile.class.php.

getId

(

)

Get profile identifier

Returns:

integer

Definition at line 304 of file profile.class.php.

getLabel

(

)

Get profile label

Returns:

string

Definition at line 315 of file profile.class.php.

getName

(

)

Get profile name

Returns:

string

Definition at line 326 of file profile.class.php.

getType

(

)

Get profile type ()

Returns:

string

Definition at line 337 of file profile.class.php.

isCourseManager

(

)

Get course manager status

Returns:

boolean

Definition at line 381 of file profile.class.php.

isLocked

(

)

Get locked status

Returns:

boolean

Definition at line 370 of file profile.class.php.

isMailNotify

(

)

Get mail notify status

Returns:

boolean

Definition at line 403 of file profile.class.php.

isRequired

(

)

Get required status

Returns:

boolean

Definition at line 359 of file profile.class.php.

isUserPublic

(

)

Get user public status

Returns:

boolean

Definition at line 392 of file profile.class.php.

load

(

$

id

)

Load a profile from DB

Parameters:

integer

$id identifier of profile

Returns:

boolean load successfull

Definition at line 131 of file profile.class.php.

RightProfile

(

)

Constructor

Definition at line 104 of file profile.class.php.

save

(

)

save profile to DB

Returns:

mixed false or id of the profile

Definition at line 179 of file profile.class.php.

setDescription

(

$

value

)

Set description

Parameters:

string

$description

Definition at line 435 of file profile.class.php.

setIsCourseManager

(

$

value

)

Set course manager status

Parameters:

boolean

$value

Definition at line 476 of file profile.class.php.

setIsEmailNotify

(

$

value

)

Set email notification status

Parameters:

boolean

$value

Definition at line 506 of file profile.class.php.

setIsLocked

(

$

value

)

Set locked status

Parameters:

boolean

$value

Definition at line 456 of file profile.class.php.

setIsRequired

(

$

value

)

Set required status

Parameters:

boolean

$value

Definition at line 466 of file profile.class.php.

setIsTutor

(

$

value

)

Set is tutor status

Parameters:

boolean

$value

Definition at line 486 of file profile.class.php.

setIsUserPublic

(

$

value

)

Set user public status

Parameters:

boolean

$value

Definition at line 496 of file profile.class.php.

setLabel

(

$

value

)

Set profile label

Parameters:

string

$value

Definition at line 414 of file profile.class.php.

setName

(

$

value

)

Set profile name

Parameters:

string

$value

Definition at line 424 of file profile.class.php.

setType

(

$

value

)

Set type

Parameters:

string

$value

Definition at line 446 of file profile.class.php.

validate

(

)

Check if data are valide

Returns:

boolean

Definition at line 271 of file profile.class.php.

validateForm

(

)

Validate profile form data

Returns:

boolean

Definition at line 633 of file profile.class.php.

---

Field Documentation

$description

Definition at line 56 of file profile.class.php.

$id

Definition at line 32 of file profile.class.php.

$isCourseManager

Definition at line 74 of file profile.class.php.

$isEmailNotify

Definition at line 92 of file profile.class.php.

$isLocked

Definition at line 62 of file profile.class.php.

$isRequired

Definition at line 68 of file profile.class.php.

$isTutor

Definition at line 80 of file profile.class.php.

$isUserPublic

Definition at line 86 of file profile.class.php.

$label

Definition at line 38 of file profile.class.php.

$name

Definition at line 44 of file profile.class.php.

$tbl = array()

Definition at line 98 of file profile.class.php.

$type

Definition at line 50 of file profile.class.php.

---

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

• claroline/claroline/inc/lib/right/profile.class.php