Main Page | Modules | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages | Examples

Authentication
[Implementation]


Functions

 CASClient::setUser ($user)
 CASClient::getUser ()
 CASClient::forceAuthentication ()
 CASClient::checkAuthentication ()
 CASClient::isAuthenticated ()
 CASClient::isSessionAuthenticated ()
 CASClient::wasPreviouslyAuthenticated ()
 CASClient::redirectToCas ($gateway=false)
 CASClient::logout ($url="")

Variables

 CASClient::$_user

Function Documentation

CASClient::checkAuthentication  )  [inherited]
 

This method is called to check whether the ser is authenticated or not.

Returns:
TRUE when the user is authenticated, FALSE otherwise.

Definition at line 635 of file client.php.

References CASClient::isAuthenticated(), CASClient::redirectToCas(), and phpCAS::traceBegin().

CASClient::forceAuthentication  )  [inherited]
 

This method is called to be sure that the user is authenticated. When not authenticated, halt by redirecting to the CAS server; otherwise return TRUE.

Returns:
TRUE when the user is authenticated; otherwise halt.

Definition at line 611 of file client.php.

References CASClient::isAuthenticated(), CASClient::redirectToCas(), and phpCAS::traceBegin().

Referenced by CASClient::getUser().

CASClient::getUser  )  [inherited]
 

This method returns the CAS user's login name.

Warning:
should be called only after CASClient::forceAuthentication() or CASClient::isAuthenticated(), otherwise halt with an error.
Returns:
the login name of the authenticated user

Definition at line 597 of file client.php.

References CASClient::forceAuthentication(), and CASClient::isAuthenticated().

Referenced by CASClient::isAuthenticated().

CASClient::isAuthenticated  )  [inherited]
 

This method is called to check if the user is authenticated (previously or by tickets given in the URL

Returns:
TRUE when the user is authenticated; otherwise halt.

Definition at line 664 of file client.php.

References CASClient::getPGT(), CASClient::getUser(), CASClient::isProxy(), phpCAS::traceBegin(), CASClient::validatePGT(), CASClient::validatePT(), CASClient::validateST(), and CASClient::wasPreviouslyAuthenticated().

Referenced by CASClient::checkAuthentication(), CASClient::forceAuthentication(), and CASClient::getUser().

CASClient::isSessionAuthenticated  )  [inherited]
 

This method tells if the current session is authenticated.

Returns:
true if authenticated based soley on $_SESSION variable
Since:
0.4.22 by Brendan Arnold

Definition at line 713 of file client.php.

Referenced by CASClient::wasPreviouslyAuthenticated().

CASClient::logout url = ""  )  [inherited]
 

This method is used to logout from CAS.

Parameters:
$url a URL that will be transmitted to the CAS server (to come back to when logged out)

Definition at line 802 of file client.php.

References CAS_STR_LOGOUT, CAS_STR_SHOULD_HAVE_BEEN_REDIRECTED, CASClient::getServerLogoutURL(), CASClient::logout(), CASClient::printHTMLFooter(), phpCAS::traceBegin(), and phpCAS::traceExit().

Referenced by CASClient::getServerLogoutURL(), and CASClient::logout().

CASClient::redirectToCas gateway = false  )  [inherited]
 

This method is used to redirect the client to the CAS server. It is used by CASClient::forceAuthentication() and CASClient::checkAuthentication().

Parameters:
$gateway true to check authentication, false to force it

Definition at line 785 of file client.php.

References CAS_STR_AUTHENTICATION_WANTED, CAS_STR_SHOULD_HAVE_BEEN_REDIRECTED, CASClient::printHTMLFooter(), CASClient::redirectToCas(), phpCAS::traceBegin(), and phpCAS::traceExit().

Referenced by CASClient::checkAuthentication(), CASClient::forceAuthentication(), and CASClient::redirectToCas().

CASClient::setUser user  )  [private, inherited]
 

This method sets the CAS user's login name.

Parameters:
$user the login name of the authenticated user.

Definition at line 585 of file client.php.

References CASClient::setUser().

Referenced by CASClient::setUser().

CASClient::wasPreviouslyAuthenticated  )  [private, inherited]
 

This method tells if the user has already been (previously) authenticated by looking into the session variables.

Note:
This function switches to callback mode when needed.
Returns:
TRUE when the user has already been authenticated; FALSE otherwise.

Definition at line 728 of file client.php.

References CASClient::callback(), CASClient::isCallbackMode(), CASClient::isProxy(), CASClient::isSessionAuthenticated(), CASClient::setPGT(), CASClient::setPT(), CASClient::setST(), and phpCAS::traceBegin().

Referenced by CASClient::isAuthenticated().


Variable Documentation

CASClient::$_user [private, inherited]
 

The Authenticated user. Written by CASClient::setUser(), read by CASClient::getUser().

Attention:
client applications should use phpCAS::getUser().

Definition at line 576 of file client.php.


Generated on Thu Aug 17 02:03:22 2006 for phpCAS by doxygen 1.3.7