当前位置: 首页> 函数类别大全> iterator_apply

iterator_apply

为迭代器中每个元素调用一个用户自定义函数
名称:iterator_apply
分类:SPL
所属语言:php
一句话介绍:为迭代器中每个元素调用一个用户自定义函数

iterator_apply函数

适用PHP版本

PHP 5.0.0 及以上版本

函数说明

iterator_apply 函数用于应用一个回调函数到一个迭代器中的每一个元素。该函数会逐一迭代给定的迭代器,直到回调函数返回false为止,或者迭代器被完全遍历。

函数语法

  bool iterator_apply ( Traversable $iterator , callable $callback [, mixed $userdata = NULL ] )
  

参数

  • $iterator: 一个实现了 Traversable 接口的对象。常见的有 Iterator、IteratorAggregate 等类型。
  • $callback: 这是一个回调函数,该函数会被应用到迭代器中的每个元素。回调函数必须接受迭代器的当前元素作为参数,并返回布尔值。如果回调返回false,迭代会停止。
  • $userdata (可选): 如果需要,可以传递额外的数据作为回调函数的参数。

返回值

返回一个布尔值。成功时返回true,如果迭代器被完全遍历或者回调函数返回false,则返回false。

示例

  $array = new ArrayIterator([1, 2, 3, 4, 5]);
<p>$callback = function($item) {<br>
echo "Processing item: $item\n";<br>
if ($item == 3) {<br>
return false; // 停止迭代<br>
}<br>
return true;<br>
};</p>
<p>iterator_apply($array, $callback);<br>

示例代码的说明

在上述示例中,我们创建了一个包含整数的迭代器(ArrayIterator)。然后,我们定义了一个回调函数,该函数会打印当前项并判断是否要停止迭代。回调函数在遇到数字3时返回false,从而停止了迭代。

同类函数
热门文章