phpCAS Class Reference [User interface]

List of all members.

Static Public Member Functions
static	client ($server_version, $server_hostname, $server_port, $server_uri, $start_session=true)
static	proxy ($server_version, $server_hostname, $server_port, $server_uri, $start_session=true)
static	setDebug ($filename= '')
static	backtrace ()
static	log ($str)
static	error ($msg)
static	trace ($str)
static	traceBegin ()
static	traceEnd ($res= '')
static	traceExit ()
static	setLang ($lang)
static	getVersion ()
static	setHTMLHeader ($header)
static	setHTMLFooter ($footer)
static	setPGTStorage ($storage)
static	setPGTStorageDb ($dsn_or_pdo, $username='', $password='', $table='', $driver_options=null)
static	setPGTStorageFile ($format= '', $path= '')
static	serviceWeb ($url, &$err_code, &$output)
static	serviceMail ($url, $service, $flags, &$err_code, &$err_msg, &$pt)
static	setCacheTimesForAuthRecheck ($n)
static	setPostAuthenticateCallback ($function, array $additionalArgs=array())
static	setSingleSignoutCallback ($function, array $additionalArgs=array())
static	checkAuthentication ()
static	forceAuthentication ()
static	renewAuthentication ()
static	isAuthenticated ()
static	isSessionAuthenticated ()
static	getUser ()
static	getAttributes ()
static	hasAttributes ()
static	hasAttribute ($key)
static	getAttribute ($key)
static	handleLogoutRequests ($check_client=true, $allowed_clients=false)
static	getServerLoginURL ()
static	setServerLoginURL ($url= '')
static	setServerServiceValidateURL ($url= '')
static	setServerProxyValidateURL ($url= '')
static	setServerSamlValidateURL ($url= '')
static	getServerLogoutURL ()
static	setServerLogoutURL ($url= '')
static	logout ($params="")
static	logoutWithRedirectService ($service)
static	logoutWithUrl ($url)
static	logoutWithRedirectServiceAndUrl ($service, $url)
static	setFixedCallbackURL ($url= '')
static	setFixedServiceURL ($url)
static	getServiceURL ()
static	retrievePT ($target_service, &$err_code, &$err_msg)
static	setCasServerCACert ($cert)
static	setNoCasServerValidation ()
static	setExtraCurlOption ($key, $value)
static	getProxies ()

---

Detailed Description

The phpCAS class is a simple container for the phpCAS library. It provides CAS authentication for web applications written in PHP.

Author:

Pascal Aubry <pascal.aubry at univ-rennes1.fr>

Examples:

example_custom_urls.php, example_file.php, example_gateway.php, example_html.php, example_lang.php, example_proxy.php, example_proxy2.php, example_session_proxy.php, and example_simple.php.

Definition at line 318 of file CAS.php.

---

Member Function Documentation

static phpCAS::getProxies

(

)

[static]

Answer an array of proxies that are sitting in front of this application.

This method will only return a non-empty array if we have received and validated a Proxy Ticket.

Returns:

array public

Since:

6/25/09

Definition at line 1586 of file CAS.php.

References error().

static phpCAS::setExtraCurlOption	(	$	key,
		$	value
	)			[static]

Change CURL options. CURL is used to connect through HTTPS to CAS server

Parameters:

	$key	the option key
	$value	the value to set

Definition at line 1565 of file CAS.php.

References error(), traceBegin(), and traceEnd().