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

Inheritance diagram for TYPO3\CMS\Extbase\Domain\Model\BackendUser:

Public Member Functions
	getUserName ()
	setUserName ($userName)
	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 ()
	initializeObject ()
	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 = ''
	$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 file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! This model represents a back-end user.

Definition at line 21 of file BackendUser.php.

Member Function Documentation

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 169 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 150 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

boolean whether the IP lock for this user is disabled

Definition at line 253 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

boolean whether this user is an administrator

Definition at line 93 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

boolean whether this user is disabled

Definition at line 112 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 262 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 188 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 131 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 74 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

boolean whether this user is currently activated

Definition at line 208 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

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

Definition at line 230 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

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

Definition at line 217 of file BackendUser.php.

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

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

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 179 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 160 of file BackendUser.php.

setIpLockIsDisabled()

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

(

$disableIpLock

)

Sets whether the IP lock for this user is disabled.

Parameters

boolean

$disableIpLock

whether the IP lock for this user is disabled

Returns

void

Definition at line 244 of file BackendUser.php.

setIsAdministrator()

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

(

$isAdministrator

)

Sets whether this user should be an administrator.

Parameters

boolean

$isAdministrator

whether this user should be an administrator

Returns

void

Definition at line 103 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

boolean

$isDisabled

whether this user is disabled

Returns

void

Definition at line 122 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 272 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 197 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 141 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 84 of file BackendUser.php.

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

Member Data Documentation

$email

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

protected

Definition at line 52 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 47 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 67 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 32 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 37 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 62 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 57 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 42 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 27 of file BackendUser.php.

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