ext/spl: Deprecate SplObjectStorage::contains(), SplObjectStorage::attach(), and SplObjectStorage::detach() (#19424)

RFC: https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_splobjectstoragecontains_splobjectstorageattach_and_splobjectstoragedetach

Author: Girgias

Zend/tests/enum/spl-object-storage.phpt

@@ -16,8 +16,8 @@ $storage[Foo::Baz] = 'Baz';
 var_dump($storage[Foo::Bar]);
 var_dump($storage[Foo::Baz]);
 
-var_dump($storage->contains(Foo::Bar));
-var_dump($storage->contains(Foo::Qux));
+var_dump($storage->offsetExists(Foo::Bar));
+var_dump($storage->offsetExists(Foo::Qux));
 
 $serialized = serialize($storage);
 var_dump($serialized);

ext/spl/spl_observer.c

@@ -25,6 +25,7 @@
 #include "zend_smart_str.h"
 #include "zend_interfaces.h"
 #include "zend_exceptions.h"
+#include "zend_attributes.h"
 
 #include "php_spl.h" /* For php_spl_object_hash() */
 #include "spl_observer.h"

ext/spl/spl_observer.stub.php

@@ -23,12 +23,15 @@ public function notify(): void;
 class SplObjectStorage implements Countable, SeekableIterator, Serializable, ArrayAccess
 {
     /** @tentative-return-type */
+    #[\Deprecated(since: '8.5', message: "use method SplObjectStorage::offsetSet() instead")]
     public function attach(object $object, mixed $info = null): void {}
 
     /** @tentative-return-type */
+    #[\Deprecated(since: '8.5', message: "use method SplObjectStorage::offsetUnset() instead")]
     public function detach(object $object): void {}
 
     /** @tentative-return-type */
+    #[\Deprecated(since: '8.5', message: "use method SplObjectStorage::offsetExists() instead")]
     public function contains(object $object): bool {}
 
     /** @tentative-return-type */

ext/spl/spl_observer_arginfo.h

@@ -19,15 +19,17 @@ var_dump(isset($s[$o2]));
 var_dump(empty($s[$o2]));
 $s[$o2] = null;
 var_dump($s[$o2] ?? new stdClass());
-echo "check isset/empty/contains for null. offsetExists returns true as long as the entry is there.\n";
+echo "check isset/empty/contains/offsetExists for null. offsetExists returns true as long as the entry is there.\n";
 var_dump(isset($s[$o2]));
 var_dump(empty($s[$o2]));
 var_dump($s->contains($o2));
-echo "check isset/empty/contains for false.\n";
+var_dump($s->offsetExists($o2));
+echo "check isset/empty/contains/offsetExists for false.\n";
 $s[$o2] = false;
 var_dump(isset($s[$o2]));
 var_dump(empty($s[$o2]));
 var_dump($s->contains($o2));
+var_dump($s->offsetExists($o2));
 try {
     $s['invalid'] = 123;
 } catch (Error $e) {
@@ -56,18 +58,24 @@ bool(false)
 bool(true)
 object(stdClass)#4 (0) {
 }
-check isset/empty/contains for null. offsetExists returns true as long as the entry is there.
+check isset/empty/contains/offsetExists for null. offsetExists returns true as long as the entry is there.
 bool(true)
 bool(true)
+
+Deprecated: Method SplObjectStorage::contains() is deprecated since 8.5, use method SplObjectStorage::offsetExists() instead in %s on line %d
+bool(true)
 bool(true)
-check isset/empty/contains for false.
+check isset/empty/contains/offsetExists for false.
 bool(true)
 bool(true)
+
+Deprecated: Method SplObjectStorage::contains() is deprecated since 8.5, use method SplObjectStorage::offsetExists() instead in %s on line %d
+bool(true)
 bool(true)
 TypeError: SplObjectStorage::offsetSet(): Argument #1 ($object) must be of type object, string given
 TypeError: SplObjectStorage::offsetExists(): Argument #1 ($object) must be of type object, string given
 
-Notice: Indirect modification of overloaded element of SplObjectStorage has no effect in %s on line 38
+Notice: Indirect modification of overloaded element of SplObjectStorage has no effect in %s on line %d
 object(SplObjectStorage)#1 (1) {
   ["storage":"SplObjectStorage":private]=>
   array(2) {

ext/spl/tests/SplObjectStorage/SplObjectStorage_coalesce.phpt

@@ -10,16 +10,16 @@ $b = (object) 'b';
 $c = (object) 'c';
 
 $foo = new SplObjectStorage;
-$foo->attach($a);
-$foo->attach($b);
+$foo->offsetSet($a);
+$foo->offsetSet($b);
 
 $bar = new SplObjectStorage;
-$bar->attach($b);
-$bar->attach($c);
+$bar->offsetSet($b);
+$bar->offsetSet($c);
 
 $foo->removeAllExcept($bar);
-var_dump($foo->contains($a));
-var_dump($foo->contains($b));
+var_dump($foo->offsetExists($a));
+var_dump($foo->offsetExists($b));
 
 ?>
 --EXPECT--

ext/spl/tests/SplObjectStorage/SplObjectStorage_removeAllExcept_basic.phpt

@@ -64,8 +64,8 @@ var_dump($storage->current());
 
 echo "--- With holes cases ---\n";
 
-$storage->detach($b);
-$storage->detach($d);
+$storage->offsetUnset($b);
+$storage->offsetUnset($d);
 
 foreach (range(0, 2) as $index) {
     $storage->seek($index);

ext/spl/tests/SplObjectStorage_seek.phpt …ObjectStorage/SplObjectStorage_seek.phptext/spl/tests/SplObjectStorage_seek.phpt renamed to ext/spl/tests/SplObjectStorage/SplObjectStorage_seek.phpt ext/spl/tests/SplObjectStorage_seek.phpt renamed to ext/spl/tests/SplObjectStorage/SplObjectStorage_seek.phpt

@@ -7,8 +7,8 @@ $o2 = new stdClass;
 
 $s = new SplObjectStorage();
 
-$s->attach($o1, array('prev' => 2, 'next' => $o2));
-$s->attach($o2, array('prev' => $o1));
+$s->offsetSet($o1, array('prev' => 2, 'next' => $o2));
+$s->offsetSet($o2, array('prev' => $o1));
 
 $ss = serialize($s);
 unset($s,$o1,$o2);

ext/spl/tests/SplObjectStorage/bug49263.phpt

@@ -13,8 +13,8 @@ function LimitedScope()
     $myB = new SplObjectStorage();
     $myC = new myClass();
     $myC->member = $myA; // myC has a reference to myA
-    $myB->Attach($myC);  // myB attaches myC
-    $myA->member = $myB; // myA has myB, comleting the cycle
+    $myB->offsetSet($myC);  // myB attaches myC
+    $myA->member = $myB; // myA has myB, completing the cycle
 }
 LimitedScope();
 var_dump(gc_collect_cycles());

ext/spl/tests/SplObjectStorage/bug53071.phpt

@@ -11,7 +11,7 @@ class MyObjectStorage extends SplObjectStorage {
 class TestObject {}
 
 $list = new MyObjectStorage();
-$list->attach(new TestObject());
+$list->offsetSet(new TestObject());
 
 foreach($list as $x) var_dump($list->offsetExists($x));