VuFind API Documentation

Tags extends RowGateway
in package
implements DbTableAwareInterface, TagsEntityInterface Uses DbTableAwareTrait

Row Definition for tags

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link

Main Site

Interfaces, Classes, Traits and Enums

DbTableAwareInterface
Marker interface for classes that depend on the \VuFind\Db\Table\PluginManager
TagsEntityInterface
Entity model interface for tags table

Table of Contents

$id  : int
$tag  : string
$tableManager  : PluginManager
Database table plugin manager
__construct()  : mixed
Constructor
getDbTable()  : Gateway
Get a database table object.
getDbTableManager()  : PluginManager
Get the table plugin manager. Throw an exception if it is missing.
getId()  : int
Id getter
getPrimaryKeyColumn()  : array<string|int, mixed>
Retrieve primary key information.
getResources()  : array<string|int, mixed>
Get all resources associated with the current tag.
getTag()  : string
Tag getter
setDbTableManager()  : void
Set the table plugin manager.
setTag()  : TagsEntityInterface
Tag setter

Properties

Methods

__construct()

Constructor

public __construct(Adapter $adapter) : mixed
Parameters
$adapter : Adapter

Database adapter

Return values
mixed

getDbTable()

Get a database table object.

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

Table to load.

Return values
Gateway

getId()

Id getter

public getId() : int
Return values
int

getPrimaryKeyColumn()

Retrieve primary key information.

public getPrimaryKeyColumn() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResources()

Get all resources associated with the current tag.

public getResources([string $source = null ][, string $sort = null ], int $offset[, int $limit = null ]) : array<string|int, mixed>
Parameters
$source : string = null

Record source (optional limiter)

$sort : string = null

Resource field to sort on (optional)

$offset : int

Offset for results

$limit : int = null

Limit for results (null for none)

Return values
array<string|int, mixed>

getTag()

Tag getter

public getTag() : string
Return values
string

Search results