PHP Класс 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.

С версии: 3.1.0

Автор: Qiang Xue ([email protected])

Наследование: extends Prado\TModule, implements IUserManager

Показать файл Открыть проект

Открытые методы

Метод	Описание
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.

Защищенные методы

Метод	Описание
createDbConnection ( $connectionID ) : TDbConnection	Creates the DB connection.

Описание методов

createDbConnection() защищенный метод

Creates the DB connection.

protected createDbConnection ( $connectionID ) : TDbConnection
Результат	TDbConnection	the created DB connection

getConnectionID() публичный метод

public getConnectionID ( ) : string
Результат	string	the ID of a TDataSourceConfig module. Defaults to empty string, meaning not set.

getDbConnection() публичный метод

public getDbConnection ( ) : TDbConnection
Результат	TDbConnection	the database connection that may be used to retrieve user data.

getGuestName() публичный метод

public getGuestName ( ) : string
Результат	string	guest name, defaults to 'Guest'

getUser() публичный метод

Returns a user instance given the user name.

public getUser ( $username = null ) : TUser
Результат	TUser	the user instance, null if the specified username is not in the user database.

getUserClass() публичный метод

public getUserClass ( ) : string
Результат	string	the user class name in namespace format. Defaults to empty string, meaning not set.

getUserFromCookie() публичный метод

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

С версии: 3.1.1

public getUserFromCookie ( $cookie ) : TDbUser
Результат	TDbUser	the user instance generated based on the cookie auth data, null if the cookie does not have valid auth data.

init() публичный метод

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

public init ( $config )

saveUserToCookie() публичный метод

Saves user auth data into a cookie.

С версии: 3.1.1

public saveUserToCookie ( $cookie )

setConnectionID() публичный метод

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

public setConnectionID ( $value )

setGuestName() публичный метод

public setGuestName ( $value )

setUserClass() публичный метод

public setUserClass ( $value )

validateUser() публичный метод

Validates if the username and password are correct.

public validateUser ( $username, $password ) : boolean
Результат	boolean	true if validation is successful, false otherwise.