Collaboration diagram for Authentication:

Functions
	phpCAS::setCacheTimesForAuthRecheck ($n)
	Set the times authentication will be cached before really accessing the CAS server in gateway mode: More...

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

	phpCAS::forceAuthentication ()
	This method is called to force authentication if the user was not already authenticated. More...

	phpCAS::renewAuthentication ()
	This method is called to renew the authentication. More...

	phpCAS::authenticate ()
	This method has been left from version 0.4.1 for compatibility reasons. More...

	phpCAS::isAuthenticated ()
	This method is called to check if the user is authenticated (previously or by tickets given in the URL). More...

	phpCAS::isSessionAuthenticated ()
	Checks whether authenticated based on $_SESSION. More...

	phpCAS::getUser ()
	This method returns the CAS user's login name. More...

	phpCAS::getAttributes ()
	This method returns the CAS user's login name. More...

	phpCAS::handleLogoutRequests ($check_client=true, $allowed_clients=false)
	Handle logout requests. More...

	phpCAS::getServerLoginURL ()
	This method returns the URL to be used to login. More...

	phpCAS::setServerLoginURL ($url='')
	Set the login URL of the CAS server. More...

	phpCAS::setServerServiceValidateURL ($url='')
	Set the serviceValidate URL of the CAS server. More...

	phpCAS::setServerProxyValidateURL ($url='')
	Set the proxyValidate URL of the CAS server. More...

	phpCAS::setServerSamlValidateURL ($url='')
	Set the samlValidate URL of the CAS server. More...

	phpCAS::getServerLogoutURL ()
	This method returns the URL to be used to login. More...

	phpCAS::setServerLogoutURL ($url='')
	Set the logout URL of the CAS server. More...

	phpCAS::logout ($params="")
	This method is used to logout from CAS. More...

	phpCAS::logoutWithRedirectService ($service)
	This method is used to logout from CAS. More...

	phpCAS::logoutWithUrl ($url)
	This method is used to logout from CAS. More...

	phpCAS::logoutWithRedirectServiceAndUrl ($service, $url)
	This method is used to logout from CAS. More...

	phpCAS::setFixedCallbackURL ($url='')
	Set the fixed URL that will be used by the CAS server to transmit the PGT. More...

	phpCAS::setFixedServiceURL ($url)
	Set the fixed URL that will be set as the CAS service parameter. More...

	phpCAS::getServiceURL ()
	Get the URL that is set as the CAS service parameter. More...

	phpCAS::retrievePT ($target_service, & $err_code, & $err_msg)
	Retrieve a Proxy Ticket from the CAS server. More...

	phpCAS::setCasServerCert ($cert)
	Set the certificate of the CAS server. More...

	phpCAS::setCasServerCACert ($cert)
	Set the certificate of the CAS server CA. More...

	phpCAS::setNoCasServerValidation ()
	Set no SSL validation for the CAS server. More...

Detailed Description

Function Documentation

◆ authenticate()

phpCAS::authenticate ( )

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

Definition at line 1020 of file CAS.php.

References phpCAS\error().

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

Here is the call graph for this function:

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

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

Referenced by ilSoapAuthenticationCAS\authenticate().

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

Here is the caller 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 961 of file CAS.php.

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

Referenced by ilCASAuth\forceCASAuth().

                                        {
                 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();
                 return $auth;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttributes()

phpCAS::getAttributes ( )

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

References $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, and phpCAS\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->getAttributes();
         }

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

References $PHPCAS_CLIENT, and phpCAS\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 1222 of file CAS.php.

References $PHPCAS_CLIENT, and phpCAS\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 1390 of file CAS.php.

References $PHPCAS_CLIENT, and phpCAS\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 1075 of file CAS.php.

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

Referenced by phpCAS\forceAuthentication(), ilCASAuth\getCASUser(), and ilCASAuth\login().

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

Here is the caller graph for this function:

◆ handleLogoutRequests()

phpCAS::handleLogoutRequests	(	$check_client = `true`,
		$allowed_clients = `false`
	)

Handle logout requests.

Definition at line 1112 of file CAS.php.

References $PHPCAS_CLIENT, and phpCAS\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->handleLogoutRequests($check_client, $allowed_clients));
         }

Here is the call graph for this function:

◆ isAuthenticated()

phpCAS::isAuthenticated ( )

This method is called to check if the user is authenticated (previously or by tickets given in the URL).

Returns: TRUE when the user is authenticated.

Definition at line 1030 of file CAS.php.

References $auth, $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, phpCAS\backtrace(), phpCAS\error(), phpCAS\traceBegin(), and phpCAS\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()');
                 }
 
                 // call the isAuthenticated method of the global $PHPCAS_CLIENT object
                 $auth = $PHPCAS_CLIENT->isAuthenticated();
 
                 // 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:

◆ isSessionAuthenticated()

phpCAS::isSessionAuthenticated ( )

Checks whether authenticated based on $_SESSION.

Useful to avoid server calls.

Returns: true if authenticated, false otherwise.

Since: 0.4.22 by Brendan Arnold

Definition at line 1060 of file CAS.php.

References $PHPCAS_CLIENT, and phpCAS\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->isSessionAuthenticated());
         }

Here is the call graph for this function:

◆ logout()

phpCAS::logout ( $params = "" )

This method is used to logout from CAS.

$params an array that contains the optional url and service parameters that will be passed to the CAS server

Definition at line 1255 of file CAS.php.

References $params, $PHPCAS_CLIENT, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\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()');
                 }
                 $parsedParams = array ();
                 if ($params != "") {
                         if (is_string($params)) {
                                 phpCAS :: error('method `phpCAS::logout($url)\' is now deprecated, use `phpCAS::logoutWithUrl($url)\' instead');
                         }
                         if (!is_array($params)) {
                                 phpCAS :: error('type mismatched for parameter $params (should be `array\')');
                         }
                         foreach ($params as $key => $value) {
                                 if ($key != "service" && $key != "url") {
                                         phpCAS :: error('only `url\' and `service\' parameters are allowed for method `phpCAS::logout($params)\'');
                                 }
                                 $parsedParams[$key] = $value;
                         }
                 }
                 $PHPCAS_CLIENT->logout($parsedParams);
                 // never reached
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

◆ logoutWithRedirectService()

phpCAS::logoutWithRedirectService ( $service )

This method is used to logout from CAS.

Halts by redirecting to the CAS server.

Parameters

$service a URL that will be transmitted to the CAS server

Definition at line 1285 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\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()');
                 }
                 if (!is_string($service)) {
                         phpCAS :: error('type mismatched for parameter $service (should be `string\')');
                 }
                 $PHPCAS_CLIENT->logout(array (
                         "service" => $service
                 ));
                 // never reached
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

◆ logoutWithRedirectServiceAndUrl()

phpCAS::logoutWithRedirectServiceAndUrl	(	$service,
		$url
	)

This method is used to logout from CAS.

Halts by redirecting to the CAS server.

Parameters

$service	a URL that will be transmitted to the CAS server
$url	a URL that will be transmitted to the CAS server

Definition at line 1326 of file CAS.php.

References $PHPCAS_CLIENT, $url, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\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()');
                 }
                 if (!is_string($service)) {
                         phpCAS :: error('type mismatched for parameter $service (should be `string\')');
                 }
                 if (!is_string($url)) {
                         phpCAS :: error('type mismatched for parameter $url (should be `string\')');
                 }
                 $PHPCAS_CLIENT->logout(array (
                         "service" => $service,
                         "url" => $url
                 ));
                 // never reached
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

◆ logoutWithUrl()

phpCAS::logoutWithUrl ( $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

Definition at line 1305 of file CAS.php.

References $PHPCAS_CLIENT, $url, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\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()');
                 }
                 if (!is_string($url)) {
                         phpCAS :: error('type mismatched for parameter $url (should be `string\')');
                 }
                 $PHPCAS_CLIENT->logout(array (
                         "url" => $url
                 ));
                 // never reached
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

◆ renewAuthentication()

phpCAS::renewAuthentication ( )

This method is called to renew the authentication.

Definition at line 995 of file CAS.php.

                                        {
                 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()');
                 }
 
                 // 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_CLIENT->renewAuthentication();
                 phpCAS :: traceEnd();
         }

◆ retrievePT()

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

Retrieve a Proxy Ticket from the CAS server.

Definition at line 1401 of file CAS.php.

References $PHPCAS_CLIENT, and phpCAS\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:

◆ setCacheTimesForAuthRecheck()

phpCAS::setCacheTimesForAuthRecheck ( $n )

Set the times authentication will be cached before really accessing the CAS server in gateway mode:

-1: check only once, and then never again (until you pree login)
0: always check
n: check every "n" time

Parameters

$n	an integer.

Definition at line 918 of file CAS.php.

References $n, $PHPCAS_CLIENT, and phpCAS\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($n) != 'integer') {
                         phpCAS :: error('type mismatched for parameter $header (should be `string\')');
                 }
                 $PHPCAS_CLIENT->setCacheTimesForAuthRecheck($n);
         }

Here is the call graph for this function:

◆ setCasServerCACert()

phpCAS::setCasServerCACert ( $cert )

Set the certificate of the CAS server CA.

Parameters

$cert the CA certificate

Definition at line 1435 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\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()');
                 }
                 if (gettype($cert) != 'string') {
                         phpCAS :: error('type mismatched for parameter $cert (should be `string\')');
                 }
                 $PHPCAS_CLIENT->setCasServerCACert($cert);
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

◆ setCasServerCert()

phpCAS::setCasServerCert ( $cert )

Set the certificate of the CAS server.

Parameters

$cert the PEM certificate

Definition at line 1417 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\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()');
                 }
                 if (gettype($cert) != 'string') {
                         phpCAS :: error('type mismatched for parameter $cert (should be `string\')');
                 }
                 $PHPCAS_CLIENT->setCasServerCert($cert);
                 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 1352 of file CAS.php.

References $PHPCAS_CLIENT, $url, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\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 1374 of file CAS.php.

References $PHPCAS_CLIENT, $url, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by ilSoapAuthenticationCAS\__buildAuth().

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

Here is the caller graph for this function:

◆ setNoCasServerValidation()

phpCAS::setNoCasServerValidation ( )

Set no SSL validation for the CAS server.

Definition at line 1451 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by ilAuthContainerCAS\initCAS().

                                             {
                 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->setNoCasServerValidation();
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setServerLoginURL()

phpCAS::setServerLoginURL ( $url = '' )

Set the login URL of the CAS server.

Parameters

$url	the login URL

Since: 0.4.21 by Wyman Chan

Definition at line 1139 of file CAS.php.

References $PHPCAS_CLIENT, $url, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

                                               {
                 global $PHPCAS_CLIENT;
                 phpCAS :: traceBegin();
                 if (!is_object($PHPCAS_CLIENT)) {
                         phpCAS :: error('this method should only be called after
                                                         ' . __CLASS__ . '::client()');
                 }
                 if (gettype($url) != 'string') {
                         phpCAS :: error('type mismatched for parameter $url (should be
                                                 `string\')');
                 }
                 $PHPCAS_CLIENT->setServerLoginURL($url);
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

◆ setServerLogoutURL()

phpCAS::setServerLogoutURL ( $url = '' )

Set the logout URL of the CAS server.

Parameters

$url	the logout URL

Since: 0.4.21 by Wyman Chan

Definition at line 1235 of file CAS.php.

References $PHPCAS_CLIENT, $url, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

                                                {
                 global $PHPCAS_CLIENT;
                 phpCAS :: traceBegin();
                 if (!is_object($PHPCAS_CLIENT)) {
                         phpCAS :: error('this method should only be called after
                                                         ' . __CLASS__ . '::client()');
                 }
                 if (gettype($url) != 'string') {
                         phpCAS :: error('type mismatched for parameter $url (should be
                                                 `string\')');
                 }
                 $PHPCAS_CLIENT->setServerLogoutURL($url);
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

◆ setServerProxyValidateURL()

phpCAS::setServerProxyValidateURL ( $url = '' )

Set the proxyValidate URL of the CAS server.

Used for all CAS 2.0 validations

Parameters

$url	the proxyValidate URL

Since: 1.1.0 by Joachim Fritschi

Definition at line 1181 of file CAS.php.

References $PHPCAS_CLIENT, $url, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

                                                       {
                 global $PHPCAS_CLIENT;
                 phpCAS :: traceBegin();
                 if (!is_object($PHPCAS_CLIENT)) {
                         phpCAS :: error('this method should only be called after
                                                         ' . __CLASS__ . '::client()');
                 }
                 if (gettype($url) != 'string') {
                         phpCAS :: error('type mismatched for parameter $url (should be
                                                 `string\')');
                 }
                 $PHPCAS_CLIENT->setServerProxyValidateURL($url);
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

◆ setServerSamlValidateURL()

phpCAS::setServerSamlValidateURL ( $url = '' )

Set the samlValidate URL of the CAS server.

Parameters

$url	the samlValidate URL

Since: 1.1.0 by Joachim Fritschi

Definition at line 1201 of file CAS.php.

References $PHPCAS_CLIENT, $url, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

                                                      {
                 global $PHPCAS_CLIENT;
                 phpCAS :: traceBegin();
                 if (!is_object($PHPCAS_CLIENT)) {
                         phpCAS :: error('this method should only be called after
                                                         ' . __CLASS__ . '::client()');
                 }
                 if (gettype($url) != 'string') {
                         phpCAS :: error('type mismatched for parameter $url (should be
                                                 `string\')');
                 }
                 $PHPCAS_CLIENT->setServerSamlValidateURL($url);
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

◆ setServerServiceValidateURL()

phpCAS::setServerServiceValidateURL ( $url = '' )

Set the serviceValidate URL of the CAS server.

Used only in CAS 1.0 validations

Parameters

$url	the serviceValidate URL

Since: 1.1.0 by Joachim Fritschi

Definition at line 1160 of file CAS.php.

References $PHPCAS_CLIENT, $url, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

                                                         {
                 global $PHPCAS_CLIENT;
                 phpCAS :: traceBegin();
                 if (!is_object($PHPCAS_CLIENT)) {
                         phpCAS :: error('this method should only be called after
                                                         ' . __CLASS__ . '::client()');
                 }
                 if (gettype($url) != 'string') {
                         phpCAS :: error('type mismatched for parameter $url (should be
                                                 `string\')');
                 }
                 $PHPCAS_CLIENT->setServerServiceValidateURL($url);
                 phpCAS :: traceEnd();
         }

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation

◆ authenticate()

◆ checkAuthentication()

◆ forceAuthentication()

◆ getAttributes()

◆ getServerLoginURL()

◆ getServerLogoutURL()

◆ getServiceURL()

◆ getUser()

◆ handleLogoutRequests()

◆ isAuthenticated()

◆ isSessionAuthenticated()

◆ logout()

◆ logoutWithRedirectService()

◆ logoutWithRedirectServiceAndUrl()

◆ logoutWithUrl()

◆ renewAuthentication()

◆ retrievePT()

◆ setCacheTimesForAuthRecheck()

◆ setCasServerCACert()

◆ setCasServerCert()

◆ setFixedCallbackURL()

◆ setFixedServiceURL()

◆ setNoCasServerValidation()

◆ setServerLoginURL()

◆ setServerLogoutURL()

◆ setServerProxyValidateURL()

◆ setServerSamlValidateURL()

◆ setServerServiceValidateURL()