Main Page | Modules | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages | Examples

Authentication
[User interface]


Functions

 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 897 of file CAS.php.

References phpCAS::error().

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 837 of file CAS.php.

References $PHPCAS_AUTH_CHECK_CALL, $PHPCAS_CLIENT, phpCAS::backtrace(), 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 864 of file CAS.php.

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

Referenced by 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 953 of file CAS.php.

References $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 989 of file CAS.php.

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

phpCAS::getServiceURL  )  [inherited]
 

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

Definition at line 1082 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 932 of file CAS.php.

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

Referenced by phpCAS::forceAuthentication().

phpCAS::isAuthenticated  )  [inherited]
 

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

Definition at line 905 of file CAS.php.

References phpCAS::error().

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 916 of file CAS.php.

References $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)

Definition at line 1023 of file CAS.php.

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

Referenced by phpCAS::logout().

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

Retrieve a Proxy Ticket from the CAS server.

Definition at line 1094 of file CAS.php.

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

Referenced by phpCAS::retrievePT().

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 1042 of file CAS.php.

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

Referenced by phpCAS::setFixedCallbackURL().

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 1065 of file CAS.php.

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

Referenced by phpCAS::setFixedServiceURL().

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 967 of file CAS.php.

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

Referenced by phpCAS::setServerLoginURL().

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 1003 of file CAS.php.

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

Referenced by phpCAS::setServerLogoutURL().


Generated on Thu Aug 17 02:03:22 2006 for phpCAS by doxygen 1.3.7