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 915 of file client.php.

Referenced by CASClient::isAuthenticated().

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 931 of file client.php.

Referenced by CASClient::isAuthenticated().

CASClient::setST ( st  )  [private, inherited]

This method stores the Service Ticket.

Parameters:
$st The Service Ticket.

Definition at line 923 of file client.php.

Referenced by CASClient::CASClient(), 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 957 of file client.php.

References CASClient::authError(), domxml_open_mem(), CASClient::getServerServiceValidateURL(), CASClient::getServerVersion(), CASClient::isProxy(), CASClient::readURL(), CASClient::setUser(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().

Referenced by CASClient::isAuthenticated().


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 908 of file client.php.


Generated on Wed Mar 14 14:55:56 2007 for phpCAS by  doxygen 1.5.0