add iterator pattern example

Author: basherr

app/Controller/BehavioralController.php

@@ -24,6 +24,7 @@ public function command()
 
   public function iterator()
   {
-    (new \App\Factory\Behavioral\Iterator\UserRoles\Application)->run();
+    // (new \App\Factory\Behavioral\Iterator\UserRoles\Application)->run();
+    (new \App\Factory\Behavioral\Iterator\HotelSuppliers\Application)->run();
   }
 }

app/Factory/Behavioral/Iterator/HotelSuppliers/Application.php

@@ -0,0 +1,15 @@
+<?php namespace App\Factory\Behavioral\Iterator\HotelSuppliers;
+
+class Application
+{
+  public function run()
+  {
+    $iterator = new \AppendIterator;
+    $iterator->append(new DTWSupplierIterator(new DTWSupplier));
+    $iterator->append(new HTOSupplierIterator(new HTOSupplier));
+
+    foreach ($iterator as $value) {
+      echo '<pre>value: '.  $value;
+    }
+  }
+}

app/Factory/Behavioral/Iterator/HotelSuppliers/DTWSupplier.php

@@ -0,0 +1,15 @@
+<?php namespace App\Factory\Behavioral\Iterator\HotelSuppliers;
+
+class DTWSupplier
+{
+  private $_hotels = [
+    ['id' => 1, 'name' => 'Sri Sutra Hotel Kuala Lumpur'],
+    ['id' => 2, 'name' => 'Hotel Inn Kuala Lumpur'],
+    ['id' => 3, 'name' => 'Moven Pick Hotel Kuala Lumpur']
+  ];
+
+  public function getHotels()
+  {
+    return $this->_hotels;
+  }
+}

app/Factory/Behavioral/Iterator/HotelSuppliers/DTWSupplierIterator.php

@@ -0,0 +1,65 @@
+<?php namespace App\Factory\Behavioral\Iterator\HotelSuppliers;
+
+class DTWSupplierIterator implements \Iterator
+{
+  private $_hotels;
+  /**
+  * counter for supplier items
+  */
+  private $_counter = 0;
+
+  public function __construct(DTWSupplier $supplier)
+  {
+    $this->_hotels = $supplier->getHotels();
+  }
+  /**
+  * current element
+  *
+  * @param null
+  * @return string
+  */
+  public function current(): string
+  {
+    return $this->_hotels[$this->_counter]['name'];
+  }
+  /**
+  * get the current index
+  *
+  * @param null
+  * @return int
+  */
+  public function key(): int
+  {
+    return $this->_counter;
+  }
+  /**
+  * get the next element in the array
+  *
+  * @param null
+  * @return void
+  */
+  public function next(): void
+  {
+    $this->_counter++;
+  }
+  /**
+  * check weather we have next element in the array
+  *
+  * @param null
+  * @return bool
+  */
+  public function valid(): bool
+  {
+    return (count($this->_hotels) - 1) > $this->_counter;
+  }
+  /**
+  * rewind from the start
+  *
+  * @param null
+  * @return void
+  */
+  public function rewind(): void
+  {
+    $this->_counter = 0;
+  }
+}

app/Factory/Behavioral/Iterator/HotelSuppliers/HTOSupplier.php

@@ -0,0 +1,15 @@
+<?php namespace App\Factory\Behavioral\Iterator\HotelSuppliers;
+
+class HTOSupplier
+{
+  private $_hotels = [
+    ['id' => 1, 'title' => 'Avari tower hotel Kuala Lumpur'],
+    ['id' => 2, 'title' => 'Mehran hotel Kuala Lumpur'],
+    ['id' => 3, 'title' => 'Foo Hotel Kuala Lumpur']
+  ];
+
+  public function getHotels()
+  {
+    return $this->_hotels;
+  }
+}

app/Factory/Behavioral/Iterator/HotelSuppliers/HTOSupplierIterator.php

@@ -0,0 +1,65 @@
+<?php namespace App\Factory\Behavioral\Iterator\HotelSuppliers;
+
+class HTOSupplierIterator implements \Iterator
+{
+  private $_hotels;
+  /**
+  * counter for supplier items
+  */
+  private $_counter = 0;
+
+  public function __construct(HTOSupplier $supplier)
+  {
+    $this->_hotels = $supplier->getHotels();
+  }
+  /**
+  * current element
+  *
+  * @param null
+  * @return string
+  */
+  public function current(): string
+  {
+    return $this->_hotels[$this->_counter]['title'];
+  }
+  /**
+  * get the current index
+  *
+  * @param null
+  * @return int
+  */
+  public function key(): int
+  {
+    return $this->_counter;
+  }
+  /**
+  * get the next element in the array
+  *
+  * @param null
+  * @return void
+  */
+  public function next(): void
+  {
+    $this->_counter++;
+  }
+  /**
+  * check weather we have next element in the array
+  *
+  * @param null
+  * @return bool
+  */
+  public function valid(): bool
+  {
+    return (count($this->_hotels) - 1) > $this->_counter;
+  }
+  /**
+  * rewind from the start
+  *
+  * @param null
+  * @return void
+  */
+  public function rewind(): void
+  {
+    $this->_counter = 0;
+  }
+}

app/Factory/Behavioral/Iterator/UserRoles/Application.php

@@ -0,0 +1,29 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+use App\Factory\Behavioral\Iterator\HotelSuppliers\{
+  HTOSupplierIterator,
+  HTOSupplier,
+  DTWSupplierIterator,
+  DTWSupplier
+};
+
+class IteratorPatternTest extends TestCase {
+  public function testCanIteratorThroughHTOSupplierIterator()
+  {
+    $supplier = new HTOSupplier;
+    $iterator = new HTOSupplierIterator($supplier);
+    
+    $hotelName = $iterator->current();
+    $this->assertSame($supplier->getHotels()[0]['title'], $hotelName);
+  }
+  
+  public function testCanIteratorThroughDTWSupplierIterator()
+  {
+    $supplier = new DTWSupplier;
+    $iterator = new DTWSupplierIterator($supplier);
+    
+    $hotelName = $iterator->current();
+    $this->assertSame($supplier->getHotels()[0]['name'], $hotelName);
+  }
+}