3 * StatusNet, the distributed open-source microblogging tool
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.
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.
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/>.
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/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
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
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/
60 * Constructor that makes a Location from Notice::locationOptions(...)
62 * @param array $options an array for example provided by Notice::locationOptions(...)
64 * @return Location Location with the given options (lat, lon, id, name)
66 static function fromOptions(array $options) {
67 $location = new Location();
68 foreach (['lat', 'lon', 'location_id', 'location_ns'] as $opt) {
69 if (isset($options[$opt])) {
70 $location->$opt = $options[$opt];
77 * Constructor that makes a Location from a string name
79 * @param string $name Human-readable name (any kind)
80 * @param string $language Language, default = common_language()
82 * @return Location Location with that name (or null if not found)
85 static function fromName($name, $language=null)
87 if (is_null($language)) {
88 $language = common_language();
93 // Let a third-party handle it
95 Event::handle('LocationFromName', array($name, $language, &$location));
101 * Constructor that makes a Location from an ID
103 * @param integer $id Identifier ID
104 * @param integer $ns Namespace of the identifier
105 * @param string $language Language to return name in (default is common)
107 * @return Location The location with this ID (or null if none)
110 static function fromId($id, $ns, $language=null)
112 if (is_null($language)) {
113 $language = common_language();
118 // Let a third-party handle it
120 Event::handle('LocationFromId', array($id, $ns, $language, &$location));
126 * Constructor that finds the nearest location to a lat/lon pair
128 * @param float $lat Latitude
129 * @param float $lon Longitude
130 * @param string $language Language for results, default = current
132 * @return Location the location found, or null if none found
135 static function fromLatLon($lat, $lon, $language=null)
137 if (is_null($language)) {
138 $language = common_language();
143 // Let a third-party handle it
145 if (Event::handle('LocationFromLatLon',
146 array($lat, $lon, $language, &$location))) {
147 // Default is just the lat/lon pair
149 $location = new Location();
151 $location->lat = $lat;
152 $location->lon = $lon;
159 * Get the name for this location in the given language
161 * @param string $language language to use, default = current
163 * @return string location name or null if not found
166 function getName($language=null)
168 if (is_null($language)) {
169 $language = common_language();
172 if (array_key_exists($language, $this->names)) {
173 return $this->names[$language];
176 Event::handle('LocationNameLanguage', array($this, $language, &$name));
178 $this->names[$language] = $name;
185 * Get an URL suitable for this location
187 * @return string URL for this location or NULL
194 if (is_string($this->_url)) {
200 Event::handle('LocationUrl', array($this, &$url));
208 * Get an URL for this location, suitable for embedding in RDF
210 * @return string URL for this location or NULL
217 if (is_string($this->_rdfurl)) {
218 return $this->_rdfurl;
223 Event::handle('LocationRdfUrl', array($this, &$url));
225 $this->_rdfurl = $url;