Authentication

Collaboration diagram for Authentication:

Functions
static	phpCAS::setCacheTimesForAuthRecheck ($n)
	Set the times authentication will be cached before really accessing the CAS server in gateway mode: More...
static	phpCAS::setCasAttributeParserCallback ($function, array $additionalArgs=array())
	Set a callback function to be run when receiving CAS attributes. More...
static	phpCAS::setPostAuthenticateCallback ($function, array $additionalArgs=array())
	Set a callback function to be run when a user authenticates. More...
static	phpCAS::setSingleSignoutCallback ($function, array $additionalArgs=array())
	Set a callback function to be run when a single-signout request is received. More...
static	phpCAS::checkAuthentication ()
	This method is called to check if the user is already authenticated locally or has a global cas session. More...
static	phpCAS::forceAuthentication ()
	This method is called to force authentication if the user was not already authenticated. More...
static	phpCAS::renewAuthentication ()
	This method is called to renew the authentication. More...
static	phpCAS::isAuthenticated ()
	This method is called to check if the user is authenticated (previously or by tickets given in the URL). More...
static	phpCAS::isSessionAuthenticated ()
	Checks whether authenticated based on $_SESSION. More...
static	phpCAS::getUser ()
	This method returns the CAS user's login name. More...
static	phpCAS::getAttributes ()
	Answer attributes about the authenticated user. More...
static	phpCAS::hasAttributes ()
	Answer true if there are attributes for the authenticated user. More...
static	phpCAS::hasAttribute ($key)
	Answer true if an attribute exists for the authenticated user. More...
static	phpCAS::getAttribute ($key)
	Answer an attribute for the authenticated user. More...
static	phpCAS::handleLogoutRequests ($check_client=true, $allowed_clients=false)
	Handle logout requests. More...
static	phpCAS::getServerLoginURL ()
	This method returns the URL to be used to login. More...
static	phpCAS::setServerLoginURL ($url='')
	Set the login URL of the CAS server. More...
static	phpCAS::setServerServiceValidateURL ($url='')
	Set the serviceValidate URL of the CAS server. More...
static	phpCAS::setServerProxyValidateURL ($url='')
	Set the proxyValidate URL of the CAS server. More...
static	phpCAS::setServerSamlValidateURL ($url='')
	Set the samlValidate URL of the CAS server. More...
static	phpCAS::getServerLogoutURL ()
	This method returns the URL to be used to login. More...
static	phpCAS::setServerLogoutURL ($url='')
	Set the logout URL of the CAS server. More...
static	phpCAS::logout ($params="")
	This method is used to logout from CAS. More...
static	phpCAS::logoutWithRedirectService ($service)
	This method is used to logout from CAS. More...
static	phpCAS::logoutWithUrl ($url)
	This method is used to logout from CAS. More...
static	phpCAS::logoutWithRedirectServiceAndUrl ($service, $url)
	This method is used to logout from CAS. More...
static	phpCAS::setFixedCallbackURL ($url='')
	Set the fixed URL that will be used by the CAS server to transmit the PGT. More...
static	phpCAS::setFixedServiceURL ($url)
	Set the fixed URL that will be set as the CAS service parameter. More...
static	phpCAS::getServiceURL ()
	Get the URL that is set as the CAS service parameter. More...
static	phpCAS::retrievePT ($target_service, & $err_code, & $err_msg)
	Retrieve a Proxy Ticket from the CAS server. More...
static	phpCAS::setCasServerCACert ($cert, $validate_cn=true)
	Set the certificate of the CAS server CA and if the CN should be properly verified. More...
static	phpCAS::setNoCasServerValidation ()
	Set no SSL validation for the CAS server. More...
static	phpCAS::setNoClearTicketsFromUrl ()
	Disable the removal of a CAS-Ticket from the URL when authenticating DISABLING POSES A SECURITY RISK: We normally remove the ticket by an additional redirect as a security precaution to prevent a ticket in the HTTP_REFERRER or be carried over in the URL parameter. More...

Detailed Description

Function Documentation

checkAuthentication()

static phpCAS::checkAuthentication ( )

static

This method is called to check if the user is already authenticated locally or has a global cas session.

A already existing cas session is determined by a cas gateway call.(cas login call without any interactive prompt)

Returns

true when the user is authenticated, false when a previous gateway login failed or the function will not return if the user is redirected to the cas server for a gateway login attempt

Definition at line 1073 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        $auth = self::$_PHPCAS_CLIENT->checkAuthentication();
 
        // store where the authentication has been checked and the result
        self::$_PHPCAS_CLIENT->markAuthenticationCall($auth);
 
        phpCAS :: traceEnd($auth);
        return $auth;
    }

References phpCAS\_validateClientExists(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by ilSoapAuthenticationCAS\authenticate().

Here is the call graph for this function:

Here is the caller graph for this function:

forceAuthentication()

static phpCAS::forceAuthentication ( )

static

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.

Returns

bool Authentication

Definition at line 1094 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
        $auth = self::$_PHPCAS_CLIENT->forceAuthentication();
 
        // store where the authentication has been checked and the result
        self::$_PHPCAS_CLIENT->markAuthenticationCall($auth);
 
        /*      if (!$auth) {
         phpCAS :: trace('user is not authenticated, redirecting to the CAS server');
        self::$_PHPCAS_CLIENT->forceAuthentication();
        } else {
        phpCAS :: trace('no need to authenticate (user `' . phpCAS :: getUser() . '\' is already authenticated)');
        }*/
 
        phpCAS :: traceEnd();
        return $auth;
    }

References phpCAS\_validateClientExists(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by ilAuthProviderCAS\doAuthentication(), and ilCASAuth\forceCASAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

getAttribute()

static phpCAS::getAttribute (   $key )

static

Answer an attribute for the authenticated user.

Parameters

string

$key

attribute name

Returns

mixed string for a single value or an array if multiple values exist.

Warning

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

Definition at line 1253 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        try {
            return self::$_PHPCAS_CLIENT->getAttribute($key);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
    }

References phpCAS\_validateClientExists(), and phpCAS\error().

Here is the call graph for this function:

getAttributes()

static phpCAS::getAttributes ( )

static

Answer attributes about the authenticated user.

Warning

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

Returns

array

Definition at line 1194 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        try {
            return self::$_PHPCAS_CLIENT->getAttributes();
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
    }

References phpCAS\_validateClientExists(), and phpCAS\error().

Here is the call graph for this function:

getServerLoginURL()

static phpCAS::getServerLoginURL ( )

static

This method returns the URL to be used to login.

or phpCAS::isAuthenticated().

Returns

the login name of the authenticated user

Definition at line 1285 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        return self::$_PHPCAS_CLIENT->getServerLoginURL();
    }

References phpCAS\_validateClientExists().

Here is the call graph for this function:

getServerLogoutURL()

static phpCAS::getServerLogoutURL ( )

static

This method returns the URL to be used to login.

or phpCAS::isAuthenticated().

Returns

the login name of the authenticated user

Definition at line 1393 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        return self::$_PHPCAS_CLIENT->getServerLogoutURL();
    }

References phpCAS\_validateClientExists().

Here is the call graph for this function:

getServiceURL()

static phpCAS::getServiceURL ( )

static

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

Returns

string Service Url

Definition at line 1585 of file CAS.php.

    {
        phpCAS::_validateProxyExists();
        return (self::$_PHPCAS_CLIENT->getURL());
    }

References phpCAS\_validateProxyExists().

Here is the call graph for this function:

getUser()

static phpCAS::getUser ( )

static

This method returns the CAS user's login name.

Returns

string the login name of the authenticated user

Warning

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

Definition at line 1175 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        try {
            return self::$_PHPCAS_CLIENT->getUser();
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
    }

References phpCAS\_validateClientExists(), and phpCAS\error().

Referenced by ilAuthProviderCAS\doAuthentication(), ilCASAuth\getCASUser(), and ilCASAuth\login().

Here is the call graph for this function:

Here is the caller graph for this function:

handleLogoutRequests()

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

static

Handle logout requests.

Parameters

bool	$check_client	additional safety check
array	$allowed_clients	array of allowed clients

Returns

void

Definition at line 1272 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        return (self::$_PHPCAS_CLIENT->handleLogoutRequests($check_client, $allowed_clients));
    }

References phpCAS\_validateClientExists(), and phpCAS\handleLogoutRequests().

Referenced by phpCAS\handleLogoutRequests().

Here is the call graph for this function:

Here is the caller graph for this function:

hasAttribute()

static phpCAS::hasAttribute (   $key )

static

Answer true if an attribute exists for the authenticated user.

Parameters

string

$key

attribute name

Returns

bool

Warning

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

Definition at line 1233 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        try {
            return self::$_PHPCAS_CLIENT->hasAttribute($key);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
    }

References phpCAS\_validateClientExists(), and phpCAS\error().

Here is the call graph for this function:

hasAttributes()

static phpCAS::hasAttributes ( )

static

Answer true if there are attributes for the authenticated user.

Warning

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

Returns

bool

Definition at line 1213 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        try {
            return self::$_PHPCAS_CLIENT->hasAttributes();
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
    }

References phpCAS\_validateClientExists(), and phpCAS\error().

Here is the call graph for this function:

isAuthenticated()

static phpCAS::isAuthenticated ( )

static

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

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        // call the isAuthenticated method of the $_PHPCAS_CLIENT object
        $auth = self::$_PHPCAS_CLIENT->isAuthenticated();
 
        // store where the authentication has been checked and the result
        self::$_PHPCAS_CLIENT->markAuthenticationCall($auth);
 
        phpCAS :: traceEnd($auth);
        return $auth;
    }

References phpCAS\_validateClientExists(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Here is the call graph for this function:

isSessionAuthenticated()

static phpCAS::isSessionAuthenticated ( )

static

Checks whether authenticated based on $_SESSION.

Useful to avoid server calls.

Returns

bool true if authenticated, false otherwise.

Since

0.4.22 by Brendan Arnold

Definition at line 1161 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        return (self::$_PHPCAS_CLIENT->isSessionAuthenticated());
    }

References phpCAS\_validateClientExists(), and phpCAS\isSessionAuthenticated().

Referenced by phpCAS\isSessionAuthenticated().

Here is the call graph for this function:

Here is the caller graph for this function:

logout()

static phpCAS::logout (   $params = "" )

static

This method is used to logout from CAS.

Parameters

string

$params

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

Returns

void

Definition at line 1430 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        $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;
            }
        }
        self::$_PHPCAS_CLIENT->logout($parsedParams);
        // never reached
        phpCAS :: traceEnd();
    }

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

Here is the call graph for this function:

logoutWithRedirectService()

static phpCAS::logoutWithRedirectService (   $service )

static

This method is used to logout from CAS.

Halts by redirecting to the CAS server.

Parameters

string

$service

a URL that will be transmitted to the CAS server

Returns

void

Definition at line 1463 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        if (!is_string($service)) {
            phpCAS :: error('type mismatched for parameter $service (should be `string\')');
        }
        self::$_PHPCAS_CLIENT->logout(array ( "service" => $service ));
        // never reached
        phpCAS :: traceEnd();
    }

References phpCAS\_validateClientExists(), phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Here is the call graph for this function:

logoutWithRedirectServiceAndUrl()

static phpCAS::logoutWithRedirectServiceAndUrl (   $service,   $url  )

static

This method is used to logout from CAS.

Halts by redirecting to the CAS server.

Parameters

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

Returns

void

Deprecated:

The url parameter has been removed from the CAS server as of version 3.3.5.1

Definition at line 1513 of file CAS.php.

    {
        trigger_error('Function deprecated for cas servers >= 3.3.5.1', E_USER_DEPRECATED);
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        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\')');
        }
        self::$_PHPCAS_CLIENT->logout(
            array (
                "service" => $service,
                "url" => $url
            )
        );
        // never reached
        phpCAS :: traceEnd();
    }

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

Here is the call graph for this function:

logoutWithUrl()

static phpCAS::logoutWithUrl (   $url )

static

This method is used to logout from CAS.

Halts by redirecting to the CAS server.

Parameters

string

$url

a URL that will be transmitted to the CAS server

Returns

void

Deprecated:

The url parameter has been removed from the CAS server as of version 3.3.5.1

Definition at line 1486 of file CAS.php.

    {
        trigger_error('Function deprecated for cas servers >= 3.3.5.1', E_USER_DEPRECATED);
        phpCAS :: traceBegin();
        if (!is_object(self::$_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\')');
        }
        self::$_PHPCAS_CLIENT->logout(array ( "url" => $url ));
        // never reached
        phpCAS :: traceEnd();
    }

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

Here is the call graph for this function:

renewAuthentication()

static phpCAS::renewAuthentication ( )

static

This method is called to renew the authentication.

Returns

void

Definition at line 1119 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        $auth = self::$_PHPCAS_CLIENT->renewAuthentication();
 
        // store where the authentication has been checked and the result
        self::$_PHPCAS_CLIENT->markAuthenticationCall($auth);
 
        //self::$_PHPCAS_CLIENT->renewAuthentication();
        phpCAS :: traceEnd();
    }

References phpCAS\_validateClientExists(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Here is the call graph for this function:

retrievePT()

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

static

Retrieve a Proxy Ticket from the CAS server.

Parameters

string	$target_service	Url string of service to proxy
string	&$err_code	error code
string	&$err_msg	error message

Returns

string Proxy Ticket

Definition at line 1600 of file CAS.php.

    {
        phpCAS::_validateProxyExists();
 
        try {
            return (self::$_PHPCAS_CLIENT->retrievePT($target_service, $err_code, $err_msg));
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
    }

References phpCAS\_validateProxyExists(), phpCAS\error(), and phpCAS\retrievePT().

Referenced by phpCAS\retrievePT().

Here is the call graph for this function:

Here is the caller graph for this function:

setCacheTimesForAuthRecheck()

static phpCAS::setCacheTimesForAuthRecheck (   $n )

static

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

int

$n

an integer.

Returns

void

Definition at line 986 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        try {
            self::$_PHPCAS_CLIENT->setCacheTimesForAuthRecheck($n);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
    }

References $n, phpCAS\_validateClientExists(), and phpCAS\error().

Here is the call graph for this function:

setCasAttributeParserCallback()

static phpCAS::setCasAttributeParserCallback (   $function, array  $additionalArgs = array()  )

static

Set a callback function to be run when receiving CAS attributes.

The callback function will be passed an $success_elements payload of the response (\DOMElement) as its first parameter.

Parameters

string	$function	Callback function
array	$additionalArgs	optional array of arguments

Returns

void

Definition at line 1009 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        self::$_PHPCAS_CLIENT->setCasAttributeParserCallback($function, $additionalArgs);
    }

References phpCAS\_validateClientExists().

Here is the call graph for this function:

setCasServerCACert()

static phpCAS::setCasServerCACert (   $cert,   $validate_cn = true  )

static

Set the certificate of the CAS server CA and if the CN should be properly verified.

Parameters

string	$cert	CA certificate file name
bool	$validate_cn	Validate CN in certificate (default true)

Returns

void

Definition at line 1620 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        try {
            self::$_PHPCAS_CLIENT->setCasServerCACert($cert, $validate_cn);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
 
        phpCAS :: traceEnd();
    }

References phpCAS\_validateClientExists(), phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Here is the call graph for this function:

setFixedCallbackURL()

static phpCAS::setFixedCallbackURL (   $url = '' )

static

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

string

$url

the URL

Returns

void

Definition at line 1544 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateProxyExists();
 
        try {
            self::$_PHPCAS_CLIENT->setCallbackURL($url);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
 
        phpCAS :: traceEnd();
    }

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

Here is the call graph for this function:

setFixedServiceURL()

static phpCAS::setFixedServiceURL (   $url )

static

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

string

$url

the URL

Returns

void

Definition at line 1566 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateProxyExists();
 
        try {
            self::$_PHPCAS_CLIENT->setURL($url);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
 
        phpCAS :: traceEnd();
    }

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

Referenced by ilSoapAuthenticationCAS\__buildAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

setNoCasServerValidation()

static phpCAS::setNoCasServerValidation ( )

static

Set no SSL validation for the CAS server.

Returns

void

Definition at line 1639 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        phpCAS :: trace('You have configured no validation of the legitimacy of the cas server. This is not recommended for production use.');
        self::$_PHPCAS_CLIENT->setNoCasServerValidation();
        phpCAS :: traceEnd();
    }

References phpCAS\_validateClientExists(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by ilAuthProviderCAS\doAuthentication(), and ilAuthContainerCAS\initCAS().

Here is the call graph for this function:

Here is the caller graph for this function:

setNoClearTicketsFromUrl()

static phpCAS::setNoClearTicketsFromUrl ( )

static

Disable the removal of a CAS-Ticket from the URL when authenticating DISABLING POSES A SECURITY RISK: We normally remove the ticket by an additional redirect as a security precaution to prevent a ticket in the HTTP_REFERRER or be carried over in the URL parameter.

Returns

void

Definition at line 1659 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        self::$_PHPCAS_CLIENT->setNoClearTicketsFromUrl();
        phpCAS :: traceEnd();
    }

References phpCAS\_validateClientExists(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Here is the call graph for this function:

setPostAuthenticateCallback()

static phpCAS::setPostAuthenticateCallback (   $function, array  $additionalArgs = array()  )

static

Set a callback function to be run when a user authenticates.

The callback function will be passed a $logoutTicket as its first parameter, followed by any $additionalArgs you pass. The $logoutTicket parameter is an opaque string that can be used to map the session-id to logout request in order to support single-signout in applications that manage their own sessions (rather than letting phpCAS start the session).

phpCAS::forceAuthentication() will always exit and forward client unless they are already authenticated. To perform an action at the moment the user logs in (such as registering an account, performing logging, etc), register a callback function here.

Parameters

string	$function	Callback function
array	$additionalArgs	optional array of arguments

Returns

void

Definition at line 1035 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        self::$_PHPCAS_CLIENT->setPostAuthenticateCallback($function, $additionalArgs);
    }

References phpCAS\_validateClientExists().

Here is the call graph for this function:

setServerLoginURL()

static phpCAS::setServerLoginURL (   $url = '' )

static

Set the login URL of the CAS server.

Parameters

string

$url

the login URL

Returns

void

Since

0.4.21 by Wyman Chan

Definition at line 1300 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        try {
            self::$_PHPCAS_CLIENT->setServerLoginURL($url);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
 
        phpCAS :: traceEnd();
    }

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

Here is the call graph for this function:

setServerLogoutURL()

static phpCAS::setServerLogoutURL (   $url = '' )

static

Set the logout URL of the CAS server.

Parameters

string

$url

the logout URL

Returns

void

Since

0.4.21 by Wyman Chan

Definition at line 1408 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        try {
            self::$_PHPCAS_CLIENT->setServerLogoutURL($url);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
 
        phpCAS :: traceEnd();
    }

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

Here is the call graph for this function:

setServerProxyValidateURL()

static phpCAS::setServerProxyValidateURL (   $url = '' )

static

Set the proxyValidate URL of the CAS server.

Used for all CAS versions of proxy URL validations Examples: CAS 1.0 http://www.exemple.com/ CAS 2.0 http://www.exemple.com/proxyValidate CAS 3.0 http://www.exemple.com/p3/proxyValidate

Parameters

string

$url

the proxyValidate URL

Returns

void

Definition at line 1352 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        try {
            self::$_PHPCAS_CLIENT->setServerProxyValidateURL($url);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
 
        phpCAS :: traceEnd();
    }

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

Here is the call graph for this function:

setServerSamlValidateURL()

static phpCAS::setServerSamlValidateURL (   $url = '' )

static

Set the samlValidate URL of the CAS server.

Parameters

string

$url

the samlValidate URL

Returns

void

Definition at line 1373 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        try {
            self::$_PHPCAS_CLIENT->setServerSamlValidateURL($url);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
 
        phpCAS :: traceEnd();
    }

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

Here is the call graph for this function:

setServerServiceValidateURL()

static phpCAS::setServerServiceValidateURL (   $url = '' )

static

Set the serviceValidate URL of the CAS server.

Used for all CAS versions of URL validations. Examples: CAS 1.0 http://www.exemple.com/validate CAS 2.0 http://www.exemple.com/validateURL CAS 3.0 http://www.exemple.com/p3/serviceValidate

Parameters

string

$url

the serviceValidate URL

Returns

void

Definition at line 1326 of file CAS.php.

    {
        phpCAS :: traceBegin();
        phpCAS::_validateClientExists();
 
        try {
            self::$_PHPCAS_CLIENT->setServerServiceValidateURL($url);
        } catch (Exception $e) {
            phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
        }
 
        phpCAS :: traceEnd();
    }

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

Here is the call graph for this function:

setSingleSignoutCallback()

static phpCAS::setSingleSignoutCallback (   $function, array  $additionalArgs = array()  )

static

Set a callback function to be run when a single-signout request is received.

The callback function will be passed a $logoutTicket as its first parameter, followed by any $additionalArgs you pass. The $logoutTicket parameter is an opaque string that can be used to map a session-id to the logout request in order to support single-signout in applications that manage their own sessions (rather than letting phpCAS start and destroy the session).

Parameters

string	$function	Callback function
array	$additionalArgs	optional array of arguments

Returns

void

Definition at line 1056 of file CAS.php.

    {
        phpCAS::_validateClientExists();
 
        self::$_PHPCAS_CLIENT->setSingleSignoutCallback($function, $additionalArgs);
    }

References phpCAS\_validateClientExists().

Here is the call graph for this function: