Main Page | Modules | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages | Examples

CAS Basic client features (CAS 1.0, Service Tickets)
[Implementation]


Functions

 CASClient::getST ()
 CASClient::setST ($st)
 CASClient::hasST ()
 CASClient::validateST ($validate_url, &$text_response, &$tree_response)

Variables

 CASClient::$_st

Function Documentation

CASClient::getST  )  [private, inherited]
 

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

Returns:
The service ticket.

Definition at line 852 of file client.php.

CASClient::hasST  )  [private, inherited]
 

This method tells if a Service Ticket was stored.

Returns:
TRUE if a Service Ticket has been stored.

Definition at line 868 of file client.php.

CASClient::setST st  )  [private, inherited]
 

This method stores the Service Ticket.

Parameters:
$st The Service Ticket.

Definition at line 860 of file client.php.

References CASClient::setST().

Referenced by CASClient::CASClient(), CASClient::setST(), and CASClient::wasPreviouslyAuthenticated().

CASClient::validateST validate_url,
&$  text_response,
&$  tree_response
[private, inherited]
 

This method is used to validate a ST; halt on failure, and sets $validate_url, $text_reponse and $tree_response on success. These parameters are used later by CASClient::validatePGT() for CAS proxies.

Parameters:
$validate_url the URL of the request to the CAS server.
$text_response the response of the CAS server, as is (XML text).
$tree_response the response of the CAS server, as a DOM XML tree.
Returns:
bool TRUE when successfull, halt otherwise by calling CASClient::authError().

Definition at line 894 of file client.php.

References CASClient::authError(), CAS_VERSION_1_0, CAS_VERSION_2_0, domxml_open_mem(), CASClient::getServerServiceValidateURL(), CASClient::getServerVersion(), CASClient::isProxy(), CASClient::readURL(), phpCAS::traceBegin(), and CASClient::validateST().

Referenced by CASClient::isAuthenticated(), and CASClient::validateST().


Variable Documentation

CASClient::$_st [private, inherited]
 

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

Definition at line 845 of file client.php.


Generated on Thu Aug 17 02:03:22 2006 for phpCAS by doxygen 1.3.7