explain results for Geocode::lookup()

[nominatim.git] / lib / Geocode.php

diff --git a/lib/Geocode.php b/lib/Geocode.php
index 4d0c48656cf1c10ddaba056a7618524b349e4bf1..91f828fab50f493fe52e646a902ed097528e5f6f 100644 (file)
--- a/lib/Geocode.php
+++ b/lib/Geocode.php
@@ -43,6 +43,11 @@
                        $this->oDB =& $oDB;
                }
 
+               function setReverseInPlan($bReverse)
+               {
+                       $this->bReverseInPlan = $bReverse;
+               }
+
                function setLanguagePreference($aLangPref)
                {
                        $this->aLangPrefOrder = $aLangPref;
@@ -190,17 +195,17 @@
                        return $this->sQuery;
                }
 
-               function loadStructuredAddressElement(&$aStructuredQuery, &$iMinAddressRank, &$iMaxAddressRank, &$aAddressRankList, $sValue, $sKey, $iNewMinAddressRank, $iNewMaxAddressRank, $aItemListValues)
+               function loadStructuredAddressElement($sValue, $sKey, $iNewMinAddressRank, $iNewMaxAddressRank, $aItemListValues)
                {
                        $sValue = trim($sValue);
                        if (!$sValue) return false;
-                       $aStructuredQuery[$sKey] = $sValue;
-                       if ($iMinAddressRank == 0 && $iMaxAddressRank == 30)
+                       $this->aStructuredQuery[$sKey] = $sValue;
+                       if ($this->iMinAddressRank == 0 && $this->iMaxAddressRank == 30)
                        {
-                               $iMinAddressRank = $iNewMinAddressRank;
-                               $iMaxAddressRank = $iNewMaxAddressRank;
+                               $this->iMinAddressRank = $iNewMinAddressRank;
+                               $this->iMaxAddressRank = $iNewMaxAddressRank;
                        }
-                       if ($aItemListValues) $aAddressRankList = array_merge($aAddressRankList, $aItemListValues);
+                       if ($aItemListValues) $this->aAddressRankList = array_merge($this->aAddressRankList, $aItemListValues);
                        return true;
                }
 
@@ -211,13 +216,13 @@
                        $this->aStructuredQuery = array();
                        $this->sAllowedTypesSQLList = '';
 
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sAmentiy, 'amenity', 26, 30, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sStreet, 'street', 26, 30, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sCity, 'city', 14, 24, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sCounty, 'county', 9, 13, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sState, 'state', 8, 8, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sCountry, 'country', 4, 4, false);
-                       $this->loadStructuredAddressElement($this->aStructuredQuery, $this->iMinAddressRank, $this->iMaxAddressRank, $this->aAddressRankList, $sPostalCode, 'postalcode' , 5, 11, array(5, 11));
+                       $this->loadStructuredAddressElement($sAmentiy, 'amenity', 26, 30, false);
+                       $this->loadStructuredAddressElement($sStreet, 'street', 26, 30, false);
+                       $this->loadStructuredAddressElement($sCity, 'city', 14, 24, false);
+                       $this->loadStructuredAddressElement($sCounty, 'county', 9, 13, false);
+                       $this->loadStructuredAddressElement($sState, 'state', 8, 8, false);
+                       $this->loadStructuredAddressElement($sPostalCode, 'postalcode' , 5, 11, array(5, 11));
+                       $this->loadStructuredAddressElement($sCountry, 'country', 4, 4, false);
 
                        if (sizeof($this->aStructuredQuery) > 0) 
                        {
@@ -304,6 +309,36 @@
                        return $aSearchResults;
                }
 
+        /* Perform the actual query lookup.
+
+           Returns an ordered list of results, each with the following fields:
+              osm_type:   type of corresponding OSM object
+                            N - node
+                            W - way
+                            R - relation
+                            P - postcode (internally computed)
+              osm_id: id of corresponding OSM object
+              class: general object class (corresponds to tag key of primary OSM tag)
+              type: subclass of object (corresponds to tag value of primary OSM tag)
+              admin_level:  see http://wiki.openstreetmap.org/wiki/Admin_level
+              rank_search:  rank in search hierarchy
+                            (see also http://wiki.openstreetmap.org/wiki/Nominatim/Development_overview#Country_to_street_level)
+              rank_address: rank in address hierarchy (determines orer in address)
+              place_id: internal key (may differ between different instances)
+              country_code: ISO country code
+              langaddress: localized full address
+              placename: localized name of object
+              ref: content of ref tag (if available)
+              lon: longitude
+              lat: latitude
+              importance: importance of place based on Wikipedia link count
+              addressimportance: cumulated importance of address elements
+              extra_place: type of place (for admin boundaries, if there is a place tag)
+              aBoundingBox: bounding Box
+              label: short description of the object class/type (English only) 
+              name: full name (currently the same as langaddress)
+              foundorder: further ordering value for places with same importance
+         */
                function lookup()
                {
                        if (!$this->sQuery && !$this->aStructuredQuery) return false;