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 user_resource 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  Db_Interface
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 Main Site
28 */
29
30namespace VuFind\Db\Entity;
31
32use DateTime;
33
34/**
35 * Entity model interface for user_resource table
36 *
37 * @category VuFind
38 * @package  Db_Interface
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 Main Site
42 */
43interface UserResourceEntityInterface 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 user.
54     *
55     * @return UserEntityInterface
56     */
57    public function getUser(): UserEntityInterface;
58
59    /**
60     * Set user.
61     *
62     * @param UserEntityInterface $user User
63     *
64     * @return UserResourceEntityInterface
65     */
66    public function setUser(UserEntityInterface $user): UserResourceEntityInterface;
67
68    /**
69     * Get resource.
70     *
71     * @return ResourceEntityInterface
72     */
73    public function getResource(): ResourceEntityInterface;
74
75    /**
76     * Set resource.
77     *
78     * @param ResourceEntityInterface $resource Resource
79     *
80     * @return UserResourceEntityInterface
81     */
82    public function setResource(ResourceEntityInterface $resource): UserResourceEntityInterface;
83
84    /**
85     * Get user list.
86     *
87     * @return ?UserListEntityInterface
88     */
89    public function getUserList(): ?UserListEntityInterface;
90
91    /**
92     * Set user list.
93     *
94     * @param ?UserListEntityInterface $list User list
95     *
96     * @return UserResourceEntityInterface
97     */
98    public function setUserList(?UserListEntityInterface $list): UserResourceEntityInterface;
99
100    /**
101     * Get notes.
102     *
103     * @return ?string
104     */
105    public function getNotes(): ?string;
106
107    /**
108     * Set notes.
109     *
110     * @param ?string $notes Notes associated with the resource
111     *
112     * @return UserResourceEntityInterface
113     */
114    public function setNotes(?string $notes): UserResourceEntityInterface;
115
116    /**
117     * Get saved date.
118     *
119     * @return DateTime
120     */
121    public function getSaved(): DateTime;
122
123    /**
124     * Set saved date.
125     *
126     * @param DateTime $dateTime Created date
127     *
128     * @return UserResourceEntityInterface
129     */
130    public function setSaved(DateTime $dateTime): UserResourceEntityInterface;
131}