Multiple locations per item

controllers/MapController.php

@@ -9,30 +9,34 @@ public function init()
 
     public function browseAction()
     {
-        $table = $this->_helper->db->getTable();
-        $locationTable = $this->_helper->db->getTable('Location');
+        [$params, $limit, $currentPage] = $this->_getBrowseParams();
 
+        $this->view->totalItems = $this->_helper->db->getTable()->count($params);
+        $this->view->params = $params;
+
+        Zend_Registry::set('pagination', [
+            'page' => $currentPage,
+            'per_page' => $limit,
+            'total_results' => $this->view->totalItems,
+        ]);
+    }
+
+    public function browseJsonAction()
+    {
+        [$params, $limit, $currentPage] = $this->_getBrowseParams();
+
+        $items = $this->_helper->db->getTable()->findBy($params, $limit, $currentPage);
+        $this->view->items = $items;
+        $this->view->locations = $this->_helper->db->getTable('Location')->findLocationsByItem($items);
+        $this->getResponse()->setHeader('Content-Type', 'application/json');
+    }
+
+    private function _getBrowseParams()
+    {
         $params = $this->getAllParams();
         $params['geolocation-mapped'] = true;
         $limit = (int) get_option('geolocation_per_page');
         $currentPage = $this->getParam('page', 1);
-
-        // Only get pagination data for the "normal" page, only get
-        // item/location data for the KML output.
-        if ($this->_helper->contextSwitch->getCurrentContext() == 'kml') {
-            $items = $table->findBy($params, $limit, $currentPage);
-            $this->view->items = $items;
-            $this->view->locations = $locationTable->findLocationByItem($items);
-        } else {
-            $this->view->totalItems = $table->count($params);
-            $this->view->params = $params;
-
-            $pagination = [
-                'page' => $currentPage,
-                'per_page' => $limit,
-                'total_results' => $this->view->totalItems,
-            ];
-            Zend_Registry::set('pagination', $pagination);
-        }
+        return [$params, $limit, $currentPage];
     }
 }

models/Api/Location.php

@@ -25,8 +25,8 @@ public function getRepresentation(Omeka_Record_AbstractRecord $record)
             'latitude' => $record->latitude,
             'longitude' => $record->longitude,
             'zoom_level' => $record->zoom_level,
-            'map_type' => $record->map_type,
             'address' => $record->address,
+            'label' => $record->label,
             'item' => [
                 'id' => $record->item_id,
                 'url' => $this->getResourceUrl("/items/{$record->item_id}"),
@@ -47,25 +47,7 @@ public function setPostData(Omeka_Record_AbstractRecord $record, $data)
         if (isset($data->item->id)) {
             $record->item_id = $data->item->id;
         }
-        if (isset($data->latitude)) {
-            $record->latitude = $data->latitude;
-        }
-        if (isset($data->longitude)) {
-            $record->longitude = $data->longitude;
-        }
-        if (isset($data->zoom_level)) {
-            $record->zoom_level = $data->zoom_level;
-        }
-        if (isset($data->map_type)) {
-            $record->map_type = $data->map_type;
-        } else {
-            $record->map_type = '';
-        }
-        if (isset($data->address)) {
-            $record->address = $data->address;
-        } else {
-            $record->address = '';
-        }
+        $this->_applyLocationFields($record, $data);
     }
 
     /**
@@ -75,6 +57,11 @@ public function setPostData(Omeka_Record_AbstractRecord $record, $data)
      * @param mixed $data
      */
     public function setPutData(Omeka_Record_AbstractRecord $record, $data)
+    {
+        $this->_applyLocationFields($record, $data);
+    }
+
+    private function _applyLocationFields(Omeka_Record_AbstractRecord $record, $data)
     {
         if (isset($data->latitude)) {
             $record->latitude = $data->latitude;
@@ -85,15 +72,15 @@ public function setPutData(Omeka_Record_AbstractRecord $record, $data)
         if (isset($data->zoom_level)) {
             $record->zoom_level = $data->zoom_level;
         }
-        if (isset($data->map_type)) {
-            $record->map_type = $data->map_type;
-        } else {
-            $record->map_type = '';
-        }
         if (isset($data->address)) {
             $record->address = $data->address;
         } else {
             $record->address = '';
         }
+        if (isset($data->label)) {
+            $record->label = $data->label;
+        } else {
+            $record->label = '';
+        }
     }
 }

models/Location.php

@@ -10,20 +10,20 @@ class Location extends Omeka_Record_AbstractRecord implements Zend_Acl_Resource_
     public $latitude;
     public $longitude;
     public $zoom_level;
-    public $map_type;
     public $address;
+    public $label;
 
     /**
      * Executes before the record is saved.
      */
     protected function beforeSave($args)
     {
-        if (is_null($this->map_type)) {
-            $this->map_type = '';
-        }
         if (is_null($this->address)) {
             $this->address = '';
         }
+        if (is_null($this->label)) {
+            $this->label = '';
+        }
     }
 
     /**
@@ -38,18 +38,13 @@ protected function _validate()
         if (!$this->getTable('Item')->exists($this->item_id)) {
             $this->addError('item_id', __('Location requires a valid item ID.'));
         }
-        // An item can only have one location. This assumes that updating an
-        // existing location will never modify the item ID.
-        if (!$this->exists() && $this->getTable()->findBy(['item_id' => $this->item_id])) {
-            $this->addError('latitude', __('A location already exists for the provided item.'));
-        }
-        if (empty($this->latitude)) {
+        if (!is_numeric($this->latitude)) {
             $this->addError('latitude', __('Location requires a latitude.'));
         }
-        if (empty($this->longitude)) {
+        if (!is_numeric($this->longitude)) {
             $this->addError('longitude', __('Location requires a longitude.'));
         }
-        if (empty($this->zoom_level)) {
+        if (!is_numeric($this->zoom_level)) {
             $this->addError('zoom_level', __('Location requires a zoom level.'));
         }
     }

models/Table/Location.php

@@ -2,12 +2,12 @@
 class Table_Location extends Omeka_Db_Table
 {
     /**
-     * Returns a location (or array of locations) for an item (or array of items)
-     * @param array|Item|int $item An item or item id, or an array of items or item ids
-     * @param boolean $findOnlyOne Whether or not to return only one location if it exists for the item
-     * @return array|Location A location or an array of locations
-     **/
-    public function findLocationByItem($item, $findOnlyOne = false)
+     * Returns all locations for an item or array of items, grouped by item_id.
+     *
+     * @param array|Item|int $item
+     * @return array item_id => Location[]
+     */
+    public function findLocationsByItem($item)
     {
         $db = get_db();
 
@@ -16,11 +16,10 @@ public function findLocationByItem($item, $findOnlyOne = false)
         } elseif (is_array($item) && !count($item)) {
             return [];
         }
+
         $alias = $this->getTableAlias();
-        // Create a SELECT statement for the Location table
         $select = $db->select()->from([$alias => $db->Location], "$alias.*");
 
-        // Create a WHERE condition that will pull down all the location info
         if (is_array($item)) {
             $itemIds = [];
             foreach ($item as $it) {
@@ -32,31 +31,20 @@ public function findLocationByItem($item, $findOnlyOne = false)
             $select->where("$alias.item_id = ?", $itemId);
         }
 
-        // If only a single location is request, return the first one found.
-        if ($findOnlyOne) {
-            $location = $this->fetchObject($select);
-            return $location;
-        }
-
-        // Get the locations.
         $locations = $this->fetchObjects($select);
-
-        // Return an associative array of locations where the key is the item_id of the location
-        // Note: Since each item can only have one location, this makes sense to associate a single location with a single item_id.
-        // However, if in the future, an item can have multiple locations, then we cannot just associate a single location with a single item_id;
-        // Instead, in the future, we would have to associate an array of locations with a single item_id.
-        $indexedLocations = [];
-        foreach ($locations as $k => $loc) {
-            $indexedLocations[$loc['item_id']] = $loc;
+        $grouped = [];
+        foreach ($locations as $loc) {
+            $grouped[$loc->item_id][] = $loc;
         }
-        return $indexedLocations;
+        return $grouped;
     }
 
     /**
-     * Add permission check to location queries.
+     * Join items so that public permissions on items are enforced for locations.
      *
-     * Since all locations belong to an item we can override this method to join
-     * the items table and add a permission check to the select object.
+     * Locations have no visibility of their own — a location is public only if
+     * its item is public. Joining the items table here means every query on
+     * this table automatically excludes locations for private items.
      *
      * @return Omeka_Db_Select
      */

plugin.ini

@@ -7,4 +7,4 @@ link="https://omeka.org/classic/docs/Plugins/Geolocation/"
 support_link="https://forum.omeka.org/c/omeka-classic/plugins"
 omeka_minimum_version="2.5"
 omeka_target_version="3.0"
-version="3.3"
+version="4.0"

tests/Geolocation_IntegrationHelper.php

@@ -38,8 +38,6 @@ public function _addPluginHooksAndFilters($pluginBroker, $pluginName)
 
         // Add plugin filters
         add_filter('admin_navigation_main', 'geolocation_admin_nav');
-        add_filter('define_response_contexts', 'geolocation_kml_response_context');
-        add_filter('define_action_contexts', 'geolocation_kml_action_context');
         add_filter('admin_items_form_tabs', 'geolocation_item_form_tabs');
     }
 }

views/helpers/GeolocationMapBrowse.php

@@ -18,8 +18,8 @@ public function geolocationMapBrowse($divId = 'map', $options = [], $attrs = [],
 
         if (!array_key_exists('uri', $options)) {
             // This should not be a link to the public side b/c then all the URLs that
-            // are generated inside the KML will also link to the public side.
-            $options['uri'] = url('geolocation/map.kml');
+            // are generated inside the JSON will also link to the public side.
+            $options['uri'] = url('geolocation/map/browse-json');
         }
 
         if (!array_key_exists('fitMarkers', $options)) {

views/helpers/GeolocationMapOptions.php

@@ -27,6 +27,11 @@ public function geolocationMapOptions($options = [])
 
         $options['custom_map'] = json_decode((string) get_option('geolocation_custom_map'), true);
 
+        $options['strings'] = [
+            'fitAllMarkers' => __('Fit all markers'),
+            'label'         => __('Label'),
+        ];
+
         return js_escape($options);
     }
 

views/helpers/GeolocationMapSingle.php

@@ -2,46 +2,57 @@
 
 class Geolocation_View_Helper_GeolocationMapSingle extends Zend_View_Helper_Abstract
 {
-    public function geolocationMapSingle($item = null, $width = '200px', $height = '200px', $hasBalloonForMarker = false, $markerHtmlClassName = 'geolocation_balloon')
+    public function geolocationMapSingle($item = null, $width = '200px', $height = '200px')
     {
         $divId = "item-map-{$item->id}";
-        $location = get_db()->getTable('Location')->findLocationByItem($item, true);
-        // Only set the center of the map if this item actually has a location
-        // associated with it
-        if ($location) {
-            $center['latitude'] = $location->latitude;
-            $center['longitude'] = $location->longitude;
-            $center['zoomLevel'] = $location->zoom_level;
-            $center['show'] = true;
-            if ($hasBalloonForMarker) {
-                $titleLink = link_to_item(metadata($item, ['Dublin Core', 'Title'], [], $item), [], 'show', $item);
-                $thumbnailLink = !(item_image('thumbnail')) ? '' : link_to_item(item_image('thumbnail', [], 0, $item), [], 'show', $item);
-                $description = metadata($item, ['Dublin Core', 'Description'], ['snippet' => 150], $item);
-                $center['markerHtml'] = '<div class="' . $markerHtmlClassName . '">'
-                                      . '<div class="geolocation_balloon_title">' . $titleLink . '</div>'
-                                      . '<div class="geolocation_balloon_thumbnail">' . $thumbnailLink . '</div>'
-                                      . '<p class="geolocation_balloon_description">' . $description . '</p></div>';
-            }
+        $locations = get_db()->getTable('Location')->findBy(['item_id' => $item->id]);
 
-            $options = [];
-            $options['basemap'] = get_option('geolocation_basemap');
-            $options = $this->view->geolocationMapOptions($options);
-            $center = js_escape($center);
-            $varDivId = Inflector::variablize($divId);
-
-            $style = "width:$width;height:$height";
-            $divAttrs = [
-                'id' => $divId,
-                'class' => 'map geolocation-map',
-                'style' => $style,
-            ];
+        if (empty($locations)) {
+            return '<p class="map-notification">' . __('This item has no location info associated with it.') . '</p>';
+        }
 
-            $html = '<div ' . tag_attributes($divAttrs) .  '></div>';
-            $js = "var $varDivId" . "OmekaMapSingle = new OmekaMapSingle(" . js_escape($divId) . ", $center, $options); ";
-            $html .= "<script type='text/javascript'>$js</script>";
-        } else {
-            $html = '<p class="map-notification">'.__('This item has no location info associated with it.').'</p>';
+        // For single-location items this sets the initial zoom correctly.
+        // For multi-location items fitMarkers() overrides the center after all points are added.
+        $center = [
+            'latitude'  => $locations[0]->latitude,
+            'longitude' => $locations[0]->longitude,
+            'zoomLevel' => $locations[0]->zoom_level,
+        ];
+
+        $points = [];
+        foreach ($locations as $loc) {
+            $point = [
+                'latitude'  => $loc->latitude,
+                'longitude' => $loc->longitude,
+                'zoomLevel' => $loc->zoom_level,
+                'label'     => $loc->label,
+            ];
+            if ($loc->label !== '') {
+                $point['markerHtml'] = '<div class="geolocation_balloon">'
+                                     . '<div class="geolocation_balloon_title">' . html_escape($loc->label) . '</div>'
+                                     . '</div>';
+            }
+            $points[] = $point;
         }
+
+        $options = [];
+        $options['basemap'] = get_option('geolocation_basemap');
+        $options['points'] = $points;
+        $options = $this->view->geolocationMapOptions($options);
+        $center = js_escape($center);
+        $varDivId = Inflector::variablize($divId);
+
+        $style = "width:$width;height:$height";
+        $divAttrs = [
+            'id'    => $divId,
+            'class' => 'map geolocation-map',
+            'style' => $style,
+        ];
+
+        $html = '<div ' . tag_attributes($divAttrs) . '></div>';
+        $js = "var $varDivId" . "OmekaMapSingle = new OmekaMapSingle(" . js_escape($divId) . ", $center, $options); ";
+        $html .= "<script type='text/javascript'>$js</script>";
+
         return $html;
     }
 }

views/shared/css/geolocation-marker.css

@@ -40,6 +40,21 @@ div#geolocation {
     margin-bottom:0px;
 }
 
+.leaflet-control-fit-all a {
+    display: flex !important;
+    align-items: center;
+    justify-content: center;
+    width: 26px;
+    height: 26px;
+    padding: 0;
+}
+
+.leaflet-control-fit-all a svg {
+    width: 14px;
+    height: 14px;
+    flex-shrink: 0;
+}
+
 img.leaflet-tile,
 img.leaflet-marker-icon,
 img.leaflet-marker-shadow {