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 * Entity model interface for shortlinks table
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   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:database_gateways Wiki
28 */
29
30namespace VuFind\Db\Entity;
31
32use DateTime;
33
34/**
35 * Entity model interface for shortlinks table
36 *
37 * @category VuFind
38 * @package  Database
39 * @author   Demian Katz <demian.katz@villanova.edu>
40 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
41 * @link     https://vufind.org/wiki/development:plugins:database_gateways Wiki
42 */
43interface ShortlinksEntityInterface extends EntityInterface
44{
45    /**
46     * Get identifier (returns null for an uninitialized or non-persisted object).
47     *
48     * @return ?int
49     */
50    public function getId(): ?int;
51
52    /**
53     * Get the path of the URL.
54     *
55     * @return string
56     */
57    public function getPath(): string;
58
59    /**
60     * Set the path (e.g. /Search/Results?lookfor=foo) of the URL being shortened;
61     * shortened URLs are always assumed to be within the hostname where VuFind is running.
62     *
63     * @param string $path Path
64     *
65     * @return ShortlinksEntityInterface
66     */
67    public function setPath(string $path): ShortlinksEntityInterface;
68
69    /**
70     * Get shortlinks hash.
71     *
72     * @return ?string
73     */
74    public function getHash(): ?string;
75
76    /**
77     * Set shortlinks hash.
78     *
79     * @param ?string $hash Shortlinks hash
80     *
81     * @return ShortlinksEntityInterface
82     */
83    public function setHash(?string $hash): ShortlinksEntityInterface;
84
85    /**
86     * Get creation timestamp.
87     *
88     * @return DateTime
89     */
90    public function getCreated(): DateTime;
91
92    /**
93     * Set creation timestamp.
94     *
95     * @param DateTime $dateTime Creation timestamp
96     *
97     * @return ShortlinksEntityInterface
98     */
99    public function setCreated(DateTime $dateTime): ShortlinksEntityInterface;
100}