Modules | Functions | Variables

Configuration
[Implementation]

Modules

 Internal behaviour of phpCAS
 HTML output
 Internationalization

Functions

 CAS_Client::getServerVersion ()
 CAS_Client::getServerHostname ()
 CAS_Client::getServerPort ()
 CAS_Client::getServerURI ()
 CAS_Client::getServerBaseURL ()
 CAS_Client::getServerLoginURL ($gateway=false, $renew=false)
 CAS_Client::setServerLoginURL ($url)
 CAS_Client::setServerServiceValidateURL ($url)
 CAS_Client::setServerProxyValidateURL ($url)
 CAS_Client::setServerSamlValidateURL ($url)
 CAS_Client::getServerServiceValidateURL ()
 CAS_Client::getServerSamlValidateURL ()
 CAS_Client::getServerProxyValidateURL ()
 CAS_Client::getServerProxyURL ()
 CAS_Client::getServerLogoutURL ()
 CAS_Client::setServerLogoutURL ($url)
 CAS_Client::setExtraCurlOption ($key, $value)
 CAS_Client::__construct ($server_version, $proxy, $server_hostname, $server_port, $server_uri, $start_session=true)
 CAS_Client::setStartSession ($session)
 CAS_Client::getStartSession ($session)

Variables

 CAS_Client::$_server
 CAS_Client::$_curl_options = array()
 CAS_Client::$_start_session

Function Documentation

CAS_Client::__construct ( server_version,
proxy,
server_hostname,
server_port,
server_uri,
start_session = true 
) [inherited]

CAS_Client constructor.

Parameters:
$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)
Returns:
a newly created CAS_Client object

Definition at line 689 of file Client.php.

References phpCAS::error(), CAS_Client::getServerVersion(), CAS_Client::isCallbackMode(), CAS_Client::isHttps(), CAS_Client::isLogoutRequest(), CAS_Client::isProxy(), CAS_Client::setCallbackMode(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().

CAS_Client::getServerBaseURL (  )  [private, inherited]
CAS_Client::getServerHostname (  )  [private, inherited]

This method is used to retrieve the hostname of the CAS server.

Returns:
the hostname of the CAS server.

Definition at line 307 of file Client.php.

Referenced by CAS_Client::handleLogoutRequests().

CAS_Client::getServerLoginURL ( gateway = false,
renew = false 
) [inherited]

This method is used to retrieve the login URL of the CAS server.

Parameters:
$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
Returns:
a URL.

Definition at line 350 of file Client.php.

References CAS_Client::buildQueryUrl(), CAS_Client::getServerBaseURL(), CAS_Client::getURL(), phpCAS::traceBegin(), and phpCAS::traceEnd().

Referenced by CAS_Client::redirectToCas().

CAS_Client::getServerLogoutURL (  )  [inherited]

This method is used to retrieve the logout URL of the CAS server.

Returns:
a URL.

Definition at line 505 of file Client.php.

References CAS_Client::getServerBaseURL().

Referenced by CAS_Client::logout().

CAS_Client::getServerPort (  )  [private, inherited]

This method is used to retrieve the port of the CAS server.

Returns:
the port of the CAS server.

Definition at line 314 of file Client.php.

CAS_Client::getServerProxyURL (  )  [inherited]

This method is used to retrieve the proxy URL of the CAS server.

Returns:
a URL.

Definition at line 485 of file Client.php.

References CAS_Client::getServerBaseURL(), and CAS_Client::getServerVersion().

CAS_Client::getServerProxyValidateURL (  )  [inherited]

This method is used to retrieve the proxy validating URL of the CAS server.

Returns:
a URL.

Definition at line 461 of file Client.php.

References CAS_Client::buildQueryUrl(), CAS_Client::getServerBaseURL(), CAS_Client::getServerVersion(), CAS_Client::getURL(), phpCAS::traceBegin(), and phpCAS::traceEnd().

CAS_Client::getServerSamlValidateURL (  )  [inherited]

This method is used to retrieve the SAML validating URL of the CAS server.

Returns:
a URL.

Definition at line 440 of file Client.php.

References CAS_Client::buildQueryUrl(), CAS_Client::getServerBaseURL(), CAS_Client::getServerVersion(), CAS_Client::getURL(), phpCAS::traceBegin(), and phpCAS::traceEnd().

CAS_Client::getServerServiceValidateURL (  )  [inherited]

This method is used to retrieve the service validating URL of the CAS server.

Returns:
a URL.

Definition at line 418 of file Client.php.

References CAS_Client::buildQueryUrl(), CAS_Client::getServerBaseURL(), CAS_Client::getServerVersion(), CAS_Client::getURL(), phpCAS::traceBegin(), and phpCAS::traceEnd().

Referenced by CAS_Client::validateST().

CAS_Client::getServerURI (  )  [private, inherited]

This method is used to retrieve the URI of the CAS server.

Returns:
a URI.

Definition at line 321 of file Client.php.

CAS_Client::getServerVersion (  )  [private, inherited]

This method is used to retrieve the version of the CAS server.

Returns:
the version of the CAS server.

Definition at line 298 of file Client.php.

Referenced by CAS_Client::__construct(), CAS_Client::getServerProxyURL(), CAS_Client::getServerProxyValidateURL(), CAS_Client::getServerSamlValidateURL(), CAS_Client::getServerServiceValidateURL(), and CAS_Client::HTMLFilterOutput().

CAS_Client::getStartSession ( session  )  [inherited]

Definition at line 844 of file Client.php.

CAS_Client::setExtraCurlOption ( key,
value 
) [inherited]

This method is used to set additional user curl options.

Definition at line 532 of file Client.php.

CAS_Client::setServerLoginURL ( url  )  [inherited]

This method sets the login URL of the CAS server.

Parameters:
$url the login URL
Since:
0.4.21 by Wyman Chan

Definition at line 375 of file Client.php.

CAS_Client::setServerLogoutURL ( url  )  [inherited]

This method sets the logout URL of the CAS server.

Parameters:
$url the logout URL
Since:
0.4.21 by Wyman Chan

Definition at line 519 of file Client.php.

CAS_Client::setServerProxyValidateURL ( url  )  [inherited]

This method sets the proxyValidate URL of the CAS server.

Parameters:
$url the proxyValidate URL
Since:
1.1.0 by Joachim Fritschi

Definition at line 397 of file Client.php.

CAS_Client::setServerSamlValidateURL ( url  )  [inherited]

This method sets the samlValidate URL of the CAS server.

Parameters:
$url the samlValidate URL
Since:
1.1.0 by Joachim Fritschi

Definition at line 408 of file Client.php.

CAS_Client::setServerServiceValidateURL ( url  )  [inherited]

This method sets the serviceValidate URL of the CAS server.

Parameters:
$url the serviceValidate URL
Since:
1.1.0 by Joachim Fritschi

Definition at line 386 of file Client.php.

CAS_Client::setStartSession ( session  )  [private, inherited]

Definition at line 839 of file Client.php.


Variable Documentation

CAS_Client::$_curl_options = array() [private, inherited]

An array to store extra curl options.

Definition at line 527 of file Client.php.

CAS_Client::$_server [private, inherited]

a record to store information about the CAS server.

  • $_server["version"]: the version of the CAS server
  • $_server["hostname"]: the hostname of the CAS server
  • $_server["port"]: the port the CAS server is running on
  • $_server["uri"]: the base URI the CAS server is responding on
  • $_server["base_url"]: the base URL of the CAS server
  • $_server["login_url"]: the login URL of the CAS server
  • $_server["service_validate_url"]: the service validating URL of the CAS server
  • $_server["proxy_url"]: the proxy URL of the CAS server
  • $_server["proxy_validate_url"]: the proxy validating URL of the CAS server
  • $_server["logout_url"]: the logout URL of the CAS server

$_server["version"], $_server["hostname"], $_server["port"] and $_server["uri"] are written by CAS_Client::CAS_Client(), read by CAS_Client::getServerVersion(), CAS_Client::getServerHostname(), CAS_Client::getServerPort() and CAS_Client::getServerURI().

The other fields are written and read by CAS_Client::getServerBaseURL(), CAS_Client::getServerLoginURL(), CAS_Client::getServerServiceValidateURL(), CAS_Client::getServerProxyValidateURL() and CAS_Client::getServerLogoutURL().

Definition at line 288 of file Client.php.

CAS_Client::$_start_session [private, inherited]

A variable to whether phpcas will use its own session handling. Default = true

Definition at line 837 of file Client.php.