UserCard
extends RowGateway
in package
implements
DbServiceAwareInterface, UserCardEntityInterface
Uses
DbServiceAwareTrait
Row Definition for user_card
Tags
Interfaces, Classes, Traits and Enums
- DbServiceAwareInterface
- Marker interface for classes that depend on the \VuFind\Db\Service\PluginManager
- UserCardEntityInterface
- Entity model interface for user_card table
Table of Contents
- $card_name : string
- $cat_pass_enc : string|null
- $cat_password : string|null
- $cat_username : string
- $created : string
- $home_library : string|null
- $id : int
- $saved : string
- $user_id : int
- $dbServiceManager : PluginManager
- Database service plugin manager
- __construct() : mixed
- Constructor
- getCardName() : string
- Get user card name.
- getCatPassEnc() : string|null
- Get encrypted catalog password.
- getCatUsername() : string
- Get catalog username.
- getCreated() : DateTime
- Get created date.
- getDbService() : T
- Get a database service object.
- getDbServiceManager() : PluginManager
- Get the service plugin manager. Throw an exception if it is missing.
- getHomeLibrary() : string|null
- Get home library.
- getId() : int|null
- ID getter (returns null if the entity has not been saved/populated yet)
- getPrimaryKeyColumn() : array<string|int, mixed>
- Retrieve primary key information.
- getRawCatPassword() : string|null
- Get raw catalog password.
- getSaved() : DateTime
- Get saved time.
- getUser() : UserEntityInterface
- User getter
- setCardName() : UserCardEntityInterface
- Card name setter
- setCatPassEnc() : UserCardEntityInterface
- Encrypted catalog password setter
- setCatUsername() : UserCardEntityInterface
- Catalog username setter
- setCreated() : UserCardEntityInterface
- Created date setter.
- setDbServiceManager() : void
- Set the service plugin manager.
- setHomeLibrary() : UserCardEntityInterface
- Home library setter
- setRawCatPassword() : UserCardEntityInterface
- Raw catalog password setter
- setSaved() : UserCardEntityInterface
- Set time the card is saved.
- setUser() : UserCardEntityInterface
- User setter.
Properties
$card_name
public
string
$card_name
$cat_pass_enc
public
string|null
$cat_pass_enc
$cat_password
public
string|null
$cat_password
$cat_username
public
string
$cat_username
$created
public
string
$created
$home_library
public
string|null
$home_library
$id
public
int
$id
$saved
public
string
$saved
$user_id
public
int
$user_id
$dbServiceManager
Database service plugin manager
protected
PluginManager
$dbServiceManager
Methods
__construct()
Constructor
public
__construct(Adapter $adapter) : mixed
Parameters
- $adapter : Adapter
-
Database adapter
Return values
mixed —getCardName()
Get user card name.
public
getCardName() : string
Return values
string —getCatPassEnc()
Get encrypted catalog password.
public
getCatPassEnc() : string|null
Return values
string|null —getCatUsername()
Get catalog username.
public
getCatUsername() : string
Return values
string —getCreated()
Get created date.
public
getCreated() : DateTime
Return values
DateTime —getDbService()
Get a database service object.
public
getDbService(class-string<\VuFind\Db\Service\T> $name) : T
Parameters
- $name : class-string<\VuFind\Db\Service\T>
-
Name of service to retrieve
Tags
Return values
T —getDbServiceManager()
Get the service plugin manager. Throw an exception if it is missing.
public
getDbServiceManager() : PluginManager
Tags
Return values
PluginManager —getHomeLibrary()
Get home library.
public
getHomeLibrary() : string|null
Return values
string|null —getId()
ID getter (returns null if the entity has not been saved/populated yet)
public
getId() : int|null
Return values
int|null —getPrimaryKeyColumn()
Retrieve primary key information.
public
getPrimaryKeyColumn() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRawCatPassword()
Get raw catalog password.
public
getRawCatPassword() : string|null
Return values
string|null —getSaved()
Get saved time.
public
getSaved() : DateTime
Return values
DateTime —getUser()
User getter
public
getUser() : UserEntityInterface
Return values
UserEntityInterface —setCardName()
Card name setter
public
setCardName(string $cardName) : UserCardEntityInterface
Parameters
- $cardName : string
-
User card name.
Return values
UserCardEntityInterface —setCatPassEnc()
Encrypted catalog password setter
public
setCatPassEnc(string|null $passEnc) : UserCardEntityInterface
Parameters
- $passEnc : string|null
-
Encrypted password
Return values
UserCardEntityInterface —setCatUsername()
Catalog username setter
public
setCatUsername(string $catUsername) : UserCardEntityInterface
Parameters
- $catUsername : string
-
Catalog username
Return values
UserCardEntityInterface —setCreated()
Created date setter.
public
setCreated(DateTime $dateTime) : UserCardEntityInterface
Parameters
- $dateTime : DateTime
-
Created date
Return values
UserCardEntityInterface —setDbServiceManager()
Set the service plugin manager.
public
setDbServiceManager(PluginManager $manager) : void
Parameters
- $manager : PluginManager
-
Plugin manager
Return values
void —setHomeLibrary()
Home library setter
public
setHomeLibrary(string|null $homeLibrary) : UserCardEntityInterface
Parameters
- $homeLibrary : string|null
-
Home library
Return values
UserCardEntityInterface —setRawCatPassword()
Raw catalog password setter
public
setRawCatPassword(string|null $catPassword) : UserCardEntityInterface
Parameters
- $catPassword : string|null
-
Cat password
Return values
UserCardEntityInterface —setSaved()
Set time the card is saved.
public
setSaved(DateTime $dateTime) : UserCardEntityInterface
Parameters
- $dateTime : DateTime
-
Saved date and time
Return values
UserCardEntityInterface —setUser()
User setter.
public
setUser(UserEntityInterface $user) : UserCardEntityInterface
Parameters
- $user : UserEntityInterface
-
User that owns card