lib/plugin/GoogleMaps.php

   1 <?php // -*-php-*-
   2 // rcs_id('$Id$');
   3 /**
   4  * Copyright 2005 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with PhpWiki; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /**
  24  * Uses Google Maps as a Map Server
  25  *
  26  * This plugin displays a marker with further infos (when clicking) on given coordinates.
  27
  28  * Hint: You need to sign up for a Google Maps API key!
  29  *         http://www.google.com/apis/maps/signup.html
  30  *       Then enter the key in config/config.ini under GOOGLE_LICENSE_KEY=
  31  *
  32  * Usage:
  33  *  <?plugin GoogleMaps
  34  *           Latitude=53.053
  35  *             Longitude=7.803
  36  *           ZoomFactor=10
  37  *           Marker=true
  38  *           InfoText=
  39  *           InfoLink=
  40  *           MapType=Map|Satellite|Hybrid
  41  *           width=500px
  42  *           height=400px
  43  *  ?>
  44  *
  45  * @author Reini Urban
  46  *
  47  * @see plugin/GooglePlugin
  48  *      http://www.giswiki.de/index.php/Google_Maps_Extensions
  49  *      http://www.google.com/apis/maps/, http://maps.google.com/
  50  *      http://libgmail.sourceforge.net/googlemaps.html
  51  *
  52  * NOT YET SUPPORTED:
  53  *   Search for keywords (search=)
  54  *   mult. markers would need a new syntax
  55  *   directions (from - to)
  56  *   drawing polygons
  57  *   Automatic route following
  58  */
  59 class WikiPlugin_GoogleMaps
  60 extends WikiPlugin
  61 {
  62     function getName() {
  63         return _("GoogleMaps");
  64     }
  65
  66     function getDescription() {
  67       return _("Displays a marker with further infos (when clicking) on given coordinates");
  68     }
  69
  70     function getDefaultArguments() {
  71         return array(
  72                      'Longitude' =>         '',
  73                      'Latitude'  =>         '',
  74                      'ZoomFactor'=>        5,
  75                      'Marker'    =>        true,
  76                      'InfoText'  =>         '',
  77                      'MapType'   =>          'Hybrid', // Map|Satellite|Hybrid,
  78                      'SmallMapControl' => false,  // large or small
  79                      'width'     =>        '500px',
  80                      'height'    =>        '400px',
  81                     );
  82     }
  83
  84     function run($dbi, $argstr, &$request, $basepage) {
  85         global $WikiTheme;
  86
  87         $args = $this->getArgs($argstr, $request);
  88         extract($args);
  89
  90         if ($Longitude === '') {
  91             return $this->error(fmt("%s parameter missing", "'Longitude'"));
  92         }
  93         if ($Latitude === '') {
  94             return $this->error(fmt("%s parameter missing", "'Latitude'"));
  95         }
  96
  97         $maps = JavaScript('',array('src'=>"http://maps.google.com/maps?file=api&v=1&key=" . GOOGLE_LICENSE_KEY));
  98         $id = GenerateId("googlemap");
  99         switch ($MapType) {
 100         case "Satellite": $type = "_SATELLITE_TYPE"; break;
 101         case "Map":       $type = "_MAP_TYPE"; break;
 102         case "Hybrid":    $type = "_HYBRID_TYPE"; break;
 103         default: return $this->error(sprintf(_("invalid argument %s"), $MapType));
 104         }
 105         $div = HTML::div(array('id'=>$id,'style'=>'width: '.$width.'; height: '.$height));
 106
 107         // TODO: Check for multiple markers or polygons
 108         if (!$InfoText)
 109             $Marker = false;
 110         // Create a marker whose info window displays the given text
 111         if ($Marker) {
 112             if ($InfoText) {
 113                 include_once("lib/BlockParser.php");
 114                 $page = $dbi->getPage($request->getArg('pagename'));
 115                 $rev  = $page->getCurrentRevision(false);
 116                 $markup = $rev->get('markup');
 117                 $markertext = TransformText($InfoText, $markup, $basepage);
 118             }
 119             $markerjs = JavaScript("
 120 function createMarker(point, text) {
 121   var marker = new GMarker(point);
 122   var html = text + \"<br><br><font size='-1'>[" .
 123                                                _("new&nbsp;window") .
 124                                                "]</font>\";
 125   GEvent.addListener(marker, \"click\", function() {marker.openInfoWindowHtml(html);});
 126   return marker;
 127 }");
 128         }
 129
 130         $run = JavaScript("
 131 var map = new GMap(document.getElementById('".$id."'));\n" .
 132 ($SmallMapControl
 133  ? "map.addControl(new GSmallMapControl());\n"
 134  : "map.addControl(new GLargeMapControl());\n") . "
 135 map.addControl(new GMapTypeControl());
 136 map.centerAndZoom(new GPoint(".$Longitude.", ".$Latitude."), ".$ZoomFactor.");
 137 map.setMapType(".$type.");" .
 138 ($Marker
 139  ? "
 140 var point = new GPoint(".$Longitude.",".$Latitude.");
 141 var marker = createMarker(point, '".$markertext->asXml()."'); map.addOverlay(marker);"
 142  : "")
 143 );
 144         if ($Marker)
 145             return HTML($markerjs,$maps,$div,$run);
 146         else
 147             return HTML($maps,$div,$run);
 148     }
 149 };
 150
 151 // (c-file-style: "gnu")
 152 // Local Variables:
 153 // mode: php
 154 // tab-width: 8
 155 // c-basic-offset: 4
 156 // c-hanging-comment-ender-p: nil
 157 // indent-tabs-mode: nil
 158 // End:
 159 ?>