traversable(3) [php man page]

TRAVERSABLE(3)								 1							    TRAVERSABLE(3)

The Traversable interface

INTRODUCTION

	Interface to detect if a class is traversable using foreach.

	Abstract base interface that cannot be implemented alone. Instead it must be implemented by either IteratorAggregate or Iterator.

       Note

	       Internal (built-in) classes that implement this interface can be used in a foreach construct and do not need to implement Iterator-
	      Aggregate or Iterator.

       Note

	       This is an internal engine interface which cannot be implemented in PHP scripts. Either IteratorAggregate or Iterator must be  used
	      instead.	When  implementing an interface which extends Traversable, make sure to list IteratorAggregate or Iterator before its name
	      in the implements clause.

INTERFACE SYNOPSIS

       Traversable

       Traversable

	This interface has no methods, its only purpose is to be the base interface for all traversable classes.

PHP Documentation Group 													    TRAVERSABLE(3)

ITERATORAGGREGATE(3)							 1						      ITERATORAGGREGATE(3)

The IteratorAggregate interface

INTRODUCTION

	Interface to create an external Iterator.

INTERFACE SYNOPSIS

       IteratorAggregate

       IteratorAggregateextends
       Traversable

       Methods

       o abstractpublic Traversable IteratorAggregate::getIterator (void  )

       Example #1

	      Basic usage

	      <?php
	      class myData implements IteratorAggregate {
		  public $property1 = "Public property one";
		  public $property2 = "Public property two";
		  public $property3 = "Public property three";

		  public function __construct() {
		      $this->property4 = "last property";
		  }

		  public function getIterator() {
		      return new ArrayIterator($this);
		  }
	      }

	      $obj = new myData;

	      foreach($obj as $key => $value) {
		  var_dump($key, $value);
		  echo "
";
	      }
	      ?>

	      The above example will output something similar to:

	      string(9) "property1"
	      string(19) "Public property one"

	      string(9) "property2"
	      string(19) "Public property two"

	      string(9) "property3"
	      string(21) "Public property three"

	      string(9) "property4"
	      string(13) "last property"

PHP Documentation Group 												      ITERATORAGGREGATE(3)