VuFind API Documentation

RelatedInterface

Related Records Interface

This interface class is the definition of the required methods for generating record recommendations.

Note that every class implementing this interface needs to be accompanied by a template file in the Related subdirectory of every theme's template directory. For example, \VuFind\Related\Similar needs a corresponding Related/Similar.phtml template. The template will be rendered as a partial with two available variables: related (the related records object) and driver (the record driver representing the source record).

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link

Wiki

Table of Contents

init()  : void
Establishes base settings for making recommendations.

Methods

init()

Establishes base settings for making recommendations.

public init(string $settings, AbstractBase $driver) : void
Parameters
$settings : string

Settings from config.ini

$driver : AbstractBase

Record driver object

Return values
void

Search results