AuthHash
extends RowGateway
in package
implements
AuthHashEntityInterface, DbServiceAwareInterface
Uses
DbTableAwareTrait, DbServiceAwareTrait
Row Definition for auth_hash
Tags
Interfaces, Classes, Traits and Enums
- AuthHashEntityInterface
- Entity model interface for auth_hash table
- DbServiceAwareInterface
- Marker interface for classes that depend on the \VuFind\Db\Service\PluginManager
Table of Contents
- $created : string
- $data : string
- $hash : string
- $id : int
- $session_id : string
- $type : string
- $dbServiceManager : PluginManager
- Database service plugin manager
- $tableManager : PluginManager
- Database table plugin manager
- __construct() : mixed
- Constructor
- getCreated() : DateTime
- Get created date.
- getData() : string|null
- Get data.
- getDbService() : T
- Get a database service object.
- getDbServiceManager() : PluginManager
- Get the service plugin manager. Throw an exception if it is missing.
- getDbTable() : Gateway
- Get a database table object.
- getDbTableManager() : PluginManager
- Get the table plugin manager. Throw an exception if it is missing.
- getHash() : string
- Get hash value.
- getHashType() : string|null
- Get type of hash.
- getId() : int|null
- Get identifier (returns null for an uninitialized or non-persisted object).
- getPrimaryKeyColumn() : array<string|int, mixed>
- Retrieve primary key information.
- getSessionId() : string|null
- Get PHP session id string.
- setCreated() : AuthHashEntityInterface
- Set created date.
- setData() : AuthHashEntityInterface
- Set data.
- setDbServiceManager() : void
- Set the service plugin manager.
- setDbTableManager() : void
- Set the table plugin manager.
- setHash() : AuthHashEntityInterface
- Set hash value.
- setHashType() : AuthHashEntityInterface
- Set type of hash.
- setSessionId() : AuthHashEntityInterface
- Set PHP session id string.
Properties
$created
public
string
$created
$data
public
string
$data
$hash
public
string
$hash
$id
public
int
$id
$session_id
public
string
$session_id
$type
public
string
$type
$dbServiceManager
Database service plugin manager
protected
PluginManager
$dbServiceManager
$tableManager
Database table plugin manager
protected
PluginManager
$tableManager
Methods
__construct()
Constructor
public
__construct(Adapter $adapter) : mixed
Parameters
- $adapter : Adapter
-
Database adapter
Return values
mixed —getCreated()
Get created date.
public
getCreated() : DateTime
Return values
DateTime —getData()
Get data.
public
getData() : 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 —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 —getHash()
Get hash value.
public
getHash() : string
Return values
string —getHashType()
Get type of hash.
public
getHashType() : string|null
Return values
string|null —getId()
Get identifier (returns null for an uninitialized or non-persisted object).
public
getId() : int|null
Return values
int|null —getPrimaryKeyColumn()
Retrieve primary key information.
public
getPrimaryKeyColumn() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSessionId()
Get PHP session id string.
public
getSessionId() : string|null
Return values
string|null —setCreated()
Set created date.
public
setCreated(DateTime $dateTime) : AuthHashEntityInterface
Parameters
- $dateTime : DateTime
-
Created date
Return values
AuthHashEntityInterface —setData()
Set data.
public
setData(string|null $data) : AuthHashEntityInterface
Parameters
- $data : string|null
-
Data
Return values
AuthHashEntityInterface —setDbServiceManager()
Set the service plugin manager.
public
setDbServiceManager(PluginManager $manager) : void
Parameters
- $manager : PluginManager
-
Plugin manager
Return values
void —setDbTableManager()
Set the table plugin manager.
public
setDbTableManager(PluginManager $manager) : void
Parameters
- $manager : PluginManager
-
Plugin manager
Return values
void —setHash()
Set hash value.
public
setHash(string $hash) : AuthHashEntityInterface
Parameters
- $hash : string
-
Hash Value
Return values
AuthHashEntityInterface —setHashType()
Set type of hash.
public
setHashType(string|null $type) : AuthHashEntityInterface
Parameters
- $type : string|null
-
Hash Type
Return values
AuthHashEntityInterface —setSessionId()
Set PHP session id string.
public
setSessionId(string|null $sessionId) : AuthHashEntityInterface
Parameters
- $sessionId : string|null
-
PHP Session id string