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 feedback 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 feedback 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 FeedbackEntityInterface extends EntityInterface
44{
45    /**
46     * Id getter
47     *
48     * @return int
49     */
50    public function getId(): int;
51
52    /**
53     * Message setter
54     *
55     * @param string $message Message
56     *
57     * @return FeedbackEntityInterface
58     */
59    public function setMessage(string $message): FeedbackEntityInterface;
60
61    /**
62     * Message getter
63     *
64     * @return string
65     */
66    public function getMessage(): string;
67
68    /**
69     * Form data setter.
70     *
71     * @param array $data Form data
72     *
73     * @return FeedbackEntityInterface
74     */
75    public function setFormData(array $data): FeedbackEntityInterface;
76
77    /**
78     * Form data getter
79     *
80     * @return array
81     */
82    public function getFormData(): array;
83
84    /**
85     * Form name setter.
86     *
87     * @param string $name Form name
88     *
89     * @return FeedbackEntityInterface
90     */
91    public function setFormName(string $name): FeedbackEntityInterface;
92
93    /**
94     * Form name getter
95     *
96     * @return string
97     */
98    public function getFormName(): string;
99
100    /**
101     * Created setter.
102     *
103     * @param DateTime $dateTime Created date
104     *
105     * @return FeedbackEntityInterface
106     */
107    public function setCreated(DateTime $dateTime): FeedbackEntityInterface;
108
109    /**
110     * Created getter
111     *
112     * @return DateTime
113     */
114    public function getCreated(): DateTime;
115
116    /**
117     * Updated setter.
118     *
119     * @param DateTime $dateTime Last update date
120     *
121     * @return FeedbackEntityInterface
122     */
123    public function setUpdated(DateTime $dateTime): FeedbackEntityInterface;
124
125    /**
126     * Updated getter
127     *
128     * @return DateTime
129     */
130    public function getUpdated(): DateTime;
131
132    /**
133     * Status setter.
134     *
135     * @param string $status Status
136     *
137     * @return FeedbackEntityInterface
138     */
139    public function setStatus(string $status): FeedbackEntityInterface;
140
141    /**
142     * Status getter
143     *
144     * @return string
145     */
146    public function getStatus(): string;
147
148    /**
149     * Site URL setter.
150     *
151     * @param string $url Site URL
152     *
153     * @return FeedbackEntityInterface
154     */
155    public function setSiteUrl(string $url): FeedbackEntityInterface;
156
157    /**
158     * Site URL getter
159     *
160     * @return string
161     */
162    public function getSiteUrl(): string;
163
164    /**
165     * User setter.
166     *
167     * @param ?UserEntityInterface $user User that created request
168     *
169     * @return FeedbackEntityInterface
170     */
171    public function setUser(?UserEntityInterface $user): FeedbackEntityInterface;
172
173    /**
174     * User getter
175     *
176     * @return ?UserEntityInterface
177     */
178    public function getUser(): ?UserEntityInterface;
179
180    /**
181     * Updatedby setter.
182     *
183     * @param ?UserEntityInterface $user User that updated request
184     *
185     * @return FeedbackEntityInterface
186     */
187    public function setUpdatedBy(?UserEntityInterface $user): FeedbackEntityInterface;
188
189    /**
190     * Updatedby getter
191     *
192     * @return ?UserEntityInterface
193     */
194    public function getUpdatedBy(): ?UserEntityInterface;
195}