Enumerations | |
enum | PHPCAS_SERVICE_OK |
enum | PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE |
enum | PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE |
enum | PHPCAS_SERVICE_PT_FAILURE |
enum | PHPCAS_SERVICE_NOT_AVAILABLE |
enum | PHPCAS_PROXIED_SERVICE_HTTP_GET |
enum | PHPCAS_PROXIED_SERVICE_HTTP_POST |
enum | PHPCAS_PROXIED_SERVICE_IMAP |
Functions | |
static | phpCAS::getProxiedService ($type) |
static | phpCAS::initializeProxiedService (CAS_ProxiedService $proxiedService) |
static | phpCAS::serviceWeb ($url, &$err_code, &$output) |
static | phpCAS::serviceMail ($url, $service, $flags, &$err_code, &$err_msg, &$pt) |
enum PHPCAS_SERVICE_OK |
static phpCAS::getProxiedService | ( | $ | type | ) | [static, inherited] |
Answer a proxy-authenticated service handler.
string | $type The service type. One of: PHPCAS_PROXIED_SERVICE_HTTP_GET PHPCAS_PROXIED_SERVICE_HTTP_POST PHPCAS_PROXIED_SERVICE_IMAP |
InvalidArgumentException | If the service type is unknown. |
Definition at line 820 of file CAS.php.
References phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().
static phpCAS::initializeProxiedService | ( | CAS_ProxiedService $ | proxiedService | ) | [static, inherited] |
Initialize a proxied-service handler with the proxy-ticket it should use.
CAS_ProxiedService | $proxiedService |
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 857 of file CAS.php.
References phpCAS::error().
Referenced by CAS_ProxiedService_Abstract::initializeProxyTicket().
static phpCAS::serviceMail | ( | $ | url, | |
$ | service, | |||
$ | flags, | |||
&$ | err_code, | |||
&$ | err_msg, | |||
&$ | pt | |||
) | [static, inherited] |
This method is used to access an IMAP/POP3/NNTP service.
$url | a string giving the URL of the service, including the mailing box for IMAP URLs, as accepted by imap_open(). | |
$service | a string giving for CAS retrieve Proxy ticket | |
$flags | options given to imap_open(). | |
$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. | |
$err_msg | an error message on failure | |
$pt | the Proxy Ticket (PT) retrieved from the CAS server to access the URL on success, FALSE on error). |
Definition at line 932 of file CAS.php.
References phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().
static phpCAS::serviceWeb | ( | $ | url, | |
&$ | err_code, | |||
&$ | output | |||
) | [static, inherited] |
This method is used to access an HTTP[S] service.
$url | the service to access. | |
$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. | |
$output | the output of the service (also used to give an error message on failure). |
Definition at line 889 of file CAS.php.
References phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().