Hướng dẫn php array iterator

Iterator

Iterator về bản chất là một interface chuẩn được xây dựng sẵn trong PHP để bạn giễ dàng thao tác với các bộ giá trị. Cấu trúc của interface iterator trong PHP mặc định khai báo một số phương thức như sau:

Show
interface Iterator{
  function rewind();
  function current();
  function key();
  function next();
  function valid();
}

Vậy nên lớp nào sử dụng interface interator đều phải định nghĩa các phương thức trên. Chúng ta sẽ cùng xem xét một ví dụ về việc sử dụng interator để duyệt mảng trả về từ CSDL.

class QueryInterator implements Iterator{
    private $result;
    private $connection;
    private $key=0;
    private $valid;
    private $data;
   
    function __construct($host, $user, $password, $dbname){
        $this->connection = mysql_connect($host,$user, $password);
        mysql_selectdb($dbname,$this->connection);
    }
   
    public function exceute($query){
        $this->result = mysql_query($query,$this->connection);
        if(mysql_num_rows($this->result) > 0){
            $this->next();
        }
    }
   
    public function current(){
        return $this->data;
    }
    public function rewind(){}
    public function key(){
        return $this->key;
    }
   
    public function next(){
        if($this->data = mysql_fetch_assoc($this->result)){
            $this->valid = true;
            $this->key +=1;
        }else{
            $this->valid = false;
        }
    }
   
    public function valid(){
        return $this->valid;
    }
}
$q = new QueryInterator("localhost","root","","test");
$q->exceute("SELECT name FROM ex1");
echo '<pre>';
while($q->valid()){
    print_r($q->current());
    $q->next();
}
echo '</pre>';

ArrayIterator

ArrayIterator về bản chất nó là đối tượng được xây dựng sẵn trong thư viện PHP chuẩn và lớp này sử dụng iterface iterator.

Trong bài viết trước có đề cập đến ArrayObject cũng là đối tượng được xây dựng sẵn trong thư viện PHP chuẩn và nó có phương thức __construct() như sau:

__construct ($array, $flags=0, $iterator_class="ArrayIterator")

Chúng ta thấy đối số thứ 3 mặc định đã được khởi tạo là "ArrayIterator" để đối tượng dạng mảng có thể sử dụng đối tượng ArrayIterator thông qua phương thức getIterator().
ArrayItertor định nghĩa cho chúng ta bộ phương thức theo đúng interface iterator để thao tác với mảng. Bạn có thể xem ví dụ ở bài trước về ArrayObject với phương thức getIterator().

Tham khảo "object-oriented programming with PHP5 _ Hasin Hayder".

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

iterator_to_arrayCopy the iterator into an array

Description

iterator_to_array(Traversable $iterator, bool $preserve_keys = true): array

Parameters

iterator

The iterator being copied.

preserve_keys

Whether to use the iterator element keys as index.

If a key is an array or object, a warning will be generated. null keys will be converted to an empty string, float keys will be truncated to their int counterpart, resource keys will generate a warning and be converted to their resource ID, and bool keys will be converted to integers.

Note:

If this parameter is not set or set to true, duplicate keys will be overwritten. The last value with a given key will be in the returned array. Set this parameter to false to get all the values in any case.

Return Values

An array containing the elements of the iterator.

Examples

Example #1 iterator_to_array() example

<?php
$iterator 
= new ArrayIterator(array('recipe'=>'pancakes''egg''milk''flour'));
var_dump(iterator_to_array($iteratortrue));
var_dump(iterator_to_array($iteratorfalse));
?>

The above example will output:

array(4) {
  ["recipe"]=>
  string(8) "pancakes"
  [0]=>
  string(3) "egg"
  [1]=>
  string(4) "milk"
  [2]=>
  string(5) "flour"
}
array(4) {
  [0]=>
  string(8) "pancakes"
  [1]=>
  string(3) "egg"
  [2]=>
  string(4) "milk"
  [3]=>
  string(5) "flour"
}

jerome at yazo dot net

13 years ago

Using the boolean param :

<?php

$first

= new ArrayIterator( array('k1' => 'a' , 'k2' => 'b''k3' => 'c''k4' => 'd') );
$second = new ArrayIterator( array( 'k1' => 'X', 'k2' => 'Y', 'Z' ) ); $combinedIterator= new AppendIterator();
$combinedIterator->append( $first );
$combinedIterator->append( $second ); var_dump( iterator_to_array($combinedIterator, false) ); ?>

will output :

array(7) (
  [0]=>
  string(1) "a"
  [1]=>
  string(1) "b"
  [2]=>
  string(1) "c"
  [3]=>
  string(1) "d"
  [4]=>
  string(1) "X"
  [5]=>
  string(1) "Y"
  [6]=>
  string(1) "Z"
)

<?php

var_dump

( iterator_to_array($combinedIterator, true) ); ?>

will output (since keys would merge) :

array(5) (
  ["k1"]=>
  string(1) "X"
  ["k2"]=>
  string(1) "Y"
  ["k3"]=>
  string(1) "c"
  ["k4"]=>
  string(1) "d"
  [0]=>
  string(1) "Z"
)

joksnet at gmail dot com

7 years ago

To generate an deep array from nested iterators:

<?php
function iterator_to_array_deep(\Traversable $iterator, $use_keys = true) {
   
$array = array();
    foreach (
$iterator as $key => $value) {
        if (
$value instanceof \Iterator) {
           
$value = iterator_to_array_deep($value, $use_keys);
        }
        if (
$use_keys) {
           
$array[$key] = $value;
        } else {
           
$array[] = $value;
        }
    }
    return
$array;
}
?>

I use it to test an iterator: https://gist.github.com/jm42/cb328106f393eeb28751

Harry Willis

7 years ago

When using iterator_to_array() on an SplObjectStorage object, it's advisable to set $use_keys to false.

The resulting array is identical, since the iterator keys produced by SplObjectStorage::key() are always integers from 0 to (COUNT-1). Passing $use_keys=false cuts out the unnecessary calls to SplObjectStorage::key(), giving a slight performance advantage.

wizzard351 at yahoo dot com

5 months ago

One important thing to remember is that in iterator can be infinite. Not all iterators necessarily end. If iterator_to_array is used on such an iterator, it will exhaust the available memory, and throw a fatal error.

For example, consider the following code:

<?phpfunction fibonacci(): Generator
{
    yield
$a = 1;
    yield
$b = 2;start:
    yield
$c = $a + $b;
   
$a = $b;
   
$b = $c;
    goto
start;
}
$fibonacciSequence = fibonacci();
iterator_to_array($fibonacciSequence);?>

Since <?php fibonacci(); ?> generates an infinite fibonacci sequence, which is valid, since it is actually an infinite sequence, then attempting to convert it to an array will fail.

chad 0x40 herballure 0x2e com

14 years ago

The use_keys parameter was added in one of the 5.2.x releases; it defaults to TRUE. This matches the behavior in PHP 5.1.6, which lacks this parameter.

enelar at develop-project dot ru

5 years ago

Generator approach

function scandir_deep($dir)
{
  foreach (scandir($dir) as $key => $value)
    if (in_array($value, [".",".."]))
      continue;
    else if (is_dir($dir . DIRECTORY_SEPARATOR . $value))
      yield $value => scandir_deep($dir . DIRECTORY_SEPARATOR . $value);
    else
      yield $value;
}

Tải thêm tài liệu liên quan đến bài viết Hướng dẫn php array iterator