Authentication

This section will introduce you to the authentication service and how to user it.

User Authenticator

This class will go over the \Anomaly\UsersModule\User\UserAuthenticator class and how to use it.

UserAuthenticator::attempt()

The attempt method attempts to authorize a user. The login method is ran if the authentication succeeds.

Returns: \Anomaly\UsersModule\User\Contract\UserInterface or false

Arguments

Example

$authenticator->attempt(['email' => '[email protected]', 'password' => 'secret']);

UserAuthenticator::authenticate()

The authenticate method authenticates credentials without logging the user in.

Returns: \Anomaly\UsersModule\User\Contract\UserInterface or false

Arguments

Example

$authenticator->authenticate(['email' => '[email protected]', 'password' => 'secret password']);

UserAuthenticator::login()

The login method logs in the user.

Returns: void

Arguments

Example

$authenticator->login($user);

UserAuthenticator::logout()

The logout method logs out the user.

Returns: void

Arguments

Example

$authenticator->logout($user);

UserAuthenticator::kickOut()

The kickOut method kicks a user. The kickOut method is similar to logout but a different event is fired for you to hook into as needed.

Returns: void

Arguments

Example

$authenticator->kickOut($user);