PHP Класс Bolt\AccessControl\Login

Автор: Gawain Lynch ([email protected])
Наследование: extends AccessChecker
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$authTokenName string
$passwordFactory PasswordLib\Password\Factory

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

Метод Описание
__construct ( Silex\Application $app ) Constructor.
login ( string $userName, string $password, Bolt\Events\AccessControlEvent $event ) : boolean Attempt to login a user with the given password. Accepts username or email.

Защищенные методы

Метод Описание
getUserEntity ( string $userName ) : Bolt\Storage\Entity\Users | null Get the user record entity if it exists.
loginCheckAuthtoken ( string $authCookie, Bolt\Events\AccessControlEvent $event ) : boolean Attempt to login a user via the bolt_authtoken cookie.
loginCheckPassword ( string $userName, string $password, Bolt\Events\AccessControlEvent $event ) : boolean Check a user login request for username/password combinations.
loginFailed ( Bolt\Storage\Entity\Users $userEntity ) : false Add error messages to logs and update the user.
loginFinish ( Bolt\Storage\Entity\Users $userEntity ) : boolean Finish user login process(es).
updateAuthToken ( Bolt\Storage\Entity\Users $userEntity ) : Bolt\Storage\Entity\Authtoken Set the Authtoken cookie and DB-entry. If it's already present, update it.
updateUserLogin ( Bolt\Storage\Entity\Users $userEntity ) : boolean Update the user record with latest login information.
updateUserShadowLogin ( Bolt\Storage\Entity\Users $userEntity ) : Bolt\Storage\Entity\Users Remove expired shadow login data.

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

Метод Описание
throttleUntil ( integer $attempts ) : DateTime Calculate the amount of time until we should throttle login attempts for a user.

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

__construct() публичный Метод

Constructor.
public __construct ( Silex\Application $app )
$app Silex\Application

getUserEntity() защищенный Метод

Get the user record entity if it exists.
protected getUserEntity ( string $userName ) : Bolt\Storage\Entity\Users | null
$userName string
Результат Bolt\Storage\Entity\Users | null

login() публичный Метод

Attempt to login a user with the given password. Accepts username or email.
public login ( string $userName, string $password, Bolt\Events\AccessControlEvent $event ) : boolean
$userName string
$password string
$event Bolt\Events\AccessControlEvent
Результат boolean

loginCheckAuthtoken() защищенный Метод

Attempt to login a user via the bolt_authtoken cookie.
protected loginCheckAuthtoken ( string $authCookie, Bolt\Events\AccessControlEvent $event ) : boolean
$authCookie string
$event Bolt\Events\AccessControlEvent
Результат boolean

loginCheckPassword() защищенный Метод

Check a user login request for username/password combinations.
protected loginCheckPassword ( string $userName, string $password, Bolt\Events\AccessControlEvent $event ) : boolean
$userName string
$password string
$event Bolt\Events\AccessControlEvent
Результат boolean

loginFailed() защищенный Метод

Add error messages to logs and update the user.
protected loginFailed ( Bolt\Storage\Entity\Users $userEntity ) : false
$userEntity Bolt\Storage\Entity\Users
Результат false

loginFinish() защищенный Метод

Finish user login process(es).
protected loginFinish ( Bolt\Storage\Entity\Users $userEntity ) : boolean
$userEntity Bolt\Storage\Entity\Users
Результат boolean

updateAuthToken() защищенный Метод

Set the Authtoken cookie and DB-entry. If it's already present, update it.
protected updateAuthToken ( Bolt\Storage\Entity\Users $userEntity ) : Bolt\Storage\Entity\Authtoken
$userEntity Bolt\Storage\Entity\Users
Результат Bolt\Storage\Entity\Authtoken

updateUserLogin() защищенный Метод

Update the user record with latest login information.
protected updateUserLogin ( Bolt\Storage\Entity\Users $userEntity ) : boolean
$userEntity Bolt\Storage\Entity\Users
Результат boolean

updateUserShadowLogin() защищенный Метод

Remove expired shadow login data.
protected updateUserShadowLogin ( Bolt\Storage\Entity\Users $userEntity ) : Bolt\Storage\Entity\Users
$userEntity Bolt\Storage\Entity\Users
Результат Bolt\Storage\Entity\Users

Описание свойств

$authTokenName защищенное свойство

protected string $authTokenName
Результат string

$passwordFactory защищенное свойство

protected Factory,PasswordLib\Password $passwordFactory
Результат PasswordLib\Password\Factory