summaryrefslogtreecommitdiffstats
path: root/User/AccountInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'User/AccountInterface.php')
-rw-r--r--User/AccountInterface.php60
1 files changed, 60 insertions, 0 deletions
diff --git a/User/AccountInterface.php b/User/AccountInterface.php
new file mode 100644
index 0000000..067366e
--- /dev/null
+++ b/User/AccountInterface.php
@@ -0,0 +1,60 @@
+<?php
+
+namespace Symfony\Component\Security\User;
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * AccountInterface is the interface that user classes must implement.
+ *
+ * @author Fabien Potencier <fabien.potencier@symfony-project.com>
+ */
+interface AccountInterface
+{
+ /**
+ * Returns a string representation of the User.
+ *
+ * @return string A string return of the User
+ */
+ function __toString();
+
+ /**
+ * Returns the roles granted to the user.
+ *
+ * @return Role[] The user roles
+ */
+ function getRoles();
+
+ /**
+ * Returns the password used to authenticate the user.
+ *
+ * @return string The password
+ */
+ function getPassword();
+
+ /**
+ * Returns the salt.
+ *
+ * @return string The salt
+ */
+ function getSalt();
+
+ /**
+ * Returns the username used to authenticate the user.
+ *
+ * @return string The username
+ */
+ function getUsername();
+
+ /**
+ * Removes sensitive data from the user.
+ */
+ function eraseCredentials();
+}