ArrayIterator::getArrayCopy

    (PHP 5, PHP 7, PHP 8)

    ArrayIterator::getArrayCopy — Get array copy

    Description

    public ArrayIterator::getArrayCopy(): array

    Get a copy of an array.

    Warning

    This function is currently not documented; only its argument list is available.

    Parameters

    This function has no parameters.

    Return Values

    A copy of the array, or array of public properties if ArrayIterator refers to an object.

    See Also

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    3
    irvine L
    6 years ago
    Just in case some of you out there do NOT know this:

    (a). 'getArrayCopy()', returns a copy of the ORIGINAL array - iterator object. Therefore, using (for example) 'LimitIterator' on an array-object, and then calling 'getArrayCopy' afterwards, might not return the current (adjusted) object.

    (b). Instead, use the 'iterator_to_array' function, in order to access, or return, the current state of the array-object-iterator (whatever). Using the example above (in '(a)'); passing the 'LimitIterator' object into 'iterator_to_array', should return the CURRENT, and NOT ORIGINAL state of your array (iterator object).
    up
    2
    lenye01 at gmail dot com
    13 years ago
    the difference of this method and the direct assign the object to a value is as follows:

    <?php
    $b     = array('name'=>'mengzhi','age'=>'12','city'=>'shanghai');
    $a = new ArrayIterator($b);
    $a->append(array('home'=>'china','work'=>'developer'));
    $c = $a->getArrayCopy();
    var_dump($a);
    var_dump($c);
    ?>
    result:
    object(ArrayIterator)#1 (1) { ["storage":"ArrayIterator":private]=> array(4) { ["name"]=> string(7) "mengzhi" ["age"]=> string(2) "12" ["city"]=> string(8) "shanghai" [0]=> array(2) { ["home"]=> string(5) "china" ["work"]=> string(9) "developer" } } }

    array(4) { ["name"]=> string(7) "mengzhi" ["age"]=> string(2) "12" ["city"]=> string(8) "shanghai" [0]=> array(2) { ["home"]=> string(5) "china" ["work"]=> string(9) "developer" } }
    ＋add a note
    To Top