Debugging [User interface]

Enumerations
enum	DEFAULT_DEBUG_DIR
Functions
static	phpCAS::setDebug ($filename= '')
static	phpCAS::log ($str)
static	phpCAS::error ($msg)
static	phpCAS::trace ($str)
static	phpCAS::traceBegin ()
static	phpCAS::traceEnd ($res= '')
static	phpCAS::traceExit ()

---

Enumeration Type Documentation

enum DEFAULT_DEBUG_DIR

The default directory for the debug file under Unix.

Definition at line 240 of file CAS.php.

---

Function Documentation

static phpCAS::error

(

$

msg

)

[static, inherited]

This method is used by interface methods to print an error and where the function was originally called from.

Parameters:

string

$msg the message to print

Returns:

void

Definition at line 497 of file CAS.php.

References phpCAS::trace(), and phpCAS::traceEnd().

Referenced by CAS_PGTStorage_File::__construct(), CAS_PGTStorage_AbstractStorage::__construct(), CAS_Client::__construct(), CAS_Client::_callback(), CAS_Client::_readURL(), CAS_Client::_renameSession(), phpCAS::addRebroadcastHeader(), phpCAS::addRebroadcastNode(), phpCAS::allowProxyChain(), phpCAS::checkAuthentication(), phpCAS::client(), CAS_PGTStorage_Db::createTable(), phpCAS::forceAuthentication(), phpCAS::getAttribute(), CAS_Client::getAttributes(), phpCAS::getAttributes(), phpCAS::getProxiedService(), phpCAS::getProxies(), phpCAS::getServerLoginURL(), phpCAS::getServerLogoutURL(), phpCAS::getServiceURL(), CAS_PGTStorage_AbstractStorage::getStorageInfo(), CAS_PGTStorage_AbstractStorage::getStorageType(), CAS_Client::getUser(), phpCAS::getUser(), CAS_Client::handleLogoutRequests(), phpCAS::handleLogoutRequests(), phpCAS::hasAttribute(), phpCAS::hasAttributes(), CAS_PGTStorage_Db::init(), phpCAS::initializeProxiedService(), phpCAS::isAuthenticated(), phpCAS::isSessionAuthenticated(), phpCAS::logout(), phpCAS::logoutWithRedirectService(), phpCAS::logoutWithRedirectServiceAndUrl(), phpCAS::logoutWithUrl(), phpCAS::proxy(), CAS_PGTStorage_File::read(), CAS_PGTStorage_AbstractStorage::read(), phpCAS::renewAuthentication(), phpCAS::retrievePT(), phpCAS::serviceMail(), phpCAS::serviceWeb(), phpCAS::setCacheTimesForAuthRecheck(), phpCAS::setCasServerCACert(), phpCAS::setDebug(), phpCAS::setExtraCurlOption(), phpCAS::setFixedCallbackURL(), phpCAS::setFixedServiceURL(), phpCAS::setHTMLFooter(), phpCAS::setHTMLHeader(), phpCAS::setLang(), phpCAS::setNoCasServerValidation(), phpCAS::setNoClearTicketsFromUrl(), CAS_Client::setPGTStorage(), phpCAS::setPGTStorage(), phpCAS::setPGTStorageDb(), phpCAS::setPGTStorageFile(), phpCAS::setPostAuthenticateCallback(), phpCAS::setServerLoginURL(), phpCAS::setServerLogoutURL(), phpCAS::setServerProxyValidateURL(), phpCAS::setServerSamlValidateURL(), phpCAS::setServerServiceValidateURL(), phpCAS::setSingleSignoutCallback(), CAS_PGTStorage_File::write(), CAS_PGTStorage_Db::write(), and CAS_PGTStorage_AbstractStorage::write().

static phpCAS::log

(

$

str

)

[static, inherited]

Logs a string in debug mode.

Parameters:

string

$str the string to write

Returns:

void

Definition at line 463 of file CAS.php.

Referenced by phpCAS::addRebroadcastNode(), phpCAS::trace(), phpCAS::traceBegin(), phpCAS::traceEnd(), and phpCAS::traceExit().

static phpCAS::setDebug

(

$

filename = ''

)

[static, inherited]

Set/unset debug mode

Parameters:

string

$filename the name of the file used for logging, or false to stop debugging.

Returns:

void

Examples:

example_advanced_saml11.php, example_custom_urls.php, example_gateway.php, example_html.php, example_lang.php, example_logout.php, example_pgt_storage_db.php, example_pgt_storage_file.php, example_proxy_GET.php, example_proxy_POST.php, example_proxy_serviceWeb.php, example_proxy_serviceWeb_chaining.php, example_service.php, example_service_POST.php, example_service_that_proxies.php, and example_simple.php.

Definition at line 421 of file CAS.php.

References phpCAS::error(), and phpCAS::trace().

static phpCAS::trace

(

$

str

)

[static, inherited]

This method is used to log something in debug mode.

Parameters:

string

$str string to log

Returns:

void

Definition at line 528 of file CAS.php.

References phpCAS::log().

Referenced by CAS_Client::__construct(), CAS_AuthenticationException::__construct(), CAS_Client::_authError(), CAS_Client::_callback(), CAS_Request_CurlRequest::_initAndConfigure(), CAS_Client::_rebroadcast(), CAS_Client::_renameSession(), CAS_Client::_setSessionAttributes(), CAS_Client::_validatePGT(), CAS_Client::_wasPreviouslyAuthenticated(), CAS_Client::checkAuthentication(), CAS_ProxyChain_AllowedList::contains(), phpCAS::error(), CAS_Client::forceAuthentication(), CAS_Client::getURL(), CAS_Client::handleLogoutRequests(), CAS_Client::isAuthenticated(), CAS_ProxyChain_AllowedList::isProxyListAllowed(), CAS_Client::logout(), CAS_ProxiedService_Http_Abstract::makeRequest(), CAS_ProxyChain_Any::matches(), CAS_ProxyChain::matches(), CAS_ProxiedService_Imap::open(), CAS_CookieJar::parseCookieHeader(), CAS_PGTStorage_File::read(), CAS_PGTStorage_Db::read(), CAS_Client::redirectToCas(), CAS_Client::renewAuthentication(), CAS_Client::retrievePT(), CAS_Request_CurlRequest::sendRequest(), phpCAS::setDebug(), phpCAS::setNoCasServerValidation(), CAS_CookieJar::storeCookies(), CAS_Client::validateCAS10(), CAS_Client::validateCAS20(), CAS_Client::validateSA(), and CAS_PGTStorage_File::write().

static phpCAS::traceBegin

(

)

[static, inherited]

This method is used to indicate the start of the execution of a function in debug mode.

Returns:

void

Definition at line 539 of file CAS.php.

References phpCAS::log().

Referenced by CAS_PGTStorage_File::__construct(), CAS_PGTStorage_Db::__construct(), CAS_PGTStorage_AbstractStorage::__construct(), CAS_Client::__construct(), CAS_AuthenticationException::__construct(), CAS_Client::_authError(), CAS_Client::_buildSAMLPayload(), CAS_Client::_callback(), CAS_Client::_getNodeType(), CAS_Client::_readURL(), CAS_Client::_rebroadcast(), CAS_Client::_renameSession(), CAS_Client::_setSessionAttributes(), CAS_Client::_validatePGT(), CAS_Client::_wasPreviouslyAuthenticated(), phpCAS::addRebroadcastHeader(), phpCAS::addRebroadcastNode(), phpCAS::allowProxyChain(), CAS_Client::checkAuthentication(), phpCAS::checkAuthentication(), phpCAS::client(), CAS_ProxyChain_AllowedList::contains(), CAS_PGTStorage_Db::createTable(), CAS_Client::forceAuthentication(), phpCAS::forceAuthentication(), CAS_PGTStorage_File::getPGTIouFilename(), phpCAS::getProxiedService(), CAS_Client::getServerLoginURL(), CAS_Client::getServerProxyValidateURL(), CAS_Client::getServerSamlValidateURL(), CAS_Client::getServerServiceValidateURL(), CAS_Client::getURL(), CAS_Client::handleLogoutRequests(), CAS_PGTStorage_File::init(), CAS_PGTStorage_Db::init(), CAS_Client::isAuthenticated(), phpCAS::isAuthenticated(), CAS_ProxyChain_AllowedList::isProxyListAllowed(), CAS_Client::logout(), phpCAS::logout(), phpCAS::logoutWithRedirectService(), phpCAS::logoutWithRedirectServiceAndUrl(), phpCAS::logoutWithUrl(), CAS_ProxiedService_Imap::open(), CAS_CookieJar::parseCookieHeaders(), phpCAS::proxy(), CAS_PGTStorage_File::read(), CAS_PGTStorage_Db::read(), CAS_Client::redirectToCas(), CAS_Client::renewAuthentication(), phpCAS::renewAuthentication(), CAS_Client::retrievePT(), CAS_ProxiedService_Http_Abstract::send(), CAS_Request_CurlRequest::sendRequest(), phpCAS::serviceMail(), phpCAS::serviceWeb(), phpCAS::setCasServerCACert(), phpCAS::setExtraCurlOption(), phpCAS::setFixedCallbackURL(), phpCAS::setFixedServiceURL(), CAS_Client::setLang(), phpCAS::setNoCasServerValidation(), phpCAS::setNoClearTicketsFromUrl(), phpCAS::setPGTStorage(), phpCAS::setPGTStorageDb(), phpCAS::setPGTStorageFile(), phpCAS::setServerLoginURL(), phpCAS::setServerLogoutURL(), phpCAS::setServerProxyValidateURL(), phpCAS::setServerSamlValidateURL(), phpCAS::setServerServiceValidateURL(), CAS_Client::validateCAS10(), CAS_Client::validateCAS20(), CAS_PGTStorage_File::write(), and CAS_PGTStorage_Db::write().

static phpCAS::traceEnd

(

$

res = ''

)

[static, inherited]

This method is used to indicate the end of the execution of a function in debug mode.

Parameters:

string

$res the result of the function

Returns:

void

Definition at line 586 of file CAS.php.

References phpCAS::log().

Referenced by CAS_PGTStorage_File::__construct(), CAS_PGTStorage_Db::__construct(), CAS_PGTStorage_AbstractStorage::__construct(), CAS_Client::__construct(), CAS_Client::_buildSAMLPayload(), CAS_Client::_getNodeType(), CAS_Client::_readURL(), CAS_Client::_rebroadcast(), CAS_Client::_renameSession(), CAS_Client::_setSessionAttributes(), CAS_Client::_validatePGT(), CAS_Client::_wasPreviouslyAuthenticated(), phpCAS::addRebroadcastHeader(), phpCAS::addRebroadcastNode(), phpCAS::allowProxyChain(), CAS_Client::checkAuthentication(), phpCAS::checkAuthentication(), phpCAS::client(), CAS_ProxyChain_AllowedList::contains(), CAS_PGTStorage_Db::createTable(), phpCAS::error(), CAS_Client::forceAuthentication(), phpCAS::forceAuthentication(), CAS_PGTStorage_File::getPGTIouFilename(), phpCAS::getProxiedService(), CAS_Client::getServerLoginURL(), CAS_Client::getServerProxyValidateURL(), CAS_Client::getServerSamlValidateURL(), CAS_Client::getServerServiceValidateURL(), CAS_Client::getURL(), CAS_Client::handleLogoutRequests(), CAS_PGTStorage_File::init(), CAS_PGTStorage_Db::init(), CAS_Client::isAuthenticated(), phpCAS::isAuthenticated(), CAS_ProxyChain_AllowedList::isProxyListAllowed(), phpCAS::logout(), phpCAS::logoutWithRedirectService(), phpCAS::logoutWithRedirectServiceAndUrl(), phpCAS::logoutWithUrl(), CAS_CookieJar::parseCookieHeaders(), phpCAS::proxy(), CAS_PGTStorage_File::read(), CAS_PGTStorage_Db::read(), CAS_Client::renewAuthentication(), phpCAS::renewAuthentication(), CAS_Client::retrievePT(), CAS_ProxiedService_Http_Abstract::send(), CAS_Request_CurlRequest::sendRequest(), phpCAS::serviceMail(), phpCAS::serviceWeb(), phpCAS::setCasServerCACert(), phpCAS::setExtraCurlOption(), phpCAS::setFixedCallbackURL(), phpCAS::setFixedServiceURL(), CAS_Client::setLang(), phpCAS::setNoCasServerValidation(), phpCAS::setNoClearTicketsFromUrl(), phpCAS::setPGTStorage(), phpCAS::setPGTStorageDb(), phpCAS::setPGTStorageFile(), phpCAS::setServerLoginURL(), phpCAS::setServerLogoutURL(), phpCAS::setServerProxyValidateURL(), phpCAS::setServerSamlValidateURL(), phpCAS::setServerServiceValidateURL(), CAS_PGTStorage_File::write(), and CAS_PGTStorage_Db::write().

static phpCAS::traceExit

(

)

[static, inherited]

This method is used to indicate the end of the execution of the program

Returns:

void

Definition at line 609 of file CAS.php.

References phpCAS::log().

Referenced by CAS_AuthenticationException::__construct(), CAS_Client::_authError(), CAS_Client::_callback(), CAS_Client::handleLogoutRequests(), CAS_Client::isAuthenticated(), CAS_Client::logout(), and CAS_Client::redirectToCas().