Deprecate SessionIdentifierAwareInterface for removal in v2.0 (#61)

mezzio · Aug 16, 2024 · 5b027d0 · 5b027d0
1 parent 8bb7dbf
commit 5b027d0
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -5,19 +5,32 @@
       <code>generateCacheHeaders</code>
     </UnusedMethod>
   </file>
+  <file src="src/LazySession.php">
+    <DeprecatedInterface>
+      <code>LazySession</code>
+    </DeprecatedInterface>
+  </file>
   <file src="src/RetrieveSession.php">
     <UnusedConstructor>
       <code>__construct</code>
     </UnusedConstructor>
   </file>
   <file src="src/Session.php">
+    <DeprecatedInterface>
+      <code>Session</code>
+    </DeprecatedInterface>
     <MixedInferredReturnType>
       <code>null|bool|int|float|string|array</code>
     </MixedInferredReturnType>
     <MixedReturnStatement>
       <code>json_decode(json_encode($value, JSON_PRESERVE_ZERO_FRACTION), true)</code>
     </MixedReturnStatement>
   </file>
+  <file src="src/SessionPersistenceInterface.php">
+    <DeprecatedInterface>
+      <code><![CDATA[SessionInterface&SessionIdentifierAwareInterface]]></code>
+    </DeprecatedInterface>
+  </file>
   <file src="test/Persistence/CacheHeadersGeneratorTraitTest.php">
     <PossiblyUnusedMethod>
       <code>provideCacheHeaderValues</code>

diff --git a/src/SessionIdentifierAwareInterface.php b/src/SessionIdentifierAwareInterface.php
@@ -4,6 +4,10 @@
 
 namespace Mezzio\Session;
 
+/**
+ * @deprecated This interface will be removed in version 2.0 of this component.
+ *             The method getId() has been added to SessionInterface.
+ */
 interface SessionIdentifierAwareInterface
 {
     /**