CAS_ProxiedService_Abstract Class Reference

This class implements common methods for ProxiedService implementations included with phpCAS. More...

Inheritance diagram for CAS_ProxiedService_Abstract:

Collaboration diagram for CAS_ProxiedService_Abstract:

Public Member Functions
	setProxyTicket ($proxyTicket)
	Register a proxy ticket with the Proxy that it can use when making requests. More...
	setCasClient (CAS_Client $casClient)
	Use a particular CAS_Client->initializeProxiedService() rather than the static phpCAS::initializeProxiedService(). More...
Public Member Functions inherited from CAS_ProxiedService
	getServiceUrl ()
	Answer a service identifier (URL) for whom we should fetch a proxy ticket. More...
	setProxyTicket ($proxyTicket)
	Register a proxy ticket with the ProxiedService that it can use when making requests. More...
	setCasClient (CAS_Client $casClient)
	Use a particular CAS_Client->initializeProxiedService() rather than the static phpCAS::initializeProxiedService(). More...

Protected Member Functions
	getProxyTicket ()
	Answer the proxy ticket to be used when making requests. More...
	initializeProxyTicket ()
	Fetch our proxy ticket. More...

Private Attributes
	$_proxyTicket
	The proxy ticket that can be used when making service requests. More...
	$_casClient

Detailed Description

This class implements common methods for ProxiedService implementations included with phpCAS.

Definition at line 41 of file Abstract.php.

Member Function Documentation

getProxyTicket()

CAS_ProxiedService_Abstract::getProxyTicket ( )

protected

Answer the proxy ticket to be used when making requests.

Returns

string

Exceptions

CAS_OutOfSequenceException

If called before a proxy ticket has already been initialized/set.

Definition at line 83 of file Abstract.php.

    {
        if (empty($this->_proxyTicket)) {
            throw new CAS_OutOfSequenceException(
                'No proxy ticket yet. Call $this->initializeProxyTicket() to aquire the proxy ticket.'
            );
        }
 
        return $this->_proxyTicket;
    }

References $_proxyTicket.

Referenced by CAS_ProxiedService_Http_Abstract\send().

Here is the caller graph for this function:

initializeProxyTicket()

CAS_ProxiedService_Abstract::initializeProxyTicket ( )

protected

Fetch our proxy ticket.

Descendent classes should call this method once their service URL is available to initialize their proxy ticket.

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after a proxy ticket has already been initialized.

Definition at line 133 of file Abstract.php.

    {
        if (!empty($this->_proxyTicket)) {
            throw new CAS_OutOfSequenceException(
                'Already initialized, cannot initialize again.'
            );
        }
        // Allow usage of a particular CAS_Client for unit testing.
        if (empty($this->_casClient)) {
            phpCAS::initializeProxiedService($this);
        } else {
            $this->_casClient->initializeProxiedService($this);
        }
    }

References phpCAS\initializeProxiedService().

Referenced by CAS_ProxiedService_Imap\open(), and CAS_ProxiedService_Http_Abstract\send().

Here is the call graph for this function:

Here is the caller graph for this function:

setCasClient()

CAS_ProxiedService_Abstract::setCasClient

(

CAS_Client

$casClient

)

Use a particular CAS_Client->initializeProxiedService() rather than the static phpCAS::initializeProxiedService().

This method should not be called in standard operation, but is needed for unit testing.

Parameters

CAS_Client

$casClient

cas client

Returns

void

Exceptions

CAS_OutOfSequenceException

If called after a proxy ticket has already been initialized/set.

Implements CAS_ProxiedService_Testable.

Definition at line 112 of file Abstract.php.

    {
        if (!empty($this->_proxyTicket)) {
            throw new CAS_OutOfSequenceException(
                'Already initialized, cannot change the CAS_Client.'
            );
        }
 
        $this->_casClient = $casClient;
    }

setProxyTicket()

CAS_ProxiedService_Abstract::setProxyTicket

(

$proxyTicket

)

Register a proxy ticket with the Proxy that it can use when making requests.

Parameters

string

$proxyTicket

proxy ticket

Returns

void

Exceptions

InvalidArgumentException	If the $proxyTicket is invalid.
CAS_OutOfSequenceException	If called after a proxy ticket has already been initialized/set.

Reimplemented from CAS_ProxiedService.

Definition at line 61 of file Abstract.php.

    {
        if (empty($proxyTicket)) {
            throw new CAS_InvalidArgumentException(
                'Trying to initialize with an empty proxy ticket.'
            );
        }
        if (!empty($this->_proxyTicket)) {
            throw new CAS_OutOfSequenceException(
                'Already initialized, cannot change the proxy ticket.'
            );
        }
        $this->_proxyTicket = $proxyTicket;
    }

Field Documentation

$_casClient

CAS_Client CAS_ProxiedService_Abstract::$_casClient

private

Definition at line 97 of file Abstract.php.

$_proxyTicket

string CAS_ProxiedService_Abstract::$_proxyTicket

private

The proxy ticket that can be used when making service requests.

Definition at line 49 of file Abstract.php.

Referenced by getProxyTicket().

---

The documentation for this class was generated from the following file:

• Services/CAS/lib/CAS/ProxiedService/Abstract.php