Skip to content

Feature: Custom osm URL and attribution #435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
e1mo wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Feature: Custom osm URL and attribution #435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fb83fe
Feature: custom OSM tile server and attribution
e1mo Nov 6, 2022
d97dc14
Move satelite map to template instead of module
e1mo Nov 7, 2022
1d4a7d6
Use custom tiles server in admin UI
e1mo Nov 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions assets/js/admin/sp-geocoder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ var map = L.map( 'sp-location-picker' ).setView( [latitude, longitude], 15
marker = L.marker( [latitude, longitude],{draggable: true, autoPan: true} ).addTo( map );

L.tileLayer(
'http://{s}.tile.osm.org/{z}/{x}/{y}.png',
sp_osm_settings["tile_server"],
{
attribution: '&copy; <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
attribution: sp_osm_settings["attribution"]
}
).addTo( map );

Expand Down
36 changes: 36 additions & 0 deletions includes/admin/settings/class-sp-settings-general.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,42 @@ public function get_settings() {
);
}

$options = array_merge(
$options,
array(
array(
'type' => 'sectionend',
'id' => 'general_options',
),
array(
'title' => esc_attr__( 'OpenStreetMap', 'sportspress' ),
'type' => 'title',
'desc' => '',
'id' => 'osm_options',
),
array(
'title' => esc_attr__( 'Tile server', 'sportspress' ),
'id' => 'sportspress_osm_tile_server',
'placeholder' => 'https://tile.openstreetmap.org/{z}/{x}/{y}.png',
'css' => 'width:100%;',
'type' => 'text',
'desc' => esc_attr__('Leave empty to use the default', 'sportspress'),
),
array(
'title' => esc_attr__( 'Attributions', 'sportspress' ),
'id' => 'sportspress_osm_attribution',
'placeholder' => 'Map data &amp;copy; &lt;a href=&quot;https://www.openstreetmap.org/&quot;&gt;OpenStreetMap&lt;/a&gt; contributors',
'css' => 'width:100%;',
'type' => 'text',
'desc' => esc_attr__('Leave empty to use the default', 'sportspress'),
),
array(
'type' => 'sectionend',
'id' => 'general_options',
),
)
);

Comment on lines +250 to +285

@e1mo e1mo Nov 7, 2022

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minutes after posting I stumbled across the map settings on the event page which I totally missed. I think those should be moved there, but I'm not sure (I'm neither familiar with wp plugins nor this codebase) how these settings could be incorporated. Maybe something like the other option sportspress_event_teams_delimiter could work here?

I'm very open to ideas, patches or hints how this could be implemented!

$settings = array_merge(
$settings,
apply_filters( 'sportspress_script_styling_options', $options ),
Expand Down
36 changes: 24 additions & 12 deletions modules/sportspress-openstreetmap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function __construct() {
add_action( 'sp_admin_venue_scripts', array( $this, 'admin_venue_scripts' ) );
add_action( 'sp_frontend_venue_scripts', array( $this, 'frontend_venue_scripts' ) );
add_action( 'wp_enqueue_scripts', array( $this, 'frontend_scripts' ) );
add_action( 'sp_venue_show_map', array( $this, 'show_venue_map' ), 10, 5 );
add_action( 'sp_venue_show_map', array( $this, 'show_venue_map' ), 10, 6 );
add_action( 'sp_admin_geocoder_scripts', array( $this, 'admin_geocoder_scripts' ), 10 );
add_action( 'sp_setup_geocoder_scripts', array( $this, 'setup_geocoder_scripts' ), 10 );
add_action( 'sp_setup_venue_geocoder_scripts', array( $this, 'setup_venue_geocoder_scripts' ), 10 );
Expand Down Expand Up @@ -70,7 +70,25 @@ public function admin_scripts() {
* Enqueue admin venue scripts
*/
public function admin_venue_scripts() {
$screen = get_current_screen();
$screen = get_current_screen();

$maptype = get_option( 'sportspress_map_type', 'roadmap' );
$maptype = strtolower( $maptype );
$osm_tile = get_option( 'sportspress_osm_tile_server', '' );
$osm_tile = strtolower( $osm_tile );
$osm_tile = empty( $osm_tile ) ? 'https://tile.openstreetmap.org/{z}/{x}/{y}.png' : $osm_tile;
$osm_attribution = get_option( 'sportspress_osm_attribution', '' );
$osm_attribution = empty( $osm_attribution ) ? 'Map data &copy; <a href="https://www.openstreetmap.org/">OpenStreetMap</a> contributors' : $osm_attribution;
if ( 'satellite' === $maptype ) {
$osm_tile = 'https://server.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer/tile/{z}/{y}/{x}';
$osm_attribution = 'Tiles &copy; Esri &mdash; Source: Esri, i-cubed, USDA, USGS, AEX, GeoEye, Getmapping, Aerogrid, IGN, IGP, UPR-EGP, and the GIS User Community';
}
Comment on lines +75 to +85

@e1mo e1mo Nov 7, 2022

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deduplicating this and themes/venue-map.php would probably be a good idea. Tho I'm not sure how this could be done in the most elegant fashion.

$osm_config = [
'tile_server' => $osm_tile,
'attribution' => $osm_attribution,
];



if ( in_array( $screen->id, sp_get_screen_ids() ) ) {
wp_enqueue_style( 'leaflet_stylesheet', SP()->plugin_url() . '/assets/css/leaflet.css', array(), '1.8.0' );
Expand All @@ -81,6 +99,7 @@ public function admin_venue_scripts() {
wp_register_script( 'leaflet_js', SP()->plugin_url() . '/assets/js/leaflet.js', array(), '1.8.0' );
wp_register_script( 'control-geocoder', SP()->plugin_url() . '/assets/js/Control.Geocoder.min.js', array( 'leaflet_js' ), '1.13.0' );
wp_register_script( 'sportspress-admin-geocoder', SP()->plugin_url() . '/assets/js/admin/sp-geocoder.js', array( 'leaflet_js', 'control-geocoder' ), SP_VERSION, true );
wp_localize_script( 'sportspress-admin-geocoder', 'sp_osm_settings', $osm_config );
}

if ( in_array( $screen->id, array( 'edit-sp_venue' ) ) ) {
Expand Down Expand Up @@ -113,7 +132,7 @@ public function frontend_venue_scripts() {
*
* @return mix
*/
public function show_venue_map( $latitude, $longitude, $address, $zoom, $maptype ) {
public function show_venue_map( $latitude, $longitude, $address, $zoom, $osm_tile, $osm_attribution ) {
$lat = abs( $latitude );
$lat_deg = floor( $lat );
$lat_sec = ( $lat - $lat_deg ) * 3600;
Expand All @@ -136,17 +155,10 @@ public function show_venue_map( $latitude, $longitude, $address, $zoom, $maptype
// initialize map
map = L.map('sp_openstreetmaps_container', { zoomControl:false }).setView([lat, lon], <?php echo esc_attr( $zoom ); ?>);
// set map tiles source
<?php if ( 'satellite' === $maptype ) { ?>
L.tileLayer('https://server.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer/tile/{z}/{y}/{x}', {
attribution: 'Tiles &copy; Esri &mdash; Source: Esri, i-cubed, USDA, USGS, AEX, GeoEye, Getmapping, Aerogrid, IGN, IGP, UPR-EGP, and the GIS User Community',
maxZoom: 18,
}).addTo(map);
<?php } else { ?>
L.tileLayer('https://tile.openstreetmap.org/{z}/{x}/{y}.png', {
attribution: 'Map data &copy; <a href="https://www.openstreetmap.org/">OpenStreetMap</a> contributors',
L.tileLayer('<?php echo htmlspecialchars($osm_tile); ?>', {
attribution: '<?php echo $osm_attribution ?>',
maxZoom: 18,
}).addTo(map);
<?php } ?>
// add marker to the map
marker = L.marker([lat, lon]).addTo(map);
map.dragging.disable();
Expand Down
13 changes: 10 additions & 3 deletions templates/venue-map.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,23 @@
$zoom = get_option( 'sportspress_map_zoom', 15 );
$maptype = get_option( 'sportspress_map_type', 'roadmap' );
$maptype = strtolower( $maptype );
$osm_tile = get_option( 'sportspress_osm_tile_server', '' );
$osm_tile = strtolower( $osm_tile );
$osm_tile = empty( $osm_tile ) ? 'https://tile.openstreetmap.org/{z}/{x}/{y}.png' : $osm_tile;
$osm_attribution = get_option( 'sportspress_osm_attribution', '' );
$osm_attribution = empty( $osm_attribution ) ? 'Map data &copy; <a href="https://www.openstreetmap.org/">OpenStreetMap</a> contributors' : $osm_attribution;

if ( '' === $address ) {
$address = '+';
}
if ( 'satellite' !== $maptype ) {
$maptype = 'roadmap';
if ( 'satellite' === $maptype ) {
$osm_tile = 'https://server.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer/tile/{z}/{y}/{x}';
$osm_attribution = 'Tiles &copy; Esri &mdash; Source: Esri, i-cubed, USDA, USGS, AEX, GeoEye, Getmapping, Aerogrid, IGN, IGP, UPR-EGP, and the GIS User Community';
}


if ( $latitude != null && $longitude != null ) {
do_action( 'sp_venue_show_map', $latitude, $longitude, $address, $zoom, $maptype );
do_action( 'sp_venue_show_map', $latitude, $longitude, $address, $zoom, $osm_tile, $osm_attribution );
}
if ( is_tax( 'sp_venue' ) ) {
do_action( 'sportspress_after_venue_map' );
Expand Down