UserList
extends Gateway
in package
implements
DbServiceAwareInterface
Uses
DbServiceAwareTrait
Table Definition for user_list
Tags
Interfaces, Classes, Traits and Enums
- DbServiceAwareInterface
- Marker interface for classes that depend on the \VuFind\Db\Service\PluginManager
Table of Contents
- $dbServiceManager : PluginManager
- Database service plugin manager
- $session : Container
- Session container for last list information.
- $tableManager : PluginManager
- Table manager
- __construct() : mixed
- Constructor
- beginTransaction() : void
- Begin a database transaction.
- commitTransaction() : void
- Commit a database transaction.
- createRow() : object
- Create a new row.
- getDbService() : T
- Get a database service object.
- getDbServiceManager() : PluginManager
- Get the service plugin manager. Throw an exception if it is missing.
- getDbTable() : Gateway
- Get access to another table.
- getExisting() : UserList
- Retrieve a list object.
- getListsContainingResource() : array<string|int, mixed>
- Get lists containing a specific user_resource
- getNew() : UserList
- Create a new list object.
- initializeFeatures() : void
- Initialize features
- rollBackTransaction() : void
- Roll back a database transaction.
- setDbServiceManager() : void
- Set the service plugin manager.
Properties
$dbServiceManager
Database service plugin manager
protected
PluginManager
$dbServiceManager
$session
Session container for last list information.
protected
Container
$session
$tableManager
Table manager
protected
PluginManager
$tableManager
Methods
__construct()
Constructor
public
__construct(Adapter $adapter, PluginManager $tm, array<string|int, mixed> $cfg[, RowGateway $rowObj = null ][, Container $session = null ][, string $table = 'user_list' ]) : mixed
Parameters
- $adapter : Adapter
-
Database adapter
- $tm : PluginManager
-
Table manager
- $cfg : array<string|int, mixed>
-
Laminas configuration
- $rowObj : RowGateway = null
-
Row prototype object (null for default)
- $session : Container = null
-
Session container (must use same namespace as container provided to \VuFind\View\Helper\Root\UserList).
- $table : string = 'user_list'
-
Name of database table to interface with
Return values
mixed —beginTransaction()
Begin a database transaction.
public
beginTransaction() : void
Tags
Return values
void —commitTransaction()
Commit a database transaction.
public
commitTransaction() : void
Tags
Return values
void —createRow()
Create a new row.
public
createRow() : object
Return values
object —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 access to another table.
public
getDbTable(string $table) : Gateway
Parameters
- $table : string
-
Table name
Return values
Gateway —getExisting()
Retrieve a list object.
public
getExisting(int $id) : UserList
Parameters
- $id : int
-
Numeric ID for existing list.
Tags
Return values
UserList —getListsContainingResource()
Get lists containing a specific user_resource
public
getListsContainingResource(string $resourceId[, string $source = DEFAULT_SEARCH_BACKEND ][, int $userId = null ]) : array<string|int, mixed>
Parameters
- $resourceId : string
-
ID of record being checked.
- $source : string = DEFAULT_SEARCH_BACKEND
-
Source of record to look up
- $userId : int = null
-
Optional user ID (to limit results to a particular user).
Return values
array<string|int, mixed> —getNew()
Create a new list object.
public
getNew(UserList|bool $user) : UserList
Parameters
- $user : UserList|bool
-
User object representing owner of new list (or false if not logged in)
Tags
Return values
UserList —initializeFeatures()
Initialize features
public
initializeFeatures(array<string|int, mixed> $cfg) : void
Parameters
- $cfg : array<string|int, mixed>
-
Laminas configuration
Return values
void —rollBackTransaction()
Roll back a database transaction.
public
rollBackTransaction() : void
Tags
Return values
void —setDbServiceManager()
Set the service plugin manager.
public
setDbServiceManager(PluginManager $manager) : void
Parameters
- $manager : PluginManager
-
Plugin manager