PHP Class RainLab\User\Components\Account

Inheritance: extends Cms\Classes\ComponentBase

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

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

public componentDetails ( )

public defineProperties ( )

public getRedirectOptions ( )

Returns the login model attribute.

public loginAttribute ( )

Returns the login label as a word.

public loginAttributeLabel ( )

The URL can come from the "redirect" property or the "redirect" postback value.

protected makeRedirection ( ) : mixed
return	mixed

Activate the user

public onActivate ( string $code = null )
$code	string	Activation code

Deactivate user

public onDeactivate ( )

public onRegister ( )

Executed when this component is bound to a page or layout.

public onRun ( )

Trigger a subsequent activation email

public onSendActivationEmail ( )

public onSignin ( )

Update the user

public onUpdate ( )

Sends the activation email to a user

protected sendActivationEmail ( User $user ) : void
$user	User
return	void

Returns the logged in user, if available

public user ( )