Constructor & Destructor Documentation
__construct |
( |
$ |
session_name, |
|
|
$ |
application_url, |
|
|
$ |
ssl_certificate |
|
) |
| |
Constructor
- Parameters:
-
string | $session_name | HTTP Session Name |
string | $ssl_certificate | Full Path to the SSL Certificate |
string | $application_url | Base URL of your application (where ECAS has to redirect the user in case of successful authentication) public |
Member Function Documentation
If needed, redirect to the ECAS login page public
Ends up the HTTP Session and Log off from ECAS public
Check the validity of an ECAS "ticket"
- Parameters:
-
string | $ticket | ECAS Ticket ID |
- Returns:
- string|bool The User ID in case of success, false otherwise protected
Closes a session and - if requested - logoff the user
- Parameters:
-
bool | $logoff | If set to True, also logoff the user |
Implements iAuthentication.
Check if the session has been established successfully
- Returns:
- bool True if the section has been established, false otherwise
Implements iAuthentication.
Establish a session (and proceed with authentication if needed)
- Parameters:
-
bool | $login | If set to True also login to the system, otherwise just create an HTTP session (this parameter should always be set to true, but at logoff time) |
- Returns:
- iUser|bool An iUser object in case of success, false otherwise
Implements iAuthentication.
Field Documentation
$application_url = false [protected] |
$application_url_with_query = false [protected] |
$session_name = false [protected] |
$ssl_certificate = false [protected] |
The documentation for this class was generated from the following file: