lib/location.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Class for locations
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Location
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * class for locations
  36  *
  37  * These are stored in the DB as part of notice and profile records,
  38  * but since they're about the same in both, we have a separate class
  39  * for them.
  40  *
  41  * @category Location
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47
  48 class Location
  49 {
  50     public $lat;
  51     public $lon;
  52     public $location_id;
  53     public $location_ns;
  54
  55     var $names = array();
  56
  57     /**
  58      * Constructor that makes a Location from a string name
  59      *
  60      * @param string $name     Human-readable name (any kind)
  61      * @param string $language Language, default = common_language()
  62      *
  63      * @return Location Location with that name (or null if not found)
  64      */
  65
  66     static function fromName($name, $language=null)
  67     {
  68         if (is_null($language)) {
  69             $language = common_language();
  70         }
  71
  72         $location = null;
  73
  74         // Let a third-party handle it
  75
  76         Event::handle('LocationFromName', array($name, $language, &$location));
  77
  78         return $location;
  79     }
  80
  81     /**
  82      * Constructor that makes a Location from an ID
  83      *
  84      * @param integer $id       Identifier ID
  85      * @param integer $ns       Namespace of the identifier
  86      * @param string  $language Language to return name in (default is common)
  87      *
  88      * @return Location The location with this ID (or null if none)
  89      */
  90
  91     static function fromId($id, $ns, $language=null)
  92     {
  93         $location = null;
  94
  95         // Let a third-party handle it
  96
  97         Event::handle('LocationFromId', array($id, $ns, $language, &$location));
  98
  99         return $location;
 100     }
 101
 102     /**
 103      * Constructor that finds the nearest location to a lat/lon pair
 104      *
 105      * @param float  $lat      Latitude
 106      * @param float  $lon      Longitude
 107      * @param string $language Language for results, default = current
 108      *
 109      * @return Location the location found, or null if none found
 110      */
 111
 112     static function fromLatLon($lat, $lon, $language=null)
 113     {
 114         if (is_null($language)) {
 115             $language = common_language();
 116         }
 117
 118         $location = null;
 119
 120         // Let a third-party handle it
 121
 122         if (Event::handle('LocationFromLatLon',
 123                           array($lat, $lon, $language, &$location))) {
 124             // Default is just the lat/lon pair
 125
 126             $location = new Location();
 127
 128             $location->lat = $lat;
 129             $location->lon = $lon;
 130         }
 131
 132         return $location;
 133     }
 134
 135     /**
 136      * Get the name for this location in the given language
 137      *
 138      * @param string $language language to use, default = current
 139      *
 140      * @return string location name or null if not found
 141      */
 142
 143     function getName($language=null)
 144     {
 145         if (is_null($language)) {
 146             $language = common_language();
 147         }
 148
 149         if (array_key_exists($language, $this->names)) {
 150             return $this->names[$language];
 151         } else {
 152             $name = null;
 153             Event::handle('LocationNameLanguage', array($this, $language, &$name));
 154             if (!empty($name)) {
 155                 $this->names[$language] = $name;
 156                 return $name;
 157             }
 158         }
 159     }
 160 }