PHP 8.1.0 Released!

ArrayIterator::offsetUnset

(PHP 5, PHP 7, PHP 8)

ArrayIterator::offsetUnsetEfface la valeur d'une position

Description

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

Efface la valeur d'une position.

Si une itération est en cours, et que ArrayIterator::offsetUnset() est utilisé pour unset l'index actuel de l'itération, la position de l'itération sera avancé au prochain index. Comme la position de l'itération est aussi avancée à la fin de la déclaration de boucle foreach, l'utilisation de ArrayIterator::offsetUnset() à l'intérieur d'une boucle foreach peut résulter en des index qui seront omit.

Liste de paramètres

key

La position à effacer.

Valeurs de retour

Aucune valeur n'est retournée.

Voir aussi

add a note add a note

User Contributed Notes 3 notes

up
2
rkos...
7 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
2
olav at fwt dot no
10 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
0
Adil Baig @ AIdezigns
10 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.
To Top