Class \Prado\Security\TDbUserManager

TDbUserManager class

TDbUserManager manages user accounts that are stored in a database. TDbUserManager is mainly designed to be used together with 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:

<module id="db"
    class="Prado\Data\TDataSourceConfig" ..../>
<module id="users"
    class="Prado\Security\TDbUserManager"
    UserClass="Path\To\MyUserClass"
    ConnectionID="db" />
<module id="auth"
    class="Prado\Security\TAuthManager"
    UserManager="users" LoginPage="Path\To\LoginPage" />

In the above, \Prado\Security\setUserClass specifies what class will be used to create user instance. The class must extend from TDbUser. \Prado\Security\setConnectionID refers to the ID of a TDataSourceConfig module which specifies how to establish database connection to retrieve user information.

Class hierarchy

\Prado\Security\TDbUserManager implements IUserManager, IDbModule

\Prado\TModule implements IModule

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.1.0

Methods summary
`public`	`getConnectionID() : string`
`public`	`getDbConnection() : TDbConnection`
`public`	`getGuestName() : string`
`public`	`getUser([null\|string $username = null ]) : TUser` Returns a user instance given the user name.
`public`	`getUserClass() : string`
`public`	`getUserFromCookie(THttpCookie $cookie) : TDbUser` Returns a user instance according to auth data stored in a cookie.
`public`	`init(array<string\|int, mixed>\|TXmlElement $config) : mixed` Initializes.
`public`	`saveUserToCookie(THttpCookie $cookie) : mixed` Saves user auth data into a cookie.
`public`	`setConnectionID(string $value) : mixed` Sets the ID of a TDataSourceConfig module. The datasource module will be used to establish the DB connection that will be used by the user manager.
`public`	`setGuestName(string $value) : mixed`
`public`	`setUserClass(string $value) : mixed`
`public`	`validateUser(string $username, string $password) : bool` Validates if the username and password are correct.
`protected`	`createDbConnection(string $connectionID) : TDbConnection` Creates the DB connection.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getID, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, listen, publishAsset, publishFilePath, raiseEvent, setID, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Security\TDbUserManager

Class hierarchy