summaryrefslogtreecommitdiffstats
path: root/Core/User/EquatableInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'Core/User/EquatableInterface.php')
-rw-r--r--Core/User/EquatableInterface.php37
1 files changed, 37 insertions, 0 deletions
diff --git a/Core/User/EquatableInterface.php b/Core/User/EquatableInterface.php
new file mode 100644
index 0000000..e2bde9e
--- /dev/null
+++ b/Core/User/EquatableInterface.php
@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Core\User;
+
+/**
+ * EquatableInterface used to test if two objects are equal in security
+ * and re-authentication context.
+ *
+ * @author Dariusz Górecki <darek.krk@gmail.com>
+ */
+interface EquatableInterface
+{
+ /**
+ * The equality comparison should neither be done by referential equality
+ * nor by comparing identities (i.e. getId() === getId()).
+ *
+ * However, you do not need to compare every attribute, but only those that
+ * are relevant for assessing whether re-authentication is required.
+ *
+ * Also implementation should consider that $user instance may implement
+ * the extended user interface `AdvancedUserInterface`.
+ *
+ * @param UserInterface $user
+ *
+ * @return Boolean
+ */
+ function isEqualTo(UserInterface $user);
+}