Remove AbstractExtension, simplify constructors across models, and replace Point constants with PointType enum 🫃

Author: Sibyx

README.md

@@ -100,6 +100,7 @@ $file->save('output.json', phpGPX::JSON_FORMAT);
 
 use phpGPX\Models\GpxFile;
 use phpGPX\Models\Point;
+use phpGPX\Models\PointType;
 use phpGPX\Models\Segment;
 use phpGPX\Models\Track;
 use phpGPX\Models\Extensions;
@@ -113,7 +114,7 @@ $track->type = 'RUN';
 
 $segment = new Segment();
 
-$point = new Point(Point::TRACKPOINT);
+$point = new Point(PointType::Trackpoint);
 $point->latitude = 54.9328621088893;
 $point->longitude = 9.860624216140083;
 $point->elevation = 0;

docs/01_Usage/02_Creating_Files.md

@@ -8,6 +8,7 @@ You can build GPX files programmatically.
 use phpGPX\Models\GpxFile;
 use phpGPX\Models\Metadata;
 use phpGPX\Models\Point;
+use phpGPX\Models\PointType;
 use phpGPX\Models\Segment;
 use phpGPX\Models\Track;
 use phpGPX\phpGPX;
@@ -34,7 +35,7 @@ $points = [
 ];
 
 foreach ($points as $data) {
-    $point = new Point(Point::TRACKPOINT);
+    $point = new Point(PointType::Trackpoint);
     $point->latitude = $data['lat'];
     $point->longitude = $data['lon'];
     $point->elevation = $data['ele'];
@@ -67,6 +68,7 @@ echo "Distance: " . round($gpxFile->tracks[0]->stats->distance) . " m\n";
 ```php
 use phpGPX\Models\GpxFile;
 use phpGPX\Models\Point;
+use phpGPX\Models\PointType;
 use phpGPX\Models\Route;
 use phpGPX\phpGPX;
 
@@ -82,7 +84,7 @@ $waypoints = [
 ];
 
 foreach ($waypoints as $data) {
-    $point = new Point(Point::ROUTEPOINT);
+    $point = new Point(PointType::Routepoint);
     $point->latitude = $data['lat'];
     $point->longitude = $data['lon'];
     $point->elevation = $data['ele'];
@@ -100,11 +102,12 @@ $gpxFile->save('trail.gpx', phpGPX::XML_FORMAT);
 use phpGPX\Models\GpxFile;
 use phpGPX\Models\Link;
 use phpGPX\Models\Point;
+use phpGPX\Models\PointType;
 use phpGPX\phpGPX;
 
 $gpxFile = new GpxFile();
 
-$waypoint = new Point(Point::WAYPOINT);
+$waypoint = new Point(PointType::Waypoint);
 $waypoint->latitude = 48.8566;
 $waypoint->longitude = 2.3522;
 $waypoint->elevation = 35;

docs/01_Usage/05_Extensions.md

@@ -118,10 +118,9 @@ To add support for a new GPX extension type, implement two interfaces:
 ### 1. Extension model — `ExtensionInterface`
 
 ```php
-use phpGPX\Models\Extensions\AbstractExtension;
 use phpGPX\Models\Extensions\ExtensionInterface;
 
-class MyExtension extends AbstractExtension implements ExtensionInterface
+class MyExtension implements ExtensionInterface
 {
     public const NAMESPACE = 'http://example.com/ext/v1';
     public const XSD = 'http://example.com/ext/v1/schema.xsd';

examples/CreateFileFromScratch.php

@@ -7,6 +7,7 @@
 use phpGPX\Models\Link;
 use phpGPX\Models\Metadata;
 use phpGPX\Models\Point;
+use phpGPX\Models\PointType;
 use phpGPX\Models\Segment;
 use phpGPX\Models\Track;
 use phpGPX\Models\Extensions;
@@ -84,7 +85,7 @@
 
 foreach ($sample_data as $sample_point) {
 	// Creating trackpoint
-	$point 						= new Point(Point::TRACKPOINT);
+	$point 						= new Point(PointType::Trackpoint);
 	$point->latitude 			= $sample_point['latitude'];
 	$point->longitude 			= $sample_point['longitude'];
 	$point->elevation 			= $sample_point['elevation'];
@@ -106,7 +107,7 @@
 $gpx_file->tracks[] 			= $track;
 
 // Create waypoint
-$point 							= new Point(Point::WAYPOINT);
+$point 							= new Point(PointType::Waypoint);
 $point->name 					= 'Example Waypoint';
 $point->latitude 				= $sample_point['latitude'];
 $point->longitude 				= $sample_point['longitude'];

examples/waypoints_create.php

@@ -7,6 +7,7 @@
 use phpGPX\Models\Link;
 use phpGPX\Models\Metadata;
 use phpGPX\Models\Point;
+use phpGPX\Models\PointType;
 use phpGPX\Models\Segment;
 use phpGPX\Models\Track;
 
@@ -75,7 +76,7 @@
 $wp = [];
 foreach ($sample_data as $sample_point) {
 	// Creating trackpoint
-	$point 						= new Point(Point::WAYPOINT);
+	$point 						= new Point(PointType::Waypoint);
 	$point->latitude 			= $sample_point['latitude'];
 	$point->longitude 			= $sample_point['longitude'];
 	$point->elevation 			= $sample_point['elevation'];

src/phpGPX/Models/Bounds.php

@@ -1,73 +1,40 @@
 <?php
-/**
- * Created            16/02/2017 22:03
- * @author            Jakub Dubec <jakub.dubec@gmail.com>
- */
 
 namespace phpGPX\Models;
 
+/**
+ * Two lat/lon pairs defining the extent of an element.
+ */
 class Bounds implements \JsonSerializable
 {
-    public const TAG_NAME = 'bounds';
-
-	/**
-	 * Minimal latitude in file.
-	 * @var float|null
-	 */
-	public ?float $minLatitude;
-
-	/**
-	 * Minimal longitude in file.
-	 * @var float|null
-	 */
-	public ?float $minLongitude;
+	public const TAG_NAME = 'bounds';
 
-	/**
-	 * Maximal latitude in file.
-	 * @var float|null
-	 */
-	public ?float $maxLatitude;
+	public function __construct(
+		public ?float $minLatitude = null,
+		public ?float $minLongitude = null,
+		public ?float $maxLatitude = null,
+		public ?float $maxLongitude = null,
+	) {}
 
 	/**
-	 * Maximal longitude in file.
-	 * @var float|null
+	 * GeoJSON bbox: [minLon, minLat, maxLon, maxLat]
 	 */
-	public ?float $maxLongitude;
-
-    /**
-     * @param float|null $minLatitude
-     * @param float|null $minLongitude
-     * @param float|null $maxLatitude
-     * @param float|null $maxLongitude
-     */
-    public function __construct(?float $minLatitude, ?float $minLongitude, ?float $maxLatitude, ?float $maxLongitude)
-    {
-        $this->minLatitude = $minLatitude;
-        $this->minLongitude = $minLongitude;
-        $this->maxLatitude = $maxLatitude;
-        $this->maxLongitude = $maxLongitude;
-    }
-
-    /**
-     * GeoJSON serializer
-     * @return array
-     */
-    public function jsonSerialize(): array
-    {
-        return [$this->minLongitude, $this->minLatitude, $this->maxLongitude, $this->maxLatitude];
-    }
-
-    public static function parse(\SimpleXMLElement $node): ?Bounds
-    {
-        if ($node->getName() != self::TAG_NAME) {
-            return null;
-        }
-
-        return new Bounds(
-            (float) $node['minlat'],
-            (float) $node['minlon'],
-            (float) $node['maxlat'],
-            (float) $node['maxlon']
-        );
-    }
-}
+	public function jsonSerialize(): array
+	{
+		return [$this->minLongitude, $this->minLatitude, $this->maxLongitude, $this->maxLatitude];
+	}
+
+	public static function parse(\SimpleXMLElement $node): ?Bounds
+	{
+		if ($node->getName() != self::TAG_NAME) {
+			return null;
+		}
+
+		return new Bounds(
+			(float) $node['minlat'],
+			(float) $node['minlon'],
+			(float) $node['maxlat'],
+			(float) $node['maxlon']
+		);
+	}
+}

src/phpGPX/Models/Collection.php

@@ -1,100 +1,39 @@
 <?php
-/**
- * Created            26/08/16 14:21
- * @author            Jakub Dubec <jakub.dubec@gmail.com>
- */
 
 namespace phpGPX\Models;
 
 /**
- * Class Collection
- * @package phpGPX\Models
+ * Abstract base class for Track and Route.
  */
 abstract class Collection implements \JsonSerializable
 {
+	/** GPS name of route / track. */
+	public ?string $name = null;
 
-	/**
-	 * GPS name of route / track.
-	 * An original GPX 1.1 attribute.
-	 * @var string|null
-	 */
-	public ?string $name;
-
-	/**
-	 * GPS comment for route.
-	 * An original GPX 1.1 attribute.
-	 * @var string|null
-	 */
-	public ?string $comment;
-
-	/**
-	 * Text description of route/track for user. Not sent to GPS.
-	 * An original GPX 1.1 attribute.
-	 * @var string|null
-	 */
-	public ?string $description;
-
-	/**
-	 * Source of data. Included to give user some idea of reliability and accuracy of data.
-	 * An original GPX 1.1 attribute.
-	 * @var string|null
-	 */
-	public ?string $source;
+	/** GPS comment for route. */
+	public ?string $comment = null;
 
-	/**
-	 * Links to external information about the route/track.
-	 * An original GPX 1.1 attribute.
-	 * @var Link[]
-	 */
-	public array $links;
+	/** Text description of route/track for user. */
+	public ?string $description = null;
 
-	/**
-	 * GPS route/track number.
-	 * An original GPX 1.1 attribute.
-	 * @var int|null
-	 */
-	public ?int $number;
+	/** Source of data. */
+	public ?string $source = null;
 
-	/**
-	 * Type (classification) of route/track.
-	 * An original GPX 1.1 attribute.
-	 * @var string|null
-	 */
-	public ?string $type;
+	/** @var Link[] Links to external information. */
+	public array $links = [];
 
-	/**
-	 * You can add extend GPX by adding your own elements from another schema here.
-	 * An original GPX 1.1 attribute.
-	 * @var Extensions|null
-	 */
-	public ?Extensions $extensions;
+	/** GPS route/track number. */
+	public ?int $number = null;
 
-	/**
-	 * Objects contains calculated statistics for collection.
-	 * @var Stats|null
-	 */
-	public ?Stats $stats;
+	/** Type (classification) of route/track. */
+	public ?string $type = null;
 
-	/**
-	 * Collection constructor.
-	 */
-	public function __construct()
-	{
-		$this->name = null;
-		$this->comment = null;
-		$this->description = null;
-		$this->source = null;
-		$this->links = [];
-		$this->number = null;
-		$this->type = null;
-		$this->extensions = null;
-		$this->stats = null;
-	}
+	/** GPX extensions. */
+	public ?Extensions $extensions = null;
 
+	/** Calculated statistics. */
+	public ?Stats $stats = null;
 
-	/**
-	 * Return all points in collection.
-	 * @return Point[]
-	 */
+	/** @return Point[] */
 	abstract public function getPoints(): array;
-}
+}