1<?php 2/* 3 * Copyright (c) 2008 Mark C. Prins <mprins@users.sf.net> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 * 17 * @phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps 18 */ 19 20/** 21 * Action for Plugin OL Maps: Allow Display of a OpenLayers Map in a wiki page. 22 * @author Mark Prins 23 */ 24class action_plugin_openlayersmap extends DokuWiki_Action_Plugin 25{ 26 /** 27 * Plugin uses this method to register its handlers with the DokuWiki's event controller. 28 * 29 * @param $controller DokuWiki's event controller object. Also available as global $EVENT_HANDLER 30 */ 31 final public function register(Doku_Event_Handler $controller): void 32 { 33 $controller->register_hook('TOOLBAR_DEFINE', 'AFTER', $this, 'insertButton'); 34 $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'insertCSSSniffer'); 35 $controller->register_hook('PLUGIN_POPULARITY_DATA_SETUP', 'AFTER', $this, 'popularity'); 36 } 37 38 /** 39 * Inserts the toolbar button. 40 * @param Doku_Event $event the DokuWiki event 41 */ 42 final public function insertButton(Doku_Event $event): void 43 { 44 $strOpen = '<olmap id="olMapOne" width="550px" height="450px" lat="50.0" '; 45 $strOpen .= 'lon="5.1" zoom="12" controls="1" '; 46 $strOpen .= 'baselyr="OpenStreetMap" gpxfile="" kmlfile="" geojsonfile="" summary="" >\n'; 47 $strOpen .= '~~ Plugin olmap help.\n'; 48 $strOpen .= '~~ Required in the above tag are values for: id (unique on this page), width, heigth.\n'; 49 $strOpen .= '~~ Also you will want to enter zoomlevel and lat, lon values that make sense for where you'; 50 $strOpen .= '~~ want the map to start.\n\n'; 51 $strOpen .= '~~ Below is an example of a POI, you can add as many as you want. '; 52 $strOpen .= '~~ More examples: https://dokuwiki.org/plugin:openlayersmap \n'; 53 $event->data[] = array( 54 'type' => 'format', 55 'title' => $this->getLang('openlayersmap'), 56 'icon' => '../../plugins/openlayersmap/toolbar/map.png', 57 'open' => $strOpen, 58 'sample' => '50.0117,5.1287,-90,.8,marker-green.png,Pont de Barbouillons; Daverdisse \\\\ external link: 59 [[https://test.com|test.com]] \\\\ internal link: [[::start]]\\\\ **DW Formatting** \n', 60 'close' => '</olmap>\n', 61 ); 62 } 63 64 /** 65 * Add a snippet of javascript into the head to do a css operation we can check for later on. 66 * @param Doku_Event $event the DokuWiki event 67 */ 68 final public function insertCSSSniffer(Doku_Event $event): void 69 { 70 $event->data["script"][] = array("_data" => "document.documentElement.className += ' olCSSsupported';"); 71 } 72 73 /** 74 * Add openlayersmap popularity data. 75 * 76 * @param Doku_Event $event the DokuWiki event 77 */ 78 final public function popularity(Doku_Event $event): void 79 { 80 $versionInfo = getVersionData(); 81 $plugin_info = $this->getInfo(); 82 $event->data['openlayersmap']['version'] = $plugin_info['date']; 83 $event->data['openlayersmap']['dwversion'] = $versionInfo['date']; 84 $event->data['openlayersmap']['combinedversion'] = $versionInfo['date'] . '_' . $plugin_info['date']; 85 } 86} 87
