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

Public Member Functions

 __construct ($session_name, $application_url, $ssl_certificate)
 startSession ($login=true)
 endSession ($logoff=false)
 sessionEstablished ()

Data Fields

const EC_ECAS_SERVER = 'https://ecas.cc.cec.eu.int:7002/cas'

Protected Member Functions

 call_ecas_login_page ()
 call_ecas_logoff_page ()
 checkECASTicket ($ticket)

Protected Attributes

 $application_url = false
 $application_url_with_query = false
 $session_name = false
 $ssl_certificate = false

Constructor & Destructor Documentation

__construct ( session_name,
application_url,
ssl_certificate 
)

Constructor

Parameters:
string$session_nameHTTP Session Name
string$ssl_certificateFull Path to the SSL Certificate
string$application_urlBase URL of your application (where ECAS has to redirect the user in case of successful authentication) public

Member Function Documentation

call_ecas_login_page ( ) [final, protected]

If needed, redirect to the ECAS login page public

call_ecas_logoff_page ( ) [final, protected]

Ends up the HTTP Session and Log off from ECAS public

checkECASTicket ( ticket) [final, protected]

Check the validity of an ECAS "ticket"

Parameters:
string$ticketECAS Ticket ID
Returns:
string|bool The User ID in case of success, false otherwise protected
endSession ( logoff = false)

Closes a session and - if requested - logoff the user

Parameters:
bool$logoffIf 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.

startSession ( login = true)

Establish a session (and proceed with authentication if needed)

Parameters:
bool$loginIf 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]
const EC_ECAS_SERVER = 'https://ecas.cc.cec.eu.int:7002/cas'

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