About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:plugins:database_gateways

Database Gateway Plugins

VuFind uses Laminas' table/row gateway classes to communicate with the database. The plugin managers described here control how gateway objects are retrieved.

Table Gateways

Key Plugin Details

Default Namespace: \VuFind\Db\Table

Base Class: \VuFind\Db\Table\Gateway

Service Locator Configuration Section in module.config.php: ['vufind']['plugin_managers']['db_table']

Service Manager Name for Service Locator: VuFind\DBTablePluginManager (VuFind 2.x-4.x), VuFind\Db\Table\PluginManager (VuFind 5.0+)

See the General Plugin Information page for more details on VuFind plugins.

Row Gateways

:!: Prior to VuFind 4.0, each table class specifies the associated row class, so if you need to override a row class, you also need to override the table class, if only to change how it loads rows. Starting in release 4.0, the row-specific plugin manager was added to allow direct row overriding.

Key Plugin Details

Default Namespace: \VuFind\Db\Row

Base Class: \VuFind\Db\Row\RowGateway

Service Locator Configuration Section in module.config.php: ['vufind']['plugin_managers']['db_row']

Service Manager Name for Service Locator: VuFind\DBRowPluginManager (VuFind 2.x-4.x), VuFind\Db\Row\PluginManager (VuFind 5.0+)

See the General Plugin Information page for more details on VuFind plugins.

development/plugins/database_gateways.txt · Last modified: 2020/09/22 14:19 by demiankatz