Functions | Variables

CAS proxied client features (CAS 2.0, Proxy Tickets)
[ImplementationCAS Basic client features (CAS 1.0, Service Tickets)]

Functions

 CASClient::getPT ()
 CASClient::setPT ($pt)
 CASClient::hasPT ()
 CASClient::getProxies ()
 CASClient::setProxies ($proxies)
 CASClient::getSA ()
 CASClient::setSA ($sa)
 CASClient::hasSA ()
 CASClient::validatePT (&$validate_url, &$text_response, &$tree_response)

Variables

 CASClient::$_pt
 CASClient::$_proxies = array()

Function Documentation

CASClient::getProxies (  )  [inherited]

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

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

Returns:
array public
Since:
6/25/09

Definition at line 2644 of file client.php.

CASClient::getPT (  )  [inherited]

This method returns the Proxy Ticket provided in the URL of the request.

Returns:
The proxy ticket.

Definition at line 2603 of file client.php.

Referenced by CASClient::isAuthenticated().

CASClient::getSA (  )  [inherited]

This method returns the SAML Ticket provided in the URL of the request.

Returns:
The SAML ticket.

Definition at line 2664 of file client.php.

Referenced by CASClient::isAuthenticated().

CASClient::hasPT (  )  [inherited]

This method tells if a Proxy Ticket was stored.

Returns:
TRUE if a Proxy Ticket has been stored.

Definition at line 2620 of file client.php.

Referenced by CASClient::isAuthenticated().

CASClient::hasSA (  )  [inherited]

This method tells if a SAML Ticket was stored.

Returns:
TRUE if a SAML Ticket has been stored.

Definition at line 2678 of file client.php.

Referenced by CASClient::isAuthenticated().

CASClient::setProxies ( proxies  )  [private, inherited]

Set the Proxy array, probably from persistant storage.

Parameters:
array $proxies
Returns:
void private
Since:
6/25/09

Definition at line 2656 of file client.php.

Referenced by CASClient::wasPreviouslyAuthenticated().

CASClient::setPT ( pt  )  [inherited]

This method stores the Proxy Ticket.

Parameters:
$pt The Proxy Ticket.

Definition at line 2613 of file client.php.

Referenced by CASClient::wasPreviouslyAuthenticated().

CASClient::setSA ( sa  )  [inherited]

This method stores the SAML Ticket.

Parameters:
$sa The SAML Ticket.

Definition at line 2671 of file client.php.

CASClient::validatePT ( &$  validate_url,
&$  text_response,
&$  tree_response 
) [inherited]

This method is used to validate a ST or PT; halt on failure Used for all CAS 2.0 validations

Returns:
bool TRUE when successfull, halt otherwise by calling CASClient::authError().

Definition at line 2695 of file client.php.

References phpCAS::trace(), and phpCAS::traceBegin().

Referenced by CASClient::isAuthenticated().


Variable Documentation

CASClient::$_proxies = array() [private, inherited]

This array will store a list of proxies in front of this application. This property will only be populated if this script is being proxied rather than accessed directly.

It is set in CASClient::validatePT() and can be read by CASClient::getProxies() private

Definition at line 2632 of file client.php.

CASClient::$_pt [private, inherited]

the Proxy Ticket provided in the URL of the request if present (empty otherwise). Written by CASClient::CASClient(), read by CASClient::getPT() and CASClient::hasPGT().

Definition at line 2597 of file client.php.