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

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

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

authenticate()

phpCAS::authenticate

(

)

This method has been left from version 0.4.1 for compatibility reasons.

Definition at line 902 of file CAS.php.

    {
      phpCAS::error('this method is deprecated. You should use '.__CLASS__.'::forceAuthentication() instead');
    }

backtrace()

phpCAS::backtrace

(

)

This method is a wrapper for debug_backtrace() that is not available in all PHP versions (>= 4.3.0 only)

Definition at line 415 of file CAS.php.

    {
      if ( function_exists('debug_backtrace') ) {
        return debug_backtrace();
      } else {
        // poor man's hack ... but it does work ...
        return array();
      }
    }

checkAuthentication()

phpCAS::checkAuthentication

(

)

This method is called to check if the user is authenticated (use the gateway feature).

Returns

TRUE when the user is authenticated; otherwise FALSE.

Definition at line 843 of file CAS.php.

References $auth, $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, backtrace(), error(), traceBegin(), and traceEnd().

    {
      global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

      phpCAS::traceBegin();
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should not be called before '.__CLASS__.'::client() or '.__CLASS__.'::proxy()');
      }

      $auth = $PHPCAS_CLIENT->checkAuthentication();

      // store where the authentication has been checked and the result
      $dbg = phpCAS::backtrace();
      $PHPCAS_AUTH_CHECK_CALL = array('done' => TRUE,
                                      'file' => $dbg[0]['file'],
                                      'line' => $dbg[0]['line'],
                                      'method' => __CLASS__.'::'.__FUNCTION__,
                                      'result' => $auth );
      phpCAS::traceEnd($auth);
      return $auth; 
    }

Here is the call graph for this function:

client()

phpCAS::client	(		$server_version,
			$server_hostname,
			$server_port,
			$server_uri,
			$start_session = true
	)

phpCAS client initializer.

Note

Only one of the phpCAS::client() and phpCAS::proxy functions should be called, only once, and before all other methods (except phpCAS::getVersion() and phpCAS::setDebug()).

Parameters

$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 URI the CAS server is responding on
$start_session	Have phpCAS start PHP sessions (default true)

Returns

a newly created CASClient object

Definition at line 270 of file CAS.php.

References $PHPCAS_CLIENT, $PHPCAS_INIT_CALL, backtrace(), error(), traceBegin(), and traceEnd().

    {
      global $PHPCAS_CLIENT, $PHPCAS_INIT_CALL;

      phpCAS::traceBegin();
      if ( is_object($PHPCAS_CLIENT) ) {
        phpCAS::error($PHPCAS_INIT_CALL['method'].'() has already been called (at '.$PHPCAS_INIT_CALL['file'].':'.$PHPCAS_INIT_CALL['line'].')');
      }
      if ( gettype($server_version) != 'string' ) {
        phpCAS::error('type mismatched for parameter $server_version (should be `string\')');
      }
      if ( gettype($server_hostname) != 'string' ) {
        phpCAS::error('type mismatched for parameter $server_hostname (should be `string\')');
      }
      if ( gettype($server_port) != 'integer' ) {
        phpCAS::error('type mismatched for parameter $server_port (should be `integer\')');
      }
      if ( gettype($server_uri) != 'string' ) {
        phpCAS::error('type mismatched for parameter $server_uri (should be `string\')');
      }

      // store where the initialzer is called from
      $dbg = phpCAS::backtrace();
      $PHPCAS_INIT_CALL = array('done' => TRUE,
                                'file' => $dbg[0]['file'],
                                'line' => $dbg[0]['line'],
                                'method' => __CLASS__.'::'.__FUNCTION__);

      // initialize the global object $PHPCAS_CLIENT
      $PHPCAS_CLIENT = new CASClient($server_version,FALSE/*proxy*/,$server_hostname,$server_port,$server_uri,$start_session);
      phpCAS::traceEnd();
    }

Here is the call graph for this function:

error()

phpCAS::error (   $msg )

private

This method is used by interface methods to print an error and where the function was originally called from.

Parameters

$msg	the message to print

Definition at line 454 of file CAS.php.

References $file, backtrace(), exit, trace(), and traceExit().

    {
      $dbg = phpCAS::backtrace();
      $function = '?';
      $file = '?';
      $line = '?';
      if ( is_array($dbg) ) {
        for ( $i=1; $i<sizeof($dbg); $i++) {
          if ( is_array($dbg[$i]) ) {
            if ( $dbg[$i]['class'] == __CLASS__ ) {
              $function = $dbg[$i]['function'];
              $file = $dbg[$i]['file'];
              $line = $dbg[$i]['line'];
            }
          }
        }
      }
      echo "<br />\n<b>phpCAS error</b>: <font color=\"FF0000\"><b>".__CLASS__."::".$function.'(): '.htmlentities($msg)."</b></font> in <b>".$file."</b> on line <b>".$line."</b><br />\n";
      phpCAS::trace($msg);
      phpCAS::traceExit();
      exit();
    }

Here is the call graph for this function:

forceAuthentication()

phpCAS::forceAuthentication

(

)

This method is called to force authentication if the user was not already authenticated.

If the user is not authenticated, halt by redirecting to the CAS server.

Definition at line 870 of file CAS.php.

References $auth, $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, backtrace(), error(), getUser(), trace(), and traceBegin().

    {
      global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

      phpCAS::traceBegin();
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should not be called before '.__CLASS__.'::client() or '.__CLASS__.'::proxy()');
      }
      
      $auth = $PHPCAS_CLIENT->forceAuthentication();

      // store where the authentication has been checked and the result
      $dbg = phpCAS::backtrace();
      $PHPCAS_AUTH_CHECK_CALL = array('done' => TRUE,
                                      'file' => $dbg[0]['file'],
                                      'line' => $dbg[0]['line'],
                                      'method' => __CLASS__.'::'.__FUNCTION__,
                                      'result' => $auth );

      if ( !$auth ) {
        phpCAS::trace('user is not authenticated, redirecting to the CAS server');
        $PHPCAS_CLIENT->forceAuthentication();
      } else {
        phpCAS::trace('no need to authenticate (user `'.phpCAS::getUser().'\' is already authenticated)');
      }

      phpCAS::traceEnd();
    }

Here is the call graph for this function:

getServerLoginURL()

phpCAS::getServerLoginURL

(

)

This method returns the URL to be used to login.

or phpCAS::isAuthenticated().

Returns

the login name of the authenticated user

Definition at line 943 of file CAS.php.

References $PHPCAS_CLIENT, and error().

    {
      global $PHPCAS_CLIENT;
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should not be called before '.__CLASS__.'::client() or '.__CLASS__.'::proxy()');
      }
      return $PHPCAS_CLIENT->getServerLoginURL();
    }

Here is the call graph for this function:

getServerLogoutURL()

phpCAS::getServerLogoutURL

(

)

This method returns the URL to be used to login.

or phpCAS::isAuthenticated().

Returns

the login name of the authenticated user

Definition at line 958 of file CAS.php.

References $PHPCAS_CLIENT, and error().

    {
      global $PHPCAS_CLIENT;
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should not be called before '.__CLASS__.'::client() or '.__CLASS__.'::proxy()');
      }
      return $PHPCAS_CLIENT->getServerLogoutURL();
    }

Here is the call graph for this function:

getServiceURL()

phpCAS::getServiceURL

(

)

Get the URL that is set as the CAS service parameter.

Definition at line 1030 of file CAS.php.

References $PHPCAS_CLIENT, and error().

   {
     global $PHPCAS_CLIENT;
     if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::proxy()');
     }  
     return($PHPCAS_CLIENT->getURL());
   }

Here is the call graph for this function:

getUser()

phpCAS::getUser

(

)

This method returns the CAS user's login name.

Warning

should not be called only after phpCAS::forceAuthentication() or phpCAS::checkAuthentication().

Returns

the login name of the authenticated user

Definition at line 922 of file CAS.php.

References $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, and error().

    {
      global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should not be called before '.__CLASS__.'::client() or '.__CLASS__.'::proxy()');
      }
      if ( !$PHPCAS_AUTH_CHECK_CALL['done'] ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::forceAuthentication() or '.__CLASS__.'::isAuthenticated()');
      }
      if ( !$PHPCAS_AUTH_CHECK_CALL['result'] ) {
        phpCAS::error('authentication was checked (by '.$PHPCAS_AUTH_CHECK_CALL['method'].'() at '.$PHPCAS_AUTH_CHECK_CALL['file'].':'.$PHPCAS_AUTH_CHECK_CALL['line'].') but the method returned FALSE');
      }
      return $PHPCAS_CLIENT->getUser();
    }

Here is the call graph for this function:

getVersion()

phpCAS::getVersion

(

)

This method returns the phpCAS version.

Returns

the phpCAS version.

Definition at line 585 of file CAS.php.

References PHPCAS_VERSION.

    {
      return PHPCAS_VERSION;
    }

isAuthenticated()

phpCAS::isAuthenticated

(

)

This method has been left from version 0.4.19 for compatibility reasons.

Definition at line 910 of file CAS.php.

References error().

    {
      phpCAS::error('this method is deprecated. You should use '.__CLASS__.'::forceAuthentication() instead');
    }

Here is the call graph for this function:

log()

phpCAS::log (   $str )

private

Logs a string in debug mode.

Parameters

$str	the string to write

Definition at line 432 of file CAS.php.

References $PHPCAS_DEBUG.

    {
      $indent_str = ".";
      global $PHPCAS_DEBUG;

      if ( $PHPCAS_DEBUG['filename'] ) {
        for ($i=0;$i<$PHPCAS_DEBUG['indent'];$i++) {
          $indent_str .= '|    ';
        }
        error_log($PHPCAS_DEBUG['unique_id'].' '.$indent_str.$str."\n",3,$PHPCAS_DEBUG['filename']);
      }

    }

logout()

phpCAS::logout

(

$url = ""

)

This method is used to logout from CAS.

Halts by redirecting to the CAS server.

Parameters

$url	a URL that will be transmitted to the CAS server (to come back to when logged out)

Definition at line 971 of file CAS.php.

References $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->logout($url);
      // never reached
      phpCAS::traceEnd();
    }

Here is the call graph for this function:

proxy()

phpCAS::proxy	(		$server_version,
			$server_hostname,
			$server_port,
			$server_uri,
			$start_session = true
	)

phpCAS proxy initializer.

Note

Only one of the phpCAS::client() and phpCAS::proxy functions should be called, only once, and before all other methods (except phpCAS::getVersion() and phpCAS::setDebug()).

Parameters

$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 URI the CAS server is responding on
$start_session	Have phpCAS start PHP sessions (default true)

Returns

a newly created CASClient object

Definition at line 321 of file CAS.php.

References $PHPCAS_CLIENT, $PHPCAS_INIT_CALL, backtrace(), error(), traceBegin(), and traceEnd().

    {
      global $PHPCAS_CLIENT, $PHPCAS_INIT_CALL;

      phpCAS::traceBegin();
      if ( is_object($PHPCAS_CLIENT) ) {
        phpCAS::error($PHPCAS_INIT_CALL['method'].'() has already been called (at '.$PHPCAS_INIT_CALL['file'].':'.$PHPCAS_INIT_CALL['line'].')');
      }
      if ( gettype($server_version) != 'string' ) {
        phpCAS::error('type mismatched for parameter $server_version (should be `string\')');
      }
      if ( gettype($server_hostname) != 'string' ) {
        phpCAS::error('type mismatched for parameter $server_hostname (should be `string\')');
      }
      if ( gettype($server_port) != 'integer' ) {
        phpCAS::error('type mismatched for parameter $server_port (should be `integer\')');
      }
      if ( gettype($server_uri) != 'string' ) {
        phpCAS::error('type mismatched for parameter $server_uri (should be `string\')');
      }

      // store where the initialzer is called from
      $dbg = phpCAS::backtrace();
      $PHPCAS_INIT_CALL = array('done' => TRUE,
                                'file' => $dbg[0]['file'],
                                'line' => $dbg[0]['line'],
                                'method' => __CLASS__.'::'.__FUNCTION__);

      // initialize the global object $PHPCAS_CLIENT
      $PHPCAS_CLIENT = new CASClient($server_version,TRUE/*proxy*/,$server_hostname,$server_port,$server_uri,$start_session);
      phpCAS::traceEnd();
    }

Here is the call graph for this function:

retrievePT()

phpCAS::retrievePT	(		$target_service,
		&	$err_code,
		&	$err_msg
	)

Retrieve a Proxy Ticket from the CAS server.

Definition at line 1042 of file CAS.php.

References $PHPCAS_CLIENT, and error().

   {
     global $PHPCAS_CLIENT;
     if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::proxy()');
     }  
     if ( gettype($target_service) != 'string' ) {
        phpCAS::error('type mismatched for parameter $target_service(should be `string\')');
     }
     return($PHPCAS_CLIENT->retrievePT($target_service,$err_code,$err_msg));
   }

Here is the call graph for this function:

serviceWeb()

phpCAS::serviceWeb	(		$url,
		&	$err_code,
		&	$output
	)

This method is used to access an HTTP[S] service.

Parameters

$url	the service to access.
$err_code	an error code Possible values are PHPCAS_SERVICE_OK (on success), PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE, PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE, PHPCAS_SERVICE_PT_FAILURE, PHPCAS_SERVICE_NOT AVAILABLE.
$output	the output of the service (also used to give an error message on failure).

Returns

TRUE on success, FALSE otherwise (in this later case, $err_code gives the reason why it failed and $output contains an error message).

Definition at line 756 of file CAS.php.

References $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, $res, error(), traceBegin(), and traceEnd().

    {
      global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

      phpCAS::traceBegin();
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::proxy()');
      }
      if ( !$PHPCAS_CLIENT->isProxy() ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::proxy()');
      }
      if ( !$PHPCAS_AUTH_CHECK_CALL['done'] ) {
        phpCAS::error('this method should only be called after the programmer is sure the user has been authenticated (by calling '.__CLASS__.'::checkAuthentication() or '.__CLASS__.'::forceAuthentication()');
      }
      if ( !$PHPCAS_AUTH_CHECK_CALL['result'] ) {
        phpCAS::error('authentication was checked (by '.$PHPCAS_AUTH_CHECK_CALL['method'].'() at '.$PHPCAS_AUTH_CHECK_CALL['file'].':'.$PHPCAS_AUTH_CHECK_CALL['line'].') but the method returned FALSE');
      }
      if ( gettype($url) != 'string' ) {
        phpCAS::error('type mismatched for parameter $url (should be `string\')');
      }
      
      $res = $PHPCAS_CLIENT->serviceWeb($url,$err_code,$output);

      phpCAS::traceEnd($res);
      return $res;
    }

Here is the call graph for this function:

setDebug()

phpCAS::setDebug

(

$filename = ''

)

Set/unset debug mode.

Parameters

$filename

the name of the file used for logging, or FALSE to stop debugging.

Definition at line 373 of file CAS.php.

References $filename, $PHPCAS_DEBUG, error(), and trace().

    {
      global $PHPCAS_DEBUG;

      if ( $filename != FALSE && gettype($filename) != 'string' ) {
        phpCAS::error('type mismatched for parameter $dbg (should be FALSE or the name of the log file)');
      }

      if ( empty($filename) ) {
        if ( preg_match('/^Win.*/',getenv('OS')) ) {
          if ( isset($_ENV['TMP']) ) {
            $debugDir = $_ENV['TMP'].'/';
          } else if ( isset($_ENV['TEMP']) ) {
            $debugDir = $_ENV['TEMP'].'/';
          } else {
            $debugDir = '';
          }
        } else {
          $debugDir = '/tmp/';
        }
        $filename = $debugDir . 'phpCAS.log';
      }

      if ( empty($PHPCAS_DEBUG['unique_id']) ) {
        $PHPCAS_DEBUG['unique_id'] = substr(strtoupper(md5(uniqid(''))),0,4);
      }

      $PHPCAS_DEBUG['filename'] = $filename;

      phpCAS::trace('START ******************');
    }

Here is the call graph for this function:

setExtraCurlOption()

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 $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:

setFixedCallbackURL()

phpCAS::setFixedCallbackURL

(

$url = ''

)

Set the fixed URL that will be used by the CAS server to transmit the PGT.

When this method is not called, a phpCAS script uses its own URL for the callback.

Parameters

$url

the URL

Definition at line 990 of file CAS.php.

References $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__.'::proxy()');
     }
     if ( !$PHPCAS_CLIENT->isProxy() ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::proxy()');
     }
     if ( gettype($url) != 'string' ) {
        phpCAS::error('type mismatched for parameter $url (should be `string\')');
     }
     $PHPCAS_CLIENT->setCallbackURL($url);
     phpCAS::traceEnd();
   }

Here is the call graph for this function:

setFixedServiceURL()

phpCAS::setFixedServiceURL

(

$url

)

Set the fixed URL that will be set as the CAS service parameter.

When this method is not called, a phpCAS script uses its own URL.

Parameters

$url

the URL

Definition at line 1013 of file CAS.php.

References $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__.'::proxy()');
     }  
     if ( gettype($url) != 'string' ) {
        phpCAS::error('type mismatched for parameter $url (should be `string\')');
     }
     $PHPCAS_CLIENT->setURL($url);
     phpCAS::traceEnd();
   }

Here is the call graph for this function:

setHTMLFooter()

phpCAS::setHTMLFooter

(

$footer

)

This method sets the HTML footer used for all outputs.

Parameters

$footer

the HTML footer.

Definition at line 621 of file CAS.php.

References $PHPCAS_CLIENT, and error().

    {
      global $PHPCAS_CLIENT;
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should not be called before '.__CLASS__.'::client() or '.__CLASS__.'::proxy()');
      }
      if ( gettype($footer) != 'string' ) {
        phpCAS::error('type mismatched for parameter $footer (should be `string\')');
      }
      $PHPCAS_CLIENT->setHTMLHeader($header);
    }

Here is the call graph for this function:

setHTMLHeader()

phpCAS::setHTMLHeader

(

$header

)

This method sets the HTML header used for all outputs.

Parameters

$header

the HTML header.

Definition at line 604 of file CAS.php.

References $PHPCAS_CLIENT, and error().

    {
      global $PHPCAS_CLIENT;
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should not be called before '.__CLASS__.'::client() or '.__CLASS__.'::proxy()');
      }
      if ( gettype($header) != 'string' ) {
        phpCAS::error('type mismatched for parameter $header (should be `string\')');
      }
      $PHPCAS_CLIENT->setHTMLHeader($header);
    }

Here is the call graph for this function:

setLang()

phpCAS::setLang

(

$lang

)

This method is used to set the language used by phpCAS.

Note

Can be called only once.

Parameters

$lang

a string representing the language.

See also

PHPCAS_LANG_FRENCH, PHPCAS_LANG_ENGLISH

Definition at line 559 of file CAS.php.

References $lang, $PHPCAS_CLIENT, and error().

    {
      global $PHPCAS_CLIENT;
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should not be called before '.__CLASS__.'::client() or '.__CLASS__.'::proxy()');
      }
      if ( gettype($lang) != 'string' ) {
        phpCAS::error('type mismatched for parameter $lang (should be `string\')');
      }
      $PHPCAS_CLIENT->setLang($lang);
    }

Here is the call graph for this function:

setPGTStorageDB()

phpCAS::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.

Note

The connection to the database is done only when needed. As a consequence, bad parameters are detected only when initializing PGT storage, except in debug mode.

Parameters

$user	the user to access the data with
$password	the user's password
$database_type	the type of the database hosting the data
$hostname	the server hosting the database
$port	the port the server is listening on
$database	the name of the database
$table	the name of the table storing the data

Definition at line 689 of file CAS.php.

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

    {
      global $PHPCAS_CLIENT,$PHPCAS_AUTH_CHECK_CALL;

      phpCAS::traceBegin();
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::proxy()');
      }
      if ( !$PHPCAS_CLIENT->isProxy() ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::proxy()');
      }
      if ( $PHPCAS_AUTH_CHECK_CALL['done'] ) {
        phpCAS::error('this method should only be called before '.$PHPCAS_AUTH_CHECK_CALL['method'].'() (called at '.$PHPCAS_AUTH_CHECK_CALL['file'].':'.$PHPCAS_AUTH_CHECK_CALL['line'].')');
      }
      if ( gettype($user) != 'string' ) {
        phpCAS::error('type mismatched for parameter $user (should be `string\')');
      }
      if ( gettype($password) != 'string' ) {
        phpCAS::error('type mismatched for parameter $password (should be `string\')');
      }
      if ( gettype($database_type) != 'string' ) {
        phpCAS::error('type mismatched for parameter $database_type (should be `string\')');
      }
      if ( gettype($hostname) != 'string' ) {
        phpCAS::error('type mismatched for parameter $hostname (should be `string\')');
      }
      if ( gettype($port) != 'integer' ) {
        phpCAS::error('type mismatched for parameter $port (should be `integer\')');
      }
      if ( gettype($database) != 'string' ) {
        phpCAS::error('type mismatched for parameter $database (should be `string\')');
      }
      if ( gettype($table) != 'string' ) {
        phpCAS::error('type mismatched for parameter $table (should be `string\')');
      }
      $PHPCAS_CLIENT->setPGTStorageDB($this,$user,$password,$hostname,$port,$database,$table);
      phpCAS::traceEnd();
    }

Here is the call graph for this function:

setPGTStorageFile()

phpCAS::setPGTStorageFile	(		$format = '',
			$path = ''
	)

This method is used to tell phpCAS to store the response of the CAS server to PGT requests onto the filesystem.

Parameters

$format	the format used to store the PGT's (`plain' and `xml' allowed)
$path	the path where the PGT's should be stored

Definition at line 649 of file CAS.php.

References $path, $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, error(), traceBegin(), and traceEnd().

    {
      global $PHPCAS_CLIENT,$PHPCAS_AUTH_CHECK_CALL;

      phpCAS::traceBegin();
      if ( !is_object($PHPCAS_CLIENT) ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::proxy()');
      }
      if ( !$PHPCAS_CLIENT->isProxy() ) {
        phpCAS::error('this method should only be called after '.__CLASS__.'::proxy()');
      }
      if ( $PHPCAS_AUTH_CHECK_CALL['done'] ) {
        phpCAS::error('this method should only be called before '.$PHPCAS_AUTH_CHECK_CALL['method'].'() (called at '.$PHPCAS_AUTH_CHECK_CALL['file'].':'.$PHPCAS_AUTH_CHECK_CALL['line'].')');
      }
      if ( gettype($format) != 'string' ) {
        phpCAS::error('type mismatched for parameter $format (should be `string\')');
      }
      if ( gettype($path) != 'string' ) {
        phpCAS::error('type mismatched for parameter $format (should be `string\')');
      }
      $PHPCAS_CLIENT->setPGTStorageFile($format,$path);
      phpCAS::traceEnd();
    }

Here is the call graph for this function:

trace()

phpCAS::trace

(

$str

)

This method is used to log something in debug mode.

Definition at line 480 of file CAS.php.

References backtrace(), and log().

    {
      $dbg = phpCAS::backtrace();
      phpCAS::log($str.' ['.basename($dbg[1]['file']).':'.$dbg[1]['line'].']');
    }

Here is the call graph for this function:

traceBegin()

phpCAS::traceBegin

(

)

This method is used to indicate the start of the execution of a function in debug mode.

Definition at line 489 of file CAS.php.

References $PHPCAS_DEBUG, backtrace(), and log().

    {
      global $PHPCAS_DEBUG;

      $dbg = phpCAS::backtrace();
      $str = '=> ';
      if ( !empty($dbg[2]['class']) ) {
        $str .= $dbg[2]['class'].'::';
      }
      $str .= $dbg[2]['function'].'(';      
      if ( is_array($dbg[2]['args']) ) {
        foreach ($dbg[2]['args'] as $index => $arg) {
          if ( $index != 0 ) {
            $str .= ', ';
          }
          $str .= str_replace("\n","",var_export($arg,TRUE));
        }
      }
      $str .= ') ['.basename($dbg[2]['file']).':'.$dbg[2]['line'].']';
      phpCAS::log($str);
      $PHPCAS_DEBUG['indent'] ++;
    }

Here is the call graph for this function:

traceEnd()

phpCAS::traceEnd

(

$res = ''

)

This method is used to indicate the end of the execution of a function in debug mode.

Parameters

$res	the result of the function

Definition at line 517 of file CAS.php.

References $PHPCAS_DEBUG, $res, backtrace(), and log().

    {
      global $PHPCAS_DEBUG;

      $PHPCAS_DEBUG['indent'] --;
      $dbg = phpCAS::backtrace();
      $str = '';
      $str .= '<= '.str_replace("\n","",var_export($res,TRUE));
      phpCAS::log($str);
    }

Here is the call graph for this function:

traceExit()

phpCAS::traceExit

(

)

This method is used to indicate the end of the execution of the program.

Definition at line 531 of file CAS.php.

References $PHPCAS_DEBUG, and log().

    {
      global $PHPCAS_DEBUG;

      phpCAS::log('exit()');
      while ( $PHPCAS_DEBUG['indent'] > 0 ) {
        phpCAS::log('-');
        $PHPCAS_DEBUG['indent'] --;
      }
    }

Here is the call graph for this function:

---

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

• Services/CAS/lib/CAS.php