Modules | |
| HTML output | |
| Internationalization | |
Functions | |
| CASClient::getServerVersion () | |
| CASClient::getServerHostname () | |
| CASClient::getServerPort () | |
| CASClient::getServerURI () | |
| CASClient::getServerBaseURL () | |
| CASClient::getServerLoginURL ($gateway=false, $renew=false) | |
| CASClient::setServerLoginURL ($url) | |
| CASClient::setServerServiceValidateURL ($url) | |
| CASClient::setServerProxyValidateURL ($url) | |
| CASClient::setServerSamlValidateURL ($url) | |
| CASClient::getServerServiceValidateURL () | |
| CASClient::getServerSamlValidateURL () | |
| CASClient::getServerProxyValidateURL () | |
| CASClient::getServerProxyURL () | |
| CASClient::getServerLogoutURL () | |
| CASClient::setServerLogoutURL ($url) | |
| CASClient::setExtraCurlOption ($key, $value) | |
| CASClient::isHttps () | |
| CASClient::CASClient ($server_version, $proxy, $server_hostname, $server_port, $server_uri, $start_session=true) | |
Variables | |
| CASClient::$_server | |
| CASClient::$_curl_options = array() | |
| CASClient::CASClient | ( | $ | server_version, | |
| $ | proxy, | |||
| $ | server_hostname, | |||
| $ | server_port, | |||
| $ | server_uri, | |||
| $ | start_session = true | |||
| ) | [inherited] |
CASClient constructor.
| $server_version | the version of the CAS server | |
| $proxy | TRUE if the CAS client is a CAS proxy, FALSE otherwise | |
| $server_hostname | the hostname of the CAS server | |
| $server_port | the port the CAS server is running on | |
| $server_uri | the URI the CAS server is responding on | |
| $start_session | Have phpCAS start PHP sessions (default true) |
Definition at line 574 of file client.php.
References phpCAS::error(), CASClient::getServerVersion(), CASClient::isCallbackMode(), CASClient::isHttps(), CASClient::isLogoutRequest(), CASClient::isProxy(), CASClient::setCallbackMode(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().
| CASClient::getServerBaseURL | ( | ) | [private, inherited] |
This method is used to retrieve the base URL of the CAS server.
Definition at line 331 of file client.php.
Referenced by CASClient::getServerLoginURL(), CASClient::getServerLogoutURL(), CASClient::getServerProxyURL(), CASClient::getServerProxyValidateURL(), CASClient::getServerSamlValidateURL(), CASClient::getServerServiceValidateURL(), and CASClient::HTMLFilterOutput().
| CASClient::getServerHostname | ( | ) | [private, inherited] |
This method is used to retrieve the hostname of the CAS server.
Definition at line 307 of file client.php.
Referenced by CASClient::handleLogoutRequests().
| CASClient::getServerLoginURL | ( | $ | gateway = false, |
|
| $ | renew = false | |||
| ) | [private, inherited] |
This method is used to retrieve the login URL of the CAS server.
| $gateway | true to check authentication, false to force it | |
| $renew | true to force the authentication with the CAS server NOTE : It is recommended that CAS implementations ignore the "gateway" parameter if "renew" is set |
Definition at line 353 of file client.php.
References CASClient::getServerBaseURL(), CASClient::getURL(), phpCAS::traceBegin(), and phpCAS::traceEnd().
Referenced by CASClient::redirectToCas().
| CASClient::getServerLogoutURL | ( | ) | [private, inherited] |
This method is used to retrieve the logout URL of the CAS server.
Definition at line 509 of file client.php.
References CASClient::getServerBaseURL().
Referenced by CASClient::logout().
| CASClient::getServerPort | ( | ) | [private, inherited] |
This method is used to retrieve the port of the CAS server.
Definition at line 315 of file client.php.
| CASClient::getServerProxyURL | ( | ) | [private, inherited] |
This method is used to retrieve the proxy URL of the CAS server.
Definition at line 488 of file client.php.
References CASClient::getServerBaseURL(), and CASClient::getServerVersion().
| CASClient::getServerProxyValidateURL | ( | ) | [private, inherited] |
This method is used to retrieve the proxy validating URL of the CAS server.
Definition at line 466 of file client.php.
References CASClient::getServerBaseURL(), CASClient::getServerVersion(), and CASClient::getURL().
| CASClient::getServerSamlValidateURL | ( | ) | [private, inherited] |
This method is used to retrieve the SAML validating URL of the CAS server.
Definition at line 447 of file client.php.
References CASClient::getServerBaseURL(), CASClient::getServerVersion(), CASClient::getURL(), phpCAS::traceBegin(), and phpCAS::traceEnd().
| CASClient::getServerServiceValidateURL | ( | ) | [private, inherited] |
This method is used to retrieve the service validating URL of the CAS server.
Definition at line 426 of file client.php.
References CASClient::getServerBaseURL(), CASClient::getServerVersion(), and CASClient::getURL().
Referenced by CASClient::validateST().
| CASClient::getServerURI | ( | ) | [private, inherited] |
This method is used to retrieve the URI of the CAS server.
Definition at line 323 of file client.php.
| CASClient::getServerVersion | ( | ) | [private, inherited] |
This method is used to retrieve the version of the CAS server.
Definition at line 297 of file client.php.
Referenced by CASClient::CASClient(), CASClient::getServerProxyURL(), CASClient::getServerProxyValidateURL(), CASClient::getServerSamlValidateURL(), CASClient::getServerServiceValidateURL(), and CASClient::HTMLFilterOutput().
| CASClient::isHttps | ( | ) | [private, inherited] |
This method checks to see if the request is secured via HTTPS
Definition at line 547 of file client.php.
Referenced by CASClient::CASClient().
| CASClient::setExtraCurlOption | ( | $ | key, | |
| $ | value | |||
| ) | [inherited] |
This method is used to set additional user curl options.
Definition at line 537 of file client.php.
| CASClient::setServerLoginURL | ( | $ | url | ) | [private, inherited] |
This method sets the login URL of the CAS server.
| $url | the login URL |
Definition at line 379 of file client.php.
| CASClient::setServerLogoutURL | ( | $ | url | ) | [private, inherited] |
This method sets the logout URL of the CAS server.
| $url | the logout URL |
Definition at line 524 of file client.php.
| CASClient::setServerProxyValidateURL | ( | $ | url | ) | [private, inherited] |
This method sets the proxyValidate URL of the CAS server.
| $url | the proxyValidate URL |
Definition at line 403 of file client.php.
| CASClient::setServerSamlValidateURL | ( | $ | url | ) | [private, inherited] |
This method sets the samlValidate URL of the CAS server.
| $url | the samlValidate URL |
Definition at line 415 of file client.php.
| CASClient::setServerServiceValidateURL | ( | $ | url | ) | [private, inherited] |
This method sets the serviceValidate URL of the CAS server.
| $url | the serviceValidate URL |
Definition at line 391 of file client.php.
CASClient::$_curl_options = array() [inherited] |
An array to store extra curl options.
Definition at line 532 of file client.php.
CASClient::$_server [private, inherited] |
a record to store information about the CAS server.
$_server["version"], $_server["hostname"], $_server["port"] and $_server["uri"] are written by CASClient::CASClient(), read by CASClient::getServerVersion(), CASClient::getServerHostname(), CASClient::getServerPort() and CASClient::getServerURI().
The other fields are written and read by CASClient::getServerBaseURL(), CASClient::getServerLoginURL(), CASClient::getServerServiceValidateURL(), CASClient::getServerProxyValidateURL() and CASClient::getServerLogoutURL().
Definition at line 285 of file client.php.
1.6.3