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_card 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_card 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 UserCardEntityInterface extends EntityInterface
44{
45    /**
46     * ID getter (returns null if the entity has not been saved/populated yet)
47     *
48     * @return ?int
49     */
50    public function getId(): ?int;
51
52    /**
53     * Card name setter
54     *
55     * @param string $cardName User card name.
56     *
57     * @return UserCardEntityInterface
58     */
59    public function setCardName(string $cardName): UserCardEntityInterface;
60
61    /**
62     * Get user card name.
63     *
64     * @return string
65     */
66    public function getCardName(): string;
67
68    /**
69     * Catalog username setter
70     *
71     * @param string $catUsername Catalog username
72     *
73     * @return UserCardEntityInterface
74     */
75    public function setCatUsername(string $catUsername): UserCardEntityInterface;
76
77    /**
78     * Get catalog username.
79     *
80     * @return string
81     */
82    public function getCatUsername(): string;
83
84    /**
85     * Raw catalog password setter
86     *
87     * @param ?string $catPassword Cat password
88     *
89     * @return UserCardEntityInterface
90     */
91    public function setRawCatPassword(?string $catPassword): UserCardEntityInterface;
92
93    /**
94     * Get raw catalog password.
95     *
96     * @return ?string
97     */
98    public function getRawCatPassword(): ?string;
99
100    /**
101     * Encrypted catalog password setter
102     *
103     * @param ?string $passEnc Encrypted password
104     *
105     * @return UserCardEntityInterface
106     */
107    public function setCatPassEnc(?string $passEnc): UserCardEntityInterface;
108
109    /**
110     * Get encrypted catalog password.
111     *
112     * @return ?string
113     */
114    public function getCatPassEnc(): ?string;
115
116    /**
117     * Home library setter
118     *
119     * @param ?string $homeLibrary Home library
120     *
121     * @return UserCardEntityInterface
122     */
123    public function setHomeLibrary(?string $homeLibrary): UserCardEntityInterface;
124
125    /**
126     * Get home library.
127     *
128     * @return ?string
129     */
130    public function getHomeLibrary(): ?string;
131
132    /**
133     * Created date setter.
134     *
135     * @param DateTime $dateTime Created date
136     *
137     * @return UserCardEntityInterface
138     */
139    public function setCreated(DateTime $dateTime): UserCardEntityInterface;
140
141    /**
142     * Get created date.
143     *
144     * @return DateTime
145     */
146    public function getCreated(): DateTime;
147
148    /**
149     * Set time the card is saved.
150     *
151     * @param DateTime $dateTime Saved date and time
152     *
153     * @return UserCardEntityInterface
154     */
155    public function setSaved(DateTime $dateTime): UserCardEntityInterface;
156
157    /**
158     * Get saved time.
159     *
160     * @return DateTime
161     */
162    public function getSaved(): DateTime;
163
164    /**
165     * User setter.
166     *
167     * @param UserEntityInterface $user User that owns card
168     *
169     * @return UserCardEntityInterface
170     */
171    public function setUser(UserEntityInterface $user): UserCardEntityInterface;
172
173    /**
174     * User getter
175     *
176     * @return UserEntityInterface
177     */
178    public function getUser(): UserEntityInterface;
179}