Interface Accountable

Description

Accountable interface for authentication

Any class that handles user authentication must implement this interface. It makes it almost trivial to check whether a user is currently logged in or not.

Located in /classes/Accountable.php (line 23)


	
			
Class Constant Summary
 AUTHENTICATION_ERR_MSG = 'There is no user account associated with the current session. Try logging in fist.'
Method Summary
Account getAccount ([string $user = ''])
bool isLoggedIn ()
Methods
getAccount (line 49)

Returns user account info

This method is used to retrieve the account corresponding to a given login. Note: it is not required that the user be currently logged in.

  • access: public
Account getAccount ([string $user = ''])
  • string $user: user name of the account
isLoggedIn (line 36)

Did the current user log in?

This method simply answers the question "Did the current user log in?"

  • access: public
bool isLoggedIn ()
Class Constants
AUTHENTICATION_ERR_MSG = 'There is no user account associated with the current session. Try logging in fist.' (line 25)

Documentation generated on Mon, 26 Jul 2010 22:07:03 +0100 by phpDocumentor 1.4.3