Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * DOI linker interface
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2018.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  DOI
25 * @author   Demian Katz <demian.katz@villanova.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development:plugins:record_drivers Wiki
28 */
29
30namespace VuFind\DoiLinker;
31
32/**
33 * DOI linker interface
34 *
35 * @category VuFind
36 * @package  DOI
37 * @author   Demian Katz <demian.katz@villanova.edu>
38 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39 * @link     https://vufind.org/wiki/development:plugins:record_drivers Wiki
40 */
41interface DoiLinkerInterface
42{
43    /**
44     * Given an array of DOIs, perform a lookup and return an associative array
45     * of arrays, keyed by DOI. Each array contains one or more associative arrays
46     * with required 'link' (URL to related resource) and 'label' (display text)
47     * keys and an optional 'icon' (URL to icon graphic) or localIcon (name of
48     * configured icon in theme) key.
49     *
50     * @param array $doiArray DOIs to look up
51     *
52     * @return array
53     */
54    public function getLinks(array $doiArray);
55}