PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Interface IUserManager

IUserManager interface

IUserManager specifies the interface that must be implemented by a user manager class if it is to be used together with TAuthManager and TUser.

Direct known implementers

TDbUserManager, TUserManager
Package: System\Security
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Security/IUserManager.php
Methods summary
public string
# getGuestName( )

Returns

string
name for a guest user.
public TUser
# getUser( string $username = null )

Returns a user instance given the user name.

Returns a user instance given the user name.

Parameters

$username
string
user name, null if it is a guest.

Returns

TUser
the user instance, null if the specified username is not in the user database.
public TUser
# getUserFromCookie( THttpCookie $cookie )

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

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

Parameters

$cookie
THttpCookie
the cookie storing user authentication information

Returns

TUser
the user instance generated based on the cookie auth data, null if the cookie does not have valid auth data.

Since

3.1.1
public
# saveUserToCookie( THttpCookie $cookie )

Saves user auth data into a cookie.

Saves user auth data into a cookie.

Parameters

$cookie
THttpCookie
the cookie to receive the user auth data.

Since

3.1.1
public boolean
# validateUser( string $username, string $password )

Validates if the username and password are correct.

Validates if the username and password are correct.

Parameters

$username
string
user name
$password
string
password

Returns

boolean
true if validation is successful, false otherwise.
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO