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

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

Public Member Functions
string	getUserName ()
	setUserName ($userName)
string	getDescription ()
	setDescription ($description)
bool	getIsAdministrator ()
	setIsAdministrator ($isAdministrator)
bool	getIsDisabled ()
	setIsDisabled ($isDisabled)
DateTime null	getStartDateAndTime ()
	setStartDateAndTime (\DateTime $dateAndTime=null)
DateTime null	getEndDateAndTime ()
	setEndDateAndTime (\DateTime $dateAndTime=null)
string	getEmail ()
	setEmail ($email)
string	getRealName ()
	setRealName ($name)
bool	isActivated ()
	setIpLockIsDisabled ($disableIpLock)
bool	getIpLockIsDisabled ()
DateTime null	getLastLoginDateAndTime ()
	setLastLoginDateAndTime (\DateTime $dateAndTime=null)
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
int null	getUid ()
	setPid (int $pid)
int null	getPid ()
bool	_setProperty (string $propertyName, $propertyValue)
mixed	_getProperty (string $propertyName)
array	_getProperties ()
bool	_hasProperty ($propertyName)
bool	_isNew ()
	_memorizeCleanState ($propertyName=null)
	_memorizePropertyCleanState ($propertyName)
array	_getCleanProperties ()
mixed	_getCleanProperty (string $propertyName)
bool	_isDirty ($propertyName=null)
bool	_isClone ()
	_setClone ($clone)
	__clone ()
string	__toString ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface
	_memorizeCleanState ()
bool	_isDirty ()

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

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

Detailed Description

This model represents a back-end user.

Definition at line 24 of file BackendUser.php.

Member Function Documentation

getDescription()

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

(

)

Returns

‪string

Definition at line 90 of file BackendUser.php.

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

getEmail()

string 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 188 of file BackendUser.php.

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

getEndDateAndTime()

DateTime null TYPO3\CMS\Extbase\Domain\Model\BackendUser::getEndDateAndTime

(

)

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

Returns

‪\DateTime|null the end date and time

Definition at line 168 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()

bool 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 278 of file BackendUser.php.

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

getIsAdministrator()

bool 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 108 of file BackendUser.php.

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

getIsDisabled()

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

(

)

Checks whether this user is disabled.

Returns

‪bool whether this user is disabled

Definition at line 128 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()

DateTime null TYPO3\CMS\Extbase\Domain\Model\BackendUser::getLastLoginDateAndTime

(

)

Gets this user's last login date and time.

Returns

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

Definition at line 288 of file BackendUser.php.

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

getRealName()

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

(

)

Returns this user's real name.

Returns

‪string the real name. might be empty

Definition at line 208 of file BackendUser.php.

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

getStartDateAndTime()

DateTime null TYPO3\CMS\Extbase\Domain\Model\BackendUser::getStartDateAndTime

(

)

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

Returns

‪\DateTime|null the start date and time

Definition at line 148 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()

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

(

)

Gets the user name.

Returns

‪string the user name, will not be empty

Definition at line 72 of file BackendUser.php.

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

isActivated()

bool 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 230 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()

bool 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 254 of file BackendUser.php.

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

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

isActivatedViaStartDateAndTime()

bool 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 240 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 98 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

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

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

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

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

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

Definition at line 298 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 218 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

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

Definition at line 82 of file BackendUser.php.

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

Member Data Documentation

$description

string 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

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

protected

Definition at line 53 of file BackendUser.php.

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

$endDateAndTime

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

protected

Definition at line 49 of file BackendUser.php.

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

$ipLockIsDisabled

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

protected

Definition at line 65 of file BackendUser.php.

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

$isAdministrator

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

protected

Definition at line 37 of file BackendUser.php.

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

$isDisabled

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

protected

Definition at line 41 of file BackendUser.php.

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

$lastLoginDateAndTime

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

protected

Definition at line 61 of file BackendUser.php.

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

$realName

string 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

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

protected

Definition at line 45 of file BackendUser.php.

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

$userName

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

protected

@Extbase\Validate("NotEmpty")

Definition at line 29 of file BackendUser.php.

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