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 IUser

IUser interface.

This interface must be implemented by user objects.

Direct known implementers

TUser

Indirect known implementers

TDbUser
Package: System
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at interfaces.php
Methods summary
public string
# getName( )

Returns

string
username
public
# setName( string $value )

Parameters

$value
string
username
public boolean
# getIsGuest( )

Returns

boolean
if the user is a guest
public
# setIsGuest( boolean $value )

Parameters

$value
boolean
if the user is a guest
public array
# getRoles( )

Returns

array
list of roles that the user is of
public array|string
# setRoles( mixed $value )

Returns

array|string
list of roles that the user is of. If it is a string, roles are assumed by separated by comma
public boolean
# isInRole( string $role )

Parameters

$role
string
role to be tested

Returns

boolean
whether the user is of this role
public string
# saveToString( )

Returns

string
user data that is serialized and will be stored in session
public IUser
# loadFromString( string $string )

Parameters

$string
string
user data that is serialized and restored from session

Returns

IUser
the user object
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