PHP Class tl_user

Inheritance: extends Backend
Show file Open project: contao/core-bundle

Public Methods

Method Description
__construct ( ) Import the back end user object
addIcon ( array $row, string $label, DataContainer $dc, array $args ) : string Add an image to each record
checkAdminDisable ( mixed $varValue, DataContainer $dc ) : mixed Prevent administrators from disabling their own account
checkAdminStatus ( mixed $varValue, DataContainer $dc ) : mixed Prevent administrators from downgrading their own account
checkPermission ( ) Check permissions to edit table tl_user
checkRemoveSession ( DataContainer $dc ) Check whether the user session should be removed
copyUser ( array $row, string $href, string $label, string $title, string $icon, string $attributes, string $table ) : string Return the copy page button
deleteUser ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the delete page button
editUser ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the edit user button
getModules ( ) : array Return all modules except profile modules
removeSession ( DataContainer $dc ) Remove the session if a user is deleted (see #5353)
sessionField ( DataContainer $dc ) : string Return a checkbox to delete session data
storeDateAdded ( DataContainer $dc ) Store the date when the account has been added
switchUser ( array $row, string $href, string $label, string $title, string $icon ) : string Generate a "switch account" button and return it as string
toggleIcon ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string Return the "toggle visibility" button
toggleVisibility ( integer $intId, boolean $blnVisible, DataContainer $dc = null ) Disable/enable a user group

Method Details

__construct() public method

Import the back end user object
public __construct ( )

addIcon() public method

Add an image to each record
public addIcon ( array $row, string $label, DataContainer $dc, array $args ) : string
$row array
$label string
$dc DataContainer
$args array
return string

checkAdminDisable() public method

Prevent administrators from disabling their own account
public checkAdminDisable ( mixed $varValue, DataContainer $dc ) : mixed
$varValue mixed
$dc DataContainer
return mixed

checkAdminStatus() public method

Prevent administrators from downgrading their own account
public checkAdminStatus ( mixed $varValue, DataContainer $dc ) : mixed
$varValue mixed
$dc DataContainer
return mixed

checkPermission() public method

Check permissions to edit table tl_user
public checkPermission ( )

checkRemoveSession() public method

Check whether the user session should be removed
public checkRemoveSession ( DataContainer $dc )
$dc DataContainer

copyUser() public method

Return the copy page button
public copyUser ( array $row, string $href, string $label, string $title, string $icon, string $attributes, string $table ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
$table string
return string

deleteUser() public method

Return the delete page button
public deleteUser ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

editUser() public method

Return the edit user button
public editUser ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

getModules() public method

Return all modules except profile modules
public getModules ( ) : array
return array

removeSession() public method

Remove the session if a user is deleted (see #5353)
public removeSession ( DataContainer $dc )
$dc DataContainer

sessionField() public method

Return a checkbox to delete session data
public sessionField ( DataContainer $dc ) : string
$dc DataContainer
return string

storeDateAdded() public method

Store the date when the account has been added
public storeDateAdded ( DataContainer $dc )
$dc DataContainer

switchUser() public method

Generate a "switch account" button and return it as string
public switchUser ( array $row, string $href, string $label, string $title, string $icon ) : string
$row array
$href string
$label string
$title string
$icon string
return string

toggleIcon() public method

Return the "toggle visibility" button
public toggleIcon ( array $row, string $href, string $label, string $title, string $icon, string $attributes ) : string
$row array
$href string
$label string
$title string
$icon string
$attributes string
return string

toggleVisibility() public method

Disable/enable a user group
public toggleVisibility ( integer $intId, boolean $blnVisible, DataContainer $dc = null )
$intId integer
$blnVisible boolean
$dc DataContainer