LoginToken
extends RowGateway
in package
implements
DbServiceAwareInterface, LoginTokenEntityInterface
Uses
DbServiceAwareTrait
Row Definition for login_token
Tags
Interfaces, Classes, Traits and Enums
- DbServiceAwareInterface
- Marker interface for classes that depend on the \VuFind\Db\Service\PluginManager
- LoginTokenEntityInterface
- Entity model interface for login_token table
Table of Contents
- $browser : string|null
- $expires : int
- $id : int
- $last_login : string
- $last_session_id : string
- $platform : string|null
- $series : string
- $token : string
- $user_id : int
- $dbServiceManager : PluginManager
- Database service plugin manager
- __construct() : mixed
- Constructor
- getBrowser() : string|null
- Get browser details (or null for none).
- getDbService() : T
- Get a database service object.
- getDbServiceManager() : PluginManager
- Get the service plugin manager. Throw an exception if it is missing.
- getExpires() : int
- Get expiration timestamp.
- getId() : int
- Getter for ID.
- getLastLogin() : DateTime
- Get last login date/time.
- getLastSessionId() : string|null
- Get last session ID (or null for none).
- getPlatform() : string|null
- Get platform details (or null for none).
- getPrimaryKeyColumn() : array<string|int, mixed>
- Retrieve primary key information.
- getSeries() : string
- Get series string.
- getToken() : string
- Get token string.
- getUser() : UserEntityInterface|null
- User getter (only null if entity has not been populated yet).
- setBrowser() : LoginTokenEntityInterface
- Set browser details (or null for none).
- setDbServiceManager() : void
- Set the service plugin manager.
- setExpires() : LoginTokenEntityInterface
- Set expiration timestamp.
- setLastLogin() : LoginTokenEntityInterface
- Set last login date/time.
- setLastSessionId() : LoginTokenEntityInterface
- Set last session ID (or null for none).
- setPlatform() : LoginTokenEntityInterface
- Set platform details (or null for none).
- setSeries() : LoginTokenEntityInterface
- Set series string.
- setToken() : LoginTokenEntityInterface
- Set token string.
- setUser() : LoginTokenEntityInterface
- Setter for User.
Properties
$browser
public
string|null
$browser
$expires
public
int
$expires
$id
public
int
$id
$last_login
public
string
$last_login
$last_session_id
public
string
$last_session_id
$platform
public
string|null
$platform
$series
public
string
$series
$token
public
string
$token
$user_id
public
int
$user_id
$dbServiceManager
Database service plugin manager
protected
PluginManager
$dbServiceManager
Methods
__construct()
Constructor
public
__construct(Adapter $adapter) : mixed
Parameters
- $adapter : Adapter
-
Database adapter
Return values
mixed —getBrowser()
Get browser details (or null for none).
public
getBrowser() : string|null
Return values
string|null —getDbService()
Get a database service object.
public
getDbService(class-string<\VuFind\Db\Service\T> $name) : T
Parameters
- $name : class-string<\VuFind\Db\Service\T>
-
Name of service to retrieve
Tags
Return values
T —getDbServiceManager()
Get the service plugin manager. Throw an exception if it is missing.
public
getDbServiceManager() : PluginManager
Tags
Return values
PluginManager —getExpires()
Get expiration timestamp.
public
getExpires() : int
Return values
int —getId()
Getter for ID.
public
getId() : int
Return values
int —getLastLogin()
Get last login date/time.
public
getLastLogin() : DateTime
Return values
DateTime —getLastSessionId()
Get last session ID (or null for none).
public
getLastSessionId() : string|null
Return values
string|null —getPlatform()
Get platform details (or null for none).
public
getPlatform() : string|null
Return values
string|null —getPrimaryKeyColumn()
Retrieve primary key information.
public
getPrimaryKeyColumn() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSeries()
Get series string.
public
getSeries() : string
Return values
string —getToken()
Get token string.
public
getToken() : string
Return values
string —getUser()
User getter (only null if entity has not been populated yet).
public
getUser() : UserEntityInterface|null
Return values
UserEntityInterface|null —setBrowser()
Set browser details (or null for none).
public
setBrowser(string|null $browser) : LoginTokenEntityInterface
Parameters
- $browser : string|null
-
Browser details (or null for none)
Return values
LoginTokenEntityInterface —setDbServiceManager()
Set the service plugin manager.
public
setDbServiceManager(PluginManager $manager) : void
Parameters
- $manager : PluginManager
-
Plugin manager
Return values
void —setExpires()
Set expiration timestamp.
public
setExpires(int $expires) : LoginTokenEntityInterface
Parameters
- $expires : int
-
Expiration timestamp
Return values
LoginTokenEntityInterface —setLastLogin()
Set last login date/time.
public
setLastLogin(DateTime $dateTime) : LoginTokenEntityInterface
Parameters
- $dateTime : DateTime
-
Last login date/time
Return values
LoginTokenEntityInterface —setLastSessionId()
Set last session ID (or null for none).
public
setLastSessionId(string|null $sid) : LoginTokenEntityInterface
Parameters
- $sid : string|null
-
Last session ID (or null for none)
Return values
LoginTokenEntityInterface —setPlatform()
Set platform details (or null for none).
public
setPlatform(string|null $platform) : LoginTokenEntityInterface
Parameters
- $platform : string|null
-
Platform details (or null for none)
Return values
LoginTokenEntityInterface —setSeries()
Set series string.
public
setSeries(string $series) : LoginTokenEntityInterface
Parameters
- $series : string
-
Series
Return values
LoginTokenEntityInterface —setToken()
Set token string.
public
setToken(string $token) : LoginTokenEntityInterface
Parameters
- $token : string
-
Token
Return values
LoginTokenEntityInterface —setUser()
Setter for User.
public
setUser(UserEntityInterface $user) : LoginTokenEntityInterface
Parameters
- $user : UserEntityInterface
-
User to set