UserAccountService
in package
implements
DbServiceAwareInterface
Uses
DbServiceAwareTrait
User account service
Tags
Interfaces, Classes, Traits and Enums
- DbServiceAwareInterface
- Marker interface for classes that depend on the \VuFind\Db\Service\PluginManager
Table of Contents
- $dbServiceManager : PluginManager
- Database service plugin manager
- $favoritesService : FavoritesService
- __construct() : mixed
- Constructor
- getDbService() : T
- Get a database service object.
- getDbServiceManager() : PluginManager
- Get the service plugin manager. Throw an exception if it is missing.
- purgeUserData() : void
- Destroy the user.
- setDbServiceManager() : void
- Set the service plugin manager.
Properties
$dbServiceManager
Database service plugin manager
protected
PluginManager
$dbServiceManager
$favoritesService
protected
FavoritesService
$favoritesService
Methods
__construct()
Constructor
public
__construct(FavoritesService $favoritesService) : mixed
Parameters
- $favoritesService : FavoritesService
-
Favorites service
Return values
mixed —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 —purgeUserData()
Destroy the user.
public
purgeUserData(UserEntityInterface $user[, bool $removeComments = true ][, bool $removeRatings = true ]) : void
Parameters
- $user : UserEntityInterface
-
User to delete
- $removeComments : bool = true
-
Whether to remove user's comments
- $removeRatings : bool = true
-
Whether to remove user's ratings
Return values
void —setDbServiceManager()
Set the service plugin manager.
public
setDbServiceManager(PluginManager $manager) : void
Parameters
- $manager : PluginManager
-
Plugin manager