TYPO3\CMS\Extbase\Domain\Model\BackendUser Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Domain\Model\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)
Public Member Functions inherited from TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
	__wakeup ()
	getUid ()
	setPid ($pid)
	getPid ()
	_setProperty ($propertyName, $propertyValue)
	_getProperty ($propertyName)
	_getProperties ()
	_hasProperty ($propertyName)
	_isNew ()
	_memorizeCleanState ($propertyName=null)
	_memorizePropertyCleanState ($propertyName)
	_getCleanProperties ()
	_getCleanProperty ($propertyName)
	_isDirty ($propertyName=null)
	_isClone ()
	_setClone ($clone)
	__clone ()
	__toString ()
Public Member Functions inherited from TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface
	_memorizeCleanState ()
	_isDirty ()

Protected Member Functions
	isActivatedViaStartDateAndTime ()
	isActivatedViaEndDateAndTime ()
Protected Member Functions inherited from TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
	isPropertyDirty ($previousValue, $currentValue)

Protected Attributes
	$userName = ''
	$description = ''
	$isAdministrator = false
	$isDisabled = false
	$startDateAndTime = null
	$endDateAndTime = null
	$email = ''
	$realName = ''
	$lastLoginDateAndTime
	$ipLockIsDisabled = false
Protected Attributes inherited from TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
	$uid
	$_localizedUid
	$_languageUid
	$_versionedUid
	$pid

Detailed Description

This model represents a back-end user.

Definition at line 22 of file BackendUser.php.

Member Function Documentation

getDescription()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::getDescription

(

)

Returns

string

Definition at line 99 of file BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$description.

getEmail()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::getEmail

(

)

Gets the e-mail address of this user.

Returns

string the e-mail address, might be empty

Definition at line 201 of file BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$email.

getEndDateAndTime()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$endDateAndTime.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\isActivatedViaEndDateAndTime(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\isActive().

getIpLockIsDisabled()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$ipLockIsDisabled.

getIsAdministrator()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::getIsAdministrator

(

)

Checks whether this user is an administrator.

Returns

bool whether this user is an administrator

Definition at line 117 of file BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$isAdministrator.

getIsDisabled()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::getIsDisabled

(

)

Checks whether this user is disabled.

Returns

bool whether this user is disabled

Definition at line 138 of file BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$isDisabled.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\isActivated(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\isActive().

getLastLoginDateAndTime()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$lastLoginDateAndTime.

getRealName()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::getRealName

(

)

Returns this user's real name.

Returns

string the real name. might be empty

Definition at line 222 of file BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$realName.

getStartDateAndTime()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$startDateAndTime.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\isActivatedViaStartDateAndTime(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\isActive().

getUserName()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::getUserName

(

)

Gets the user name.

Returns

string the user name, will not be empty

Definition at line 80 of file BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$userName.

isActivated()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\getIsDisabled(), TYPO3\CMS\Extbase\Domain\Model\BackendUser\isActivatedViaEndDateAndTime(), and TYPO3\CMS\Extbase\Domain\Model\BackendUser\isActivatedViaStartDateAndTime().

isActivatedViaEndDateAndTime()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\getEndDateAndTime().

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\isActivated().

isActivatedViaStartDateAndTime()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\getStartDateAndTime().

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\isActivated().

setDescription()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::setDescription

(

$description

)

Parameters

string

$description

Definition at line 107 of file BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$description.

setEmail()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$email.

setEndDateAndTime()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

setIpLockIsDisabled()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

setIsAdministrator()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$isAdministrator.

setIsDisabled()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::setIsDisabled

(

$isDisabled

)

Sets whether this user is disabled.

Parameters

bool

$isDisabled

whether this user is disabled

Returns

void

Definition at line 149 of file BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$isDisabled.

setLastLoginDateAndTime()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

setRealName()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

setStartDateAndTime()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

setUserName()

TYPO3\CMS\Extbase\Domain\Model\BackendUser::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 BackendUser.php.

References TYPO3\CMS\Extbase\Domain\Model\BackendUser\$userName.

Member Data Documentation

$description

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$description = ''

protected

Definition at line 33 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getDescription(), and TYPO3\CMS\Extbase\Domain\Model\BackendUser\setDescription().

$email

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$email = ''

protected

Definition at line 58 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getEmail(), and TYPO3\CMS\Extbase\Domain\Model\BackendUser\setEmail().

$endDateAndTime

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$endDateAndTime = null

protected

Definition at line 53 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getEndDateAndTime().

$ipLockIsDisabled

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$ipLockIsDisabled = false

protected

Definition at line 73 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getIpLockIsDisabled().

$isAdministrator

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$isAdministrator = false

protected

Definition at line 38 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getIsAdministrator(), and TYPO3\CMS\Extbase\Domain\Model\BackendUser\setIsAdministrator().

$isDisabled

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$isDisabled = false

protected

Definition at line 43 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getIsDisabled(), and TYPO3\CMS\Extbase\Domain\Model\BackendUser\setIsDisabled().

$lastLoginDateAndTime

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$lastLoginDateAndTime

protected

Definition at line 68 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getLastLoginDateAndTime().

$realName

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$realName = ''

protected

Definition at line 63 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getRealName().

$startDateAndTime

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$startDateAndTime = null

protected

Definition at line 48 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getStartDateAndTime().

$userName

TYPO3\CMS\Extbase\Domain\Model\BackendUser::$userName = ''

protected

Definition at line 28 of file BackendUser.php.

Referenced by TYPO3\CMS\Extbase\Domain\Model\BackendUser\getUserName(), and TYPO3\CMS\Extbase\Domain\Model\BackendUser\setUserName().