summaryrefslogtreecommitdiff
path: root/framework/Security/IUserManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'framework/Security/IUserManager.php')
-rw-r--r--framework/Security/IUserManager.php46
1 files changed, 46 insertions, 0 deletions
diff --git a/framework/Security/IUserManager.php b/framework/Security/IUserManager.php
new file mode 100644
index 00000000..b1a6b67c
--- /dev/null
+++ b/framework/Security/IUserManager.php
@@ -0,0 +1,46 @@
+<?php
+/**
+ * IUserManager interface file
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright &copy; 2005 PradoSoft
+ * @license http://www.pradosoft.com/license/
+ * @version $Revision: $ $Date: $
+ * @package System.Security
+ */
+
+/**
+ * IUserManager interface
+ *
+ * IUserManager specifies the interface that must be implemented by
+ * a user manager class if it is to be used together with {@link TAuthManager}
+ * and {@link TUser}.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Revision: $ $Date: $
+ * @package System.Security
+ * @since 3.0
+ */
+interface IUserManager
+{
+ /**
+ * @return string name for a guest user.
+ */
+ public function getGuestName();
+ /**
+ * Returns a user instance given the user name.
+ * @param string user name, null if it is a guest.
+ * @return TUser the user instance, null if the specified username is not in the user database.
+ */
+ public function getUser($username=null);
+ /**
+ * Validates if the username and password are correct.
+ * @param string user name
+ * @param string password
+ * @return boolean true if validation is successful, false otherwise.
+ */
+ public function validateUser($username,$password);
+}
+
+?> \ No newline at end of file