Packages » Package usher » Class UsherUser

Class UsherUser

Declaration:
<? class UsherUser implements User ?>

Implemented Interfaces:
User

Methods:
  • __construct()
  • assignRole()
    Assign a role to the user. Implementations that do not support roles may ignore calls to this method
  • getID()
    Get the user ID of this user. This ID must be unique and the underlying user management system must guarantee that this ID will be ever changed for this particluar user.
  • getLogin()
    Get the login name of this user. The login name is the string of symbols that this user enters to login into the application. The underlying user management system must guarantee that there are no duplicate login names at the same time; however, this login name may change (unlike the user ID)
  • getPassword()
    Get the user's password
  • getProperty()
    Get a particular property of the user (or the user's profile). This method is designed to be the general contract of quering different user details for different possible user system implementations.
  • getRoles()
    Return all the roles of this user. Implementations that do not support roles must return empty arrays
  • isLoggingIn()
    This method should return true if the user has logged in by the currently executing action (i.e., is "logging in"). The implementations that do not support this may always return true. The return value of this method is recommendative; it must not be relied on when checking if the user is actually logged in.
  • isRole()
    Check if the user has the specified role
  • revokeRole()
    Revoke a role form the user. Implementations that do not support roles may ignore calls to this method
  • setLogin()
    Set new login name for this user
  • setPassword()
    Set the user's password
  • setProperties()
    Set multiple properties passed as an array
  • setProperty()
    Set a paricular property of the user