]> git.openstreetmap.org Git - nominatim.git/blob - lib-php/AddressDetails.php
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / lib-php / AddressDetails.php
1 <?php
2
3 namespace Nominatim;
4
5 require_once(CONST_LibDir.'/ClassTypes.php');
6
7 /**
8  * Detailed list of address parts for a single result
9  */
10 class AddressDetails
11 {
12     private $iPlaceID;
13     private $aAddressLines;
14
15     public function __construct(&$oDB, $iPlaceID, $sHousenumber, $mLangPref)
16     {
17         $this->iPlaceID = $iPlaceID;
18
19         if (is_array($mLangPref)) {
20             $mLangPref = $oDB->getArraySQL($oDB->getDBQuotedList($mLangPref));
21         }
22
23         if (!isset($sHousenumber)) {
24             $sHousenumber = -1;
25         }
26
27         $sSQL = 'SELECT *,';
28         $sSQL .= ' get_name_by_language(name,'.$mLangPref.') as localname';
29         $sSQL .= ' FROM get_addressdata('.$iPlaceID.','.$sHousenumber.')';
30         $sSQL .= ' ORDER BY rank_address DESC, isaddress DESC';
31
32         $this->aAddressLines = $oDB->getAll($sSQL);
33     }
34
35     private static function isAddress($aLine)
36     {
37         return $aLine['isaddress'] || $aLine['type'] == 'country_code';
38     }
39
40     public function getAddressDetails($bAll = false)
41     {
42         if ($bAll) {
43             return $this->aAddressLines;
44         }
45
46         return array_filter($this->aAddressLines, array(__CLASS__, 'isAddress'));
47     }
48
49     public function getLocaleAddress()
50     {
51         $aParts = array();
52         $sPrevResult = '';
53
54         foreach ($this->aAddressLines as $aLine) {
55             if ($aLine['isaddress'] && $sPrevResult != $aLine['localname']) {
56                 $sPrevResult = $aLine['localname'];
57                 $aParts[] = $sPrevResult;
58             }
59         }
60
61         return join(', ', $aParts);
62     }
63
64     public function getAddressNames($sCountry = null)
65     {
66         $aAddress = array();
67
68         foreach ($this->aAddressLines as $aLine) {
69             if (!self::isAddress($aLine)) {
70                 continue;
71             }
72
73             $sTypeLabel = ClassTypes\getLabelTag($aLine);
74
75             $sName = null;
76             if (isset($aLine['localname']) && $aLine['localname']!=='') {
77                 $sName = $aLine['localname'];
78             } elseif (isset($aLine['housenumber']) && $aLine['housenumber']!=='') {
79                 $sName = $aLine['housenumber'];
80             }
81
82             if (isset($sName)) {
83                 $sTypeLabel = strtolower(str_replace(' ', '_', $sTypeLabel));
84                 if (!isset($aAddress[$sTypeLabel])
85                     || $aLine['class'] == 'place'
86                 ) {
87                     $aAddress[$sTypeLabel] = $sName;
88                 }
89             }
90         }
91
92         return $aAddress;
93     }
94
95     /**
96      * Annotates the given json with geocodejson address information fields.
97      *
98      * @param array  $aJson  Json hash to add the fields to.
99      *
100      * Geocodejson has the following fields:
101      *  street, locality, postcode, city, district,
102      *  county, state, country
103      *
104      * Postcode and housenumber are added by type, district is not used.
105      * All other fields are set according to address rank.
106      */
107     public function addGeocodeJsonAddressParts(&$aJson)
108     {
109         foreach (array_reverse($this->aAddressLines) as $aLine) {
110             if (!$aLine['isaddress']) {
111                 continue;
112             }
113
114             if (!isset($aLine['localname']) || $aLine['localname'] == '') {
115                 continue;
116             }
117
118             if ($aLine['type'] == 'postcode' || $aLine['type'] == 'postal_code') {
119                 $aJson['postcode'] = $aLine['localname'];
120                 continue;
121             }
122
123             if ($aLine['type'] == 'house_number') {
124                 $aJson['housenumber'] = $aLine['localname'];
125                 continue;
126             }
127
128             if ($this->iPlaceID == $aLine['place_id']) {
129                 continue;
130             }
131
132             $iRank = (int)$aLine['rank_address'];
133
134             if ($iRank > 25 && $iRank < 28) {
135                 $aJson['street'] = $aLine['localname'];
136             } elseif ($iRank >= 22 && $iRank <= 25) {
137                 $aJson['locality'] = $aLine['localname'];
138             } elseif ($iRank >= 17 && $iRank <= 21) {
139                 $aJson['district'] = $aLine['localname'];
140             } elseif ($iRank >= 13 && $iRank <= 16) {
141                 $aJson['city'] = $aLine['localname'];
142             } elseif ($iRank >= 10 && $iRank <= 12) {
143                 $aJson['county'] = $aLine['localname'];
144             } elseif ($iRank >= 5 && $iRank <= 9) {
145                 $aJson['state'] = $aLine['localname'];
146             } elseif ($iRank == 4) {
147                 $aJson['country'] = $aLine['localname'];
148             }
149         }
150     }
151
152     public function getAdminLevels()
153     {
154         $aAddress = array();
155         foreach (array_reverse($this->aAddressLines) as $aLine) {
156             if (self::isAddress($aLine)
157                 && isset($aLine['admin_level'])
158                 && $aLine['admin_level'] < 15
159                 && !isset($aAddress['level'.$aLine['admin_level']])
160             ) {
161                 $aAddress['level'.$aLine['admin_level']] = $aLine['localname'];
162             }
163         }
164         return $aAddress;
165     }
166
167     public function debugInfo()
168     {
169         return $this->aAddressLines;
170     }
171 }