]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/location.php
fix notices in dumpschema
[quix0rs-gnu-social.git] / 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     private $_url;
55     private $_rdfurl;
56
57     var $names = array();
58
59     /**
60      * Constructor that makes a Location from a string name
61      *
62      * @param string $name     Human-readable name (any kind)
63      * @param string $language Language, default = common_language()
64      *
65      * @return Location Location with that name (or null if not found)
66      */
67
68     static function fromName($name, $language=null)
69     {
70         if (is_null($language)) {
71             $language = common_language();
72         }
73
74         $location = null;
75
76         // Let a third-party handle it
77
78         Event::handle('LocationFromName', array($name, $language, &$location));
79
80         return $location;
81     }
82
83     /**
84      * Constructor that makes a Location from an ID
85      *
86      * @param integer $id       Identifier ID
87      * @param integer $ns       Namespace of the identifier
88      * @param string  $language Language to return name in (default is common)
89      *
90      * @return Location The location with this ID (or null if none)
91      */
92
93     static function fromId($id, $ns, $language=null)
94     {
95         if (is_null($language)) {
96             $language = common_language();
97         }
98
99         $location = null;
100
101         // Let a third-party handle it
102
103         Event::handle('LocationFromId', array($id, $ns, $language, &$location));
104
105         return $location;
106     }
107
108     /**
109      * Constructor that finds the nearest location to a lat/lon pair
110      *
111      * @param float  $lat      Latitude
112      * @param float  $lon      Longitude
113      * @param string $language Language for results, default = current
114      *
115      * @return Location the location found, or null if none found
116      */
117
118     static function fromLatLon($lat, $lon, $language=null)
119     {
120         if (is_null($language)) {
121             $language = common_language();
122         }
123
124         $location = null;
125
126         // Let a third-party handle it
127
128         if (Event::handle('LocationFromLatLon',
129                           array($lat, $lon, $language, &$location))) {
130             // Default is just the lat/lon pair
131
132             $location = new Location();
133
134             $location->lat = $lat;
135             $location->lon = $lon;
136         }
137
138         return $location;
139     }
140
141     /**
142      * Get the name for this location in the given language
143      *
144      * @param string $language language to use, default = current
145      *
146      * @return string location name or null if not found
147      */
148
149     function getName($language=null)
150     {
151         if (is_null($language)) {
152             $language = common_language();
153         }
154
155         if (array_key_exists($language, $this->names)) {
156             return $this->names[$language];
157         } else {
158             $name = null;
159             Event::handle('LocationNameLanguage', array($this, $language, &$name));
160             if (!empty($name)) {
161                 $this->names[$language] = $name;
162                 return $name;
163             }
164         }
165     }
166
167     /**
168      * Get an URL suitable for this location
169      *
170      * @return string URL for this location or NULL
171      */
172
173     function getURL()
174     {
175         // Keep one cached
176
177         if (is_string($this->_url)) {
178             return $this->_url;
179         }
180
181         $url = null;
182
183         Event::handle('LocationUrl', array($this, &$url));
184
185         $this->_url = $url;
186
187         return $url;
188     }
189
190     /**
191      * Get an URL for this location, suitable for embedding in RDF
192      *
193      * @return string URL for this location or NULL
194      */
195
196     function getRdfURL()
197     {
198         // Keep one cached
199
200         if (is_string($this->_rdfurl)) {
201             return $this->_rdfurl;
202         }
203
204         $url = null;
205
206         Event::handle('LocationRdfUrl', array($this, &$url));
207
208         $this->_rdfurl = $url;
209
210         return $url;
211     }
212 }