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 659 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 411 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 390 of file client.php.
Referenced by CASClient::handleLogoutRequests().
CASClient::getServerLoginURL | ( | $ | gateway = false , |
|
$ | renew = false | |||
) | [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 433 of file client.php.
References CASClient::getServerBaseURL(), CASClient::getURL(), phpCAS::traceBegin(), and phpCAS::traceEnd().
Referenced by CASClient::redirectToCas().
CASClient::getServerLogoutURL | ( | ) | [inherited] |
This method is used to retrieve the logout URL of the CAS server.
Definition at line 577 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 397 of file client.php.
CASClient::getServerProxyURL | ( | ) | [inherited] |
This method is used to retrieve the proxy URL of the CAS server.
Definition at line 557 of file client.php.
References CASClient::getServerBaseURL(), and CASClient::getServerVersion().
CASClient::getServerProxyValidateURL | ( | ) | [inherited] |
This method is used to retrieve the proxy validating URL of the CAS server.
Definition at line 537 of file client.php.
References CASClient::getServerBaseURL(), CASClient::getServerVersion(), and CASClient::getURL().
CASClient::getServerSamlValidateURL | ( | ) | [inherited] |
This method is used to retrieve the SAML validating URL of the CAS server.
Definition at line 519 of file client.php.
References CASClient::getServerBaseURL(), CASClient::getServerVersion(), CASClient::getURL(), phpCAS::traceBegin(), and phpCAS::traceEnd().
CASClient::getServerServiceValidateURL | ( | ) | [inherited] |
This method is used to retrieve the service validating URL of the CAS server.
Definition at line 500 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 404 of file client.php.
CASClient::getServerVersion | ( | ) | [private, inherited] |
This method is used to retrieve the version of the CAS server.
Definition at line 381 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 636 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 604 of file client.php.
CASClient::setRequestImplementation | ( | $ | className | ) | [inherited] |
Override the default implementation used to make web requests in readUrl(). This class must implement the CAS_RequestInterface.
string | $className |
Definition at line 624 of file client.php.
CASClient::setServerLoginURL | ( | $ | url | ) | [inherited] |
This method sets the login URL of the CAS server.
$url | the login URL |
Definition at line 457 of file client.php.
CASClient::setServerLogoutURL | ( | $ | url | ) | [inherited] |
This method sets the logout URL of the CAS server.
$url | the logout URL |
Definition at line 591 of file client.php.
CASClient::setServerProxyValidateURL | ( | $ | url | ) | [inherited] |
This method sets the proxyValidate URL of the CAS server.
$url | the proxyValidate URL |
Definition at line 479 of file client.php.
CASClient::setServerSamlValidateURL | ( | $ | url | ) | [inherited] |
This method sets the samlValidate URL of the CAS server.
$url | the samlValidate URL |
Definition at line 490 of file client.php.
CASClient::setServerServiceValidateURL | ( | $ | url | ) | [inherited] |
This method sets the serviceValidate URL of the CAS server.
$url | the serviceValidate URL |
Definition at line 468 of file client.php.
CASClient::$_curl_options = array() [private, inherited] |
An array to store extra curl options.
Definition at line 599 of file client.php.
CASClient::$_requestImplementation = 'CAS_CurlRequest' [private, inherited] |
The class to instantiate for making web requests in readUrl(). The class specified must implement the CAS_RequestInterface. By default CAS_CurlRequest is used, but this may be overridden to supply alternate request mechanisms for testing.
Definition at line 615 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 371 of file client.php.