SearchService
extends AbstractDbService
in package
implements
SearchServiceInterface, DeleteExpiredInterface, DbTableAwareInterface
Uses
DbTableAwareTrait
Database service for search.
Tags
Interfaces, Classes, Traits and Enums
- SearchServiceInterface
- Database service interface for search.
- 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
- cleanUpInvalidUserIds() : int
- Set invalid user_id values in the table to null; return count of affected rows.
- createAndPersistEntityWithChecksum() : SearchEntityInterface
- Create a search entity containing the specified checksum, persist it to the database, and return a fully populated object. Throw an exception if something goes wrong during the process.
- createEntity() : SearchEntityInterface
- Create a search entity.
- deleteExpired() : int
- Delete expired records. Allows setting a limit so that rows can be deleted in small batches.
- destroySession() : void
- Destroy unsaved searches belonging to the specified session/user.
- getDbTable() : Gateway
- Get a database table object.
- getDbTableManager() : PluginManager
- Get the table plugin manager. Throw an exception if it is missing.
- getSavedSearchesWithMissingChecksums() : array<string|int, SearchEntityInterface>
- Get saved searches with missing checksums (used for cleaning up legacy data).
- getScheduledSearches() : array<string|int, SearchEntityInterface>
- Get scheduled searches.
- getSearchById() : SearchEntityInterface|null
- Get a SearchEntityInterface object by ID.
- getSearchByIdAndOwner() : SearchEntityInterface|null
- Get a SearchEntityInterface object by ID and owner.
- getSearches() : array<string|int, SearchEntityInterface>
- Get an array of rows for the specified user.
- getSearchesByChecksumAndOwner() : array<string|int, SearchEntityInterface>
- Retrieve all searches matching the specified checksum and belonging to the user specified by session or user entity/ID.
- persistEntity() : void
- Persist an entity.
- setDbTableManager() : void
- Set the table plugin manager.
Properties
$tableManager
Database table plugin manager
protected
PluginManager
$tableManager
Methods
cleanUpInvalidUserIds()
Set invalid user_id values in the table to null; return count of affected rows.
public
cleanUpInvalidUserIds() : int
Return values
int —createAndPersistEntityWithChecksum()
Create a search entity containing the specified checksum, persist it to the database, and return a fully populated object. Throw an exception if something goes wrong during the process.
public
createAndPersistEntityWithChecksum(int $checksum) : SearchEntityInterface
Parameters
- $checksum : int
-
Checksum
Tags
Return values
SearchEntityInterface —createEntity()
Create a search entity.
public
createEntity() : SearchEntityInterface
Return values
SearchEntityInterface —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
destroySession()
Destroy unsaved searches belonging to the specified session/user.
public
destroySession(string $sessionId[, UserEntityInterface|int|null $userOrId = null ]) : void
Parameters
- $sessionId : string
-
Session ID of current user.
- $userOrId : UserEntityInterface|int|null = null
-
User entity or ID of current user (optional).
Return values
void —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 —getSavedSearchesWithMissingChecksums()
Get saved searches with missing checksums (used for cleaning up legacy data).
public
getSavedSearchesWithMissingChecksums() : array<string|int, SearchEntityInterface>
Return values
array<string|int, SearchEntityInterface> —getScheduledSearches()
Get scheduled searches.
public
getScheduledSearches() : array<string|int, SearchEntityInterface>
Return values
array<string|int, SearchEntityInterface> —getSearchById()
Get a SearchEntityInterface object by ID.
public
getSearchById(int $id) : SearchEntityInterface|null
Parameters
- $id : int
-
Search identifier
Return values
SearchEntityInterface|null —getSearchByIdAndOwner()
Get a SearchEntityInterface object by ID and owner.
public
getSearchByIdAndOwner(int $id, string $sessionId, UserEntityInterface|int|null $userOrId) : SearchEntityInterface|null
Parameters
- $id : int
-
Search identifier
- $sessionId : string
-
Session ID of current user.
- $userOrId : UserEntityInterface|int|null
-
User entity or ID of current user (optional).
Return values
SearchEntityInterface|null —getSearches()
Get an array of rows for the specified user.
public
getSearches(string $sessionId[, UserEntityInterface|int|null $userOrId = null ]) : array<string|int, SearchEntityInterface>
Parameters
- $sessionId : string
-
Session ID of current user.
- $userOrId : UserEntityInterface|int|null = null
-
User entity or ID of current user (optional).
Return values
array<string|int, SearchEntityInterface> —getSearchesByChecksumAndOwner()
Retrieve all searches matching the specified checksum and belonging to the user specified by session or user entity/ID.
public
getSearchesByChecksumAndOwner(int $checksum, string $sessionId[, UserEntityInterface|int|null $userOrId = null ]) : array<string|int, SearchEntityInterface>
Parameters
- $checksum : int
-
Checksum to match
- $sessionId : string
-
Current session ID
- $userOrId : UserEntityInterface|int|null = null
-
Entity or ID representing current user (optional).
Tags
Return values
array<string|int, SearchEntityInterface> —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