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

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

Public Member Functions
	setAllowedLanguages ($allowedLanguages)
string	getAllowedLanguages ()
	setDbMountPoints ($dbMountPoints)
string	getDbMountPoints ()
	setFileMountPoints ($fileMountPoints)
string	getFileMountPoints ()
bool	isActive ()
	setBackendUserGroups ($backendUserGroups)
ObjectStorage< BackendUserGroup >	getBackendUserGroups ()
bool	isCurrentlyLoggedIn ()
bool	isPasswordResetEnabled ()
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 ()
DateTime null	getLastLoginDateAndTime ()
	setLastLoginDateAndTime (\DateTime $dateAndTime=null)
	getBackendUser ()
‪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 = ''
ObjectStorage< BackendUserGroup >	$backendUserGroups
string	$allowedLanguages = ''
string	$dbMountPoints = ''
string	$description = ''
string	$fileMountPoints = ''
bool	$isAdministrator = false
bool	$isDisabled = false
DateTime null	$startDateAndTime
DateTime null	$endDateAndTime
string	$email = ''
string	$realName = ''
DateTime null	$lastLoginDateAndTime
‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
int	$uid
int	$_localizedUid
int	$_languageUid
int	$_versionedUid
int	$pid

Detailed Description

Model for backend user

This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.

Definition at line 29 of file BackendUser.php.

Member Function Documentation

getAllowedLanguages()

string TYPO3\CMS\Beuser\Domain\Model\BackendUser::getAllowedLanguages

(

)

Returns

‪string

Definition at line 98 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\$allowedLanguages.

getBackendUser()

TYPO3\CMS\Beuser\Domain\Model\BackendUser::getBackendUser

(

)

Gets the currently logged in backend user

Definition at line 411 of file BackendUser.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Beuser\Domain\Model\BackendUser\isCurrentlyLoggedIn(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\isPasswordResetEnabled().

getBackendUserGroups()

ObjectStorage<BackendUserGroup> TYPO3\CMS\Beuser\Domain\Model\BackendUser::getBackendUserGroups

(

)

Returns

‪ObjectStorage<BackendUserGroup>

Definition at line 160 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\$backendUserGroups.

getDbMountPoints()

string TYPO3\CMS\Beuser\Domain\Model\BackendUser::getDbMountPoints

(

)

Returns

‪string

Definition at line 114 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\$dbMountPoints.

getDescription()

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

(

)

Returns

‪string

Definition at line 215 of file BackendUser.php.

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

getEmail()

string TYPO3\CMS\Beuser\Domain\Model\BackendUser::getEmail

(

)

Gets the e-mail address of this user.

Returns

‪string the e-mail address, might be empty

Definition at line 313 of file BackendUser.php.

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

getEndDateAndTime()

DateTime null TYPO3\CMS\Beuser\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 293 of file BackendUser.php.

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

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

getFileMountPoints()

string TYPO3\CMS\Beuser\Domain\Model\BackendUser::getFileMountPoints

(

)

Returns

‪string

Definition at line 130 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\$fileMountPoints.

getIsAdministrator()

bool TYPO3\CMS\Beuser\Domain\Model\BackendUser::getIsAdministrator

(

)

Checks whether this user is an administrator.

Returns

‪bool whether this user is an administrator

Definition at line 233 of file BackendUser.php.

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

getIsDisabled()

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

(

)

Checks whether this user is disabled.

Returns

‪bool whether this user is disabled

Definition at line 253 of file BackendUser.php.

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

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

getLastLoginDateAndTime()

DateTime null TYPO3\CMS\Beuser\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 393 of file BackendUser.php.

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

getRealName()

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

(

)

Returns this user's real name.

Returns

‪string the real name. might be empty

Definition at line 333 of file BackendUser.php.

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

getStartDateAndTime()

DateTime null TYPO3\CMS\Beuser\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 273 of file BackendUser.php.

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

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

getUserName()

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

(

)

Gets the user name.

Returns

‪string the user name, will not be empty

Definition at line 197 of file BackendUser.php.

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

isActivated()

bool TYPO3\CMS\Beuser\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 355 of file BackendUser.php.

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

isActivatedViaEndDateAndTime()

bool TYPO3\CMS\Beuser\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 379 of file BackendUser.php.

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

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

isActivatedViaStartDateAndTime()

bool TYPO3\CMS\Beuser\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 365 of file BackendUser.php.

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

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

isActive()

bool TYPO3\CMS\Beuser\Domain\Model\BackendUser::isActive

(

)

Check if user is active, not disabled

Returns

‪bool

Definition at line 140 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\getEndDateAndTime(), TYPO3\CMS\Beuser\Domain\Model\BackendUser\getIsDisabled(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\getStartDateAndTime().

isCurrentlyLoggedIn()

bool TYPO3\CMS\Beuser\Domain\Model\BackendUser::isCurrentlyLoggedIn

(

)

Check if user is currently logged in

Returns

‪bool

Definition at line 170 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\getBackendUser(), and TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject\getUid().

Referenced by TYPO3\CMS\Beuser\Domain\Model\BackendUser\isPasswordResetEnabled().

isPasswordResetEnabled()

bool TYPO3\CMS\Beuser\Domain\Model\BackendUser::isPasswordResetEnabled

(

)

Check if the user is allowed to trigger a password reset

Requirements:

1. ‪The user for which the password reset should be triggered is not the currently logged in user
2. ‪Password reset is enabled for the user (Email+Password are set)
3. ‪The currently logged in user is allowed to reset passwords in the backend (Enabled in user TSconfig)

Returns

‪bool

Definition at line 185 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\getBackendUser(), TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject\getUid(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\isCurrentlyLoggedIn().

setAllowedLanguages()

TYPO3\CMS\Beuser\Domain\Model\BackendUser::setAllowedLanguages

(

$allowedLanguages

)

Parameters

string

$allowedLanguages

Definition at line 90 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\$allowedLanguages.

setBackendUserGroups()

TYPO3\CMS\Beuser\Domain\Model\BackendUser::setBackendUserGroups

(

$backendUserGroups

)

Parameters

ObjectStorage<BackendUserGroup>

‪$backendUserGroups

Definition at line 152 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\$backendUserGroups.

setDbMountPoints()

TYPO3\CMS\Beuser\Domain\Model\BackendUser::setDbMountPoints

(

$dbMountPoints

)

Parameters

string

$dbMountPoints

Definition at line 106 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\$dbMountPoints.

setDescription()

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

(

$description

)

Parameters

string

$description

Definition at line 223 of file BackendUser.php.

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

setEmail()

TYPO3\CMS\Beuser\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 323 of file BackendUser.php.

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

setEndDateAndTime()

TYPO3\CMS\Beuser\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 303 of file BackendUser.php.

setFileMountPoints()

TYPO3\CMS\Beuser\Domain\Model\BackendUser::setFileMountPoints

(

$fileMountPoints

)

Parameters

string

$fileMountPoints

Definition at line 122 of file BackendUser.php.

References TYPO3\CMS\Beuser\Domain\Model\BackendUser\$fileMountPoints.

setIsAdministrator()

TYPO3\CMS\Beuser\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 243 of file BackendUser.php.

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

setIsDisabled()

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

(

$isDisabled

)

Sets whether this user is disabled.

Parameters

bool

$isDisabled

‪whether this user is disabled

Definition at line 263 of file BackendUser.php.

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

setLastLoginDateAndTime()

TYPO3\CMS\Beuser\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 403 of file BackendUser.php.

setRealName()

TYPO3\CMS\Beuser\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 343 of file BackendUser.php.

setStartDateAndTime()

TYPO3\CMS\Beuser\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 283 of file BackendUser.php.

setUserName()

TYPO3\CMS\Beuser\Domain\Model\BackendUser::setUserName

(

$userName

)

Sets the user name.

Parameters

string

$userName

‪the user name to set, must not be empty

Definition at line 207 of file BackendUser.php.

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

Member Data Documentation

$allowedLanguages

string TYPO3\CMS\Beuser\Domain\Model\BackendUser::$allowedLanguages = ''

protected

Comma separated list of uids in multi-select Might retrieve the labels from TCA/DataMapper

Definition at line 45 of file BackendUser.php.

Referenced by TYPO3\CMS\Beuser\Domain\Model\BackendUser\getAllowedLanguages(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\setAllowedLanguages().

$backendUserGroups

ObjectStorage<BackendUserGroup> TYPO3\CMS\Beuser\Domain\Model\BackendUser::$backendUserGroups

protected

Definition at line 38 of file BackendUser.php.

Referenced by TYPO3\CMS\Beuser\Domain\Model\BackendUser\getBackendUserGroups(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\setBackendUserGroups().

$dbMountPoints

string TYPO3\CMS\Beuser\Domain\Model\BackendUser::$dbMountPoints = ''

protected

Definition at line 49 of file BackendUser.php.

Referenced by TYPO3\CMS\Beuser\Domain\Model\BackendUser\getDbMountPoints(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\setDbMountPoints().

$description

string TYPO3\CMS\Beuser\Domain\Model\BackendUser::$description = ''

protected

Definition at line 53 of file BackendUser.php.

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

$email

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

protected

Definition at line 77 of file BackendUser.php.

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

$endDateAndTime

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

protected

Definition at line 73 of file BackendUser.php.

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

$fileMountPoints

string TYPO3\CMS\Beuser\Domain\Model\BackendUser::$fileMountPoints = ''

protected

Definition at line 57 of file BackendUser.php.

Referenced by TYPO3\CMS\Beuser\Domain\Model\BackendUser\getFileMountPoints(), and TYPO3\CMS\Beuser\Domain\Model\BackendUser\setFileMountPoints().

$isAdministrator

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

protected

Definition at line 61 of file BackendUser.php.

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

$isDisabled

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

protected

Definition at line 65 of file BackendUser.php.

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

$lastLoginDateAndTime

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

protected

Definition at line 85 of file BackendUser.php.

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

$realName

string TYPO3\CMS\Beuser\Domain\Model\BackendUser::$realName = ''

protected

Definition at line 81 of file BackendUser.php.

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

$startDateAndTime

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

protected

Definition at line 69 of file BackendUser.php.

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

$userName

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

protected

@Extbase\Validate("NotEmpty")

Definition at line 34 of file BackendUser.php.

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