PHP Class tl_member

Provide miscellaneous methods that are used by the data configuration array.
Inheritance: extends Backend
显示文件 Open project: contao/core-bundle Class Usage Examples

Public Methods

Method Description
__construct ( ) Import the back end user object
addIcon ( array $row, string $label, DataContainer $dc, array $args ) : array Add an image to each record
checkRemoveSession ( DataContainer $dc ) Check whether the user session should be removed
getActiveGroups ( ) : array Filter disabled groups
removeSession ( DataContainer $dc ) Remove the session if a user is deleted (see #5353)
setNewPassword ( string $strPassword, DataContainer | MemberModel $user ) : string Call the "setNewPassword" callback
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 ) : array
$row array
$label string
$dc DataContainer
$args array
return array

checkRemoveSession() public method

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

getActiveGroups() public method

Filter disabled groups
public getActiveGroups ( ) : array
return array

removeSession() public method

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

setNewPassword() public method

Call the "setNewPassword" callback
public setNewPassword ( string $strPassword, DataContainer | MemberModel $user ) : string
$strPassword string
$user DataContainer | MemberModel
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