PHP Class RainLab\User\Controllers\Users

Inheritance: extends Backend\Classes\Controller
Show file Open project: rainlab/user-plugin Class Usage Examples

Public Properties

Property Type Description
$bodyClass
$formConfig
$implement
$listConfig
$relationConfig
$requiredPermissions

Public Methods

Method Description
__construct ( )
formAfterUpdate ( $model )
formExtendFields ( $form ) Display username field if settings permit
formExtendModel ( $model )
formExtendQuery ( $query )
index ( )
index_onBulkAction ( ) Perform bulk action on selected users
listExtendQuery ( $query )
listInjectRowClass ( $record, $definition = null ) {@inheritDoc}
preview_onActivate ( $recordId = null ) Manually activate a user
preview_onConvertGuest ( $recordId ) Manually convert a guest user to a registered one
preview_onLoadConvertGuestForm ( $recordId ) Display the convert to registered user popup
preview_onUnban ( $recordId = null ) Manually unban a user
update_onDelete ( $recordId = null ) Force delete a user.

Method Details

__construct() public method

public __construct ( )

formAfterUpdate() public method

public formAfterUpdate ( $model )

formExtendFields() public method

Display username field if settings permit
public formExtendFields ( $form )

formExtendModel() public method

public formExtendModel ( $model )

formExtendQuery() public method

public formExtendQuery ( $query )

index() public method

public index ( )

index_onBulkAction() public method

Perform bulk action on selected users
public index_onBulkAction ( )

listExtendQuery() public method

public listExtendQuery ( $query )

listInjectRowClass() public method

{@inheritDoc}
public listInjectRowClass ( $record, $definition = null )

preview_onActivate() public method

Manually activate a user
public preview_onActivate ( $recordId = null )

preview_onConvertGuest() public method

Manually convert a guest user to a registered one
public preview_onConvertGuest ( $recordId )

preview_onLoadConvertGuestForm() public method

Display the convert to registered user popup
public preview_onLoadConvertGuestForm ( $recordId )

preview_onUnban() public method

Manually unban a user
public preview_onUnban ( $recordId = null )

update_onDelete() public method

Force delete a user.
public update_onDelete ( $recordId = null )

Property Details

$bodyClass public property

public $bodyClass

$formConfig public property

public $formConfig

$implement public property

public $implement

$listConfig public property

public $listConfig

$relationConfig public property

public $relationConfig

$requiredPermissions public property

public $requiredPermissions