Edit Report a Bug

    ArrayIterator::offsetUnset

    (PHP 5, PHP 7, PHP 8)

    ArrayIterator::offsetUnset — Сбрасывает значение по смещению

    Описание

    public ArrayIterator::offsetUnset(mixed $key): void

    Сбрасывает значение по смещению.

    Если итерация выполняется и ArrayIterator::offsetUnset() используется для сброса текущего индекса итерации, позиция итерации будет смещена к следующему индексу. Поскольку позиция итерации также смещается в конце foreach в теле цикла, использование ArrayIterator::offsetUnset() внутри цикла foreach может привести к пропуску индексов.

    Список параметров

    key

    Смещение для сброса.

    Возвращаемые значения

    Функция не возвращает значения после выполнения.

    Смотрите также

    add a note add a note

    User Contributed Notes 3 notes

    up
    3
    olav at fwt dot no
    13 years ago
    When unsetting elements as you go it will not remove the second index of the Array being worked on. Im not sure exactly why but there is some speculations that when calling unsetOffset(); it resets the pointer aswell.

    <?php

    $a     = new ArrayObject( range( 0,9 ) );
    $b = new ArrayIterator( $a );

    for (     $b->rewind(); $b->valid(); $b->next() )
    {
        echo     "#{$b->key()} - {$b->current()} - \r\n";
            $b->offsetUnset( $b->key() );
    }

    ?>

    To avoid this bug you can call offsetUnset in the for loop

    <?php
    /*** ... ***/
    for ( $b->rewind(); $b->valid(); $b->offsetUnset( $b->key() ) )
    {
    /*** ... ***/
    ?>

    Or unset it directly in the ArrayObject
    <?php
    /*** ... ***/
            $a->offsetUnset( $b->key() );
    /*** ... ***/
    ?>

    which will produce correct results
    up
    2
    rkos...
    10 years ago
    This is my solution for problem with offsetUnset
    <?php

    $a     = new ArrayObject( range( 0,9 ) );
    $b = new ArrayIterator( $a );

    for (     $b->rewind(); $b->valid();  )
    {
        echo     "#{$b->key()} - {$b->current()} - <br>\r\n";
        if(    $b->key()==0 || $b->key()==1){
                $b->offsetUnset( $b->key() );
        }else {
                $b->next();
        }
    }

    var_dump($b);
    ?>
    up
    0
    Adil Baig @ AIdezigns
    13 years ago
    Make sure you use this function to unset a value. You can't access this iterator's values as an array. Ex:

    <?php
    $iterator     = new \RecursiveIteratorIterator(new \RecursiveArrayIterator($arr));

    foreach(    $iterator as $key => $value)
    {
        unset(    $iterator[$key]);
    }
    ?>

    Will return :

    PHP Fatal error:  Cannot use object of type RecursiveIteratorIterator as array

    offsetUnset works properly even when removing items from nested arrays.
    add a note add a note
    To Top