LoginTokenService
extends AbstractDbService
in package
implements
LoginTokenServiceInterface, DeleteExpiredInterface, DbTableAwareInterface
Uses
DbTableAwareTrait
Database service for login_token table.
Tags
Interfaces, Classes, Traits and Enums
- LoginTokenServiceInterface
- Database service interface for login_token table.
- DeleteExpiredInterface
- Interface for exposing the "deleteExpired" method required by command line cleanup tools.
- DbTableAwareInterface
- Marker interface for classes that depend on the \VuFind\Db\Table\PluginManager
Table of Contents
- $tableManager : PluginManager
- Database table plugin manager
- createAndPersistToken() : LoginTokenEntityInterface
- Create and persist a token.
- createEntity() : LoginTokenEntityInterface
- Create a new login token entity.
- deleteBySeries() : void
- Delete all tokens in a given series.
- deleteByUser() : void
- Delete all tokens for a user.
- deleteExpired() : int
- Delete expired records. Allows setting a limit so that rows can be deleted in small batches.
- getBySeries() : array<string|int, LoginTokenEntityInterface>
- Get token by series.
- getByUser() : array<string|int, LoginTokenEntityInterface>
- Get tokens for a given user.
- getDbTable() : Gateway
- Get a database table object.
- getDbTableManager() : PluginManager
- Get the table plugin manager. Throw an exception if it is missing.
- matchToken() : LoginTokenEntityInterface|null
- Check if a login token matches one in database.
- persistEntity() : void
- Persist an entity.
- setDbTableManager() : void
- Set the table plugin manager.
Properties
$tableManager
Database table plugin manager
protected
PluginManager
$tableManager
Methods
createAndPersistToken()
Create and persist a token.
public
createAndPersistToken(UserEntityInterface $user, string $token, string $series[, string $browser = '' ][, string $platform = '' ], int $expires[, string $sessionId = '' ]) : LoginTokenEntityInterface
Parameters
- $user : UserEntityInterface
-
User identifier
- $token : string
-
Login token
- $series : string
-
Series the token belongs to
- $browser : string = ''
-
User browser
- $platform : string = ''
-
User platform
- $expires : int
-
Token expiration timestamp
- $sessionId : string = ''
-
Session associated with the token
Return values
LoginTokenEntityInterface —createEntity()
Create a new login token entity.
public
createEntity() : LoginTokenEntityInterface
Return values
LoginTokenEntityInterface —deleteBySeries()
Delete all tokens in a given series.
public
deleteBySeries(string $series[, int|null $currentTokenId = null ]) : void
Parameters
- $series : string
-
series
- $currentTokenId : int|null = null
-
Current token ID to keep
Return values
void —deleteByUser()
Delete all tokens for a user.
public
deleteByUser(UserEntityInterface|int $userOrId) : void
Parameters
- $userOrId : UserEntityInterface|int
-
User entity object or identifier
Return values
void —deleteExpired()
Delete expired records. Allows setting a limit so that rows can be deleted in small batches.
public
deleteExpired(DateTime $dateLimit[, int|null $limit = null ]) : int
Parameters
- $dateLimit : DateTime
-
Date threshold of an "expired" record.
- $limit : int|null = null
-
Maximum number of rows to delete or null for no limit.
Return values
int —Number of rows deleted
getBySeries()
Get token by series.
public
getBySeries(string $series) : array<string|int, LoginTokenEntityInterface>
Parameters
- $series : string
-
Series identifier
Return values
array<string|int, LoginTokenEntityInterface> —getByUser()
Get tokens for a given user.
public
getByUser(UserEntityInterface|int $userOrId[, bool $grouped = true ]) : array<string|int, LoginTokenEntityInterface>
Parameters
- $userOrId : UserEntityInterface|int
-
User entity object or identifier
- $grouped : bool = true
-
Whether to return results grouped by series
Return values
array<string|int, LoginTokenEntityInterface> —getDbTable()
Get a database table object.
public
getDbTable(string $table) : Gateway
Parameters
- $table : string
-
Table to load.
Return values
Gateway —getDbTableManager()
Get the table plugin manager. Throw an exception if it is missing.
public
getDbTableManager() : PluginManager
Tags
Return values
PluginManager —matchToken()
Check if a login token matches one in database.
public
matchToken(array<string|int, mixed> $token) : LoginTokenEntityInterface|null
Parameters
- $token : array<string|int, mixed>
-
array containing user id, token and series
Tags
Return values
LoginTokenEntityInterface|null —persistEntity()
Persist an entity.
public
persistEntity(EntityInterface $entity) : void
Parameters
- $entity : EntityInterface
-
Entity to persist.
Return values
void —setDbTableManager()
Set the table plugin manager.
public
setDbTableManager(PluginManager $manager) : void
Parameters
- $manager : PluginManager
-
Plugin manager