Functions | |
CASClient::setUser ($user) | |
CASClient::getUser () | |
CASClient::forceAuthentication () | |
CASClient::setCacheTimesForAuthRequest ($n) | |
CASClient::checkAuthentication () | |
CASClient::isAuthenticated () | |
CASClient::isSessionAuthenticated () | |
CASClient::wasPreviouslyAuthenticated () | |
CASClient::redirectToCas ($gateway=false) | |
CASClient::logout ($url="") | |
Variables | |
CASClient::$_user | |
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 667 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 623 of file client.php.
References CASClient::isAuthenticated(), CASClient::redirectToCas(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
Referenced by CASClient::getUser().
CASClient::getUser | ( | ) | [inherited] |
This method returns the CAS user's login name.
Definition at line 609 of file client.php.
References phpCAS::error(), CASClient::forceAuthentication(), and CASClient::isAuthenticated().
Referenced by CASClient::isAuthenticated(), and CASClient::serviceMail().
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 724 of file client.php.
References CASClient::getPGT(), CASClient::getPT(), CASClient::getST(), CASClient::getUser(), CASClient::hasPT(), CASClient::hasST(), CASClient::isProxy(), phpCAS::trace(), phpCAS::traceBegin(), phpCAS::traceEnd(), 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.
Definition at line 776 of file client.php.
Referenced by CASClient::wasPreviouslyAuthenticated().
CASClient::logout | ( | $ | url = "" |
) | [inherited] |
This method is used to logout from CAS.
$url | a URL that will be transmitted to the CAS server (to come back to when logged out) |
Definition at line 865 of file client.php.
References CASClient::getServerLogoutURL(), CASClient::getString(), CASClient::printHTMLFooter(), CASClient::printHTMLHeader(), phpCAS::traceBegin(), and phpCAS::traceExit().
Referenced by CASClient::getServerLogoutURL().
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().
$gateway | true to check authentication, false to force it |
Definition at line 848 of file client.php.
References CASClient::getServerLoginURL(), CASClient::getString(), CASClient::printHTMLFooter(), CASClient::printHTMLHeader(), phpCAS::traceBegin(), and phpCAS::traceExit().
Referenced by CASClient::checkAuthentication(), and CASClient::forceAuthentication().
CASClient::setCacheTimesForAuthRequest | ( | $ | n | ) | [inherited] |
Set the number of times authentication will be cached before rechecked.
$n | an integer. |
Definition at line 657 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 597 of file client.php.
Referenced by CASClient::validatePT(), 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 791 of file client.php.
References CASClient::callback(), CASClient::isCallbackMode(), CASClient::isProxy(), CASClient::isSessionAuthenticated(), CASClient::setPGT(), CASClient::setPT(), CASClient::setST(), CASClient::setUser(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
Referenced by CASClient::isAuthenticated().
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 648 of file client.php.
CASClient::$_user [private, inherited] |
The Authenticated user. Written by CASClient::setUser(), read by CASClient::getUser().
Definition at line 588 of file client.php.