From: Sarah Hoffmann <lonvia@denofr.de>
Date: Mon, 9 Oct 2017 21:12:13 +0000 (+0200)
Subject: coding style and some documentation
X-Git-Tag: v3.1.0~47^2~1
X-Git-Url: https://git.openstreetmap.org/nominatim.git/commitdiff_plain/c02bf4986f4c6a820325727fa4b56e54a63c40d6

coding style and some documentation
---

diff --git a/lib/Geocode.php b/lib/Geocode.php
index 27c33ad6..e02aae94 100644
--- a/lib/Geocode.php
+++ b/lib/Geocode.php
@@ -846,7 +846,7 @@ class Geocode
                 $this->aRouteWidth,
                 $this->bBoundedSearch
             );
-        } else if ($this->aViewBox) {
+        } elseif ($this->aViewBox) {
             $oCtx->setViewboxFromBox($this->aViewBox, $this->bBoundedSearch);
         }
         if ($this->aExcludePlaceIDs) {
diff --git a/lib/SearchContext.php b/lib/SearchContext.php
index f5eab95a..9bab8658 100644
--- a/lib/SearchContext.php
+++ b/lib/SearchContext.php
@@ -6,7 +6,7 @@ require_once(CONST_BasePath.'/lib/lib.php');
 
 
 /**
- * Collects search constraints that are independent of the
+ * Collection of search constraints that are independent of the
  * actual interpretation of the search query.
  *
  * The search context is shared between all SearchDescriptions. This
@@ -15,16 +15,25 @@ require_once(CONST_BasePath.'/lib/lib.php');
  */
 class SearchContext
 {
+    /// Search radius around a given Near reference point.
     private $fNearRadius = false;
+    /// True if search must be restricted to viewbox only.
     public $bViewboxBounded = false;
 
+    /// Reference point for search (as SQL).
     public $sqlNear = '';
+    /// Viewbox selected for search (as SQL).
     public $sqlViewboxSmall = '';
+    /// Viewbox with a larger buffer around (as SQL).
     public $sqlViewboxLarge = '';
+    /// Reference along a route (as SQL).
     public $sqlViewboxCentre = '';
+    /// List of countries to restrict search to (as SQL).
     public $sqlCountryList = '';
+    /// List of place IDs to exclude (as SQL).
     private $sqlExcludeList = '';
 
+
     public function hasNearPoint()
     {
         return $this->fNearRadius !== false;
@@ -44,7 +53,6 @@ class SearchContext
     public function isBoundedSearch()
     {
         return $this->hasNearPoint() || ($this->sqlViewboxSmall && $this->bViewboxBounded);
-
     }
 
     public function setViewboxFromBox(&$aViewBox, $bBounded)
diff --git a/lib/SearchDescription.php b/lib/SearchDescription.php
index f3afaff2..c287c898 100644
--- a/lib/SearchDescription.php
+++ b/lib/SearchDescription.php
@@ -73,23 +73,6 @@ class SearchDescription
                && preg_match('/[0-9]+/', $this->sHouseNumber);
     }
 
-    private function poiTable()
-    {
-        return 'place_classtype_'.$this->sClass.'_'.$this->sType;
-    }
-
-    public function countryCodeSQL($sVar)
-    {
-        if ($this->sCountryCode) {
-            return $sVar.' = \''.$this->sCountryCode."'";
-        }
-        if ($this->oContext->sqlCountryList) {
-            return $sVar.' in '.$this->oContext->sqlCountryList;
-        }
-
-        return '';
-    }
-
     public function hasOperator()
     {
         return $this->iOperator != Operator::NONE;
@@ -335,6 +318,7 @@ class SearchDescription
 
     /////////// Query functions
 
+
     public function query(&$oDB, &$aWordFrequencyScores, &$aExactMatchCache, $iMinRank, $iMaxRank, $iLimit)
     {
         $aPlaceIDs = array();
@@ -450,7 +434,7 @@ class SearchDescription
             }
             if ($this->oContext->hasNearPoint()) {
                 $sSQL .= ' WHERE '.$this->oContext->withinSQL('ct.centroid');
-            } else if ($this->oContext->bViewboxBounded) {
+            } elseif ($this->oContext->bViewboxBounded) {
                 $sSQL .= ' WHERE ST_Contains('.$this->oContext->sqlViewboxSmall.', ct.centroid)';
             }
             if ($this->oContext->sqlCountryList) {
@@ -869,6 +853,22 @@ class SearchDescription
         return $aClassPlaceIDs;
     }
 
+    private function poiTable()
+    {
+        return 'place_classtype_'.$this->sClass.'_'.$this->sType;
+    }
+
+    private function countryCodeSQL($sVar)
+    {
+        if ($this->sCountryCode) {
+            return $sVar.' = \''.$this->sCountryCode."'";
+        }
+        if ($this->oContext->sqlCountryList) {
+            return $sVar.' in '.$this->oContext->sqlCountryList;
+        }
+
+        return '';
+    }
 
     /////////// Sort functions