Backend\Classes\AuthManager
Overview
AuthManager is backend authentication manager.
Extends
Implements
- Illuminate\Contracts\Auth\Guard
- Illuminate\Contracts\Auth\StatefulGuard
Public Properties
There are no public properties in the class.
Show inherited public properties
Inherited Public Properties
- $ipAddress - of this request. (defined in October\Rain\Auth\Manager)
Protected Properties
protected static $instance
{@inheritdoc}
protected $sessionKey
{@inheritdoc}
protected $userModel
{@inheritdoc}
protected string $roleModel
roleModel class
protected $groupModel
{@inheritdoc}
protected $throttleModel
{@inheritdoc}
protected $requireActivation
{@inheritdoc}
Show inherited protected properties
Inherited Protected Properties
- $user - that is currently logged in. (defined in October\Rain\Auth\Manager)
- $throttle - cache in memory [md5($userId. (defined in October\Rain\Auth\Manager)
- $useThrottle - flag to enable login throttling. (defined in October\Rain\Auth\Manager)
- $useRehash - flag to enable password rehashing. (defined in October\Rain\Auth\Manager)
- $useSession - internal flag to toggle using the session for the current authentication request. (defined in October\Rain\Auth\Manager)
- $viaRemember - indicates if the user was authenticated via a recaller cookie. (defined in October\Rain\Auth\Manager)
- $checkCache - adds a specific cache to the check() method to reduce the number of database calls. (defined in October\Rain\Auth\Manager)
Public Methods
public userHasAccess()
public userHasAccess($permissions, $all = true): void
userHasAccess is identical to User::hasAccess
public userHasPermission()
public userHasPermission($permissions, $all = true): void
userHasPermission is identical to User::hasPermission
public userHasSiteAccess()
public userHasSiteAccess($site): bool
userHasSiteAccess returns true when the current user is permitted to access the supplied site definition or ID
Inherited Public Methods
- attempt() - to authenticate a user using the given credentials. (defined in October\Rain\Auth\Manager)
- authenticate() - the given user according to the passed credentials. (defined in October\Rain\Auth\Manager)
- check() - to see if the user is logged in and activated, and hasn't been banned or suspended. (defined in October\Rain\Auth\Manager)
- clearThrottleForUserId() - unsuspends and clears all throttles records for a user. (defined in October\Rain\Auth\Manager)
- createRoleModel() - creates an instance of the role model. (defined in October\Rain\Auth\Manager)
- createThrottleModel() - creates an instance of the throttle model. (defined in October\Rain\Auth\Manager)
- createUserModel() - instance. (defined in October\Rain\Auth\Manager)
- extendUserQuery() - used for finding the user. (defined in October\Rain\Auth\Manager)
- findThrottleByLogin() - and ip address. (defined in October\Rain\Auth\Manager)
- findThrottleByUserId() - and ip address. (defined in October\Rain\Auth\Manager)
- findUserByCredentials() - finds a user by the given credentials. (defined in October\Rain\Auth\Manager)
- findUserById() - finds a user by the login value. (defined in October\Rain\Auth\Manager)
- findUserByLogin() - finds a user by the login value. (defined in October\Rain\Auth\Manager)
- forgetInstance() - if it exists. (defined in October\Rain\Auth\Manager)
- getImpersonator() - gets the original user doing the impersonation. (defined in October\Rain\Auth\Manager)
- getModel() - returns the class name for the user model. (defined in October\Rain\Auth\Manager)
- getProvider() - just passes it back to the current class. (defined in October\Rain\Auth\Manager)
- getRealUser() - gets the "real" user to bypass impersonation. (defined in October\Rain\Auth\Manager)
- getUser() - returns the current user, if any. (defined in October\Rain\Auth\Manager)
- guest() - determines if the current user is a guest. (defined in October\Rain\Auth\Manager)
- hasRemember() - returns true if the user requested to stay logged in. (defined in October\Rain\Auth\Manager)
- hasSession() - returns true if a user session exists without verifying it. (defined in October\Rain\Auth\Manager)
- hasUser() - determines if the guard has a user instance. (defined in October\Rain\Auth\Manager)
- id() - for the currently authenticated user. (defined in October\Rain\Auth\Manager)
- impersonate() - the given user and sets properties in the session but not the cookie. (defined in October\Rain\Auth\Manager)
- impersonateRole() - will impersonate a role for the current user. (defined in October\Rain\Auth\Manager)
- instance() - create a new instance of this singleton. (defined in October\Rain\Auth\Manager)
- isImpersonator() - checks to see if the current session is being impersonated. (defined in October\Rain\Auth\Manager)
- isRoleImpersonator() - (defined in October\Rain\Auth\Manager)
- login() - the given user and sets properties in the session. (defined in October\Rain\Auth\Manager)
- loginUsingId() - logs the given user ID into the application. (defined in October\Rain\Auth\Manager)
- logout() - logs the current user out. (defined in October\Rain\Auth\Manager)
- once() - logs a user into the application without sessions or cookies. (defined in October\Rain\Auth\Manager)
- onceUsingId() - logs the given user ID into the application without sessions or cookies. (defined in October\Rain\Auth\Manager)
- register() - a user with the provided credentials with optional flags for. (defined in October\Rain\Auth\Manager)
- setUser() - will set the current user. (defined in October\Rain\Auth\Manager)
- stopImpersonate() - stops the current session being impersonated and. (defined in October\Rain\Auth\Manager)
- stopImpersonateRole() - will stop role impersonation. (defined in October\Rain\Auth\Manager)
- user() - will return the currently authenticated user. (defined in October\Rain\Auth\Manager)
- validate() - a user's credentials. (defined in October\Rain\Auth\Manager)
- viaRemember() - determines if the user was authenticated via "remember me" cookie. (defined in October\Rain\Auth\Manager)
Protected Methods
protected createUserModelQuery()
protected createUserModelQuery(): void
{@inheritdoc}
protected validateUserModel()
protected validateUserModel($user): void
{@inheritdoc}
Show inherited protected methods
Inherited Protected Methods
- __construct() - (defined in October\Rain\Auth\Manager)
- applyRoleImpersonation() - tells the user model to impersonate the role. (defined in October\Rain\Auth\Manager)
- getPersistCodeFromSession() - will return the user ID and persist token from the session. (defined in October\Rain\Auth\Manager)
- init() - the singleton. (defined in October\Rain\Auth\Manager)
- setPersistCodeToSession() - stores the user persistence in the session and cookie. (defined in October\Rain\Auth\Manager)
- validateInternal() - a user's credentials, method used internally. (defined in October\Rain\Auth\Manager)