X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/c02bf4986f4c6a820325727fa4b56e54a63c40d6..4e99f8a3408d59f5c6bf8d934fda7bb3726f2da2:/lib/SearchContext.php

diff --git a/lib/SearchContext.php b/lib/SearchContext.php
index 9bab8658..134b138f 100644
--- a/lib/SearchContext.php
+++ b/lib/SearchContext.php
@@ -34,27 +34,67 @@ class SearchContext
     private $sqlExcludeList = '';
 
 
+    /**
+     * Check if a reference point is defined.
+     *
+     * @return bool True if a reference point is defined.
+     */
     public function hasNearPoint()
     {
         return $this->fNearRadius !== false;
     }
 
+    /**
+     * Get radius around reference point.
+     *
+     * @return float Search radius around refernce point.
+     */
     public function nearRadius()
     {
         return $this->fNearRadius;
     }
 
+    /**
+     * Set search reference point in WGS84.
+     *
+     * If set, then only places around this point will be taken into account.
+     *
+     * @param float $fLat    Latitude of point.
+     * @param float $fLon    Longitude of point.
+     * @param float $fRadius Search radius around point.
+     *
+     * @return void
+     */
     public function setNearPoint($fLat, $fLon, $fRadius = 0.1)
     {
         $this->fNearRadius = $fRadius;
         $this->sqlNear = 'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)';
     }
 
+    /**
+     * Check if the search is geographically restricted.
+     *
+     * Searches are restricted if a reference point is given or if
+     * a bounded viewbox is set.
+     *
+     * @return bool True, if the search is geographically bounded.
+     */
     public function isBoundedSearch()
     {
         return $this->hasNearPoint() || ($this->sqlViewboxSmall && $this->bViewboxBounded);
     }
 
+    /**
+     * Set rectangular viewbox.
+     *
+     * The viewbox may be bounded which means that no search results
+     * must be outside the viewbox.
+     *
+     * @param float[4] $aViewBox Coordinates of the viewbox.
+     * @param bool     $bBounded True if the viewbox is bounded.
+     *
+     * @return void
+     */
     public function setViewboxFromBox(&$aViewBox, $bBounded)
     {
         $this->bViewboxBounded = $bBounded;
@@ -80,6 +120,19 @@ class SearchContext
         );
     }
 
+    /**
+     * Set viewbox along a route.
+     *
+     * The viewbox may be bounded which means that no search results
+     * must be outside the viewbox.
+     *
+     * @param object   $oDB          DB connection to use for computing the box.
+     * @param string[] $aRoutePoints List of x,y coordinates along a route.
+     * @param float    $fRouteWidth  Buffer around the route to use.
+     * @param bool     $bBounded     True if the viewbox bounded.
+     *
+     * @return void
+     */
     public function setViewboxFromRoute(&$oDB, $aRoutePoints, $fRouteWidth, $bBounded)
     {
         $this->bViewboxBounded = $bBounded;
@@ -101,22 +154,36 @@ class SearchContext
         $this->sqlViewboxLarge = "'".$sGeom."'::geometry";
     }
 
+    /**
+     * Set list of excluded place IDs.
+     *
+     * @param integer[] $aExcluded List of IDs.
+     *
+     * @return void
+     */
     public function setExcludeList($aExcluded)
     {
         $this->sqlExcludeList = ' not in ('.join(',', $aExcluded).')';
     }
 
+    /**
+     * Set list of countries to restrict search to.
+     *
+     * @param string[] $aCountries List of two-letter lower-case country codes.
+     *
+     * @return void
+     */
     public function setCountryList($aCountries)
     {
         $this->sqlCountryList = '('.join(',', array_map('addQuotes', $aCountries)).')';
     }
 
     /**
-     * Extract a coordinate point from a query string.
+     * Extract a reference point from a query string.
      *
      * @param string $sQuery Query to scan.
      *
-     * @return The remaining query string.
+     * @return string The remaining query string.
      */
     public function setNearPointFromQuery($sQuery)
     {
@@ -135,16 +202,41 @@ class SearchContext
         return $sQuery;
     }
 
+    /**
+     * Get an SQL snipped for computing the distance from the reference point.
+     *
+     * @param string $sObj SQL variable name to compute the distance from.
+     *
+     * @return string An SQL string.
+     */
     public function distanceSQL($sObj)
     {
         return 'ST_Distance('.$this->sqlNear.", $sObj)";
     }
 
+    /**
+     * Get an SQL snipped for checking if something is within range of the
+     * reference point.
+     *
+     * @param string $sObj SQL variable name to compute if it is within range.
+     *
+     * @return string An SQL string.
+     */
     public function withinSQL($sObj)
     {
         return sprintf('ST_DWithin(%s, %s, %F)', $sObj, $this->sqlNear, $this->fNearRadius);
     }
 
+    /**
+     * Get an SQL snipped of the importance factor of the viewbox.
+     *
+     * The importance factor is computed by checking if an object is within
+     * the viewbox and/or the extended version of the viewbox.
+     *
+     * @param string $sObj SQL variable name of object to weight the importance
+     *
+     * @return string SQL snipped of the factor with a leading multiply sign.
+     */
     public function viewboxImportanceSQL($sObj)
     {
         $sSQL = '';
@@ -159,6 +251,14 @@ class SearchContext
         return $sSQL;
     }
 
+    /**
+     * SQL snipped checking if a place ID should be excluded.
+     *
+     * @param string $sVariable SQL variable name of place ID to check,
+     *                          potentially prefixed with more SQL.
+     *
+     * @return string SQL snippet.
+     */
     public function excludeSQL($sVariable)
     {
         if ($this->sqlExcludeList) {