BackendUser extends AbstractEntity

Model for backend user

Internal

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

Table of Contents

Constants

PROPERTY_LANGUAGE_UID  = '_languageUid'
PROPERTY_LOCALIZED_UID  = '_localizedUid'
PROPERTY_PID  = 'pid'
PROPERTY_UID  = 'uid'
PROPERTY_VERSIONED_UID  = '_versionedUid'

Properties

$_languageUid  : int<-1, max>|null
$_localizedUid  : int<0, max>|null
$_versionedUid  : int|null
The uid of the versioned record.
$allowedLanguages  : string
Comma separated list of uids in multi-select Might retrieve the labels from TCA/DataMapper
$backendUserGroups  : ObjectStorage<string|int, BackendUserGroup>
$dbMountPoints  : string
$description  : string
$email  : string
$endDateAndTime  : DateTime|null
$fileMountPoints  : string
$isAdministrator  : bool
$isDisabled  : bool
$lastLoginDateAndTime  : DateTime|null
$pid  : int<0, max>|null
$realName  : string
$startDateAndTime  : DateTime|null
$uid  : int<1, max>|null
$userName  : string

Methods

__clone()  : mixed
__toString()  : non-empty-string
_getCleanProperties()  : array<non-empty-string, mixed>
Returns a hash map of clean properties and $values.
_getCleanProperty()  : mixed
Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.
_getProperties()  : array<non-empty-string, mixed>
_getProperty()  : mixed
_hasProperty()  : bool
_isClone()  : bool
_isDirty()  : bool
Returns TRUE if the properties were modified after reconstitution
_isNew()  : bool
Returns TRUE if the object is new (the uid was not set, yet)
_memorizeCleanState()  : void
Register an object's clean state, e.g. after it has been reconstituted from the database.
_memorizePropertyCleanState()  : void
Register a property's clean state, e.g. after it has been reconstituted from the database.
_setClone()  : mixed
Setter whether this Domain Object is a clone of another one.
_setProperty()  : bool
getAllowedLanguages()  : string
getBackendUser()  : BackendUserAuthentication
getBackendUserGroups()  : ObjectStorage<string|int, BackendUserGroup>
getDbMountPoints()  : string
getDescription()  : string
getEmail()  : string
Gets the e-mail address of this user.
getEndDateAndTime()  : DateTime|null
Returns the point in time before which this user is enabled.
getFileMountPoints()  : string
getIsAdministrator()  : bool
Checks whether this user is an administrator.
getIsDisabled()  : bool
Checks whether this user is disabled.
getLastLoginDateAndTime()  : DateTime|null
Gets this user's last login date and time.
getPid()  : int<0, max>|null
getRealName()  : string
Returns this user's real name.
getStartDateAndTime()  : DateTime|null
Returns the point in time from which this user is enabled.
getUid()  : int<1, max>|null
getUserName()  : string
Gets the user name.
isActivated()  : bool
Checks whether this user is currently activated.
isActive()  : bool
Check if user is active, not disabled
isCurrentlyLoggedIn()  : bool
Check if user is currently logged in
isPasswordResetEnabled()  : bool
Check if the user is allowed to trigger a password reset
setAllowedLanguages()  : mixed
setBackendUserGroups()  : mixed
setDbMountPoints()  : mixed
setDescription()  : mixed
setEmail()  : mixed
Sets the e-mail address of this user.
setEndDateAndTime()  : mixed
Sets the point in time before which this user is enabled.
setFileMountPoints()  : mixed
setIsAdministrator()  : mixed
Sets whether this user should be an administrator.
setIsDisabled()  : mixed
Sets whether this user is disabled.
setLastLoginDateAndTime()  : mixed
Sets this user's last login date and time.
setPid()  : void
setRealName()  : mixed
Sets this user's real name.
setStartDateAndTime()  : mixed
Sets the point in time from which this user is enabled.
setUserName()  : mixed
Sets the user name.
isActivatedViaEndDateAndTime()  : bool
Checks whether this user is activated as far as the end date and time is concerned.
isActivatedViaStartDateAndTime()  : bool
Checks whether this user is activated as far as the start date and time is concerned.
isPropertyDirty()  : bool
Checks the $value against the $cleanState.

Constants

PROPERTY_LANGUAGE_UID

public mixed PROPERTY_LANGUAGE_UID = '_languageUid'

PROPERTY_LOCALIZED_UID

public mixed PROPERTY_LOCALIZED_UID = '_localizedUid'

PROPERTY_PID

public mixed PROPERTY_PID = 'pid'

PROPERTY_UID

public mixed PROPERTY_UID = 'uid'

PROPERTY_VERSIONED_UID

public mixed PROPERTY_VERSIONED_UID = '_versionedUid'

Properties

$_languageUid

protected int<-1, max>|null $_languageUid = null

The uid of the language of the object. This is the id of the corresponding sing language.

Internal
Tags
todo

make private in 13.0 and expose value via getter

$_localizedUid

protected int<0, max>|null $_localizedUid = null

The uid of the localized record. Holds the uid of the record in default language (the translationOrigin).

Internal
Tags
todo

make private in 13.0 and expose value via getter

$_versionedUid

The uid of the versioned record.

protected int|null $_versionedUid = null
Internal
Tags
todo

make private in 13.0 and expose value via getter

$allowedLanguages

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

protected string $allowedLanguages = ''

$dbMountPoints

protected string $dbMountPoints = ''

$description

protected string $description = ''

$endDateAndTime

protected DateTime|null $endDateAndTime

$fileMountPoints

protected string $fileMountPoints = ''

$isAdministrator

protected bool $isAdministrator = false

$isDisabled

protected bool $isDisabled = false

$lastLoginDateAndTime

protected DateTime|null $lastLoginDateAndTime

$pid

protected int<0, max>|null $pid

The id of the page the record is "stored".

Tags
todo

introduce type declarations in 13.0 (possibly breaking)

$startDateAndTime

protected DateTime|null $startDateAndTime

$uid

protected int<1, max>|null $uid

The uid of the record. The uid is only unique in the context of the database table.

Tags
todo

introduce type declarations in 13.0 (possibly breaking)

$userName

protected string $userName = ''
Tags
Extbase\Validate

("NotEmpty")

Methods

__toString()

public __toString() : non-empty-string
Return values
non-empty-string

_getCleanProperties()

Returns a hash map of clean properties and $values.

public _getCleanProperties() : array<non-empty-string, mixed>
Return values
array<non-empty-string, mixed>

_getCleanProperty()

Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.

public _getCleanProperty(non-empty-string $propertyName) : mixed
Parameters
$propertyName : non-empty-string

The name of the property to be memorized.

Internal
Return values
mixed —

The clean property value or NULL

_getProperties()

public _getProperties() : array<non-empty-string, mixed>
Internal
Return values
array<non-empty-string, mixed> —

a hash map of property names and property values.

_getProperty()

public _getProperty(string $propertyName) : mixed
Parameters
$propertyName : string
Internal

_hasProperty()

public _hasProperty(non-empty-string $propertyName) : bool
Parameters
$propertyName : non-empty-string
Internal
Return values
bool

_isClone()

public _isClone() : bool
Return values
bool

_isDirty()

Returns TRUE if the properties were modified after reconstitution

public _isDirty([non-empty-string|null $propertyName = null ]) : bool
Parameters
$propertyName : non-empty-string|null = null

An optional name of a property to be checked if its value is dirty

Tags
throws
TooDirtyException
Return values
bool

_isNew()

Returns TRUE if the object is new (the uid was not set, yet)

public _isNew() : bool
Internal
Return values
bool

_memorizeCleanState()

Register an object's clean state, e.g. after it has been reconstituted from the database.

public _memorizeCleanState([non-empty-string|null $propertyName = null ]) : void
Parameters
$propertyName : non-empty-string|null = null

The name of the property to be memorized. If omitted all persistable properties are memorized.

_memorizePropertyCleanState()

Register a property's clean state, e.g. after it has been reconstituted from the database.

public _memorizePropertyCleanState(non-empty-string $propertyName) : void
Parameters
$propertyName : non-empty-string

The name of the property to be memorized. If omitted all persistable properties are memorized.

_setClone()

Setter whether this Domain Object is a clone of another one.

public _setClone(bool $clone) : mixed

NEVER SET THIS PROPERTY DIRECTLY. We currently need it to make the _isDirty check inside AbstractEntity work, but it is just a work- around right now.

Parameters
$clone : bool
Internal

_setProperty()

public _setProperty(string $propertyName, mixed $propertyValue) : bool
Parameters
$propertyName : string
$propertyValue : mixed
Internal
Return values
bool

getAllowedLanguages()

public getAllowedLanguages() : string
Return values
string

getDbMountPoints()

public getDbMountPoints() : string
Return values
string

getDescription()

public getDescription() : string
Return values
string

getEmail()

Gets the e-mail address of this user.

public getEmail() : string
Return values
string —

the e-mail address, might be empty

getEndDateAndTime()

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

public getEndDateAndTime() : DateTime|null
Return values
DateTime|null —

the end date and time

getFileMountPoints()

public getFileMountPoints() : string
Return values
string

getIsAdministrator()

Checks whether this user is an administrator.

public getIsAdministrator() : bool
Return values
bool —

whether this user is an administrator

getIsDisabled()

Checks whether this user is disabled.

public getIsDisabled() : bool
Return values
bool —

whether this user is disabled

getLastLoginDateAndTime()

Gets this user's last login date and time.

public getLastLoginDateAndTime() : DateTime|null
Return values
DateTime|null —

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

getPid()

public getPid() : int<0, max>|null
Return values
int<0, max>|null

getRealName()

Returns this user's real name.

public getRealName() : string
Return values
string —

the real name. might be empty

getStartDateAndTime()

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

public getStartDateAndTime() : DateTime|null
Return values
DateTime|null —

the start date and time

getUid()

public getUid() : int<1, max>|null
Return values
int<1, max>|null

getUserName()

Gets the user name.

public getUserName() : string
Return values
string —

the user name, will not be empty

isActivated()

Checks whether this user is currently activated.

public isActivated() : bool

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

Return values
bool —

whether this user is currently activated

isActive()

Check if user is active, not disabled

public isActive() : bool
Return values
bool

isCurrentlyLoggedIn()

Check if user is currently logged in

public isCurrentlyLoggedIn() : bool
Return values
bool

isPasswordResetEnabled()

Check if the user is allowed to trigger a password reset

public isPasswordResetEnabled() : bool

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)
Return values
bool

setAllowedLanguages()

public setAllowedLanguages(string $allowedLanguages) : mixed
Parameters
$allowedLanguages : string

setDbMountPoints()

public setDbMountPoints(string $dbMountPoints) : mixed
Parameters
$dbMountPoints : string

setDescription()

public setDescription(string $description) : mixed
Parameters
$description : string

setEmail()

Sets the e-mail address of this user.

public setEmail(string $email) : mixed
Parameters
$email : string

the e-mail address, may be empty

setEndDateAndTime()

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

public setEndDateAndTime([DateTime|null $dateAndTime = null ]) : mixed
Parameters
$dateAndTime : DateTime|null = null

the end date and time

setFileMountPoints()

public setFileMountPoints(string $fileMountPoints) : mixed
Parameters
$fileMountPoints : string

setIsAdministrator()

Sets whether this user should be an administrator.

public setIsAdministrator(bool $isAdministrator) : mixed
Parameters
$isAdministrator : bool

whether this user should be an administrator

setIsDisabled()

Sets whether this user is disabled.

public setIsDisabled(bool $isDisabled) : mixed
Parameters
$isDisabled : bool

whether this user is disabled

setLastLoginDateAndTime()

Sets this user's last login date and time.

public setLastLoginDateAndTime([DateTime|null $dateAndTime = null ]) : mixed
Parameters
$dateAndTime : DateTime|null = null

this user's last login date and time

setPid()

public setPid(int<0, max> $pid) : void
Parameters
$pid : int<0, max>

setRealName()

Sets this user's real name.

public setRealName(string $name) : mixed
Parameters
$name : string

the user's real name, may be empty.

setStartDateAndTime()

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

public setStartDateAndTime([DateTime|null $dateAndTime = null ]) : mixed
Parameters
$dateAndTime : DateTime|null = null

the start date and time

setUserName()

Sets the user name.

public setUserName(string $userName) : mixed
Parameters
$userName : string

the user name to set, must not be empty

isActivatedViaEndDateAndTime()

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

protected isActivatedViaEndDateAndTime() : bool
Return values
bool —

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

isActivatedViaStartDateAndTime()

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

protected isActivatedViaStartDateAndTime() : bool
Return values
bool —

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

isPropertyDirty()

Checks the $value against the $cleanState.

protected isPropertyDirty(mixed $previousValue, mixed $currentValue) : bool
Parameters
$previousValue : mixed
$currentValue : mixed
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results