Functions | |
CASClient::setUser ($user) | |
CASClient::getUser () | |
CASClient::setAttributes ($attributes) | |
CASClient::getAttributes () | |
CASClient::hasAttributes () | |
CASClient::hasAttribute ($key) | |
CASClient::getAttribute ($key) | |
CASClient::renewAuthentication () | |
CASClient::forceAuthentication () | |
CASClient::setCacheTimesForAuthRecheck ($n) | |
CASClient::checkAuthentication () | |
CASClient::isAuthenticated () | |
CASClient::isSessionAuthenticated () | |
CASClient::wasPreviouslyAuthenticated () | |
CASClient::redirectToCas ($gateway=false, $renew=false) | |
CASClient::logout ($params) | |
CASClient::isLogoutRequest () | |
CASClient::isLogoutRequestAllowed () | |
CASClient::handleLogoutRequests ($check_client=true, $allowed_clients=false) | |
Variables | |
CASClient::$_user | |
CASClient::$_attributes | |
CASClient::$_cache_times_for_auth_recheck |
CASClient::checkAuthentication | ( | ) | [inherited] |
This method is called to check whether the user is authenticated or not.
Definition at line 910 of file client.php.
References CASClient::isAuthenticated(), CASClient::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
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.
Definition at line 864 of file client.php.
References CASClient::isAuthenticated(), CASClient::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
CASClient::getAttribute | ( | $ | key | ) | [inherited] |
Definition at line 832 of file client.php.
References CASClient::hasAttribute().
CASClient::getAttributes | ( | ) | [inherited] |
Definition at line 819 of file client.php.
References phpCAS::error().
Referenced by CASClient::isAuthenticated().
CASClient::getUser | ( | ) | [inherited] |
This method returns the CAS user's login name.
Definition at line 791 of file client.php.
References phpCAS::error().
Referenced by CASClient::isAuthenticated().
CASClient::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 1188 of file client.php.
References phpCAS::error(), CASClient::getServerHostname(), CASClient::isLogoutRequest(), phpCAS::log(), phpCAS::traceBegin(), phpCAS::traceEnd(), and phpCAS::traceExit().
CASClient::hasAttribute | ( | $ | key | ) | [inherited] |
Definition at line 829 of file client.php.
Referenced by CASClient::getAttribute().
CASClient::hasAttributes | ( | ) | [inherited] |
Definition at line 826 of file client.php.
CASClient::isAuthenticated | ( | ) | [inherited] |
This method is called to check if the user is authenticated (previously or by tickets given in the URL).
Definition at line 967 of file client.php.
References CASClient::getAttributes(), CASClient::getPGT(), CASClient::getPT(), CASClient::getSA(), CASClient::getST(), CASClient::getURL(), CASClient::getUser(), CASClient::hasPT(), CASClient::hasSA(), CASClient::hasST(), CASClient::isProxy(), phpCAS::log(), phpCAS::trace(), phpCAS::traceBegin(), phpCAS::traceEnd(), CASClient::validatePGT(), CASClient::validatePT(), and CASClient::wasPreviouslyAuthenticated().
Referenced by CASClient::checkAuthentication(), CASClient::forceAuthentication(), and CASClient::renewAuthentication().
CASClient::isLogoutRequest | ( | ) | [private, inherited] |
Definition at line 1169 of file client.php.
Referenced by CASClient::CASClient(), and CASClient::handleLogoutRequests().
CASClient::isLogoutRequestAllowed | ( | ) | [private, inherited] |
Definition at line 1177 of file client.php.
CASClient::isSessionAuthenticated | ( | ) | [inherited] |
This method tells if the current session is authenticated.
Definition at line 1043 of file client.php.
Referenced by CASClient::wasPreviouslyAuthenticated().
CASClient::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 1140 of file client.php.
References CASClient::getServerLogoutURL(), CASClient::getString(), phpCAS::log(), CASClient::printHTMLFooter(), CASClient::printHTMLHeader(), phpCAS::traceBegin(), and phpCAS::traceExit().
CASClient::redirectToCas | ( | $ | gateway = false , |
|
$ | renew = false | |||
) | [inherited] |
This method is used to redirect the client to the CAS server. It is used by CASClient::forceAuthentication() and CASClient::checkAuthentication().
$gateway | true to check authentication, false to force it | |
$renew | true to force the authentication with the CAS server |
Definition at line 1119 of file client.php.
References CASClient::getServerLoginURL(), CASClient::getString(), phpCAS::log(), CASClient::printHTMLFooter(), CASClient::printHTMLHeader(), phpCAS::traceBegin(), and phpCAS::traceExit().
Referenced by CASClient::checkAuthentication(), CASClient::forceAuthentication(), and CASClient::renewAuthentication().
CASClient::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 844 of file client.php.
References CASClient::isAuthenticated(), CASClient::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
CASClient::setAttributes | ( | $ | attributes | ) | [inherited] |
Definition at line 816 of file client.php.
Referenced by CASClient::wasPreviouslyAuthenticated().
CASClient::setCacheTimesForAuthRecheck | ( | $ | n | ) | [inherited] |
Set the number of times authentication will be cached before rechecked.
$n | an integer. |
Definition at line 900 of file client.php.
CASClient::setUser | ( | $ | user | ) | [private, inherited] |
This method sets the CAS user's login name.
$user | the login name of the authenticated user. |
Definition at line 779 of file client.php.
Referenced by CASClient::validateST(), and CASClient::wasPreviouslyAuthenticated().
CASClient::wasPreviouslyAuthenticated | ( | ) | [private, inherited] |
This method tells if the user has already been (previously) authenticated by looking into the session variables.
Definition at line 1058 of file client.php.
References $auth, CASClient::callback(), CASClient::isCallbackMode(), CASClient::isProxy(), CASClient::isSessionAuthenticated(), CASClient::setAttributes(), CASClient::setPGT(), CASClient::setPT(), CASClient::setST(), CASClient::setUser(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
Referenced by CASClient::isAuthenticated().
CASClient::$_attributes [private, inherited] |
The Authenticated users attributes. Written by CASClient::setAttributes(), read by CASClient::getAttributes().
Definition at line 814 of file client.php.
CASClient::$_cache_times_for_auth_recheck [private, inherited] |
An integer that gives the number of times authentication will be cached before rechecked.
Definition at line 891 of file client.php.
CASClient::$_user [private, inherited] |
The Authenticated user. Written by CASClient::setUser(), read by CASClient::getUser().
Definition at line 770 of file client.php.