RecordService
extends AbstractDbService
in package
implements
DbTableAwareInterface, RecordServiceInterface
Uses
DbTableAwareTrait
Database service for Records.
Tags
Interfaces, Classes, Traits and Enums
- DbTableAwareInterface
- Marker interface for classes that depend on the \VuFind\Db\Table\PluginManager
- RecordServiceInterface
- Database service interface for Records.
Table of Contents
- $tableManager : PluginManager
- Database table plugin manager
- cleanup() : int
- Clean up orphaned entries (i.e. entries that are not in favorites anymore)
- createEntity() : RecordEntityInterface
- Create a record entity object.
- deleteRecord() : bool
- Delete a record by source and id. Return true if found and deleted, false if not found.
- getDbTable() : Gateway
- Get a database table object.
- getDbTableManager() : PluginManager
- Get the table plugin manager. Throw an exception if it is missing.
- getRecord() : RecordEntityInterface|null
- Retrieve a record by id.
- getRecords() : array<string|int, RecordEntityInterface>
- Retrieve records by ids.
- persistEntity() : void
- Persist an entity.
- setDbTableManager() : void
- Set the table plugin manager.
- updateRecord() : RecordEntityInterface
- Update an existing entry in the record table or create a new one.
Properties
$tableManager
Database table plugin manager
protected
PluginManager
$tableManager
Methods
cleanup()
Clean up orphaned entries (i.e. entries that are not in favorites anymore)
public
cleanup() : int
Return values
int —Number of records deleted
createEntity()
Create a record entity object.
public
createEntity() : RecordEntityInterface
Return values
RecordEntityInterface —deleteRecord()
Delete a record by source and id. Return true if found and deleted, false if not found.
public
deleteRecord(string $id, string $source) : bool
Throws exception if something goes wrong.
Parameters
- $id : string
-
Record ID
- $source : string
-
Record source
Tags
Return values
bool —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 —getRecord()
Retrieve a record by id.
public
getRecord(string $id, string $source) : RecordEntityInterface|null
Parameters
- $id : string
-
Record ID
- $source : string
-
Record source
Return values
RecordEntityInterface|null —getRecords()
Retrieve records by ids.
public
getRecords(array<string|int, string> $ids, string $source) : array<string|int, RecordEntityInterface>
Parameters
- $ids : array<string|int, string>
-
Record IDs
- $source : string
-
Record source
Return values
array<string|int, RecordEntityInterface> —Array of record objects found
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
Return values
void —updateRecord()
Update an existing entry in the record table or create a new one.
public
updateRecord(string $id, string $source, mixed $rawData) : RecordEntityInterface
Parameters
- $id : string
-
Record ID
- $source : string
-
Data source
- $rawData : mixed
-
Raw data from source (must be serializable)