Overview

Namespaces

  • None
  • WPGMZA
    • Integration
    • Selector

Classes

  • AutoLoader
  • Crud
  • DOMDocument
  • DOMElement
  • Factory
  • GDPRCompliance
  • GoogleGeocoder
  • GoogleMap
  • GoogleMapsAPILoader
  • GoogleMapsLoader
  • LatLng
  • Map
  • MapsEngineDialog
  • Marker
  • ModalDialog
  • NominatimGeocodeCache
  • OLLoader
  • Plugin
  • RestAPI
  • ScriptLoader
  • Strings

Functions

  • create_marker_instance_delegate
  • create_plugin_instance
  • query_nominatim_cache
  • store_nominatim_cache
  • Overview
  • Namespace
  • Class

Namespace WPGMZA

Namespaces summary
WPGMZA\Integration
WPGMZA\Selector
Classes summary
AutoLoader

The AutoLoader class can be used to scan a directory and register any classes found in the PHP files there, recursively.

Crud

The CRUD class is a base class which acts as an interface between any objects which are stored on in the database and represented in server side logic, for example Map, Marker, Polygon

DOMDocument
DOMElement
Factory

The Factory class is a base class which can be used to make any classes externally extensible. A filter is added for wpgmza_create_{class} which is called by createInstance. If this filter returns a subclass of Factory, that filter will override the default class and will be used.

GDPRCompliance

This module handles all GDPR functionality for the plugin, including displaying notices, settings and handling logic

GoogleGeocoder Server side Google Maps geocoding.
GoogleMap This module is currently redundant
GoogleMapsAPILoader This class handles loading the Google Maps API and the conditional settings associated with that (load API conditions, exclude pages, etc.)
GoogleMapsLoader This module loads the Google Maps API unconditionally (as opposed to the GoogleMapsAPILoader)
LatLng This class represents a latitude and longitude coordinate pair, provides type consistency for latitude and longitude, and some utility functions
Map This class represents a map.
MapsEngineDialog This class represents the map engine selection dialog, which is presented to the user on the map edit page.
Marker This class represents a marker
ModalDialog Base class for remodal dependent modal dialogs. This class enqueues the relevant scripts and styles.
NominatimGeocodeCache Used to facilitate communication and caching between the client and the Nominatim Geocoding service
OLLoader Loads the OpenLayers map engine
Plugin This class represents the plugin itself. Broadly, this module handles practically all interaction with the platform (WP), loading assets as needed, and hooking into the platforms interface to provide menus etc.
RestAPI This class facilitates all communication between the client and any server side modules which can be interacted with through the WordPress REST API.
ScriptLoader This class takes care of all mechanisms regarding script building and loading.
Strings

This class is a container for all localized strings used by the plugin. In the future, functionality will be added to build a dummy static string file from dynamic strings in the database, this will allow 3rd party software to scan dynamic strings for translation

Functions summary
create_marker_instance_delegate
create_plugin_instance The Factory class will take over this functionality from 7.11.00 onwards. Do not use this hook.
query_nominatim_cache Bind function to query Nominatim cache.
store_nominatim_cache Bind function to store a response on the Nominatim cache.
API documentation generated by ApiGen