Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
iAuthentication Interface Reference
Inheritance diagram for iAuthentication:
EC_Authentication

Public Member Functions

 startSession ($login=true)
 endSession ($logoff=false)
 sessionEstablished ()

Member Function Documentation

endSession ( logoff = false)

Closes a session and - if requested - logoff the user

Parameters:
bool$logoffIf set to True, also logoff the user

Implemented in EC_Authentication.

Check if the session has been established successfully

Returns:
bool True if the section has been established, false otherwise

Implemented in EC_Authentication.

startSession ( login = true)

Establish a session (and proceed with authentication if needed)

Parameters:
bool$logoinIf set to True, also login to the system
Returns:
iUser|bool An iUser object in case of success, false otherwise

Implemented in EC_Authentication.


The documentation for this interface was generated from the following file: