VuFind API Documentation

Ratings extends RowGateway
in package
implements RatingsEntityInterface, DbTableAwareInterface, DbServiceAwareInterface Uses DbTableAwareTrait, DbServiceAwareTrait

Row Definition for ratings

Tags
category

VuFind

author

Ere Maijala ere.maijala@helsinki.fi

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Main Site

Interfaces, Classes, Traits and Enums

RatingsEntityInterface
Entity model interface for ratings table
DbTableAwareInterface
Marker interface for classes that depend on the \VuFind\Db\Table\PluginManager
DbServiceAwareInterface
Marker interface for classes that depend on the \VuFind\Db\Service\PluginManager

Table of Contents

$created  : string
$id  : int
$rating  : int
$resource_id  : int
$user_id  : int
$dbServiceManager  : PluginManager
Database service plugin manager
$tableManager  : PluginManager
Database table plugin manager
__construct()  : mixed
Constructor
getCreated()  : DateTime
Get created date.
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.
getId()  : int|null
Get identifier (returns null for an uninitialized or non-persisted object).
getPrimaryKeyColumn()  : array<string|int, mixed>
Retrieve primary key information.
getRating()  : int
Get rating.
getResource()  : ResourceEntityInterface
Get resource.
getUser()  : UserEntityInterface|null
Get user.
setCreated()  : RatingsEntityInterface
Set created date.
setDbServiceManager()  : void
Set the service plugin manager.
setDbTableManager()  : void
Set the table plugin manager.
setRating()  : RatingsEntityInterface
Set rating.
setResource()  : RatingsEntityInterface
Set resource.
setUser()  : RatingsEntityInterface
Set user.

Properties

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

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
template

T

Return values
T

getDbTable()

Get a database table object.

public getDbTable(string $table) : Gateway
Parameters
$table : string

Table to load.

Return values
Gateway

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>

getRating()

Get rating.

public getRating() : int
Return values
int

Search results