‪TYPO3CMS  9.5
TYPO3\CMS\Backend\FrontendBackendUserAuthentication Class Reference
Inheritance diagram for TYPO3\CMS\Backend\FrontendBackendUserAuthentication:
TYPO3\CMS\Core\Authentication\BackendUserAuthentication TYPO3\CMS\Core\Authentication\AbstractUserAuthentication TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait

Public Member Functions

 initializeAdminPanel ()
 
 initializeFrontendEdit ()
 
bool isFrontendEditingActive ()
 
string displayAdminPanel ()
 
bool isAdminPanelVisible ()
 
bool checkBackendAccessSettingsFromInitPhp ()
 
bool backendCheckLogin ($proceedIfNoUserIsLoggedIn=false)
 
bool extPageReadAccess ($pageRec)
 
string extGetTreeList ($id, $depth, $begin=0, $perms_clause)
 
bool allowedToEditLanguage ($table, array $currentRecord)
 
bool allowedToEdit (string $table, array $dataArray, array $conf, bool $checkEditAccessInternals)
 
array getAllowedEditActions ($table, array $conf, $pid)
 
string extGetLL ($key)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
 __construct ()
 
bool isAdmin ()
 
bool isMemberOfGroup ($groupId)
 
bool doesUserHaveAccess ($row, $perms)
 
int null isInWebMount ($idOrRow, $readPerms='', $exitOnError=0)
 
bool modAccess ($conf, $exitOnError=null)
 
bool isSystemMaintainer ()
 
string getPagePermsClause ($perms)
 
int calcPerms ($row)
 
bool isRTE ()
 
bool check ($type, $value)
 
bool checkAuthMode ($table, $field, $value, $authMode)
 
bool checkLanguageAccess ($langValue)
 
bool checkFullLanguagesAccess ($table, $record)
 
bool recordEditAccessInternals ($table, $idOrRow, $newRecord=false, $deletedRecord=false, $checkFullLanguageAccess=false)
 
bool isPSet ($compiledPermissions, $tableName, $actionType='')
 
bool mayMakeShortcut ()
 
string workspaceCannotEditRecord ($table, $recData)
 
string workspaceCannotEditOfflineVersion ($table, $recData)
 
mixed workspaceAllowLiveRecordsInPID ($pid, $table)
 
bool workspaceCreateNewRecord ($pid, $table)
 
bool workspaceAllowAutoCreation ($table, $id, $recpid)
 
bool workspaceCheckStageForCurrent ($stage)
 
bool workspacePublishAccess ($wsid)
 
bool workspaceSwapAccess ()
 
array getTSConfig ($objectString=null, $config=null)
 
string getTSConfigVal ($objectString)
 
array getTSConfigProp ($objectString)
 
array returnWebmounts ()
 
 setWebmounts (array $mountPointUids, $append=false)
 
 initializeWebmountsForElementBrowser ()
 
bool jsConfirmation ($bitmask)
 
 fetchGroupData ()
 
 fetchGroups ($grList, $idList='')
 
 setCachedList ($cList)
 
array getCategoryMountPoints ()
 
array getFileMountRecords ()
 
TYPO3 CMS Core Resource ResourceStorage[] getFileStorages ()
 
 evaluateUserSpecificFileFilterSettings ()
 
array getFilePermissions ()
 
array getFilePermissionsForStorage (\TYPO3\CMS\Core\Resource\ResourceStorage $storageObject)
 
TYPO3 CMS Core Resource Folder bool getDefaultUploadFolder ($pid=null, $table=null, $field=null)
 
TYPO3 CMS Core Resource Folder null getDefaultUploadTemporaryFolder ()
 
string addTScomment ($str)
 
 workspaceInit ()
 
array checkWorkspace ($wsRec, $fields='uid, title, adminusers, members, reviewers, publish_access, stagechg_notification')
 
array checkWorkspaceCurrent ()
 
 setWorkspace ($workspaceId)
 
bool setTemporaryWorkspace ($workspaceId)
 
 setDefaultWorkspace ()
 
int getDefaultWorkspace ()
 
int writelog ($type, $action, $error, $details_nr, $details, $data, $tablename='', $recuid='', $recpid='', $event_pid=-1, $NEWid='', $userId=0)
 
int simplelog ($message, $extKey='', $error=0)
 
 checkLogFailures ($email, $secondsBack=3600, $max=3)
 
bool checkLockToIP ()
 
 backendSetUC ()
 
 overrideUC ()
 
 resetUC ()
 
 logoff ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
 start ()
 
bool isSetSessionCookie ()
 
bool isRefreshTimeBasedCookie ()
 
 checkAuthentication ()
 
string createSessionId ()
 
array createUserSession ($tempuser)
 
array getNewSessionRecord ($tempuser)
 
array bool fetchUserSession ($skipSessionUpdate=false)
 
 enforceNewSessionId ()
 
 removeCookie ($cookieName)
 
bool isExistingSessionRecord ($id)
 
bool isCookieSet ()
 
 writeUC ($variable='')
 
 unpack_uc ($theUC='')
 
 pushModuleData ($module, $data, $noSave=0)
 
mixed getModuleData ($module, $type='')
 
mixed getSessionData ($key)
 
 setSessionData ($key, $data)
 
 setAndSaveSessionData ($key, $data)
 
array getLoginFormData ()
 
array processLoginData ($loginData, $passwordTransmissionStrategy='')
 
array getAuthInfoArray ()
 
bool compareUident ($user, $loginData, $passwordCompareStrategy='')
 
 gc ()
 
 writelog ($type, $action, $error, $details_nr, $details, $data, $tablename, $recuid, $recpid)
 
 setBeUserByUid ($uid)
 
 setBeUserByName ($name)
 
array getRawUserByUid ($uid)
 
array getRawUserByName ($name)
 
mixed fetchUserRecord ($dbUser, $username, $extraWhere='')
 
string getSessionId ()
 
string getLoginType ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait
bool __isset (string $propertyName)
 
mixed __get (string $propertyName)
 
 __set (string $propertyName, $propertyValue)
 
 __unset (string $propertyName)
 

Public Attributes

string $formfield_uname = ''
 
string $formfield_uident = ''
 
string $formfield_status = ''
 
bool $writeStdLog = false
 
bool $writeAttemptLog = false
 
bool $extAdmEnabled = false
 
TYPO3 CMS Adminpanel View AdminPanelView $adminPanel
 
TYPO3 CMS Core FrontendEditing FrontendEditingController $frontendEdit
 
array $extAdminConfig = array( )
 
- ‪Public Attributes inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
const ROLE_SYSTEMMAINTAINER = 'systemMaintainer'
 
string $usergroup_column = 'usergroup'
 
string $usergroup_table = 'be_groups'
 
array $groupData
 
array $userGroups = array( )
 
array $userGroupsUID = array( )
 
string $groupList = ''
 
int $workspace = -99
 
array $workspaceRec = array( )
 
array $dataLists
 
array $includeGroupArray = array( )
 
string $errorMsg = ''
 
string $user_table = 'be_users'
 
string $username_column = 'username'
 
string $userident_column = 'password'
 
string $userid_column = 'uid'
 
string $lastLogin_column = 'lastlogin'
 
array $enablecolumns
 
string $formfield_uname = 'username'
 
string $formfield_uident = 'userident'
 
string $formfield_status = 'login_status'
 
bool $writeStdLog = true
 
bool $writeAttemptLog = true
 
int $sessionTimeout = 28800
 
int $firstMainGroup = 0
 
array $uc
 
array $uc_default
 
- ‪Public Attributes inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
string $name = ''
 
string $get_name = ''
 
string $user_table = ''
 
string $usergroup_table = ''
 
string $username_column = ''
 
string $userident_column = ''
 
string $userid_column = ''
 
string $usergroup_column = ''
 
string $lastLogin_column = ''
 
array $enablecolumns
 
bool $showHiddenRecords = false
 
string $formfield_uname = ''
 
string $formfield_uident = ''
 
string $formfield_status = ''
 
int $sessionTimeout = 0
 
string $auth_timeout_field = ''
 
int $lifetime = 0
 
int $gc_time = 0
 
int $gc_probability = 1
 
bool $writeStdLog = false
 
bool $writeAttemptLog = false
 
bool $sendNoCacheHeaders = true
 
bool $getFallBack = false
 
int $hash_length = 32
 
bool $getMethodEnabled = false
 
int $lockIP = 4
 
string $warningEmail = ''
 
int $warningPeriod = 3600
 
int $warningMax = 3
 
bool $checkPid = true
 
int $checkPid_value = 0
 
string $id
 
bool $loginFailure = false
 
bool $loginSessionStarted = false
 
array null $user
 
string $get_URL_ID = ''
 
bool $newSessionID = false
 
bool $forceSetCookie = false
 
bool $dontSetCookie = false
 
string $loginType = ''
 
array $svConfig = array( )
 
array $uc
 

Protected Member Functions

LanguageService getLanguageService ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
 getRealUserId ()
 
 initializeFileStorages ()
 
 initializeDbMountpointsInWorkspace ()
 
bool isUserAllowedToLogin ()
 
 releaseLockedRecords (int $userId)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
 sendHttpHeaders ()
 
array getHttpHeaders ()
 
 setSessionCookie ()
 
string getCookieDomain ()
 
string getCookie ($cookieName)
 
Traversable getAuthServices (string $subType, array $loginData, array $authInfo)
 
 regenerateSessionId (array $existingSessionRecord=[], bool $anonymous=false)
 
 updateLoginTimestamp (int $userId)
 
 performLogoff ()
 
QueryRestrictionContainerInterface userConstraints ()
 
string ipLockClause_remoteIPNumber ($parts)
 
mixed removeSensitiveLoginDataForLoggingInfo ($data, bool $isUserRecord=false)
 
SessionBackendInterface getSessionBackend ()
 

Additional Inherited Members

- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
static string getCookieName ()
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication
array $deprecatedPublicProperties
 
array $TSdataArray = array( )
 
string $userTS_text = ''
 
array $userTS = array( )
 
bool $userTSUpdated = false
 
bool $userTS_dontGetCached = false
 
array null $checkWorkspaceCurrent_cache
 
TYPO3 CMS Core Resource ResourceStorage[] $fileStorages
 
array $filePermissions
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication
bool $cookieWasSetOnCurrentRequest = false
 
SessionBackendInterface $sessionBackend
 
array $sessionData = array( )
 

Detailed Description

TYPO3 backend user authentication in the TSFE frontend. This includes mainly functions related to the Admin Panel

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

Definition at line 34 of file FrontendBackendUserAuthentication.php.

Member Function Documentation

◆ allowedToEdit()

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::allowedToEdit ( string  $table,
array  $dataArray,
array  $conf,
bool  $checkEditAccessInternals 
)

Checks whether the user is allowed to edit the requested table.

Parameters
string$table‪The name of the table.
array$dataArray‪The data array.
array$conf‪The configuration array for the edit panel.
bool$checkEditAccessInternals‪Boolean indicating whether recordEditAccessInternals should not be checked. Defaults
Returns
‪bool

Definition at line 320 of file FrontendBackendUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\BackendUserAuthentication\calcPerms(), TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Core\Authentication\BackendUserAuthentication\doesUserHaveAccess(), TYPO3\CMS\Backend\FrontendBackendUserAuthentication\getAllowedEditActions(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isAdmin(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT, and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\recordEditAccessInternals().

◆ allowedToEditLanguage()

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::allowedToEditLanguage (   $table,
array  $currentRecord 
)

Edit Access Checks whether the user has access to edit the language for the requested record.

Parameters
string$table‪The name of the table.
array$currentRecord‪The record.
Returns
‪bool

Definition at line 294 of file FrontendBackendUserAuthentication.php.

References $GLOBALS, and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\checkLanguageAccess().

◆ backendCheckLogin()

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::backendCheckLogin (   $proceedIfNoUserIsLoggedIn = false)

Implementing the access checks that the TYPO3 CMS bootstrap script does before a user is ever logged in. Used in the frontend.

Parameters
bool$proceedIfNoUserIsLoggedIn
Returns
‪bool Returns TRUE if access is OK

Reimplemented from TYPO3\CMS\Core\Authentication\BackendUserAuthentication.

Definition at line 194 of file FrontendBackendUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\BackendUserAuthentication\checkLockToIP(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isUserAllowedToLogin().

Referenced by TYPO3\CMS\Frontend\Middleware\BackendUserAuthenticator\isAuthenticated().

◆ checkBackendAccessSettingsFromInitPhp()

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::checkBackendAccessSettingsFromInitPhp ( )

Implementing the access checks that the TYPO3 CMS bootstrap script does before a user is ever logged in. Used in the frontend.

Returns
‪bool Returns TRUE if access is OK
Deprecated:
‪since TYPO3 v9.4, will be removed in TYPO3 v10.0.

Definition at line 162 of file FrontendBackendUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\BackendUserAuthentication\checkLockToIP(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isUserAllowedToLogin().

◆ displayAdminPanel()

string TYPO3\CMS\Backend\FrontendBackendUserAuthentication::displayAdminPanel ( )

Delegates to the appropriate view and renders the admin panel content.

Deprecated:
‪since TYPO3 v9 - see ext "adminpanel" for new API
Returns
‪string.

Definition at line 132 of file FrontendBackendUserAuthentication.php.

◆ extGetLL()

string TYPO3\CMS\Backend\FrontendBackendUserAuthentication::extGetLL (   $key)

Returns the label for key. If a translation for the language set in $this->uc['lang'] is found that is returned, otherwise the default value. If the global variable $LOCAL_LANG is NOT an array (yet) then this function loads the global $LOCAL_LANG array with the content of "EXT:core/Resources/Private/Language/locallang_tsfe.xlf" such that the values therein can be used for labels in the Admin Panel

Parameters
string$key‪Key for a label in the $GLOBALS['LOCAL_LANG'] array of "EXT:core/Resources/Private/Language/locallang_tsfe.xlf
Returns
‪string The value for the $key
Deprecated:
‪since TYPO3 v9.5, will be removed in TYPO3 v10.0.

Definition at line 419 of file FrontendBackendUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Backend\FrontendBackendUserAuthentication\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\includeLLFile().

◆ extGetTreeList()

string TYPO3\CMS\Backend\FrontendBackendUserAuthentication::extGetTreeList (   $id,
  $depth,
  $begin = 0,
  $perms_clause 
)

Generates a list of Page-uid's from $id. List does not include $id itself The only pages excluded from the list are deleted pages.

Parameters
int$id‪Start page id
int$depth‪Depth to traverse down the page tree.
int$begin‪Is an optional integer that determines at which level in the tree to start collecting uid's. Zero means 'start right away', 1 = 'next level and out'
string$perms_clause‪Perms clause
Returns
‪string Returns the list with a comma in the end (if any pages selected!)
Deprecated:
‪since TYPO3 v9.5, will be removed in TYPO3 v10.0.

Definition at line 245 of file FrontendBackendUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\$id, and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

◆ extPageReadAccess()

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::extPageReadAccess (   $pageRec)

Evaluates if the Backend User has read access to the input page record. The evaluation is based on both read-permission and whether the page is found in one of the users webmounts. Only if both conditions match, will the function return TRUE.

Read access means that previewing is allowed etc.

Used in \TYPO3\CMS\Frontend\Http\RequestHandler

Parameters
array$pageRec‪The page record to evaluate for
Returns
‪bool TRUE if read access
Deprecated:
‪since TYPO3 v9.5, will be removed in TYPO3 v10.0. Use underlying calls directly.

Definition at line 223 of file FrontendBackendUserAuthentication.php.

References TYPO3\CMS\Core\Authentication\BackendUserAuthentication\doesUserHaveAccess(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isInWebMount(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

◆ getAllowedEditActions()

array TYPO3\CMS\Backend\FrontendBackendUserAuthentication::getAllowedEditActions (   $table,
array  $conf,
  $pid 
)

Takes an array of generally allowed actions and filters that list based on page and content permissions.

Parameters
string$table‪The name of the table.
array$conf‪The configuration array.
int$pid‪The PID where editing will occur.
Returns
‪array

Definition at line 371 of file FrontendBackendUserAuthentication.php.

References $GLOBALS, TYPO3\CMS\Core\Authentication\BackendUserAuthentication\calcPerms(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\checkLanguageAccess(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_DELETE, TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT, and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_NEW.

Referenced by TYPO3\CMS\Backend\FrontendBackendUserAuthentication\allowedToEdit().

◆ getLanguageService()

LanguageService TYPO3\CMS\Backend\FrontendBackendUserAuthentication::getLanguageService ( )
protected
Returns
‪LanguageService

Definition at line 434 of file FrontendBackendUserAuthentication.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\FrontendBackendUserAuthentication\extGetLL().

◆ initializeAdminPanel()

TYPO3\CMS\Backend\FrontendBackendUserAuthentication::initializeAdminPanel ( )

Initializes the admin panel.

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - rewritten as middleware

Definition at line 95 of file FrontendBackendUserAuthentication.php.

◆ initializeFrontendEdit()

TYPO3\CMS\Backend\FrontendBackendUserAuthentication::initializeFrontendEdit ( )

Initializes frontend editing.

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - rewritten as middleware

Definition at line 105 of file FrontendBackendUserAuthentication.php.

◆ isAdminPanelVisible()

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::isAdminPanelVisible ( )

Determines whether the admin panel is enabled and visible.

Deprecated:
‪since TYPO3 v9 - see ext "adminpanel" for new API
Returns
‪bool true if the admin panel is enabled and visible

Definition at line 144 of file FrontendBackendUserAuthentication.php.

References $GLOBALS.

◆ isFrontendEditingActive()

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::isFrontendEditingActive ( )

Determines whether frontend editing is currently active.

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - see ext "feedit" for API
Returns
‪bool Whether frontend editing is active

Definition at line 116 of file FrontendBackendUserAuthentication.php.

References $GLOBALS.

Member Data Documentation

◆ $adminPanel

TYPO3 CMS Adminpanel View AdminPanelView TYPO3\CMS\Backend\FrontendBackendUserAuthentication::$adminPanel

Instance of admin panel

Deprecated:
‪since TYPO3 v9, property will be removed in TYPO3 v10.0 - see extension "adminpanel" for new API

Definition at line 78 of file FrontendBackendUserAuthentication.php.

◆ $extAdmEnabled

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::$extAdmEnabled = false

General flag which is set if the adminpanel is enabled at all.

Deprecated:
‪since TYPO3 v9, property will be removed in TYPO3 v10.0 - see extension "adminpanel" for new API

Definition at line 73 of file FrontendBackendUserAuthentication.php.

◆ $extAdminConfig

array TYPO3\CMS\Backend\FrontendBackendUserAuthentication::$extAdminConfig = array( )
Deprecated:
‪since TYPO3 v9, property will be removed in TYPO3 v10.0 - see extension "adminpanel" for new API

Definition at line 88 of file FrontendBackendUserAuthentication.php.

◆ $formfield_status

string TYPO3\CMS\Backend\FrontendBackendUserAuthentication::$formfield_status = ''

Formfield_status should be set to "". The value this->formfield_status is set to empty in order to disable login-attempts to the backend account through this script

Definition at line 54 of file FrontendBackendUserAuthentication.php.

◆ $formfield_uident

string TYPO3\CMS\Backend\FrontendBackendUserAuthentication::$formfield_uident = ''

Form field with password.

Definition at line 47 of file FrontendBackendUserAuthentication.php.

◆ $formfield_uname

string TYPO3\CMS\Backend\FrontendBackendUserAuthentication::$formfield_uname = ''

Form field with login name.

Definition at line 41 of file FrontendBackendUserAuthentication.php.

◆ $frontendEdit

TYPO3 CMS Core FrontendEditing FrontendEditingController TYPO3\CMS\Backend\FrontendBackendUserAuthentication::$frontendEdit
Deprecated:
‪since TYPO3 v9, property will be removed in TYPO3 v10.0 - see extension "feedit" how the functionality could be used.

Definition at line 83 of file FrontendBackendUserAuthentication.php.

◆ $writeAttemptLog

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::$writeAttemptLog = false

If the writelog() functions is called if a login-attempt has be tried without success.

Definition at line 66 of file FrontendBackendUserAuthentication.php.

◆ $writeStdLog

bool TYPO3\CMS\Backend\FrontendBackendUserAuthentication::$writeStdLog = false

Decides if the writelog() function is called at login and logout.

Definition at line 60 of file FrontendBackendUserAuthentication.php.