Consistent naming, better naming for StopLocationLookup

Author: Bertware

src/Trafiklab/Common/Model/Contract/PublicTransportApiWrapper.php

@@ -46,11 +46,11 @@ public function setRoutePlanningApiKey(string $apiKey): void;
     public function setTimeTablesApiKey(string $apiKey): void;
 
     /**
-     * Set the API key used for finding stop locations.
+     * Set the API key used for looking up stop locations.
      *
      * @param string $apiKey The API key to use.
      */
-    public function setFindStopLocationApiKey(string $apiKey): void;
+    public function setStopLocationLookupApiKey(string $apiKey): void;
 
     /**
      * Get a timetable for a certain stop.
@@ -86,11 +86,11 @@ public function getRoutePlanning(RoutePlanningRequest $routePlanningRequest): Ro
 
 
     /**
-     * Find a stop location based on (a part of) its name.
+     * Look up a stop location based on (a part of) its name.
      *
-     * @param FindStopLocationRequest $request The request object containing the query parameters.
+     * @param StopLocationLookupRequest $request The request object containing the query parameters.
      *
-     * @return FindStopLocationResponse The response from the API.
+     * @return StopLocationLookupResponse The response from the API.
      * @throws InvalidKeyException
      * @throws InvalidRequestException
      * @throws InvalidStopLocationException
@@ -99,5 +99,5 @@ public function getRoutePlanning(RoutePlanningRequest $routePlanningRequest): Ro
      * @throws RequestTimedOutException
      * @throws ServiceUnavailableException
      */
-    public function findStopLocation(FindStopLocationRequest $request): FindStopLocationResponse;
+    public function lookupStopLocation(StopLocationLookupRequest $request): StopLocationLookupResponse;
 }

…Model/Contract/FindStopLocationEntry.php …del/Contract/StopLocationLookupEntry.phpsrc/Trafiklab/Common/Model/Contract/FindStopLocationEntry.php renamed to src/Trafiklab/Common/Model/Contract/StopLocationLookupEntry.php src/Trafiklab/Common/Model/Contract/FindStopLocationEntry.php renamed to src/Trafiklab/Common/Model/Contract/StopLocationLookupEntry.php

@@ -5,41 +5,41 @@
 use Trafiklab\Common\Model\Enum\TransportType;
 
 /**
- * A stop location found by a FindStopLocationRequest.
+ * A stop location found by a StopLocationLookupRequest.
  *
- * @see FindStopLocationRequest
- * @see FindStopLocationResponse
+ * @see     StopLocationLookupRequest
+ * @see StopLocationLookupResponse
  *
  * @api
  * @package Trafiklab\Common\Model\Contract
  */
-interface FindStopLocationEntry
+interface StopLocationLookupEntry
 {
     /**
-     * Get the id of this stop area.
+     * Get the id of this stop location.
      *
-     * @return string The id of this stop area.
+     * @return string The id of this stop location.
      */
     public function getId(): string;
 
     /**
-     * Get the name of this stop area.
+     * Get the name of this stop location.
      *
-     * @return string The name of this stop area.
+     * @return string The name of this stop location.
      */
     public function getName(): string;
 
     /**
-     * The longitude of this stop area.
+     * The longitude of this stop location.
      *
-     * @return float The longitude of this stop area.
+     * @return float The longitude of this stop location.
      */
     public function getLongitude(): float;
 
     /**
-     * The latitude of this stop area.
+     * The latitude of this stop location.
      *
-     * @return float The latitude of this stop area.
+     * @return float The latitude of this stop location.
      */
     public function getLatitude(): float;
 
@@ -61,5 +61,5 @@ public function getWeight(): int;
      *
      * @see TransportType
      */
-    public function isStopAreaForTransportType(int $transportType): bool;
+    public function isStopLocationForTransportType(int $transportType): bool;
 }

…del/Contract/FindStopLocationRequest.php …l/Contract/StopLocationLookupRequest.phpsrc/Trafiklab/Common/Model/Contract/FindStopLocationRequest.php renamed to src/Trafiklab/Common/Model/Contract/StopLocationLookupRequest.php src/Trafiklab/Common/Model/Contract/FindStopLocationRequest.php renamed to src/Trafiklab/Common/Model/Contract/StopLocationLookupRequest.php

@@ -4,14 +4,14 @@
 namespace Trafiklab\Common\Model\Contract;
 
 /**
- * A FindStopLocationRequest is a request to find a certain stop area by (a part of) its name. This way a stop area ID
+ * A StopLocationLookupRequest is a request to look up a certain stop location by (a part of) its name. This way a stop location ID
  * can obtained. These APIs are called "Platsupplag" on trafiklab.se.
  *
- * @see     FindStopLocationResponse
+ * @see     StopLocationLookupResponse
  * @api
  * @package Trafiklab\Common\Model\Contract
  */
-interface FindStopLocationRequest
+interface StopLocationLookupRequest
 {
     /**
      * Set the station name to search after. The maximum length might be limited based on the implementation.

…el/Contract/FindStopLocationResponse.php …/Contract/StopLocationLookupResponse.phpsrc/Trafiklab/Common/Model/Contract/FindStopLocationResponse.php renamed to src/Trafiklab/Common/Model/Contract/StopLocationLookupResponse.php src/Trafiklab/Common/Model/Contract/FindStopLocationResponse.php renamed to src/Trafiklab/Common/Model/Contract/StopLocationLookupResponse.php

@@ -5,13 +5,13 @@
 use Trafiklab\Common\Internal\WebResponseImpl;
 
 /**
- * Interface FindStopLocationResponse
+ * Interface StopLocationLookupResponse
  *
- * @see     FindStopLocationRequest
+ * @see     StopLocationLookupRequest
  * @api
  * @package Trafiklab\Common\Model\Contract
  */
-interface FindStopLocationResponse
+interface StopLocationLookupResponse
 {
 
 
@@ -24,9 +24,9 @@ public function getOriginalApiResponse(): WebResponse;
 
 
     /**
-     * An array containing the stop areas which were found.
+     * An array containing the stop locations which were found.
      *
-     * @return FindStopLocationEntry[]
+     * @return StopLocationLookupEntry[]
      */
-    public function getFoundStopAreas(): array;
+    public function getFoundStopLocations(): array;
 }

src/Trafiklab/Common/Model/Contract/TimeTableEntry.php

@@ -22,7 +22,7 @@ interface TimeTableEntry
     public function getDirection(): string;
 
     /**
-     * The time at which the vehicle will arrive at the stop area. This can be an interval (5 min) or a time
+     * The time at which the vehicle will arrive at the stop location. This can be an interval (5 min) or a time
      * (18:00) depending on the operator and data source.
      *
      * @return string
@@ -58,7 +58,7 @@ public function getOperator(): string;
     public function getScheduledStopTime(): DateTime;
 
     /**
-     * The Id for the stop area.
+     * The Id for the stop location.
      *
      * @return string
      */

src/Trafiklab/Common/Model/Contract/TimeTableEntryWithRealTime.php

@@ -6,7 +6,7 @@
 use DateTime;
 
 /**
- * An entry in a timetable, describing a single departure or arrival of a vehicle at a stop area.
+ * An entry in a timetable, describing a single departure or arrival of a vehicle at a stop location.
  *
  * @api
  * @package Trafiklab\Common\Model
@@ -15,7 +15,7 @@ interface TimeTableEntryWithRealTime extends TimeTableEntry
 {
 
     /**
-     * The estimated time at which the vehicle will arrive at the stop area.
+     * The estimated time at which the vehicle will arrive at the stop location.
      *
      * @return DateTime
      */

src/Trafiklab/Common/Model/Contract/VehicleStop.php

@@ -13,30 +13,30 @@
 interface VehicleStop
 {
     /**
-     * The id for this stop area.
+     * The id for this stop location.
      *
      * @return string
      */
     public function getStopId(): string;
 
     /**
-     * The name of this stop area.
+     * The name of this stop location.
      *
-     * @return string The name of this stop area.
+     * @return string The name of this stop location.
      */
     public function getStopName(): string;
 
     /**
      * @return DateTime|null   The departure time at this stop. Null if there is no data about the departure time at
-     *                         this stop area.
+     *                         this stop location.
      */
     public function getScheduledDepartureTime(): ?DateTime;
 
     /**
      * The arrival time at this stop.
      *
      * @return DateTime|null The arrival time at this stop. Null if there is no data about the arrival time at this
-     *                       stop area.
+     *                       stop location.
      */
     public function getScheduledArrivalTime(): ?DateTime;
 
@@ -48,14 +48,14 @@ public function getScheduledArrivalTime(): ?DateTime;
     public function getPlatform(): ?string;
 
     /**
-     * The latitude component of this stop area's coordinates.
+     * The latitude component of this stop location's coordinates.
      *
      * @return float
      */
     public function getLatitude(): float;
 
     /**
-     * The longitude component of this stop area's coordinates.
+     * The longitude component of this stop location's coordinates.
      *
      * @return float
      */

src/Trafiklab/Common/Model/Contract/VehicleStopWithRealtime.php

@@ -15,15 +15,15 @@ interface VehicleStopWithRealtime extends VehicleStop
 {
     /**
      * @return DateTime|null   The estimated (real-time) departure time at this stop. Null if there is no data about
-     *                         the departure time at this stop area.
+     *                         the departure time at this stop location.
      */
     public function getEstimatedDepartureTime(): ?DateTime;
 
     /**
      * The arrival time at this stop.
      *
      * @return DateTime|null The estimated (real-time) arrival time at this stop. Null if there is no data about the
-     *                       arrival time at this stop area.
+     *                       arrival time at this stop location.
      */
     public function getEstimatedArrivalTime(): ?DateTime;