Merge branch '2024_1_staging' of https://github.com/morehawes/waymark into 2024_1_staging

Author: morehawes

inc/Helpers/Waymark_GeoJSON.php

@@ -2,15 +2,27 @@
 
 class Waymark_GeoJSON {
 
-	static public function string_to_feature_collection($string = '') {
+	/**
+	 * Convert a GeoJSON string to an array
+	 *
+	 * @param  string $string GeoJSON string
+	 * @return array          GeoJSON array
+	 */
+	static public function string_to_feature_collection(String $string = '') {
 		if (is_string($string)) {
 			return json_decode($string, true, 512, JSON_OBJECT_AS_ARRAY);
 		}
 
 		return false;
 	}
 
-	static public function get_feature_count($FeatureCollection = []) {
+	/**
+	 * Get count of features in a GeoJSON array
+	 *
+	 * @param  array $FeatureCollection GeoJSON array
+	 * @return int                      Count of features
+	 */
+	static public function get_feature_count(Array $FeatureCollection = []) {
 		if (is_string($FeatureCollection)) {
 			$FeatureCollection = self::string_to_feature_collection($FeatureCollection);
 		}
@@ -23,7 +35,15 @@ static public function get_feature_count($FeatureCollection = []) {
 		return false;
 	}
 
-	static public function update_feature_property($FeatureCollection = [], $property_key = null, $property_value = null) {
+	/**
+	 * Update every feature's property in a GeoJSON array
+	 *
+	 * @param  array  $FeatureCollection GeoJSON array
+	 * @param  string $property_key      Property key
+	 * @param  string $property_value    Property value
+	 * @return array                     Updated GeoJSON array
+	 */
+	static public function update_feature_property(Array $FeatureCollection = [], String $property_key = '', String $property_value = '') {
 		if (is_string($FeatureCollection)) {
 			$FeatureCollection = self::string_to_feature_collection($FeatureCollection);
 		}
@@ -44,7 +64,13 @@ static public function update_feature_property($FeatureCollection = [], $propert
 		return $FeatureCollection;
 	}
 
-	static public function clean_feature_descriptions($FeatureCollection = []) {
+	/**
+	 * Replace bad characters in every feature's description property in a GeoJSON array
+	 *
+	 * @param  array  $FeatureCollection GeoJSON array
+	 * @return array                     Updated GeoJSON array
+	 */
+	static public function clean_feature_descriptions(Array $FeatureCollection = []) {
 		//Feature Collection
 		if ($FeatureCollection && isset($FeatureCollection['features'])) {
 
@@ -61,6 +87,12 @@ static public function clean_feature_descriptions($FeatureCollection = []) {
 		return $FeatureCollection;
 	}
 
+	/**
+	 * Sort features into Markers, Lines and Shapes and then by type
+	 *
+	 * @param  array  $FeatureCollection GeoJSON array
+	 * @return array                     Sorted GeoJSON array
+	 */
 	static public function features_by_overlay_type(Array $FeatureCollection = []) {
 
 		// Waymark_Helper::debug($FeatureCollection);

readme.md

@@ -12,7 +12,7 @@ Waymark adds powerful mapping features to WordPress that are easy to use. Create
 
 ## Description ##
 
-🗺 [View the Demo](https://www.waymark.dev/demo/)
+🗺 [View the Demo](https://www.waymark.dev/)
 🛠️ [Try the Editor](https://www.waymark.dev/try/)
 📼 [Watch the Video](https://www.waymark.dev/#footer)
 📖 [Read the Docs](https://www.waymark.dev/docs/)
@@ -21,68 +21,54 @@ Waymark adds powerful mapping features to WordPress that are easy to use. Create
 
 ### Creating Maps
 
-Use the intuitive [Editor](https://www.waymark.dev/try/) to create Maps with interactive Overlays. A Map could contain a single Marker/Line/Shape, or many thousands.
-
-- **Overlays** - Markers, Lines and Shapes can have:
-	- Title
-	- Image
-	- Description
-	- [Type](https://www.waymark.dev/docs/types/)
-- **Import** - From:
-  - [GPX](https://www.topografix.com/gpx.asp)
-  - [KML](https://developers.google.com/kml/documentation/kmlreference)
-  - [GeoJSON](https://geojson.org/) (including [Properties](https://www.waymark.dev/docs/settings/#properties))
-  - [EXIF](https://www.loc.gov/preservation/digital/formats/fdd/fdd000147.shtml) (Image location metadata)
-  - [Elevation data](https://www.waymark.dev/map/track-with-elevation/)
+Use the intuitive [Editor](https://www.waymark.dev/try/) to create Maps with one, or thousands of interactive Overlays.
+
+- **Overlays** - Create Markers, Lines and Shapes with:
+  - Title
+  - Image (Upload or link to external image)
+  - Description (Rich text editor, HTML supported)
+  - [Type](https://www.waymark.dev/docs/types/) (defined in Settings)
+- **Import**
+  - GPX
+  - KML
+  - GeoJSON (including [Properties](https://www.waymark.dev/docs/settings/#properties))
+  - EXIF (Image location metadata)
+  - [Elevation data](https://www.waymark.dev/map/track-with-elevation/) (adds an interactive profile chart for Lines with elevation data)
+- **[Meta](https://www.waymark.dev/docs/meta/)** - Add extra information to your Maps using Meta; these are customisable form inputs that allow you to add additional content to your Maps.
+- **[Types](https://www.waymark.dev/docs/types/)** - Set options to visuallly distinguish between Overlays (colours/icons etc.), then select it when using the Editor.
+- **[Collections](https://www.waymark.dev/docs/collections/)** - Group Maps together and display multiple Maps at once. Create complex Collection hierarchies to suit your needs and associate Maps with multiple Collections.
+- **[Submissions](https://www.waymark.dev/docs/submissions/)** - Allow registered users, or guests to create Maps from the front-end of your site. You can control who can Submit Maps, what editor features are available and whether submissions should be approved before they are published.
 
 ### Displaying Maps
 
-- Use the [Shortcode](https://www.waymark.dev/docs/shortcodes/), or link to the [Map Details](https://www.waymark.dev/map/route-map/) page. 
+Embed your Maps using the Shortcode, or link to the [Map Details](https://www.waymark.dev/map/route-map/) page.
 
 - **[Shortcodes](https://www.waymark.dev/docs/shortcodes/)**
-	- Display a single Map, or a [Collection](https://www.waymark.dev/docs/collections/) of Maps anywhere that Shortcodes are supported.
-	- The Shortcode Header displays the Map/Collection title, a link to the Map Details page, any [Meta](https://www.waymark.dev/docs/shortcodes/) and an optional Export feature.
-	- Display a [Marker](https://www.waymark.dev/docs/shortcodes/#shortcode-markers) defined through the Shortcode.
-	- Display [Files](https://www.waymark.dev/docs/shortcodes/#shortcode-files) (GPX, KML & GeoJSON) without the need for a Map to be created.
-	- Customise which features
-
-
-Lines can also have direction arrows. 
-
-
-
-* An interactive profile chart can be displayed for Tracks uploaded with elevation data.
-
-
-
-### Customisable
-
-- **[Basemaps](https://www.waymark.dev/docs/basemaps/)** - Uses [OpenStreetMap](https://www.openstreetmap.org/fixthemap) by default, with support for multiple Basemaps.
-- **[Types](https://www.waymark.dev/docs/types/)** - Set styles and options (colours/icons etc.) once, then select it when adding an Overlay.
-- **[Meta](https://www.waymark.dev/docs/meta/)** - Add extra information to your Maps using Meta; these are customisable form inputs that allow you to add additional data to your Maps. 
-Settings
-CSS
-JavaScript
+  - Display a single Map, or a [Collection](https://www.waymark.dev/docs/collections/) of Maps anywhere that Shortcodes are supported.
+  - An optional Shortcode Header displays the Map/Collection title, a link to the Map Details page and any [Meta](https://www.waymark.dev/docs/shortcodes/).
+  - Display a [Marker](https://www.waymark.dev/docs/shortcodes/#shortcode-markers) defined through the Shortcode.
+  - Display [Files](https://www.waymark.dev/docs/shortcodes/#shortcode-files) (GPX, KML & GeoJSON) from a URL without the need for a Map to be created.
+  - Display a Basemap only, without any overlays by providing centre and zoom parameters.
+- **[Basemaps](https://www.waymark.dev/docs/basemaps/)** - Uses [OpenStreetMap](https://www.openstreetmap.org/fixthemap) by default, with support for multiple raster tiled/"slippy" Basemaps.
+- **Overlay Filter** - Allow the user to filter which Markers, Lines and Shapes are currently visible on the Map. The current Basemap can also be switched.
+- **[Export](https://www.waymark.dev/docs/shortcodes/#shortcode-export)**
+  - (Optionally) Let anyone Export Maps into GPX, KML and GeoJSON formats through the Shortcode Header or on the Map Details page.
+  - Works with the Overlay Filter to only include the currently visible Overlays.
+  - Works on mobile devices.
 
+### Customising
 
+Built to be flexible, Waymark has lots of Settings to choose from.
 
-### Data Formats
+For developers:
 
-* Import from GPX, KML and GeoJSON formats (GeoJSON properties can also be imported). You can export Maps and Collections in the same formats and let your visitors do it too.
+- Most elements can be [styled using CSS](https://www.waymark.dev/docs/styling-with-css-selectors/) and have sensibly named `waymark-` classes.
+- Maps are stored using the custom post type `waymark_map`
+- Meta is stored as Custom Fields (prefixed with `waymark_`)
+- Collections use the `waymark_collection` Taxonomy.
+- Use the [JavaScript callback function](https://www.waymark.dev/docs/callback-function/) to extend Waymark functionality.
 
-
-### GIS Features
-
-* Add extra information to your Maps using <a href="https://www.waymark.dev/docs/meta/">Meta</a>; these are customisable form inputs that allow you to add additional data to your Maps. 
-* Group Maps together using <a href="https://www.waymark.dev/docs/collections/">Collections</a> and display multiple Maps at once.
-* <a href="https://www.waymark.dev/docs/submissions/">Submissions</a> allow registered users, or guests to create Maps from the front-end of your site. You can control who can Submit Maps, what editor features are available and whether submissions should be approved before they are published.
-
-
-### Developer Friendly
-
-* For the developers: Maps are stored using the custom post type `waymark_map`, Meta is stored as Custom Fields and Collections use the `waymark_collection` Taxonomy. Most elements can be styled using CSS and have sensibly named `waymark-` classes.
-
-Waymark is free, open-source ([GPL v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)) and a labour of Love. I try to keep the plugin well supported, so please feel free to <a href="https://wordpress.org/support/plugin/waymark/#new-topic-0">reach out</a> with any questions or feedback.
+Waymark is free, open-source ([GPL v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)) and a labour of Love. I try to keep the plugin well supported, so please feel free to <a href="https://wordpress.org/support/plugin/waymark/#new-topic-0">reach out</a> with any issues, questions or feedback.
 
 ## Installation ##
 
@@ -94,7 +80,7 @@ With Waymark enabled, click on the "Maps" link in the sidebar to create and edit
 
 ### Is There a Demo? ###
 
-Yes, <a href="https://www.waymark.dev/demo/">here</a>. You can also try the Editor <a href="https://www.waymark.dev/try/">here</a>.
+Yes, <a href="https://www.waymark.dev/">here</a>. You can also try the Editor <a href="https://www.waymark.dev/try/">here</a>.
 
 ### Can I Get More Help? ###
 
@@ -103,7 +89,6 @@ Yes, please view the <a href="https://www.waymark.dev/docs/">Documentation</a>.
 ### How Can I Contribute? ###
 
 * [Star the project on GitHub](https://github.com/opengis/waymark/)
-
 * [Rate the plugin](https://wordpress.org/support/plugin/waymark/reviews/#new-post)
 * [Report bugs](https://wordpress.org/support/plugin/waymark/#new-topic-0)
 * [Suggest new features](https://wordpress.org/support/plugin/waymark/#new-topic-0)
@@ -124,12 +109,8 @@ Please! Waymark is localization ready, <a href="https://translate.wordpress.org/
 
 Waymark relies on input from it's users, thank you to everyone for providing feedback :)
 
-A big thank you to the following projects and their contributors. Without their work this plugin would not be possible:
-
 Built on the shoulders of giants, [thank you](https://www.waymark.dev/docs/thanks/)!
 
-
-
 ## Screenshots ##
 
 ### 1. Add Overlays (Markers, Lines and Shapes) to create detailed interactive Maps. You can import/export from GPX/KML/GeoJSON. ###