1: <?php
2: /**
3: * This file contains the abstract authentication handler class.
4: *
5: * @package Core
6: * @subpackage Authentication
7: * @version SVN Revision $Rev:$
8: *
9: * @author Dominik Ziegler
10: * @copyright four for business AG <www.4fb.de>
11: * @license http://www.contenido.org/license/LIZENZ.txt
12: * @link http://www.4fb.de
13: * @link http://www.contenido.org
14: */
15:
16: defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
17:
18: /**
19: * This class contains the abstract methods for the authentication in CONTENIDO.
20: *
21: * @package Core
22: * @subpackage Authentication
23: */
24: abstract class cAuthHandlerAbstract extends cAuth {
25:
26: /**
27: * Handle the pre authorization.
28: * Let return this method a valid user ID to set before the login form is
29: * handled, otherwise false.
30: *
31: * @return string false
32: */
33: abstract public function preAuthorize();
34:
35: /**
36: * Display the login form.
37: * Let this method include a file which displays the login form.
38: */
39: abstract public function displayLoginForm();
40:
41: /**
42: * Validate the credentials.
43: * Let this method validate the users input against source and return a
44: * valid user ID or false.
45: *
46: * @return string false
47: */
48: abstract public function validateCredentials();
49:
50: /**
51: * Log the successful authentication.
52: * If wished, this method can be executed for logging an successful
53: * authentication.
54: */
55: abstract public function logSuccessfulAuth();
56:
57:
58: /**
59: * Returns true if a user is logged in
60: *
61: * @return bool
62: */
63: abstract public function isLoggedIn();
64:
65: }