phpCAS Class Reference

The phpCAS class is a simple container for the phpCAS library. More...

Collaboration diagram for phpCAS:

Public Member Functions
	client ($server_version, $server_hostname, $server_port, $server_uri, $start_session=true)
	phpCAS client initializer.
	proxy ($server_version, $server_hostname, $server_port, $server_uri, $start_session=true)
	phpCAS proxy initializer.
	setDebug ($filename= '')
	Set/unset debug mode.
	backtrace ()
	This method is a wrapper for debug_backtrace() that is not available in all PHP versions (>= 4.3.0 only)
	trace ($str)
	This method is used to log something in debug mode.
	traceBegin ()
	This method is used to indicate the start of the execution of a function in debug mode.
	traceEnd ($res= '')
	This method is used to indicate the end of the execution of a function in debug mode.
	traceExit ()
	This method is used to indicate the end of the execution of the program.
	setLang ($lang)
	This method is used to set the language used by phpCAS.
	getVersion ()
	This method returns the phpCAS version.
	setHTMLHeader ($header)
	This method sets the HTML header used for all outputs.
	setHTMLFooter ($footer)
	This method sets the HTML footer used for all outputs.
	setPGTStorageFile ($format= '', $path= '')
	This method is used to tell phpCAS to store the response of the CAS server to PGT requests onto the filesystem.
	setPGTStorageDB ($user, $password, $database_type= '', $hostname= '', $port=0, $database= '', $table= '')
	This method is used to tell phpCAS to store the response of the CAS server to PGT requests into a database.
	serviceWeb ($url, &$err_code, &$output)
	This method is used to access an HTTP[S] service.
	serviceMail ($url, $service, $flags, &$err_code, &$err_msg, &$pt)
	This method is used to access an IMAP/POP3/NNTP service.
	setCacheTimesForAuthRecheck ($n)
	Set the times authentication will be cached before really accessing the CAS server in gateway mode:
	checkAuthentication ()
	This method is called to check if the user is authenticated (use the gateway feature).
	forceAuthentication ()
	This method is called to force authentication if the user was not already authenticated.
	renewAuthentication ()
	This method is called to renew the authentication.
	authenticate ()
	This method has been left from version 0.4.1 for compatibility reasons.
	isAuthenticated ()
	This method is called to check if the user is authenticated (previously or by tickets given in the URL).
	isSessionAuthenticated ()
	Checks whether authenticated based on $_SESSION.
	getUser ()
	This method returns the CAS user's login name.
	getAttributes ()
	This method returns the CAS user's login name.
	handleLogoutRequests ($check_client=true, $allowed_clients=false)
	Handle logout requests.
	getServerLoginURL ()
	This method returns the URL to be used to login.
	setServerLoginURL ($url= '')
	Set the login URL of the CAS server.
	setServerServiceValidateURL ($url= '')
	Set the serviceValidate URL of the CAS server.
	setServerProxyValidateURL ($url= '')
	Set the proxyValidate URL of the CAS server.
	setServerSamlValidateURL ($url= '')
	Set the samlValidate URL of the CAS server.
	getServerLogoutURL ()
	This method returns the URL to be used to login.
	setServerLogoutURL ($url= '')
	Set the logout URL of the CAS server.
	logout ($params="")
	This method is used to logout from CAS.
	logoutWithRedirectService ($service)
	This method is used to logout from CAS.
	logoutWithUrl ($url)
	This method is used to logout from CAS.
	logoutWithRedirectServiceAndUrl ($service, $url)
	This method is used to logout from CAS.
	setFixedCallbackURL ($url= '')
	Set the fixed URL that will be used by the CAS server to transmit the PGT.
	setFixedServiceURL ($url)
	Set the fixed URL that will be set as the CAS service parameter.
	getServiceURL ()
	Get the URL that is set as the CAS service parameter.
	retrievePT ($target_service, &$err_code, &$err_msg)
	Retrieve a Proxy Ticket from the CAS server.
	setCasServerCert ($cert)
	Set the certificate of the CAS server.
	setCasServerCACert ($cert)
	Set the certificate of the CAS server CA.
	setNoCasServerValidation ()
	Set no SSL validation for the CAS server.
	setExtraCurlOption ($key, $value)
	Change CURL options.

Private Member Functions
	log ($str)
	Logs a string in debug mode.
	error ($msg)
	This method is used by interface methods to print an error and where the function was originally called from.

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>

Definition at line 341 of file CAS.php.

Member Function Documentation

phpCAS::setExtraCurlOption	(		$key,
			$value
	)

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 1469 of file CAS.php.

References $key, $PHPCAS_CLIENT, error(), traceBegin(), and traceEnd().

                                                  {
                global $PHPCAS_CLIENT;
                phpCAS :: traceBegin();
                if (!is_object($PHPCAS_CLIENT)) {
                        phpCAS :: error('this method should only be called after ' . __CLASS__ . '::client() or' . __CLASS__ . '::proxy()');
                }
                $PHPCAS_CLIENT->setExtraCurlOption($key, $value);
                phpCAS :: traceEnd();
        }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• Services/CAS/lib/CAS.php