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_list 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 | |
30 | namespace VuFind\Db\Entity; |
31 | |
32 | use DateTime; |
33 | |
34 | /** |
35 | * Entity model interface for user_list 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 | */ |
43 | interface UserListEntityInterface 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 | * Set title. |
54 | * |
55 | * @param string $title Title |
56 | * |
57 | * @return UserListEntityInterface |
58 | */ |
59 | public function setTitle(string $title): UserListEntityInterface; |
60 | |
61 | /** |
62 | * Get title. |
63 | * |
64 | * @return string |
65 | */ |
66 | public function getTitle(): string; |
67 | |
68 | /** |
69 | * Set description. |
70 | * |
71 | * @param ?string $description Description |
72 | * |
73 | * @return UserListEntityInterface |
74 | */ |
75 | public function setDescription(?string $description): UserListEntityInterface; |
76 | |
77 | /** |
78 | * Get description. |
79 | * |
80 | * @return ?string |
81 | */ |
82 | public function getDescription(): ?string; |
83 | |
84 | /** |
85 | * Set created date. |
86 | * |
87 | * @param DateTime $dateTime Created date |
88 | * |
89 | * @return UserListEntityInterface |
90 | */ |
91 | public function setCreated(DateTime $dateTime): UserListEntityInterface; |
92 | |
93 | /** |
94 | * Get created date. |
95 | * |
96 | * @return DateTime |
97 | */ |
98 | public function getCreated(): DateTime; |
99 | |
100 | /** |
101 | * Set whether the list is public. |
102 | * |
103 | * @param bool $public Is the list public? |
104 | * |
105 | * @return UserListEntityInterface |
106 | */ |
107 | public function setPublic(bool $public): UserListEntityInterface; |
108 | |
109 | /** |
110 | * Is this a public list? |
111 | * |
112 | * @return bool |
113 | */ |
114 | public function isPublic(): bool; |
115 | |
116 | /** |
117 | * Set user. |
118 | * |
119 | * @param ?UserEntityInterface $user User owning the list. |
120 | * |
121 | * @return UserListEntityInterface |
122 | */ |
123 | public function setUser(?UserEntityInterface $user): UserListEntityInterface; |
124 | |
125 | /** |
126 | * Get user. |
127 | * |
128 | * @return ?UserEntityInterface |
129 | */ |
130 | public function getUser(): ?UserEntityInterface; |
131 | } |