LoginTokenServiceInterface
extends
DbServiceInterface
in
Database service interface for login_token table.
Tags
Table of Contents
- 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.
- getBySeries() : array<string|int, LoginTokenEntityInterface>
- Get token by series.
- getByUser() : array<string|int, LoginTokenEntityInterface>
- Get tokens for a given user.
- matchToken() : LoginTokenEntityInterface|null
- Check if a login token matches one in database.
- persistEntity() : void
- Persist an entity.
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 —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> —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.