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 * Database service interface for shortlinks.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2024.
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  Database
25 * @author   Sudharma Kellampalli <skellamp@villanova.edu>
26 * @author   Demian Katz <demian.katz@villanova.edu>
27 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
28 * @link     https://vufind.org/wiki/development:plugins:database_gateways Wiki
29 */
30
31namespace VuFind\Db\Service;
32
33use VuFind\Db\Entity\ShortlinksEntityInterface;
34
35/**
36 * Database service interface for shortlinks.
37 *
38 * @category VuFind
39 * @package  Database
40 * @author   Sudharma Kellampalli <skellamp@villanova.edu>
41 * @author   Demian Katz <demian.katz@villanova.edu>
42 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
43 * @link     https://vufind.org/wiki/development:plugins:database_gateways interface
44 */
45interface ShortlinksServiceInterface extends DbServiceInterface
46{
47    /**
48     * Create a short link entity.
49     *
50     * @return ShortlinksEntityInterface
51     */
52    public function createEntity(): ShortlinksEntityInterface;
53
54    /**
55     * Create and persist an entity for the provided path.
56     *
57     * @param string $path Path part of URL being shortened.
58     *
59     * @return ShortlinksEntityInterface
60     */
61    public function createAndPersistEntityForPath(string $path): ShortlinksEntityInterface;
62
63    /**
64     * Look up a short link by hash value.
65     *
66     * @param string $hash Hash value.
67     *
68     * @return ?ShortlinksEntityInterface
69     */
70    public function getShortLinkByHash(string $hash): ?ShortlinksEntityInterface;
71
72    /**
73     * Get rows with missing hashes (for legacy upgrading).
74     *
75     * @return ShortlinksEntityInterface[]
76     */
77    public function getShortLinksWithMissingHashes(): array;
78}