PHP 7.0.6 Released

    SplObjectStorage::detach

    (PHP 5 >= 5.1.0, PHP 7)

    SplObjectStorage::detach — Removes an object from the storage

    Description

    public void SplObjectStorage::detach ( object $object )

    Removes the object from the storage.

    Parameters

    object

    The object to remove.

    Return Values

    No value is returned.

    Examples

    Example #1 SplObjectStorage::detach() example

    <?php
    $o     = new StdClass;
    $s = new SplObjectStorage();
    $s->attach($o);
    var_dump(count($s));
    $s->detach($o);
    var_dump(count($s));
    ?>

    The above example will output something similar to:

    int(1)
int(0)

    See Also

    User Contributed Notes

    r dot wilczek at web-appz dot de
    6 years ago
    Detaching the current entry from the storage prevents SplObjectStorage::next() to operate.

    Example as a PHPUnit-test:

    <?php
    public function testDetachingCurrentPreventsNext()
    {
            $storage = new SplObjectStorage;
            $storage->attach(new stdClass);
            $storage->attach(new stdClass);
            $storage->rewind();
            $iterated = 0;
            $expected = $storage->count();
        while (    $storage->valid()) {
                $iterated++;
                $storage->detach($storage->current());
                $storage->next();
        }
            $this->assertEquals($expected, $iterated);
    }
    ?>

    This test will fail, for the iteration will never reach the second stdClass.
    SplObjectStorage::next() obviously relies on the current element to be valid.

    If you want to detach objects during iterations, you should dereference objects, before you call next() and detach the reference after next():

    <?php
    public function testDetachingReferenceAfterNext()
    {
            $storage = new SplObjectStorage;
            $storage->attach(new stdClass);
            $storage->attach(new stdClass);
            $storage->rewind();
            $iterated = 0;
            $expected = $storage->count();
        while (    $storage->valid()) {
                $iterated++;
                $object = $storage->current();
                $storage->next();
                $storage->detach($object);
        }
            $this->assertEquals($expected, $iterated);
    }
    ?>

    This test will pass.
    alan dot bem at gmail dot com
    2 years ago
    SplObjectSotage::detach() has a bug - it rewinds internal array pointer.
    Remember that - when looping over the storage - as it has no workaround.

    https://bugs.php.net/bug.php?id=65629&edit=2
    To Top