1<?php
2/*
3 * Copyright (c) 2008-2021 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 * Plugin OL Maps: Allow Display of a OpenLayers Map in a wiki page.
22 * Toolbar button.
23 * @author Mark Prins
24 */
25class action_plugin_openlayersmap extends DokuWiki_Action_Plugin {
26
27    /**
28     * plugin should use this method to register its handlers with the DokuWiki's event controller
29     *
30     * @param    $controller DokuWiki's event controller object. Also available as global $EVENT_HANDLER
31     */
32    public function register(Doku_Event_Handler $controller) {
33        $controller->register_hook('TOOLBAR_DEFINE', 'AFTER', $this, 'insertButton', array());
34        $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'insertCSSSniffer');
35    }
36
37    /**
38     * Inserts the toolbar button.
39     * @param Doku_Event $event the DokuWiki event
40     */
41    public function insertButton(Doku_Event $event, $param) {
42        $strOpen       = '<olmap id="olMapOne" width="550px" height="450px" lat="50.0" ';
43        $strOpen       .= 'lon="5.1" zoom="12" statusbar="1" controls="1" poihoverstyle="0" ';
44        $strOpen       .= 'baselyr="OpenStreetMap" gpxfile="" kmlfile="" geojsonfile="" summary="" >\n';
45        $strOpen       .= '~~ Plugin olmap help.\n';
46        $strOpen       .= '~~ Required in the above tag are values for: id (unique on this page), width, heigth.\n';
47        $strOpen       .= '~~ Also you will want to enter zoomlevel and lat, lon values that make sense for where you';
48        $strOpen       .= '~~ want the map to start.\n\n';
49        $strOpen       .= '~~ Below is an example of a POI, you can add as many as you want. ';
50        $strOpen       .= '~~ More examples: https://dokuwiki.org/plugin:openlayersmap \n';
51        $event->data[] = array(
52            'type'   => 'format',
53            'title'  => $this->getLang('openlayersmap'),
54            'icon'   => '../../plugins/openlayersmap/toolbar/map.png',
55            'open'   => $strOpen,
56            'sample' => '50.0117,5.1287,-90,.8,marker-green.png,Pont de Barbouillons; Daverdisse \\\\ external link:
57                        [[https://test.com|test.com]] \\\\ internal link: [[::start]]\\\\ **DW Formatting** \n',
58            'close'  => '</olmap>\n',
59        );
60    }
61
62    /** add a snippet of javascript into the head to do a css operation we can check for later on.*/
63    public function insertCSSSniffer(Doku_Event $event, $param) {
64        $event->data["script"][] = array(
65            "type"  => "text/javascript",
66            "_data" => "document.documentElement.className += ' olCSSsupported';",
67        );
68    }
69}
70