The EmptyIterator class

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

Introduction

The EmptyIterator class for an empty iterator.

Class synopsis

class EmptyIterator implements Iterator {

/* Methods */

public current (): never

public key (): never

public next (): void

public rewind (): void

public valid (): false

}

EmptyIterator::current — The current() method
EmptyIterator::key — The key() method
EmptyIterator::next — The next() method
EmptyIterator::rewind — The rewind() method
EmptyIterator::valid — Checks whether the current element is valid

Found A Problem?

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

+add a note

User Contributed Notes 1 note

down

Ben ¶

8 years ago

Example use case:
<?php
class MyIterator implements IteratorAggregate
{
 /**
 * @var string
 */
 private $url;
 /**
 * MyIterator constructor.
 * @param $url
 */
 public function __construct($url)
 {
 $this->url = $url;
 }
 /**
 * @inheritDoc
 */
 public function getIterator()
 {
 $content = file_get_contents($this->url);
 try {
 return @new SimpleXMLIterator($content);
 } catch (Exception $e) { // Case $content is not valid XML, but you don't care
 return new EmptyIterator();
 }
 }
}
?>