Functions | |
CAS_Client::setUser ($user) | |
CAS_Client::getUser () | |
CAS_Client::setAttributes ($attributes) | |
CAS_Client::getAttributes () | |
CAS_Client::hasAttributes () | |
CAS_Client::hasAttribute ($key) | |
CAS_Client::getAttribute ($key) | |
CAS_Client::renewAuthentication () | |
CAS_Client::forceAuthentication () | |
CAS_Client::setCacheTimesForAuthRecheck ($n) | |
CAS_Client::checkAuthentication () | |
CAS_Client::isAuthenticated () | |
CAS_Client::isSessionAuthenticated () | |
CAS_Client::wasPreviouslyAuthenticated () | |
CAS_Client::redirectToCas ($gateway=false, $renew=false) | |
CAS_Client::logout ($params) | |
CAS_Client::isLogoutRequest () | |
CAS_Client::handleLogoutRequests ($check_client=true, $allowed_clients=false) | |
Variables | |
CAS_Client::$_user | |
CAS_Client::$_attributes | |
CAS_Client::$_cache_times_for_auth_recheck |
CAS_Client::checkAuthentication | ( | ) | [inherited] |
This method is called to check whether the user is authenticated or not.
Definition at line 1001 of file Client.php.
References CAS_Client::isAuthenticated(), CAS_Client::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
CAS_Client::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.
Definition at line 958 of file Client.php.
References CAS_Client::isAuthenticated(), CAS_Client::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
CAS_Client::getAttribute | ( | $ | key | ) | [inherited] |
Definition at line 928 of file Client.php.
References CAS_Client::hasAttribute().
CAS_Client::getAttributes | ( | ) | [inherited] |
Definition at line 915 of file Client.php.
References phpCAS::error().
Referenced by CAS_Client::isAuthenticated().
CAS_Client::getUser | ( | ) | [inherited] |
This method returns the CAS user's login name.
Definition at line 888 of file Client.php.
References phpCAS::error().
Referenced by CAS_Client::isAuthenticated().
CAS_Client::handleLogoutRequests | ( | $ | check_client = true , |
|
$ | allowed_clients = false | |||
) | [inherited] |
This method handles logout requests.
$check_client | true to check the client bofore handling the request, false not to perform any access control. True by default. | |
$allowed_clients | an array of host names allowed to send logout requests. By default, only the CAs server (declared in the constructor) will be allowed. |
Definition at line 1312 of file Client.php.
References phpCAS::error(), CAS_Client::getServerHostname(), CAS_Client::isLogoutRequest(), phpCAS::trace(), phpCAS::traceBegin(), phpCAS::traceEnd(), and phpCAS::traceExit().
CAS_Client::hasAttribute | ( | $ | key | ) | [inherited] |
Definition at line 925 of file Client.php.
Referenced by CAS_Client::getAttribute().
CAS_Client::hasAttributes | ( | ) | [inherited] |
Definition at line 922 of file Client.php.
Referenced by CAS_Client::isAuthenticated().
CAS_Client::isAuthenticated | ( | ) | [inherited] |
This method is called to check if the user is authenticated (previously or by tickets given in the URL).
Definition at line 1052 of file Client.php.
References CAS_Client::getAttributes(), CAS_Client::getPGT(), CAS_Client::getPT(), CAS_Client::getSA(), CAS_Client::getST(), CAS_Client::getURL(), CAS_Client::getUser(), CAS_Client::hasAttributes(), CAS_Client::hasPT(), CAS_Client::hasSA(), CAS_Client::hasST(), CAS_Client::isProxy(), phpCAS::trace(), phpCAS::traceBegin(), phpCAS::traceEnd(), phpCAS::traceExit(), CAS_Client::validatePGT(), CAS_Client::validatePT(), and CAS_Client::wasPreviouslyAuthenticated().
Referenced by CAS_Client::checkAuthentication(), CAS_Client::forceAuthentication(), and CAS_Client::renewAuthentication().
CAS_Client::isLogoutRequest | ( | ) | [private, inherited] |
Definition at line 1301 of file Client.php.
Referenced by CAS_Client::__construct(), and CAS_Client::handleLogoutRequests().
CAS_Client::isSessionAuthenticated | ( | ) | [inherited] |
This method tells if the current session is authenticated.
Definition at line 1163 of file Client.php.
Referenced by CAS_Client::wasPreviouslyAuthenticated().
CAS_Client::logout | ( | $ | params | ) | [inherited] |
This method is used to logout from CAS. $params an array that contains the optional url and service parameters that will be passed to the CAS server
Definition at line 1273 of file Client.php.
References $cas_url, CAS_Client::getServerLogoutURL(), CAS_Client::getString(), CAS_Client::printHTMLFooter(), CAS_Client::printHTMLHeader(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceExit().
CAS_Client::redirectToCas | ( | $ | gateway = false , |
|
$ | renew = false | |||
) | [inherited] |
This method is used to redirect the client to the CAS server. It is used by CAS_Client::forceAuthentication() and CAS_Client::checkAuthentication().
$gateway | true to check authentication, false to force it | |
$renew | true to force the authentication with the CAS server |
Definition at line 1253 of file Client.php.
References $cas_url, CAS_Client::getServerLoginURL(), CAS_Client::getString(), CAS_Client::printHTMLFooter(), CAS_Client::printHTMLHeader(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceExit().
Referenced by CAS_Client::checkAuthentication(), CAS_Client::forceAuthentication(), and CAS_Client::renewAuthentication().
CAS_Client::renewAuthentication | ( | ) | [inherited] |
This method is called to renew the authentication of the user If the user is authenticated, renew the connection If not, redirect to CAS
Definition at line 939 of file Client.php.
References CAS_Client::isAuthenticated(), CAS_Client::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
CAS_Client::setAttributes | ( | $ | attributes | ) | [inherited] |
Definition at line 912 of file Client.php.
Referenced by CAS_Client::wasPreviouslyAuthenticated().
CAS_Client::setCacheTimesForAuthRecheck | ( | $ | n | ) | [inherited] |
Set the number of times authentication will be cached before rechecked.
$n | an integer. |
Definition at line 991 of file Client.php.
CAS_Client::setUser | ( | $ | user | ) | [private, inherited] |
This method sets the CAS user's login name.
$user | the login name of the authenticated user. |
Definition at line 876 of file Client.php.
Referenced by CAS_Client::validateST(), and CAS_Client::wasPreviouslyAuthenticated().
CAS_Client::wasPreviouslyAuthenticated | ( | ) | [private, inherited] |
This method tells if the user has already been (previously) authenticated by looking into the session variables.
Definition at line 1176 of file Client.php.
References $auth, CAS_Client::callback(), CAS_Client::isCallbackMode(), CAS_Client::isProxy(), CAS_Client::isSessionAuthenticated(), CAS_Client::setAttributes(), CAS_Client::setPGT(), CAS_Client::setProxies(), CAS_Client::setPT(), CAS_Client::setST(), CAS_Client::setUser(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
Referenced by CAS_Client::isAuthenticated().
CAS_Client::$_attributes [private, inherited] |
The Authenticated users attributes. Written by CAS_Client::setAttributes(), read by CAS_Client::getAttributes().
Definition at line 910 of file Client.php.
CAS_Client::$_cache_times_for_auth_recheck [private, inherited] |
An integer that gives the number of times authentication will be cached before rechecked.
Definition at line 984 of file Client.php.
CAS_Client::$_user [private, inherited] |
The Authenticated user. Written by CAS_Client::setUser(), read by CAS_Client::getUser().
Definition at line 868 of file Client.php.