Deploy docs from e0e790b

Author: github-actions[bot]

docs/_config.yml

@@ -0,0 +1,19 @@
+theme: jekyll-theme-cayman
+author: sibyx
+title: phpGPX library
+description: Simple library for reading and creating GPX files written in PHP.
+gems:
+  - jekyll-seo-tag
+  - jekyll-analytics
+  - jekyll-sitemap
+social:
+  name: Jakub Dubec
+  links:
+    - https://www.facebook.com/dubecj
+    - https://github.com/Sibyx
+    - https://keybase.io/jakubdubec
+
+jekyll_analytics:
+  GoogleAnalytics:
+    id: UA-99333937-1
+    anonymizeIp: false

docs/_data/authors.yml

@@ -0,0 +1,3 @@
+sibyx:
+    picture: https://www.gravatar.com/avatar/c08cc3a6b17177a4bd7045566b0d772a?s=500
+    twitter: jakubdubec

docs/index.md

@@ -0,0 +1,241 @@
+Simple library written in PHP for reading and creating [GPX files](https://en.wikipedia.org/wiki/GPS_Exchange_Format).
+
+Library is currently marked as Release Candidate but is already used in production on several projects without any 
+problems. [Documentation](https://sibyx.github.io/phpGPX/) is available using GitHub pages generated by Jekyll.
+
+Contribution and feedback is welcome! Please check the issues for TODO. I will be happy every feature or pull request.
+
+## Features
+
+ - Full support of [official specification](http://www.topografix.com/GPX/1/1/).
+ - Statistics calculation.
+ - Extensions.
+ - JSON & XML & PHP Array output.
+
+### Supported Extensions
+ - Garmin [TrackPointExtension](https://www8.garmin.com/xmlschemas/TrackPointExtensionv1.xsd): http://www.garmin.com/xmlschemas/TrackPointExtension/v1
+ 
+### Stats calculation
+
+ - (Smoothed) Distance (m)
+ - Average speed (m/s)
+ - Average pace  (s/km)
+ - Min / max altitude (m)
+ - (Smoothed) Elevation gain / loss (m)
+ - Start / end (DateTime object)
+ - Duration (seconds)
+ 
+## Examples
+
+### Open GPX file and load basic stats
+```php
+<?php
+use phpGPX\phpGPX;
+
+$gpx = new phpGPX();
+	
+$file = $gpx->load('example.gpx');
+	
+foreach ($file->tracks as $track)
+{
+    // Statistics for whole track
+    $track->stats->toArray();
+    
+    foreach ($track->segments as $segment)
+    {
+    	// Statistics for segment of track
+    	$segment->stats->toArray();
+    }
+}
+```
+
+### Writing to file
+```php
+<?php
+use phpGPX\phpGPX;
+
+$gpx = new phpGPX();
+	
+$file = $gpx->load('example.gpx');
+
+// XML
+$file->save('output.gpx', phpGPX::XML_FORMAT);
+	
+//JSON
+$file->save('output.json', phpGPX::JSON_FORMAT);
+```
+
+### Creating file from scratch
+```php
+<?php
+
+use phpGPX\Models\GpxFile;
+use phpGPX\Models\Link;
+use phpGPX\Models\Metadata;
+use phpGPX\Models\Point;
+use phpGPX\Models\Segment;
+use phpGPX\Models\Track;
+
+require_once '/vendor/autoload.php';
+
+$sample_data = [
+	[
+		'longitude' => 9.860624216140083,
+		'latitude' => 54.9328621088893,
+		'elevation' => 0,
+		'time' => new \DateTime("+ 1 MINUTE")
+	],
+	[
+		'latitude' => 54.83293237320851,
+		'longitude' => 9.76092208681491,
+		'elevation' => 10.0,
+		'time' => new \DateTime("+ 2 MINUTE")
+	],
+	[
+		'latitude' => 54.73327743521187,
+		'longitude' => 9.66187816543752,
+		'elevation' => 42.42,
+		'time' => new \DateTime("+ 3 MINUTE")
+	],
+	[
+		'latitude' => 54.63342326167919,
+		'longitude' => 9.562439849679859,
+		'elevation' => 12,
+		'time' => new \DateTime("+ 4 MINUTE")
+	]
+];
+
+// Creating sample link object for metadata
+$link = new Link();
+$link->href = "https://sibyx.github.io/phpgpx";
+$link->text = 'phpGPX Docs';
+
+// GpxFile contains data and handles serialization of objects
+$gpx_file = new GpxFile();
+
+// Creating sample Metadata object
+$gpx_file->metadata = new Metadata();
+
+// Time attribute is always \DateTime object!
+$gpx_file->metadata->time = new \DateTime();
+
+// Description of GPX file
+$gpx_file->metadata->description = "My pretty awesome GPX file, created using phpGPX library!";
+
+// Adding link created before to links array of metadata
+// Metadata of GPX file can contain more than one link
+$gpx_file->metadata->links[] 	= $link;
+
+// Creating track
+$track = new Track();
+
+// Name of track
+$track->name = "Some random points in logical order. Input array should be already ordered!";
+
+// Type of data stored in track
+$track->type = 'RUN';
+
+// Source of GPS coordinates
+$track->source = "MySpecificGarminDevice";
+
+// Creating Track segment
+$segment = new Segment();
+
+
+foreach ($sample_data as $sample_point)
+{
+	// Creating trackpoint
+	$point = new Point(Point::TRACKPOINT);
+	$point->latitude = $sample_point['latitude'];
+	$point->longitude = $sample_point['longitude'];
+	$point->elevation = $sample_point['elevation'];
+	$point->time = $sample_point['time'];
+
+	$segment->points[] = $point;
+}
+
+// Add segment to segment array of track
+$track->segments[] = $segment;
+
+// Recalculate stats based on received data
+$track->recalculateStats();
+
+// Add track to file
+$gpx_file->tracks[] = $track;
+
+// GPX output
+$gpx_file->save('CreatingFileFromScratchExample.gpx', \phpGPX\phpGPX::XML_FORMAT);
+
+// Serialized data as JSON
+$gpx_file->save('CreatingFileFromScratchExample.json', \phpGPX\phpGPX::JSON_FORMAT);
+
+// Direct GPX output to browser
+
+header("Content-Type: application/gpx+xml");
+header("Content-Disposition: attachment; filename=CreatingFileFromScratchExample.gpx");
+
+echo $gpx_file->toXML()->saveXML();
+exit();
+```
+
+## Installation
+
+You can easily install phpGPX library with composer. There is no stable release yet, so please use release candidates.
+
+```
+composer require sibyx/phpgpx:@RC
+```
+
+## API Documentation
+
+* phpGPX
+    * phpGPX\Parsers
+        * [EmailParser](phpGPX-Parsers-EmailParser.md)
+        * [CopyrightParser](phpGPX-Parsers-CopyrightParser.md)
+        * [SegmentParser](phpGPX-Parsers-SegmentParser.md)
+        * [LinkParser](phpGPX-Parsers-LinkParser.md)
+        * [TrackParser](phpGPX-Parsers-TrackParser.md)
+        * [WaypointParser](phpGPX-Parsers-WaypointParser.md)
+        * [PersonParser](phpGPX-Parsers-PersonParser.md)
+        * [MetadataParser](phpGPX-Parsers-MetadataParser.md)
+        * phpGPX\Parsers\Extensions
+            * [TrackPointExtensionParser](phpGPX-Parsers-Extensions-TrackPointExtensionParser.md)
+        * [PointParser](phpGPX-Parsers-PointParser.md)
+        * [RouteParser](phpGPX-Parsers-RouteParser.md)
+        * [ExtensionParser](phpGPX-Parsers-ExtensionParser.md)
+        * [BoundsParser](phpGPX-Parsers-BoundsParser.md)
+    * phpGPX\Helpers
+        * [DateTimeHelper](phpGPX-Helpers-DateTimeHelper.md)
+        * [GeoHelper](phpGPX-Helpers-GeoHelper.md)
+        * [SerializationHelper](phpGPX-Helpers-SerializationHelper.md)
+    * phpGPX\Models
+        * [Point](phpGPX-Models-Point.md)
+        * [Extensions](phpGPX-Models-Extensions.md)
+            * [AbstractExtension](phpGPX-Models-Extensions-AbstractExtension.md)
+            * [TrackPointExtension](phpGPX-Models-Extensions-TrackPointExtension.md)
+        * [Stats](phpGPX-Models-Stats.md)
+        * [Route](phpGPX-Models-Route.md)
+        * [Email](phpGPX-Models-Email.md)
+        * [Collection](phpGPX-Models-Collection.md)
+        * [StatsCalculator](phpGPX-Models-StatsCalculator.md)
+        * [Copyright](phpGPX-Models-Copyright.md)
+        * [Summarizable](phpGPX-Models-Summarizable.md)
+        * [Segment](phpGPX-Models-Segment.md)
+        * [Person](phpGPX-Models-Person.md)
+        * [Link](phpGPX-Models-Link.md)
+        * [GpxFile](phpGPX-Models-GpxFile.md)
+        * [Bounds](phpGPX-Models-Bounds.md)
+        * [Metadata](phpGPX-Models-Metadata.md)
+        * [Track](phpGPX-Models-Track.md)
+    * [phpGPX](phpGPX-phpGPX.md)
+
+## Contributors
+ 
+ - [Jakub Dubec](https://github.com/Sibyx) - Initial works, maintenance
+ - [Lukasz Lewandowski](https://github.com/luklewluk)
+  
+I wrote this library as part of my job in [Backbone s.r.o.](https://www.backbone.sk/en/).
+
+## License
+
+This project is licensed under the terms of the MIT license.

docs/phpGPX-Helpers-DateTimeHelper.md

@@ -0,0 +1,75 @@
+phpGPX\Helpers\DateTimeHelper
+===============
+
+Class DateTimeHelper
+
+
+
+
+* Class name: DateTimeHelper
+* Namespace: phpGPX\Helpers
+
+
+
+
+
+
+
+Methods
+-------
+
+
+### comparePointsByTimestamp
+
+    boolean|integer phpGPX\Helpers\DateTimeHelper::comparePointsByTimestamp(\phpGPX\Models\Point $point1, \phpGPX\Models\Point $point2)
+
+
+
+
+
+* Visibility: **public**
+* This method is **static**.
+
+
+#### Arguments
+* $point1 **[phpGPX\Models\Point](phpGPX-Models-Point.md)**
+* $point2 **[phpGPX\Models\Point](phpGPX-Models-Point.md)**
+
+
+
+### formatDateTime
+
+    null|string phpGPX\Helpers\DateTimeHelper::formatDateTime($datetime, string $format, string $timezone)
+
+
+
+
+
+* Visibility: **public**
+* This method is **static**.
+
+
+#### Arguments
+* $datetime **mixed**
+* $format **string**
+* $timezone **string**
+
+
+
+### parseDateTime
+
+    \DateTime phpGPX\Helpers\DateTimeHelper::parseDateTime($value, string $timezone)
+
+
+
+
+
+* Visibility: **public**
+* This method is **static**.
+
+
+#### Arguments
+* $value **mixed**
+* $timezone **string**
+
+

docs/phpGPX-Helpers-GeoHelper.md

@@ -0,0 +1,50 @@
+phpGPX\Helpers\GeoHelper
+===============
+
+Class GeoHelper
+Geolocation methods.
+
+
+
+
+* Class name: GeoHelper
+* Namespace: phpGPX\Helpers
+* This is an **abstract** class
+
+
+
+Constants
+----------
+
+
+### EARTH_RADIUS
+
+    const EARTH_RADIUS = 6371000
+
+
+
+
+
+
+
+Methods
+-------
+
+
+### getDistance
+
+    float phpGPX\Helpers\GeoHelper::getDistance(\phpGPX\Models\Point $point1, \phpGPX\Models\Point $point2)
+
+Returns distance in meters between two Points according to GPX coordinates.
+
+
+
+* Visibility: **public**
+* This method is **static**.
+
+
+#### Arguments
+* $point1 **[phpGPX\Models\Point](phpGPX-Models-Point.md)**
+* $point2 **[phpGPX\Models\Point](phpGPX-Models-Point.md)**
+
+