BackendUser Class Reference

Inheritance diagram for BackendUser:

Public Member Functions
	getUserName ()
	setUserName ($userName)
	getDescription ()
	setDescription ($description)
	getIsAdministrator ()
	setIsAdministrator ($isAdministrator)
	getIsDisabled ()
	setIsDisabled ($isDisabled)
	getStartDateAndTime ()
	setStartDateAndTime (\DateTime $dateAndTime=null)
	getEndDateAndTime ()
	setEndDateAndTime (\DateTime $dateAndTime=null)
	getEmail ()
	setEmail ($email)
	getRealName ()
	setRealName ($name)
	isActivated ()
	setIpLockIsDisabled ($disableIpLock)
	getIpLockIsDisabled ()
	getLastLoginDateAndTime ()
	setLastLoginDateAndTime (\DateTime $dateAndTime=null)

Protected Member Functions
	isActivatedViaStartDateAndTime ()
	isActivatedViaEndDateAndTime ()

Protected Attributes
	$userName = ''
	$description = ''
	$isAdministrator = false
	$isDisabled = false
	$startDateAndTime = null
	$endDateAndTime = null
	$email = ''
	$realName = ''
	$lastLoginDateAndTime
	$ipLockIsDisabled = false

Detailed Description

This model represents a back-end user.

Definition at line 22 of file extbase/Classes/Domain/Model/BackendUser.php.

Member Function Documentation

getDescription

(

)

Returns

string

Definition at line 99 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$description.

getEmail

(

)

Gets the e-mail address of this user.

Returns

string the e-mail address, might be empty

Definition at line 201 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$email.

getEndDateAndTime

(

)

Returns the point in time before which this user is enabled.

Returns

|NULL the end date and time

Definition at line 180 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$endDateAndTime.

Referenced by BackendUser\isActivatedViaEndDateAndTime(), and BackendUser\isActive().

getIpLockIsDisabled

(

)

Checks whether the IP lock for this user is disabled.

Returns

bool whether the IP lock for this user is disabled

Definition at line 293 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$ipLockIsDisabled.

getIsAdministrator

(

)

Checks whether this user is an administrator.

Returns

bool whether this user is an administrator

Definition at line 117 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$isAdministrator.

getIsDisabled

(

)

Checks whether this user is disabled.

Returns

bool whether this user is disabled

Definition at line 138 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$isDisabled.

Referenced by BackendUser\isActivated(), and BackendUser\isActive().

getLastLoginDateAndTime

(

)

Gets this user's last login date and time.

Returns

|NULL this user's last login date and time, will be NULL if this user has never logged in before

Definition at line 303 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$lastLoginDateAndTime.

getRealName

(

)

Returns this user's real name.

Returns

string the real name. might be empty

Definition at line 222 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$realName.

getStartDateAndTime

(

)

Returns the point in time from which this user is enabled.

Returns

|NULL the start date and time

Definition at line 159 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$startDateAndTime.

Referenced by BackendUser\isActivatedViaStartDateAndTime(), and BackendUser\isActive().

getUserName

(

)

Gets the user name.

Returns

string the user name, will not be empty

Definition at line 80 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$userName.

isActivated

(

)

Checks whether this user is currently activated.

This function takes the "disabled" flag, the start date/time and the end date/time into account.

Returns

bool whether this user is currently activated

Definition at line 244 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\getIsDisabled(), BackendUser\isActivatedViaEndDateAndTime(), and BackendUser\isActivatedViaStartDateAndTime().

isActivatedViaEndDateAndTime ( )

protected

Checks whether this user is activated as far as the end date and time is concerned.

Returns

bool whether this user is activated as far as the end date and time is concerned

Definition at line 268 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\getEndDateAndTime().

Referenced by BackendUser\isActivated().

isActivatedViaStartDateAndTime ( )

protected

Checks whether this user is activated as far as the start date and time is concerned.

Returns

bool whether this user is activated as far as the start date and time is concerned

Definition at line 254 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\getStartDateAndTime().

Referenced by BackendUser\isActivated().

setDescription

(

$description

)

Parameters

string

$description

Definition at line 107 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$description.

setEmail

(

$email

)

Sets the e-mail address of this user.

Parameters

string

$email

the e-mail address, may be empty

Returns

void

Definition at line 212 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$email.

setEndDateAndTime

(

\DateTime

$dateAndTime = null

)

Sets the point in time before which this user is enabled.

Parameters

\DateTime | NULL

$dateAndTime

the end date and time

Returns

void

Definition at line 191 of file extbase/Classes/Domain/Model/BackendUser.php.

setIpLockIsDisabled

(

$disableIpLock

)

Sets whether the IP lock for this user is disabled.

Parameters

bool

$disableIpLock

whether the IP lock for this user is disabled

Returns

void

Definition at line 283 of file extbase/Classes/Domain/Model/BackendUser.php.

setIsAdministrator

(

$isAdministrator

)

Sets whether this user should be an administrator.

Parameters

bool

$isAdministrator

whether this user should be an administrator

Returns

void

Definition at line 128 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$isAdministrator.

setIsDisabled

(

$isDisabled

)

Sets whether this user is disabled.

Parameters

bool

$isDisabled

whether this user is disabled

Returns

void

Definition at line 149 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$isDisabled.

setLastLoginDateAndTime

(

\DateTime

$dateAndTime = null

)

Sets this user's last login date and time.

Parameters

\DateTime | NULL

$dateAndTime

this user's last login date and time

Returns

void

Definition at line 314 of file extbase/Classes/Domain/Model/BackendUser.php.

setRealName

(

$name

)

Sets this user's real name.

Parameters

string

$name

the user's real name, may be empty.

Definition at line 232 of file extbase/Classes/Domain/Model/BackendUser.php.

setStartDateAndTime

(

\DateTime

$dateAndTime = null

)

Sets the point in time from which this user is enabled.

Parameters

\DateTime | NULL

$dateAndTime

the start date and time

Returns

void

Definition at line 170 of file extbase/Classes/Domain/Model/BackendUser.php.

setUserName

(

$userName

)

Sets the user name.

Parameters

string

$userName

the user name to set, must not be empty

Returns

void

Definition at line 91 of file extbase/Classes/Domain/Model/BackendUser.php.

References BackendUser\$userName.

Member Data Documentation

$description = ''

protected

Definition at line 33 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getDescription(), and BackendUser\setDescription().

$email = ''

protected

Definition at line 58 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getEmail(), and BackendUser\setEmail().

$endDateAndTime = null

protected

Definition at line 53 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getEndDateAndTime().

$ipLockIsDisabled = false

protected

Definition at line 73 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getIpLockIsDisabled().

$isAdministrator = false

protected

Definition at line 38 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getIsAdministrator(), and BackendUser\setIsAdministrator().

$isDisabled = false

protected

Definition at line 43 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getIsDisabled(), and BackendUser\setIsDisabled().

$lastLoginDateAndTime

protected

Definition at line 68 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getLastLoginDateAndTime().

$realName = ''

protected

Definition at line 63 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getRealName().

$startDateAndTime = null

protected

Definition at line 48 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getStartDateAndTime().

$userName = ''

protected

Definition at line 28 of file extbase/Classes/Domain/Model/BackendUser.php.

Referenced by BackendUser\getUserName(), and BackendUser\setUserName().