PHP Class RainLab\User\Components\Account

Inheritance: extends Cms\Classes\ComponentBase
Mostrar archivo Open project: rainlab/user-plugin Class Usage Examples

Public Methods

Method Description
componentDetails ( )
defineProperties ( )
getRedirectOptions ( )
loginAttribute ( ) Returns the login model attribute.
loginAttributeLabel ( ) Returns the login label as a word.
onActivate ( string $code = null ) Activate the user
onDeactivate ( ) Deactivate user
onRegister ( ) Register the user
onRun ( ) Executed when this component is bound to a page or layout.
onSendActivationEmail ( ) Trigger a subsequent activation email
onSignin ( ) Sign in the user
onUpdate ( ) Update the user
user ( ) Returns the logged in user, if available

Protected Methods

Method Description
makeRedirection ( ) : mixed Redirect to the intended page after successful update, sign in or registration.
sendActivationEmail ( User $user ) : void Sends the activation email to a user

Method Details

componentDetails() public method

public componentDetails ( )

defineProperties() public method

public defineProperties ( )

getRedirectOptions() public method

public getRedirectOptions ( )

loginAttribute() public method

Returns the login model attribute.
public loginAttribute ( )

loginAttributeLabel() public method

Returns the login label as a word.
public loginAttributeLabel ( )

makeRedirection() protected method

The URL can come from the "redirect" property or the "redirect" postback value.
protected makeRedirection ( ) : mixed
return mixed

onActivate() public method

Activate the user
public onActivate ( string $code = null )
$code string Activation code

onDeactivate() public method

Deactivate user
public onDeactivate ( )

onRegister() public method

Register the user
public onRegister ( )

onRun() public method

Executed when this component is bound to a page or layout.
public onRun ( )

onSendActivationEmail() public method

Trigger a subsequent activation email

onSignin() public method

Sign in the user
public onSignin ( )

onUpdate() public method

Update the user
public onUpdate ( )

sendActivationEmail() protected method

Sends the activation email to a user
protected sendActivationEmail ( User $user ) : void
$user User
return void

user() public method

Returns the logged in user, if available
public user ( )