VuFind API Documentation

Doi extends AbstractHelper
in package

DOI view helper

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

$area  : string
OpenURL context ('results', 'record' or 'holdings')
$config  : Config
VuFind OpenURL configuration
$context  : Context
Context helper
$recordDriver  : RecordDriver
Current RecordDriver
__construct()  : mixed
Constructor
__invoke()  : object
Set up context for helper
isActive()  : bool
Public method to check whether OpenURLs are active for current record
renderTemplate()  : string
Public method to render the OpenURL template
checkContext()  : bool
Does the configuration indicate that we should display DOI links in the specified context?

Properties

$area

OpenURL context ('results', 'record' or 'holdings')

protected string $area

$config

VuFind OpenURL configuration

protected Config $config

$recordDriver

Current RecordDriver

protected RecordDriver $recordDriver

Methods

__construct()

Constructor

public __construct(Context $context[, Config $config = null ]) : mixed
Parameters
$context : Context

Context helper

$config : Config = null

VuFind OpenURL config

Return values
mixed

__invoke()

Set up context for helper

public __invoke(RecordDriver $driver, string $area) : object
Parameters
$driver : RecordDriver

The current record driver

$area : string

DOI context ('results', 'record' or 'holdings'

Return values
object

isActive()

Public method to check whether OpenURLs are active for current record

public isActive() : bool
Return values
bool

renderTemplate()

Public method to render the OpenURL template

public renderTemplate([bool $imagebased = null ]) : string
Parameters
$imagebased : bool = null

Indicates if an image based link should be displayed or not (null for system default)

Return values
string

checkContext()

Does the configuration indicate that we should display DOI links in the specified context?

protected checkContext() : bool
Return values
bool

Search results