Class openStreetMap

The class for all OSM map related functionality

Package: plugins\openstreetmap
Author: Malte Müller (acrylian), Fred Sondaar (fretzl), gjr, Vincent Bourganel (vincent3569)
Located at zp-extensions/openstreetmap.php

Methods summary
`public`	# `__construct( array $geodata = NULL, openStreetMap::$obj $obj = NULL )` If no $geodata array is passed the function gets geodata from the current image or the images of the current album if in appropiate context. If no $geodata array is passed the function gets geodata from the current image or the images of the current album if in appropiate context. Alternatively you can pass an image or album object directly. This ignores the $geodata parameter then. The $geodata array requires this structure: Single marker: array( array( 'lat' => , 'long' => , 'title' => 'some title', 'desc' => 'some description', 'thumb' => 'some html' // an call or else. ) ); If you use html for title, desc or thumb be sure to use double quotes for attributes to avoid JS conflicts. For several markers add more arrays to the array. If you neither pass $geodata, an object or there is no current image/album you can still display a map. But in this case you need to set the $center and $fitbounds properties manually before printing a map. Parameters `$geodata` Array as noted above if no current image or album should be used `$obj` or album object If set this object is used and $geodatat is ignored if set as well
`public static`	# `scripts( )` Assigns the needed JS and CSS Assigns the needed JS and CSS
`public`	# `getImageGeodata( $image )` $returns coordinate informations for an image Adapted from the offical Zenphoto GoogleMap plugin by Stephen Billard (sbillard) & Vincent Bourganel (vincent3569) $returns coordinate informations for an image Adapted from the offical Zenphoto GoogleMap plugin by Stephen Billard (sbillard) & Vincent Bourganel (vincent3569) Parameters `$image` object
`public`	# `getAlbumGeodata( $album )` Gathers the map data for an album Adapted from the offical Zenphoto GoogleMap plugin by Stephen Billard (sbillard) & Vincent Bourganel (vincent3569) Gathers the map data for an album Adapted from the offical Zenphoto GoogleMap plugin by Stephen Billard (sbillard) & Vincent Bourganel (vincent3569) Parameters `$album` object
`public array`	# `getGeoData( )` Extracts the geodata from an image or the images of an album and creates the JS arrays for leaflet including title, description and thumb if set. Extracts the geodata from an image or the images of an album and creates the JS arrays for leaflet including title, description and thumb if set. Returns array
`public string`	# `getGeoDataJS( )` Processes the geodata returned by getGeoData() and formats it to a string presenting a multidimensional Javascript array for use with leafletjs Processes the geodata returned by getGeoData() and formats it to a string presenting a multidimensional Javascript array for use with leafletjs Returns string
`public array`	# `getFitBounds( )` Returns the bounds the map should fit based on the geodata of an image or images of an album Returns the bounds the map should fit based on the geodata of an image or images of an album Returns array
`public array`	# `getCenter( )` Returns the center point of the map. On an single image it is the marker of the image itself. On images from an album it is calculated from their geodata Returns the center point of the map. On an single image it is the marker of the image itself. On images from an album it is calculated from their geodata Returns array
`public string`	# `getTileLayerJS( )` Return the map tile js definition for leaflet and its leaflet-providers plugin. For certain map providers it include the access credentials. Return the map tile js definition for leaflet and its leaflet-providers plugin. For certain map providers it include the access credentials. Returns string
`public`	# `printMap( )` Prints the required HTML and JS for the map Prints the required HTML and JS for the map
`public static array`	# `getLayersList( array $providers,… )` It returns an array of layer option db name It returns an array of layer option db name Parameters `$providers`,… provider list Returns array
`public string`	# `setMapTiles( string $tileprovider = null )` It returns the provider chosen if it is valid or the default 'OpenStreetMap.Mapnik' tile It returns the provider chosen if it is valid or the default 'OpenStreetMap.Mapnik' tile Parameters `$tileprovider` The tile provider to validate Returns string
`public static array`	# `getTileProviders( )` Returns an array of all defined tile provider names from and for use with leaflet-providers.js and the plugin options Returns an array of all defined tile provider names from and for use with leaflet-providers.js and the plugin options Returns array

Properties summary
`public array`	`$geodata` Contains the array of the image or images from albums geodata Contains the array of the image or images from albums geodata	# `NULL`
`public array`	`$geodatajs` Contains a string presenting a Javascript array of geodata for leafletjs Contains a string presenting a Javascript array of geodata for leafletjs	# `NULL`
`public array`	`$fitbounds` geodata array('min' => array(lat,lng), 'max => array(lat,lng)) Default created from an image or the images of an album. geodata array('min' => array(lat,lng), 'max => array(lat,lng)) Default created from an image or the images of an album.	# `NULL`
`public array`	`$center` geodata array(lat,lng) Default created from an image or the images of an album. geodata array(lat,lng) Default created from an image or the images of an album.	# `NULL`
`public string`	`$class` Optional class name to attach to the map html Optional class name to attach to the map html	# `''`
`public string`	`$mode` "single" (one marker) "cluster" (several markers always clustered) "single-cluster" (markers of the images of the current album) Default created by the $geodata property: "single "if array with one entry, "cluster" if more entries "single" (one marker) "cluster" (several markers always clustered) "single-cluster" (markers of the images of the current album) Default created by the $geodata property: "single "if array with one entry, "cluster" if more entries	# `NULL`
`public boolean`	`$showalbummarkers` Default false if set to true on single image maps the markers of all other images are shown as well. The current image's position will be highlighted.	# `false`
`public array`	`$mapcenter` geodata array(lat,lng) Default created from the image marker or from the markers of the images of an album if in context geodata array(lat,lng) Default created from the image marker or from the markers of the images of an album if in context	# `NULL`
`public integer`	`$mapnumber` Unique number if using more than one map on a page Unique number if using more than one map on a page	# `''`
`public string`	`$width` Default 100% for responsive map. Values like "100%", "100px" or "100em" Default taken from plugin options Default 100% for responsive map. Values like "100%", "100px" or "100em" Default taken from plugin options	# `NULL`
`public string`	`$height` Values like "100px" or "100em" Default taken from plugin options Values like "100px" or "100em" Default taken from plugin options	# `NULL`
`public integer`	`$zoom` Default zoom state Default taken from plugin options Default zoom state Default taken from plugin options	# `NULL`
`public`	`$minzoom`	# `NULL`
`public`	`$maxzoom`	# `NULL`
`public array`	`$defaultlayer` The tile providers to use. Select from the $tileproviders property like $this->maptiles = $this->tileproviders[''] Must be like array('','') Default taken from plugin options The tile providers to use. Select from the $tileproviders property like $this->maptiles = $this->tileproviders[''] Must be like array('','') Default taken from plugin options	# `NULL`
`public`	`$layerslist`	# `NULL`
`public`	`$layer`	# `NULL`
`public integer`	`$clusterradius` Radius when clusters should be created on more than one marker Default taken from plugin options Radius when clusters should be created on more than one marker Default taken from plugin options	# `NULL`
`public boolean`	`$markerpopup` If used on albums or several custom markers if you wish popups on the markers If using custom markers you need to provide the content for the popups withn the $geodata property Default taken from plugin options If used on albums or several custom markers if you wish popups on the markers If using custom markers you need to provide the content for the popups withn the $geodata property Default taken from plugin options	# `false`
`public boolean`	`$markerpopup_title` Only if on an album page and if $imagepopups are enabled. If the imagepopus should contain thumbs of the images Default taken from plugin options Only if on an album page and if $imagepopups are enabled. If the imagepopus should contain thumbs of the images Default taken from plugin options	# `false`
`public boolean`	`$markerpopup_desc`	# `false`
`public boolean`	`$markerpopup_thumb`	# `false`
`public boolean`	`$showmarkers`	# `true`
`public string`	`$showminimap` Mini map parameters Mini map parameters	# `false`
`public`	`$minimap_width`	# `NULL`
`public`	`$minimap_height`	# `NULL`
`public`	`$minimap_zoom`	# `NULL`
`public string`	`$zoomcontrolpos` Position of the map controls: "topleft", "topright", "bottomleft", "bottomright" Default taken from plugin options Position of the map controls: "topleft", "topright", "bottomleft", "bottomright" Default taken from plugin options	# `NULL`
`public`	`$showscale`	# `NULL`
`public`	`$showcursorpos`	# `NULL`
`public object`	`$obj` The current image or album object if not passing custom geodata The current image or album object if not passing custom geodata	# `NULL`
`public array`	`$tileproviders` The predefined array of all free map tile providers for Open Street Map The predefined array of all free map tile providers for Open Street Map	# `NULL`

Classes

Interfaces

Exceptions

Functions

Class openStreetMap

Parameters

Parameters

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns