Source for file IAuthenticator.php

Documentation is available at IAuthenticator.php

1. 1: <?php
2. 2:  
3. 3: /**
4. 4:  * Nette Framework
5. 5:  *
6. 6:  * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7. 7:  *
8. 8:  * This source file is subject to the "Nette license" that is bundled
9. 9:  * with this package in the file license.txt.
10. 10:  *
11. 11:  * For more information please see https://nette.org
12. 12:  *
13. 13:  * @copyright  Copyright (c) 2004, 2009 David Grudl
14. 14:  * @license    https://nette.org/license  Nette license
15. 15:  * @link       https://nette.org
16. 16:  * @category   Nette
17. 17:  * @package    Nette\Security
18. 18:  * @version    $Id$
19. 19:  */
20. 20:  
21. 21:  
22. 22:  
23. 23: /**
24. 24:  * Performs authentication.
25. 25:  *
26. 26:  * @author     David Grudl
27. 27:  * @copyright  Copyright (c) 2004, 2009 David Grudl
28. 28:  * @package    Nette\Security
29. 29:  */
30. 30: interface IAuthenticator
31. 31: {
32. 32:     /**#@+ Credential key */
33. 33:     const USERNAME = 'username';
34. 34:     const PASSWORD = 'password';
35. 35:     /**#@-*/
36. 36:  
37. 37:     /**#@+ Exception error code */
38. 38:     const IDENTITY_NOT_FOUND = 1;
39. 39:     const INVALID_CREDENTIAL = 2;
40. 40:     const FAILURE = 3;
41. 41:     /**#@-*/
42. 42:  
43. 43:     /**
44. 44:      * Performs an authentication against e.g. database.
45. 45:      * and returns IIdentity on success or throws AuthenticationException
46. 46:      *
47. 47:      * @param  array 
48. 48:      * @return IIdentity 
49. 49:      * @throws AuthenticationException
50. 50:      */
51. 51:     function authenticate(array $credentials);
52. 52:  
53. 53: }