Collaboration diagram for Access to external services:

Functions
static	phpCAS::getProxiedService ($type)
	Answer a proxy-authenticated service handler. More...

static	phpCAS::initializeProxiedService (CAS_ProxiedService $proxiedService)
	Initialize a proxied-service handler with the proxy-ticket it should use. More...

static	phpCAS::serviceWeb ($url, & $err_code, & $output)
	This method is used to access an HTTP[S] service. More...

static	phpCAS::serviceMail ($url, $service, $flags, & $err_code, & $err_msg, & $pt)
	This method is used to access an IMAP/POP3/NNTP service. More...

Variables
const	PHPCAS_SERVICE_OK 0
	phpCAS::service() error code on success More...

const	PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE 1
	phpCAS::service() error code when the PT could not retrieve because the CAS server did not respond. More...

const	PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE 2
	phpCAS::service() error code when the PT could not retrieve because the response of the CAS server was ill-formed. More...

const	PHPCAS_SERVICE_PT_FAILURE 3
	phpCAS::service() error code when the PT could not retrieve because the CAS server did not want to. More...

const	PHPCAS_SERVICE_NOT_AVAILABLE 4
	phpCAS::service() error code when the service was not available. More...

const	PHPCAS_PROXIED_SERVICE_HTTP_GET 'CAS_ProxiedService_Http_Get'
	phpCAS::getProxiedService() type for HTTP GET More...

const	PHPCAS_PROXIED_SERVICE_HTTP_POST 'CAS_ProxiedService_Http_Post'
	phpCAS::getProxiedService() type for HTTP POST More...

const	PHPCAS_PROXIED_SERVICE_IMAP 'CAS_ProxiedService_Imap'
	phpCAS::getProxiedService() type for IMAP More...

Detailed Description

Function Documentation

◆ getProxiedService()

static phpCAS::getProxiedService ( $type )

static

Answer a proxy-authenticated service handler.

Parameters

string $type The service type. One of PHPCAS_PROXIED_SERVICE_HTTP_GET; PHPCAS_PROXIED_SERVICE_HTTP_POST; PHPCAS_PROXIED_SERVICE_IMAP

Returns: CAS_ProxiedService

Exceptions

InvalidArgumentException If the service type is unknown.

Definition at line 864 of file CAS.php.

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

     {
         phpCAS :: traceBegin();
         phpCAS::_validateProxyExists();
 
         try {
             $res = self::$_PHPCAS_CLIENT->getProxiedService($type);
         } catch (Exception $e) {
             phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
         }
 
         phpCAS :: traceEnd();
         return $res;
     }

Here is the call graph for this function:

◆ initializeProxiedService()

static phpCAS::initializeProxiedService ( CAS_ProxiedService $proxiedService )

static

Initialize a proxied-service handler with the proxy-ticket it should use.

Parameters

CAS_ProxiedService $proxiedService Proxied Service Handler

Returns: void

Exceptions

CAS_ProxyTicketException If there is a proxy-ticket failure. The code of the Exception will be one of: PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE PHPCAS_SERVICE_PT_FAILURE

Definition at line 891 of file CAS.php.

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

Referenced by CAS_ProxiedService_Abstract\initializeProxyTicket().

     {
         phpCAS::_validateProxyExists();
 
         try {
             self::$_PHPCAS_CLIENT->initializeProxiedService($proxiedService);
         } catch (Exception $e) {
             phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serviceMail()

static phpCAS::serviceMail	(		$url,
			$service,
			$flags,
		&	$err_code,
		&	$err_msg,
		&	$pt
	)

static

This method is used to access an IMAP/POP3/NNTP service.

Parameters

string	$url	a string giving the URL of the service, including the mailing box for IMAP URLs, as accepted by imap_open().
string	$service	a string giving for CAS retrieve Proxy ticket
string	$flags	options given to imap_open().
string	&$err_code	an error code Possible values are PHPCAS_SERVICE_OK (on success), PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE, PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE, PHPCAS_SERVICE_PT_FAILURE, PHPCAS_SERVICE_NOT_AVAILABLE.
string	&$err_msg	an error message on failure
string	&$pt	the Proxy Ticket (PT) retrieved from the CAS server to access the URL on success, false on error).

Returns: object IMAP stream on success, false otherwise (in this later case, $err_code gives the reason why it failed and $err_msg contains an error message).

Definition at line 951 of file CAS.php.

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

     {
         phpCAS :: traceBegin();
         phpCAS::_validateProxyExists();
 
         try {
             $res = self::$_PHPCAS_CLIENT->serviceMail($url, $service, $flags, $err_code, $err_msg, $pt);
         } catch (Exception $e) {
             phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
         }
 
         phpCAS :: traceEnd($res);
         return $res;
     }

Here is the call graph for this function:

◆ serviceWeb()

static phpCAS::serviceWeb	(		$url,
		&	$err_code,
		&	$output
	)

static

This method is used to access an HTTP[S] service.

Parameters

string	$url	the service to access.
string	&$err_code	an error code Possible values are PHPCAS_SERVICE_OK (on success), PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE, PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE, PHPCAS_SERVICE_PT_FAILURE, PHPCAS_SERVICE_NOT_AVAILABLE.
string	&$output	the output of the service (also used to give an error message on failure).

Returns: bool true on success, false otherwise (in this later case, $err_code gives the reason why it failed and $output contains an error message).

Definition at line 917 of file CAS.php.

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

     {
         phpCAS :: traceBegin();
         phpCAS::_validateProxyExists();
 
         try {
             $res = self::$_PHPCAS_CLIENT->serviceWeb($url, $err_code, $output);
         } catch (Exception $e) {
             phpCAS :: error(get_class($e) . ': ' . $e->getMessage());
         }
 
         phpCAS :: traceEnd($res);
         return $res;
     }