Merge pull request #11 from festivalslab/add-venue-search-iterator

Add VenueSearchIterator

Author: craig410

.github/workflows/test.yaml

@@ -41,4 +41,4 @@ jobs:
           dependency-versions: ${{ matrix.dependency-versions }}
 
       - name: Run PHPUnit
-        run: vendor/bin/phpunit
+        run: vendor/bin/phpunit

CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Unreleased
 
+### v2.5.0 (2025-08-05)
+
+* Add VenueSearchIterator to make querying venues endpoint easier
+
 ### v2.4.0 (2025-05-27)
 
 * Support PHP 8.4

composer.json

@@ -28,6 +28,11 @@
       "FestivalsApi\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "test\\unit\\FestivalsApi\\": "test/unit"
+    }
+  },
   "config": {
     "preferred-install": "dist"
   }

src/AbstractSearchIterator.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace FestivalsApi;
+
+use GuzzleHttp\Exception\GuzzleException;
+use IteratorAggregate;
+use LogicException;
+use Traversable;
+use function get_class;
+use function is_array;
+
+abstract class AbstractSearchIterator implements IteratorAggregate
+{
+    protected int $last_result_count;
+
+    protected ?int $page_size = NULL;
+
+    protected ?array $query = NULL;
+
+    protected int $request_count = 0;
+
+    public function __construct(
+        protected FestivalsApiClient $client
+    ) {
+    }
+
+    /**
+     * @throws FestivalsApiClientException if API client encounters an error
+     * @throws GuzzleException if Guzzle encounters an error
+     * @throws LogicException if no query set
+     */
+    public function getIterator(): Traversable
+    {
+        $this->throwIfNoQuerySet();
+
+        $this->query['size'] = $this->page_size;
+        $this->query['from'] = 0;
+        do {
+            $results = $this->makeApiCall();
+            ++$this->request_count;
+
+            $this->last_result_count = count($results);
+
+            foreach ($results as $result) {
+                yield $result;
+            }
+            $this->query['from'] += $this->page_size;
+        } while ($this->last_result_count === $this->page_size);
+    }
+
+    /**
+     * Total number of calls to API made by this query.
+     */
+    public function getNoOfRequestsMadeByQuery(): int
+    {
+        return $this->request_count;
+    }
+
+    /**
+     * Sets the search query.
+     *
+     * @param array $query     the query parameters eg ['festival'=>'jazz', title='Blue']
+     * @param int   $page_size the number of events to return per request, defaults to API max limit
+     */
+    public function setQuery(array $query, int $page_size = 100): void
+    {
+        $this->query         = $query;
+        $this->page_size     = $page_size;
+        $this->request_count = 0;
+    }
+
+    /**
+     * Execute the query and return the events.
+     *
+     * @throws GuzzleException
+     * @throws FestivalsApiClientException
+     */
+    protected abstract function makeApiCall(): array;
+
+    /**
+     * @throws LogicException if no query set
+     */
+    protected function throwIfNoQuerySet(): void
+    {
+        if ( ! is_array($this->query)) {
+            throw new LogicException('You must call '.get_class($this).'::setQuery() before iterating result');
+        }
+    }
+}

src/EventSearchIterator.php

@@ -10,67 +10,17 @@
 
 use FestivalsApi\Result\EventSearchResult;
 use GuzzleHttp\Exception\GuzzleException;
-use IteratorAggregate;
-use LogicException;
-use Traversable;
-use function get_class;
-use function is_array;
 
-class EventSearchIterator implements IteratorAggregate
+/**
+ * @final since 2.5.0
+ */
+class EventSearchIterator extends AbstractSearchIterator
 {
 
-    protected EventSearchResult $last_result;
-
-    protected ?int $page_size = NULL;
-
-    protected ?array $query = NULL;
-
-    protected int $request_count = 0;
-
-    public function __construct(protected FestivalsApiClient $client)
-    {
-    }
-
-    /**
-     * @throws FestivalsApiClientException if API client encounters an error
-     * @throws GuzzleException if Guzzle encounters an error
-     * @throws LogicException if no query set
-     */
-    public function getIterator(): Traversable
-    {
-        $this->throwIfNoQuerySet();
-
-        $this->query['size'] = $this->page_size;
-        $this->query['from'] = 0;
-        do {
-            $events = $this->makeApiCall();
-            foreach ($events as $event) {
-                yield $event;
-            }
-            $this->query['from'] += $this->page_size;
-        } while (count($this->last_result->getEvents()) === $this->page_size);
-    }
-
-    /**
-     * Total number of calls to API made by this query
-     */
-    public function getNoOfRequestsMadeByQuery(): int
-    {
-        return $this->request_count;
-    }
-
     /**
-     * Sets the search query
-     *
-     * @param array $query     the query parameters eg ['festival'=>'jazz', title='Blue']
-     * @param int   $page_size the number of events to return per request, defaults to API max limit
+     * @deprecated
      */
-    public function setQuery(array $query, int $page_size = 100): void
-    {
-        $this->query         = $query;
-        $this->page_size     = $page_size;
-        $this->request_count = 0;
-    }
+    protected EventSearchResult $last_result;
 
     /**
      * Execute the query and return the events
@@ -80,20 +30,10 @@ public function setQuery(array $query, int $page_size = 100): void
      */
     protected function makeApiCall(): array
     {
-        $this->request_count++;
-        $this->last_result = $this->client->searchEvents($this->query);
-
-        return $this->last_result->getEvents();
-    }
+        $result = $this->client->searchEvents($this->query);
+        $this->last_result = $result;
 
-    /**
-     * @throws LogicException if no query set
-     */
-    protected function throwIfNoQuerySet(): void
-    {
-        if ( ! is_array($this->query)) {
-            throw new LogicException("You must call ".get_class($this)."::setQuery() before iterating result");
-        }
+        return $result->getEvents();
     }
 
 }

src/FestivalsApiClient.php

@@ -96,7 +96,7 @@ public function searchVenues(array $query): VenueSearchResult
         $response = $this->sendRequest($request);
 
         return new VenueSearchResult(
-            venues: $this->decodeJsonResponse($response),
+            results: $this->decodeJsonResponse($response),
             url: $request->getUri(),
             total_results: (int) $response->getHeaderLine('x-total-results') ?: 0
         );

src/MockFestivalsApiClient.php

@@ -9,6 +9,7 @@
 use Exception;
 use FestivalsApi\Result\EventSearchResult;
 use FestivalsApi\Result\SingleEventResult;
+use FestivalsApi\Result\VenueSearchResult;
 use PHPUnit\Framework\Assert;
 use function array_pop;
 use function array_reverse;
@@ -67,4 +68,12 @@ public function searchEvents(array $query): EventSearchResult
         return new EventSearchResult($response, 'WORK IT OUT YOURSELF', $this->total_results);
     }
 
+    public function searchVenues(array $query): VenueSearchResult
+    {
+        $this->called_with[] = $query;
+        $response            = array_pop($this->responses) ?: [];
+
+        return new VenueSearchResult($response, 'WORK IT OUT YOURSELF', $this->total_results);
+    }
+
 }

src/Result/AbstractSearchResult.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * @author    Festivals Edinburgh <support@api.edinburghfestivalcity.com>
+ * @licence   BSD-3-Clause
+ */
+
+
+namespace FestivalsApi\Result;
+
+
+abstract class AbstractSearchResult
+{
+    public function __construct(
+        protected array  $results,
+        protected string $url,
+        protected int    $total_results
+    ) {
+    }
+
+    public function getTotalResults(): int
+    {
+        return $this->total_results;
+    }
+
+    public function getUrl(): string
+    {
+        return $this->url;
+    }
+}

src/Result/EventSearchResult.php

@@ -8,56 +8,11 @@
 namespace FestivalsApi\Result;
 
 
-class EventSearchResult
+class EventSearchResult extends AbstractSearchResult
 {
-    /**
-     * @var array
-     */
-    protected $events;
-
-    /**
-     * @var int
-     */
-    protected $total_results;
-
-    /**
-     * @var string
-     */
-    protected $url;
-
-    /**
-     * @param array  $events
-     * @param string $url
-     * @param int    $total_results
-     */
-    public function __construct(array $events, $url, $total_results)
-    {
-        $this->events        = $events;
-        $this->url           = $url;
-        $this->total_results = $total_results;
-    }
-
-    /**
-     * @return array
-     */
     public function getEvents(): array
     {
-        return $this->events;
+        return $this->results;
     }
 
-    /**
-     * @return int
-     */
-    public function getTotalResults(): int
-    {
-        return $this->total_results;
-    }
-
-    /**
-     * @return string
-     */
-    public function getUrl(): string
-    {
-        return $this->url;
-    }
 }

src/Result/VenueSearchResult.php

@@ -8,27 +8,10 @@
 namespace FestivalsApi\Result;
 
 
-class VenueSearchResult
+class VenueSearchResult extends AbstractSearchResult
 {
-    public function __construct(
-        protected array  $venues,
-        protected string $url,
-        protected int    $total_results
-    ) {
-    }
-
     public function getVenues(): array
     {
-        return $this->venues;
-    }
-
-    public function getTotalResults(): int
-    {
-        return $this->total_results;
-    }
-
-    public function getUrl(): string
-    {
-        return $this->url;
+        return $this->results;
     }
 }