Authentication
[User interface]


Functions

 phpCAS::setCacheTimesForAuthRecheck ($n)
 phpCAS::checkAuthentication ()
 phpCAS::forceAuthentication ()
 phpCAS::authenticate ()
 phpCAS::isAuthenticated ()
 phpCAS::isSessionAuthenticated ()
 phpCAS::getUser ()
 phpCAS::getServerLoginURL ()
 phpCAS::setServerLoginURL ($url='')
 phpCAS::getServerLogoutURL ()
 phpCAS::setServerLogoutURL ($url='')
 phpCAS::logout ($url="")
 phpCAS::setFixedCallbackURL ($url='')
 phpCAS::setFixedServiceURL ($url)
 phpCAS::getServiceURL ()
 phpCAS::retrievePT ($target_service, &$err_code, &$err_msg)

Function Documentation

phpCAS::authenticate (  )  [inherited]

This method has been left from version 0.4.1 for compatibility reasons.

Definition at line 919 of file CAS.php.

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

Referenced by phpCAS::forceAuthentication().

phpCAS::checkAuthentication (  )  [inherited]

This method is called to check if the user is authenticated (use the gateway feature).

Returns:
TRUE when the user is authenticated; otherwise FALSE.
Examples:
example_gateway.php.

Definition at line 859 of file CAS.php.

References $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, phpCAS::backtrace(), phpCAS::client(), phpCAS::error(), phpCAS::proxy(), phpCAS::traceBegin(), and phpCAS::traceEnd().

Referenced by phpCAS::serviceMail(), and phpCAS::serviceWeb().

phpCAS::forceAuthentication (  )  [inherited]

This method is called to force authentication if the user was not already authenticated. If the user is not authenticated, halt by redirecting to the CAS server.

Examples:
example_db.php, example_file.php, example_gateway.php, example_html.php, example_lang.php, example_proxy.php, example_proxy2.php, example_service.php, example_session_proxy.php, example_session_service.php, and example_simple.php.

Definition at line 886 of file CAS.php.

References $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, phpCAS::authenticate(), phpCAS::backtrace(), phpCAS::client(), phpCAS::error(), phpCAS::getUser(), phpCAS::proxy(), phpCAS::trace(), phpCAS::traceBegin(), and phpCAS::traceEnd().

Referenced by phpCAS::authenticate(), phpCAS::getUser(), phpCAS::serviceMail(), and phpCAS::serviceWeb().

phpCAS::getServerLoginURL (  )  [inherited]

This method returns the URL to be used to login. or phpCAS::isAuthenticated().

Returns:
the login name of the authenticated user

Definition at line 996 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::client(), phpCAS::error(), and phpCAS::proxy().

phpCAS::getServerLogoutURL (  )  [inherited]

This method returns the URL to be used to login. or phpCAS::isAuthenticated().

Returns:
the login name of the authenticated user

Definition at line 1032 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::client(), phpCAS::error(), and phpCAS::proxy().

phpCAS::getServiceURL (  )  [inherited]

Get the URL that is set as the CAS service parameter.

Definition at line 1125 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::error(), and phpCAS::proxy().

phpCAS::getUser (  )  [inherited]

This method returns the CAS user's login name.

Warning:
should not be called only after phpCAS::forceAuthentication() or phpCAS::checkAuthentication().
Returns:
the login name of the authenticated user
Examples:
example_db.php, example_file.php, example_gateway.php, example_html.php, example_lang.php, example_proxy.php, example_proxy2.php, example_session_proxy.php, and example_simple.php.

Definition at line 975 of file CAS.php.

References $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, phpCAS::client(), phpCAS::error(), phpCAS::forceAuthentication(), phpCAS::isAuthenticated(), and phpCAS::proxy().

Referenced by phpCAS::forceAuthentication().

phpCAS::isAuthenticated (  )  [inherited]

This method is called to check if the user is authenticated (previously or by tickets given in the URL).

Returns:
TRUE when the user is authenticated.

Definition at line 930 of file CAS.php.

References $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, phpCAS::backtrace(), phpCAS::client(), phpCAS::error(), phpCAS::proxy(), phpCAS::traceBegin(), and phpCAS::traceEnd().

Referenced by phpCAS::getUser().

phpCAS::isSessionAuthenticated (  )  [inherited]

Checks whether authenticated based on $_SESSION. Useful to avoid server calls.

Returns:
true if authenticated, false otherwise.
Since:
0.4.22 by Brendan Arnold

Definition at line 959 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::client(), phpCAS::error(), and phpCAS::proxy().

phpCAS::logout ( url = ""  )  [inherited]

This method is used to logout from CAS. Halts by redirecting to the CAS server.

Parameters:
$url a URL that will be transmitted to the CAS server (to come back to when logged out)
Examples:
example_gateway.php, and example_simple.php.

Definition at line 1066 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::client(), phpCAS::error(), phpCAS::proxy(), phpCAS::traceBegin(), and phpCAS::traceEnd().

phpCAS::retrievePT ( target_service,
&$  err_code,
&$  err_msg 
) [inherited]

Retrieve a Proxy Ticket from the CAS server.

Definition at line 1137 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::error(), and phpCAS::proxy().

phpCAS::setCacheTimesForAuthRecheck ( n  )  [inherited]

Set the times authentication will be cached before really accessing the CAS server in gateway mode:

Parameters:
$n an integer.

Definition at line 843 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::client(), phpCAS::error(), and phpCAS::proxy().

phpCAS::setFixedCallbackURL ( url = ''  )  [inherited]

Set the fixed URL that will be used by the CAS server to transmit the PGT. When this method is not called, a phpCAS script uses its own URL for the callback.

Parameters:
$url the URL

Definition at line 1085 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::error(), phpCAS::proxy(), phpCAS::traceBegin(), and phpCAS::traceEnd().

phpCAS::setFixedServiceURL ( url  )  [inherited]

Set the fixed URL that will be set as the CAS service parameter. When this method is not called, a phpCAS script uses its own URL.

Parameters:
$url the URL

Definition at line 1108 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::error(), phpCAS::proxy(), phpCAS::traceBegin(), and phpCAS::traceEnd().

phpCAS::setServerLoginURL ( url = ''  )  [inherited]

Set the login URL of the CAS server.

Parameters:
$url the login URL
Since:
0.4.21 by Wyman Chan

Definition at line 1010 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::client(), phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().

phpCAS::setServerLogoutURL ( url = ''  )  [inherited]

Set the logout URL of the CAS server.

Parameters:
$url the logout URL
Since:
0.4.21 by Wyman Chan

Definition at line 1046 of file CAS.php.

References $PHPCAS_CLIENT, phpCAS::client(), phpCAS::error(), phpCAS::traceBegin(), and phpCAS::traceEnd().


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