add documentation for new pytest tests

[nominatim.git] / lib / ParameterParser.php

diff --git a/lib/ParameterParser.php b/lib/ParameterParser.php
index 601bae5b28f922e16709eb831c8a330c8faad431..32a848b93011fce3edaa1975ad6450369b121725 100644 (file)
--- a/lib/ParameterParser.php
+++ b/lib/ParameterParser.php
@@ -1,133 +1,132 @@
 <?php
 
+namespace Nominatim;
+
 class ParameterParser
 {
     private $aParams;
 
-    function __construct($aParams=NULL)
+
+    public function __construct($aParams = null)
     {
-        $this->aParams = ($aParams === NULL) ? $_GET : $aParams;
+        $this->aParams = ($aParams === null) ? $_GET : $aParams;
     }
 
-    function getBool($sName, $bDefault=false)
+    public function getBool($sName, $bDefault = false)
     {
-        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0)
-        {
+        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0) {
             return $bDefault;
         }
 
         return (bool) $this->aParams[$sName];
     }
 
-    function getInt($sName, $bDefault=false)
+    public function getInt($sName, $bDefault = false)
     {
-        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0)
-        {
+        if (!isset($this->aParams[$sName])) {
             return $bDefault;
         }
 
-        if (!preg_match('/^[+-]?[0-9]+$/', $this->aParams[$sName]))
-        {
+        if (!preg_match('/^[+-]?[0-9]+$/', $this->aParams[$sName])) {
             userError("Integer number expected for parameter '$sName'");
         }
 
         return (int) $this->aParams[$sName];
     }
 
-    function getFloat($sName, $bDefault=false)
+    public function getFloat($sName, $bDefault = false)
     {
-        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0)
-        {
+        if (!isset($this->aParams[$sName])) {
             return $bDefault;
         }
 
-        if (!preg_match('/^[+-]?[0-9]*\.?[0-9]+$/', $this->aParams[$sName]))
-        {
+        if (!preg_match('/^[+-]?[0-9]*\.?[0-9]+$/', $this->aParams[$sName])) {
             userError("Floating-point number expected for parameter '$sName'");
         }
 
         return (float) $this->aParams[$sName];
     }
 
-    function getString($sName, $bDefault=false)
+    public function getString($sName, $bDefault = false)
     {
-        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0)
-        {
+        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0) {
             return $bDefault;
         }
 
         return $this->aParams[$sName];
     }
 
-    function getSet($sName, $aValues, $sDefault=false)
+    public function getSet($sName, $aValues, $sDefault = false)
     {
-        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0)
-        {
+        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0) {
             return $sDefault;
         }
 
-        if (!in_array($this->aParams[$sName], $aValues))
-        {
+        if (!in_array($this->aParams[$sName], $aValues)) {
             userError("Parameter '$sName' must be one of: ".join(', ', $aValues));
         }
 
         return $this->aParams[$sName];
     }
 
-    function getStringList($sName, $aDefault=false)
+    public function getStringList($sName, $aDefault = false)
     {
         $sValue = $this->getString($sName);
 
-        if ($sValue)
-        {
-            return explode(',', $sValue);
+        if ($sValue) {
+            // removes all NULL, FALSE and Empty Strings but leaves 0 (zero) values
+            return array_values(array_filter(explode(',', $sValue), 'strlen'));
         }
 
         return $aDefault;
     }
 
-    function getPreferredLanguages($sFallback=NULL)
+    public function getPreferredLanguages($sFallback = null)
     {
-        if ($sFallback === NULL && isset($_SERVER["HTTP_ACCEPT_LANGUAGE"]))
-        {
-            $sFallback = $_SERVER["HTTP_ACCEPT_LANGUAGE"];
+        if ($sFallback === null && isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
+            $sFallback = $_SERVER['HTTP_ACCEPT_LANGUAGE'];
         }
 
         $aLanguages = array();
         $sLangString = $this->getString('accept-language', $sFallback);
 
-        if ($sLangString)
-        {
-            if (preg_match_all('/(([a-z]{1,8})(-[a-z]{1,8})?)\s*(;\s*q\s*=\s*(1|0\.[0-9]+))?/i', $sLangString, $aLanguagesParse, PREG_SET_ORDER))
-            {
-                foreach($aLanguagesParse as $iLang => $aLanguage)
-                {
+        if ($sLangString) {
+            if (preg_match_all('/(([a-z]{1,8})([-_][a-z]{1,8})?)\s*(;\s*q\s*=\s*(1|0\.[0-9]+))?/i', $sLangString, $aLanguagesParse, PREG_SET_ORDER)) {
+                foreach ($aLanguagesParse as $iLang => $aLanguage) {
                     $aLanguages[$aLanguage[1]] = isset($aLanguage[5])?(float)$aLanguage[5]:1 - ($iLang/100);
                     if (!isset($aLanguages[$aLanguage[2]])) $aLanguages[$aLanguage[2]] = $aLanguages[$aLanguage[1]]/10;
                 }
                 arsort($aLanguages);
             }
         }
-        if (!sizeof($aLanguages) && CONST_Default_Language)
-        {
+        if (empty($aLanguages) && CONST_Default_Language) {
             $aLanguages[CONST_Default_Language] = 1;
         }
 
-        foreach($aLanguages as $sLanguage => $fLanguagePref)
-        {
-            $aLangPrefOrder['short_name:'.$sLanguage] = 'short_name:'.$sLanguage;
+        foreach ($aLanguages as $sLanguage => $fLanguagePref) {
             $aLangPrefOrder['name:'.$sLanguage] = 'name:'.$sLanguage;
         }
-        $aLangPrefOrder['short_name'] = 'short_name';
         $aLangPrefOrder['name'] = 'name';
         $aLangPrefOrder['brand'] = 'brand';
-        foreach($aLanguages as $sLanguage => $fLanguagePref)
-        {
+        foreach ($aLanguages as $sLanguage => $fLanguagePref) {
             $aLangPrefOrder['official_name:'.$sLanguage] = 'official_name:'.$sLanguage;
+            $aLangPrefOrder['short_name:'.$sLanguage] = 'short_name:'.$sLanguage;
         }
         $aLangPrefOrder['official_name'] = 'official_name';
+        $aLangPrefOrder['short_name'] = 'short_name';
         $aLangPrefOrder['ref'] = 'ref';
         $aLangPrefOrder['type'] = 'type';
         return $aLangPrefOrder;
     }
+
+    public function hasSetAny($aParamNames)
+    {
+        foreach ($aParamNames as $sName) {
+            if ($this->getBool($sName)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }