IteratorAggregate interface in PHP - Mini Project: Build & Apply

Using the IteratorAggregate Interface in PHP

📖 Scenario: You are creating a simple collection class in PHP that holds a list of book titles. You want to make this collection easy to loop over using a foreach loop.

🎯 Goal: Build a PHP class called BookCollection that implements the IteratorAggregate interface to allow looping over the books.

📋 What You'll Learn

Create a class named BookCollection with a private array property called books.

Add a constructor to BookCollection that accepts an array of book titles and assigns it to books.

Implement the getIterator() method from the IteratorAggregate interface to return an ArrayIterator of the books array.

Create an instance of BookCollection with exactly these books: '1984', 'Brave New World', 'Fahrenheit 451'.

Use a foreach loop to print each book title on its own line.

💡 Why This Matters

🌍 Real World

Custom collection classes are common in PHP applications to group related data and make it easy to loop over them.

💼 Career

Understanding IteratorAggregate helps you write clean, reusable code and work with PHP libraries that expect iterable objects.

1

Create the BookCollection class with books property

Create a PHP class called BookCollection with a private property books initialized as an empty array.

PHP

<?php

// Create class BookCollection with private array property books

Hint

Use private array $books = []; inside the class.

2

Add constructor to accept books array

Add a constructor method __construct to BookCollection that takes an array parameter $books and assigns it to the private property $books.

PHP

<?php

class BookCollection {
    private array $books = [];

    // Add constructor to accept array $books

}

Hint

Constructor should accept array $books and assign it to $this->books.

3

Implement IteratorAggregate interface and getIterator method

Make BookCollection implement the IteratorAggregate interface. Add the method getIterator() that returns a new ArrayIterator of the $books property.

PHP

books = $books;
    }

    // Add getIterator() method returning ArrayIterator of $books

}

Hint

Remember to add implements IteratorAggregate after the class name.

4

Create instance and loop to print books

Create a BookCollection instance named $collection with the books '1984', 'Brave New World', and 'Fahrenheit 451'. Use a foreach loop to print each book title on its own line.

PHP

books = $books;
    }

    public function getIterator(): Traversable {
        return new ArrayIterator($this->books);
    }
}

// Create instance and print each book title

Hint

Use foreach ($collection as $book) and echo $book . "\n"; inside the loop.

Practice

1.

What is the main purpose of the IteratorAggregate interface in PHP?

easy

A. To allow an object to be iterated with foreach by providing an external iterator.

B. To automatically sort arrays inside an object.

C. To enforce type checking on array elements.

D. To convert an object into a string representation.

Solution

1. Step 1: Understand the role of IteratorAggregate

   The interface requires implementing getIterator() which returns an iterator object.

2. Step 2: Connect to foreach usage

   This allows the object to be used in foreach loops by providing the iterator externally.

3. Final Answer:

   To allow an object to be iterated with foreach by providing an external iterator. -> Option A

4. Quick Check:

   IteratorAggregate enables foreach iteration [OK]

Hint: Remember: IteratorAggregate provides an iterator for foreach [OK]

Common Mistakes:

• Thinking it sorts data automatically
• Confusing it with string conversion
• Assuming it enforces type checks

2.

Which method must a class implement when it uses the IteratorAggregate interface?

easy

A. getItems()

B. iterate()

C. getIterator()

D. toArray()

Solution

1. Step 1: Recall interface requirements

   The IteratorAggregate interface requires the getIterator() method.

2. Step 2: Confirm method name

   This method must return an iterator object to enable iteration.

3. Final Answer:

   getIterator() -> Option C

4. Quick Check:

   IteratorAggregate requires getIterator() [OK]

Hint: Interface method is always getIterator() [OK]

Common Mistakes:

• Using iterate() instead of getIterator()
• Confusing with toArray() method
• Assuming getItems() is required

3.

What will be the output of this PHP code?

<?php
class MyCollection implements IteratorAggregate {
    private array $items = [1, 2, 3];
    public function getIterator(): Traversable {
        return new ArrayIterator($this->items);
    }
}

$collection = new MyCollection();
foreach ($collection as $item) {
    echo $item . ' ';
}

medium

A. ArrayIterator Object

B. 1 2 3

C. Error: getIterator must return array

D. No output

Solution

1. Step 1: Understand getIterator() return

   The method returns an ArrayIterator over the array [1, 2, 3].

2. Step 2: foreach loops over iterator

   The foreach loop iterates over the items 1, 2, and 3, echoing each with a space.

3. Final Answer:

   1 2 3 -> Option B

4. Quick Check:

   foreach prints each item from ArrayIterator [OK]

Hint: getIterator returns ArrayIterator to enable foreach [OK]

Common Mistakes:

• Expecting an error because getIterator returns ArrayIterator
• Thinking it prints object instead of values
• Missing the space after each number

4.

Identify the error in this PHP class implementing IteratorAggregate:

<?php
class Numbers implements IteratorAggregate {
    private array $nums = [10, 20, 30];
    public function getIterator() {
        return $this->nums;
    }
}

medium

A. getIterator() must return an object implementing Traversable, not an array.

B. Property $nums should be public, not private.

C. Class must implement Iterator, not IteratorAggregate.

D. getIterator() method must be static.

Solution

1. Step 1: Check getIterator() return type

   It returns an array, but getIterator() must return an object implementing Traversable.

2. Step 2: Understand interface contract

   Returning an array causes a type error because arrays do not implement Traversable.

3. Final Answer:

   getIterator() must return an object implementing Traversable, not an array. -> Option A

4. Quick Check:

   getIterator() returns Traversable object [OK]

Hint: getIterator must return Traversable object, not array [OK]

Common Mistakes:

• Returning array directly from getIterator()
• Thinking private properties cause error here
• Assuming getIterator() must be static

5.

You want to create a class FilteredCollection that implements IteratorAggregate and only iterates over items greater than 5 from an internal array. Which implementation of getIterator() is correct?

<?php
class FilteredCollection implements IteratorAggregate {
    private array $items;
    public function __construct(array $items) {
        $this->items = $items;
    }
    public function getIterator(): Traversable {
        // Which code below is correct?
    }
}

hard

A. return new ArrayIterator($this->items);

B. return new ArrayIterator(array_map(fn($v) => $v > 5, $this->items));

C. return $this->items;

D. return new ArrayIterator(array_filter($this->items, fn($v) => $v > 5));

Solution

1. Step 1: Filter items greater than 5

   Use array_filter with a callback to keep only values > 5.

2. Step 2: Return an ArrayIterator over filtered items

   Wrap filtered array in ArrayIterator to satisfy Traversable return type.

3. Final Answer:

   return new ArrayIterator(array_filter($this->items, fn($v) => $v > 5)); -> Option D

4. Quick Check:

   Filter then wrap in ArrayIterator [OK]

Hint: Filter array first, then return ArrayIterator [OK]

Common Mistakes:

• Returning unfiltered array directly
• Using array_map instead of array_filter
• Not wrapping result in an iterator object