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

Mostra file Open project: pradosoft/prado

Public Methods

Method	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.

Protected Methods

Method	Description
createDbConnection ( $connectionID ) : TDbConnection	Creates the DB connection.

Method Details

createDbConnection() protected method

Creates the DB connection.

protected createDbConnection ( $connectionID ) : TDbConnection
return	TDbConnection	the created DB connection

getConnectionID() public method

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

getDbConnection() public method

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

getGuestName() public method

public getGuestName ( ) : string
return	string	guest name, defaults to 'Guest'

getUser() public method

Returns a user instance given the user name.

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

getUserClass() public method

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

getUserFromCookie() public method

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

Since: 3.1.1

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

init() public method

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

public init ( $config )

saveUserToCookie() public method

Saves user auth data into a cookie.

Since: 3.1.1

public saveUserToCookie ( $cookie )

setConnectionID() public method

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

public setConnectionID ( $value )

setGuestName() public method

public setGuestName ( $value )

setUserClass() public method

public setUserClass ( $value )

validateUser() public method

Validates if the username and password are correct.

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