PHP Class Prado\Security\TDbUserManager

TDbUserManager manages user accounts that are stored in a database. TDbUserManager is mainly designed to be used together with {@link TAuthManager} which manages how users are authenticated and authorized in a Prado application. To use TDbUserManager together with TAuthManager, configure them in the application configuration like following:

In the above, {@link setUserClass UserClass} specifies what class will be used to create user instance. The class must extend from {@link TDbUser}. {@link setConnectionID ConnectionID} refers to the ID of a {@link TDataSourceConfig} module which specifies how to establish database connection to retrieve user information.

Since: 3.1.0

Author: Qiang Xue ([email protected])

Inheritance: extends Prado\TModule, implements IUserManager

Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode	Description
getConnectionID ( ) : string
getDbConnection ( ) : TDbConnection
getGuestName ( ) : string
getUser ( $username = null ) : TUser	Returns a user instance given the user name.
getUserClass ( ) : string
getUserFromCookie ( $cookie ) : TDbUser	Returns a user instance according to auth data stored in a cookie.
init ( $config )	Initializes the module.
saveUserToCookie ( $cookie )	Saves user auth data into a cookie.
setConnectionID ( $value )	Sets the ID of a TDataSourceConfig module.
setGuestName ( $value )
setUserClass ( $value )
validateUser ( $username, $password ) : boolean	Validates if the username and password are correct.

Méthodes protégées

Méthode	Description
createDbConnection ( $connectionID ) : TDbConnection	Creates the DB connection.

Method Details

createDbConnection() protected méthode

Creates the DB connection.

protected createDbConnection ( $connectionID ) : TDbConnection
Résultat	TDbConnection	the created DB connection

getConnectionID() public méthode

public getConnectionID ( ) : string
Résultat	string	the ID of a TDataSourceConfig module. Defaults to empty string, meaning not set.

getDbConnection() public méthode

public getDbConnection ( ) : TDbConnection
Résultat	TDbConnection	the database connection that may be used to retrieve user data.

getGuestName() public méthode

public getGuestName ( ) : string
Résultat	string	guest name, defaults to 'Guest'

getUser() public méthode

Returns a user instance given the user name.

public getUser ( $username = null ) : TUser
Résultat	TUser	the user instance, null if the specified username is not in the user database.

getUserClass() public méthode

public getUserClass ( ) : string
Résultat	string	the user class name in namespace format. Defaults to empty string, meaning not set.

getUserFromCookie() public méthode

Returns a user instance according to auth data stored in a cookie.

Since: 3.1.1

public getUserFromCookie ( $cookie ) : TDbUser
Résultat	TDbUser	the user instance generated based on the cookie auth data, null if the cookie does not have valid auth data.

init() public méthode

This method is required by IModule and is invoked by application.

public init ( $config )

saveUserToCookie() public méthode

Saves user auth data into a cookie.

Since: 3.1.1

public saveUserToCookie ( $cookie )

setConnectionID() public méthode

The datasource module will be used to establish the DB connection that will be used by the user manager.

public setConnectionID ( $value )

setGuestName() public méthode

public setGuestName ( $value )

setUserClass() public méthode

public setUserClass ( $value )

validateUser() public méthode

Validates if the username and password are correct.

public validateUser ( $username, $password ) : boolean
Résultat	boolean	true if validation is successful, false otherwise.