SplObjectStorage::detach
(PHP 5 >= 5.1.0, PHP 7)
SplObjectStorage::detach — Удаляет объект object из контейнера
Описание
public void SplObjectStorage::detach
( object
$object
)Удаляет объект object из контейнера.
Возвращаемые значения
Эта функция не возвращает значения после выполнения.
Примеры
Пример #1 Пример использования SplObjectStorage::detach()
<?php
$o = new StdClass;
$s = new SplObjectStorage();
$s->attach($o);
var_dump(count($s));
$s->detach($o);
var_dump(count($s));
?>
Результатом выполнения данного примера будет что-то подобное:
int(1) int(0)
Смотрите также
- SplObjectStorage::attach() - Добавляет объект в контейнер
- SplObjectStorage::removeAll() - Удаляет из текущего контейнера объекты, которые есть в другом контейнере
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Другие базовые расширения
- Стандартная библиотека PHP (SPL)
- Структуры данных
- Функция SplObjectStorage::addAll() - Добавляет все объекты из другого контейнера
- Функция SplObjectStorage::attach() - Добавляет объект в контейнер
- Функция SplObjectStorage::contains() - Проверяет, содержит ли контейнер заданный объект
- Функция SplObjectStorage::count() - Возвращает количество объектов в контейнере
- Функция SplObjectStorage::current() - Возвращает текущий объект
- Функция SplObjectStorage::detach() - Удаляет объект object из контейнера
- Функция SplObjectStorage::getHash() - Вычисляет уникальный идентификатор для объектов контейнера
- Функция SplObjectStorage::getInfo() - Возвращает данные ассоциированные с текущим объектом
- Функция SplObjectStorage::key() - Возвращает индекс текущего положения итератора
- Функция SplObjectStorage::next() - Переход к следующему объекту
- Функция SplObjectStorage::offsetExists() - Проверяет, существует ли объект в контейнере
- Функция SplObjectStorage::offsetGet() - Возвращает данные ассоциированные с объектом object
- Функция SplObjectStorage::offsetSet() - Ассоциирует данные с объектом в контейнере
- Функция SplObjectStorage::offsetUnset() - Удаляет объект из контейнера
- Функция SplObjectStorage::removeAll() - Удаляет из текущего контейнера объекты, которые есть в другом контейнере
- Функция SplObjectStorage::removeAllExcept() - Удаляет из текущего контейнера все объекты, которых нет в другом контейнере
- Функция SplObjectStorage::rewind() - Переводит итератор на первый элемент контейнера
- Функция SplObjectStorage::serialize() - Сериализует контейнер
- Функция SplObjectStorage::setInfo() - Ассоциирует данные с текущим объектом контейнера
- Функция SplObjectStorage::unserialize() - Восстанавливает сериализованый контейнер из строки
- Функция SplObjectStorage::valid() - Определяет, допустимо ли текущее значение итератора
Коментарии
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.
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
No complaints from SplObjectStorage if you try to detach an object that isn't in the collection; it's a no-op.
<?php
$o = new StdClass;
$t = new StdClass;
$s = new SplObjectStorage();
$s->attach($o);
var_dump(count($s));
$s->detach($t); // Didn't attach this one.
var_dump(count($s));
?>
There was problematic case when detaching object inside loop, because SplObjectStorage need to call next() before detach()
Example using foreach :
<?php
/**
* spl object storage bugs when looping
* @see https://bugs.php.net/bug.php?id=65629
*/
$firstStorage = new SplObjectStorage();
$secondStorage = new SplObjectStorage();
// temporary storage
$temporaryStorage = new SplObjectStorage();
// range 0 - 9
$range = range(0, 9);
foreach ($range as $id) {
$object = new stdClass();
$object->id = $id;
$firstStorage->attach($object);
$secondStorage->attach($object);
}
// direct detach inside loop
foreach ($firstStorage as $storage) {
// on common array it will detach all even in loop
// but object storage still remain 1 object
if ($storage->id < 5) {
$firstStorage->detach($storage);
}
}
// collect storage into temporary splObjectStorage
foreach ($secondStorage as $storage) {
// collect into temporary storage
if ($storage->id < 5) {
$temporaryStorage->attach($storage);
}
}
// removeAll by temporary Storage
$secondStorage->removeAll($temporaryStorage);
var_dump(count($firstStorage)); // int(6)
var_dump(count($secondStorage)); // int(5)
?>
Example using while :
<?php
$firstStorage = new SplObjectStorage();
$secondStorage = new SplObjectStorage();
// temporary storage
$temporaryStorage = new SplObjectStorage();
// range 0 - 9
$range = range(0, 9);
foreach ($range as $id) {
$object = new stdClass();
$object->id = $id;
$firstStorage->attach($object);
$secondStorage->attach($object);
}
$firstStorage->rewind();
while ($firstStorage->valid() && ($current = $firstStorage->current())) {
if ($current->id < 5) {
$firstStorage->detach($current);
}
// don't call next after detach
$firstStorage->next();
}
$secondStorage->rewind();
while ($secondStorage->valid() && ($current = $secondStorage->current())) {
// call next behavior before detach
$secondStorage->next();
if ($current->id < 5) {
$secondStorage->detach($current);
}
}
var_dump(count($firstStorage)); // int(6)
var_dump(count($secondStorage)); // int(5)
?>