location.php 5.31 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Class for locations
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Location
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2009 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET') && !defined('LACONICA')) {
    exit(1);
}

/**
 * class for locations
 *
37 38 39 40
 * These are stored in the DB as part of notice and profile records,
 * but since they're about the same in both, we have a separate class
 * for them.
 *
Evan Prodromou's avatar
Evan Prodromou committed
41 42 43 44 45 46 47 48 49
 * @category Location
 * @package  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */

class Location
{
50 51 52 53 54
    public  $lat;
    public  $lon;
    public  $location_id;
    public  $location_ns;
    private $_url;
Craig Andrews's avatar
Craig Andrews committed
55
    private $_rdfurl;
Evan Prodromou's avatar
Evan Prodromou committed
56

57
    var $names = array();
Evan Prodromou's avatar
Evan Prodromou committed
58

59 60 61 62 63 64 65 66
    /**
     * Constructor that makes a Location from a string name
     *
     * @param string $name     Human-readable name (any kind)
     * @param string $language Language, default = common_language()
     *
     * @return Location Location with that name (or null if not found)
     */
67

68
    static function fromName($name, $language=null)
Evan Prodromou's avatar
Evan Prodromou committed
69 70 71 72
    {
        if (is_null($language)) {
            $language = common_language();
        }
73 74 75

        $location = null;

76
        // Let a third-party handle it
77

78
        Event::handle('LocationFromName', array($name, $language, &$location));
79 80 81 82

        return $location;
    }

83 84 85 86 87 88 89 90 91 92 93
    /**
     * Constructor that makes a Location from an ID
     *
     * @param integer $id       Identifier ID
     * @param integer $ns       Namespace of the identifier
     * @param string  $language Language to return name in (default is common)
     *
     * @return Location The location with this ID (or null if none)
     */

    static function fromId($id, $ns, $language=null)
94
    {
Evan Prodromou's avatar
Evan Prodromou committed
95 96 97 98
        if (is_null($language)) {
            $language = common_language();
        }

99
        $location = null;
100 101 102 103

        // Let a third-party handle it

        Event::handle('LocationFromId', array($id, $ns, $language, &$location));
104 105

        return $location;
Evan Prodromou's avatar
Evan Prodromou committed
106 107
    }

108 109 110 111 112 113 114 115 116 117 118
    /**
     * Constructor that finds the nearest location to a lat/lon pair
     *
     * @param float  $lat      Latitude
     * @param float  $lon      Longitude
     * @param string $language Language for results, default = current
     *
     * @return Location the location found, or null if none found
     */

    static function fromLatLon($lat, $lon, $language=null)
Evan Prodromou's avatar
Evan Prodromou committed
119
    {
120 121
        if (is_null($language)) {
            $language = common_language();
Evan Prodromou's avatar
Evan Prodromou committed
122
        }
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138

        $location = null;

        // Let a third-party handle it

        if (Event::handle('LocationFromLatLon',
                          array($lat, $lon, $language, &$location))) {
            // Default is just the lat/lon pair

            $location = new Location();

            $location->lat = $lat;
            $location->lon = $lon;
        }

        return $location;
Evan Prodromou's avatar
Evan Prodromou committed
139 140
    }

141 142 143 144 145 146 147 148
    /**
     * Get the name for this location in the given language
     *
     * @param string $language language to use, default = current
     *
     * @return string location name or null if not found
     */

Evan Prodromou's avatar
Evan Prodromou committed
149 150 151 152 153 154
    function getName($language=null)
    {
        if (is_null($language)) {
            $language = common_language();
        }

155
        if (array_key_exists($language, $this->names)) {
Evan Prodromou's avatar
Evan Prodromou committed
156
            return $this->names[$language];
157 158 159 160 161 162 163
        } else {
            $name = null;
            Event::handle('LocationNameLanguage', array($this, $language, &$name));
            if (!empty($name)) {
                $this->names[$language] = $name;
                return $name;
            }
Evan Prodromou's avatar
Evan Prodromou committed
164 165
        }
    }
166 167 168 169 170 171 172 173 174

    /**
     * Get an URL suitable for this location
     *
     * @return string URL for this location or NULL
     */

    function getURL()
    {
Evan Prodromou's avatar
Evan Prodromou committed
175 176 177
        // Keep one cached

        if (is_string($this->_url)) {
178 179 180 181 182 183 184
            return $this->_url;
        }

        $url = null;

        Event::handle('LocationUrl', array($this, &$url));

Evan Prodromou's avatar
Evan Prodromou committed
185
        $this->_url = $url;
186

Evan Prodromou's avatar
Evan Prodromou committed
187
        return $url;
188
    }
Craig Andrews's avatar
Craig Andrews committed
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

    /**
     * Get an URL for this location, suitable for embedding in RDF
     *
     * @return string URL for this location or NULL
     */

    function getRdfURL()
    {
        // Keep one cached

        if (is_string($this->_rdfurl)) {
            return $this->_rdfurl;
        }

        $url = null;

        Event::handle('LocationRdfUrl', array($this, &$url));

        $this->_rdfurl = $url;

        return $url;
    }
Evan Prodromou's avatar
Evan Prodromou committed
212
}