• Главная
• Webiny
• Component
• Security
• Authentication
• Firewall

PHP Класс Webiny\Component\Security\Authentication\Firewall

The firewall class check if users is authenticated and holds the methods for authentication. Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
__construct ( string $firewallKey, ConfigObject $firewallConfig, array $userProviders, Encoder $encoder )	Constructor.
createPasswordHash ( string $password ) : string	Create a hash for the given password.
getAnonymousAccess ( ) : boolean	Check if anonymous access is allowed or not.
getConfig ( ) : ConfigObject	Get config for current firewall.
getFirewallKey ( ) : string	Returns the name of the current firewall. Don't mistake it for realm name.
getRealmName ( ) : string	Get realm name.
getToken ( ) : Token	Get the current token.
getUser ( ) : boolean | AbstractUser	Tries to retrieve the user from current token.
isUserAllowedAccess ( ) : boolean	Checks if current user has access to current area based by access rules.
processLogin ( string $authProvider = '' ) : boolean	Call this method on your login submit page, it will trigger the authentication provider and validate the provided credentials.
processLogout ( )	This method deletes user auth token and calls the logoutCallback on current login provider.
verifyPasswordHash ( string $password, string $hash ) : boolean	Verify if the $password matches the $hash.

Приватные методы

Метод	Описание
authenticate ( Login $login ) : boolean | AbstractUser	Method that validates the submitted credentials with defined firewall user providers.
getAuthProvider ( string $authProvider ) : Webiny\Component\Security\Authentication\Providers\AuthenticationInterface	Get the authentication provider.
getAuthProviderConfig ( string $authProvider ) : ConfigObject	Returns the config of current auth provider.
getTokenName ( ) : string	Returns the token name.
initRoleHierarchy ( )	Initializes role hierarchy.
initToken ( )	Initializes the Token.
setUserRoles ( )	Sets roles for current user.

Описание методов