add typing information for postcode formatter

[nominatim.git] / lib-php / TokenSpecialTerm.php

diff --git a/lib-php/TokenSpecialTerm.php b/lib-php/TokenSpecialTerm.php
index 89dfa02619447f78106eb16eb2139e8557c8ab4b..cdd04e6c41dccf6ae8646816849244a1b39b50e0 100644 (file)
--- a/lib-php/TokenSpecialTerm.php
+++ b/lib-php/TokenSpecialTerm.php
@@ -1,4 +1,12 @@
 <?php
 <?php

+/**
+ * SPDX-License-Identifier: GPL-2.0-only
+ *
+ * This file is part of Nominatim. (https://nominatim.org)
+ *
+ * Copyright (C) 2022 by the Nominatim developer community.
+ * For a full list of authors see the git log.
+ */

 
 namespace Nominatim\Token;
 
 
 namespace Nominatim\Token;
 


@@ -10,13 +18,13 @@ require_once(CONST_LibDir.'/SpecialSearchOperator.php');
 class SpecialTerm
 {
     /// Database word id, if applicable.
 class SpecialTerm
 {
     /// Database word id, if applicable.

-    public $iId;
+    private $iId;

     /// Class (or OSM tag key) of the place to look for.
     /// Class (or OSM tag key) of the place to look for.

-    public $sClass;
+    private $sClass;

     /// Type (or OSM tag value) of the place to look for.
     /// Type (or OSM tag value) of the place to look for.

-    public $sType;
+    private $sType;

     /// Relationship of the operator to the object (see Operator class).
     /// Relationship of the operator to the object (see Operator class).

-    public $iOperator;
+    private $iOperator;

 
     public function __construct($iID, $sClass, $sType, $iOperator)
     {
 
     public function __construct($iID, $sClass, $sType, $iOperator)
     {


@@ -31,6 +39,25 @@ class SpecialTerm
         return $this->iId;
     }
 
         return $this->iId;
     }
 

+    /**
+     * Check if the token can be added to the given search.
+     * Derive new searches by adding this token to an existing search.
+     *
+     * @param object  $oSearch      Partial search description derived so far.
+     * @param object  $oPosition    Description of the token position within
+                                    the query.
+     *
+     * @return True if the token is compatible with the search configuration
+     *         given the position.
+     */
+    public function isExtendable($oSearch, $oPosition)
+    {
+        return !$oSearch->hasOperator()
+               && $oPosition->isPhrase('')
+               && ($this->iOperator != \Nominatim\Operator::NONE
+                  || (!$oSearch->hasAddress() && !$oSearch->hasHousenumber() && !$oSearch->hasCountry()));
+    }
+

     /**
      * Derive new searches by adding this token to an existing search.
      *
     /**
      * Derive new searches by adding this token to an existing search.
      *


@@ -42,10 +69,6 @@ class SpecialTerm
      */
     public function extendSearch($oSearch, $oPosition)
     {
      */
     public function extendSearch($oSearch, $oPosition)
     {

-        if ($oSearch->hasOperator() || !$oPosition->isPhrase('')) {
-            return array();
-        }
-

         $iSearchCost = 2;
 
         $iOp = $this->iOperator;
         $iSearchCost = 2;
 
         $iOp = $this->iOperator;


@@ -54,8 +77,8 @@ class SpecialTerm
                 $iOp = \Nominatim\Operator::NAME;
             } else {
                 $iOp = \Nominatim\Operator::NEAR;
                 $iOp = \Nominatim\Operator::NAME;
             } else {
                 $iOp = \Nominatim\Operator::NEAR;

+                $iSearchCost += 2;

             }
             }

-            $iSearchCost += 2;

         } elseif (!$oPosition->isFirstToken() && !$oPosition->isLastToken()) {
             $iSearchCost += 2;
         }
         } elseif (!$oPosition->isFirstToken() && !$oPosition->isLastToken()) {
             $iSearchCost += 2;
         }