inc/classes/main/criteria/class_SearchCriteria.php

   1 <?php
   2 /**
   3  * Search criteria for e.g. searching in databases. Do not use this class if
   4  * you are looking for a ship or company, or what ever. Instead use this class
   5  * for looking in storages like the database.
   6  *
   7  * @author              Roland Haeder <webmaster@ship-simu.org>
   8  * @version             0.0.0
   9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
  10  * @license             GNU GPL 3.0 or any newer version
  11  * @link                http://www.ship-simu.org
  12  *
  13  * This program is free software: you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation, either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  25  */
  26 class SearchCriteria extends BaseFrameworkSystem implements LocalSearchCriteria {
  27         /**
  28          * Criteria to handle
  29          */
  30         private $searchCriteria = array();
  31
  32         /**
  33          * Limitation for the search
  34          */
  35         private $limit = 0;
  36
  37         /**
  38          * Skip these entries before using them
  39          */
  40         private $skip = 0;
  41
  42         /**
  43          * Protected constructor
  44          *
  45          * @return      void
  46          */
  47         protected function __construct () {
  48                 // Call parent constructor
  49                 parent::__construct(__CLASS__);
  50
  51                 // Set part description
  52                 $this->setObjectDescription("Search criteria class");
  53
  54                 // Create unique ID number
  55                 $this->generateUniqueId();
  56
  57                 // Clean up a little
  58                 $this->removeNumberFormaters();
  59                 $this->removeSystemArray();
  60         }
  61
  62         /**
  63          * Create an instance of this class
  64          *
  65          * @return      $criteriaInstance       An instance of this criteria
  66          */
  67         public final static function createSearchCriteria () {
  68                 // Get a new instance
  69                 $criteriaInstance = new SearchCriteria();
  70
  71                 // Return this instance
  72                 return $criteriaInstance;
  73         }
  74
  75         /**
  76          * Add criteria
  77          *
  78          * @param       $criteriaKey    Criteria key
  79          * @param       $criteriaValue  Criteria value
  80          * @return      void
  81          */
  82         public function addCriteria ($criteriaKey, $criteriaValue) {
  83                 $this->searchCriteria[$criteriaKey] = $criteriaValue;
  84         }
  85
  86         /**
  87          * Add configured criteria
  88          *
  89          * @param       $criteriaKey    Criteria key
  90          * @param       $configEntry    Configuration entry
  91          * @return      void
  92          */
  93         public function addConfiguredCriteria ($criteriaKey, $configEntry) {
  94                 // Add the configuration entry as a criteria
  95                 $value = $this->getConfigInstance()->readConfig($configEntry);
  96                 $this->addCriteria($criteriaKey, $value);
  97         }
  98
  99         /**
 100          * Setter for limit
 101          *
 102          * @param       $limit  Search limit
 103          * @return      void
 104          */
 105         public final function setLimit ($limit) {
 106                 $this->limit = $limit;
 107         }
 108
 109         /**
 110          * Getter for limit
 111          *
 112          * @return      $limit  Search limit
 113          */
 114         public final function getLimit () {
 115                 return $this->limit;
 116         }
 117
 118         /**
 119          * Setter for skip
 120          *
 121          * @param       $skip   Search skip
 122          * @return      void
 123          */
 124         public final function setSkip ($skip) {
 125                 $this->skip = $skip;
 126         }
 127
 128         /**
 129          * Getter for skip
 130          *
 131          * @return      $skip   Search skip
 132          */
 133         public final function getSkip () {
 134                 return $this->skip;
 135         }
 136
 137         /**
 138          * "Getter" for a cache key
 139          *
 140          * @return      $cacheKey       The key suitable for the cache system
 141          */
 142         public function getCacheKey () {
 143                 // Initialize the key
 144                 $cacheKey = "";
 145
 146                 // Now walk through all criterias
 147                 foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
 148                         // Add the value URL encoded to avoid any trouble with special characters
 149                         $cacheKey .= sprintf("%s=%s;",
 150                                 $criteriaKey,
 151                                 urlencode($criteriaValue)
 152                         );
 153                 }
 154
 155                 // Add limit and skip values
 156                 $cacheKey .= sprintf("%%limit%%=%s;%%skip%%=%s",
 157                         $this->limit,
 158                         $this->skip
 159                 );
 160
 161                 // Return the cache key
 162                 return $cacheKey;
 163         }
 164
 165         /**
 166          * Get criteria element or null if not found
 167          *
 168          * @param       $criteria       The criteria we want to have
 169          * @return      $value          Wether the value of the critera or null
 170          */
 171         public function getCriteriaElemnent ($criteria) {
 172                 // Default is not found
 173                 $value = null;
 174
 175                 // Is the criteria there?
 176                 if (isset($this->searchCriteria[$criteria])) {
 177                         // Then use it
 178                         $value = $this->searchCriteria[$criteria];
 179                 }
 180
 181                 // Return the value
 182                 return $value;
 183         }
 184
 185         /**
 186          * Checks wether given array entry matches
 187          *
 188          * @param       $entryArray             Array with the entries to find
 189          * @return      $matches                Wether the entry matches or not
 190          */
 191         public function ifEntryMatches (array $entryArray) {
 192                 // First nothing matches and nothing is counted
 193                 $matches = false;
 194                 $counted = 0;
 195
 196                 // Walk through all entries
 197                 foreach ($entryArray as $key=>$entry) {
 198                         // Then walk through all search criteria
 199                         foreach ($this->searchCriteria as $criteriaKey=>$criteriaValue) {
 200                                 // Is the element found and does it match?
 201                                 if (($key == $criteriaKey) && ($criteriaValue == $entry)) {
 202                                         // Then count this one up
 203                                         $counted++;
 204                                 } // END - if
 205                         } // END - foreach
 206                 } // END - foreach
 207
 208                 // Now check if the criteria matches
 209                 $matches = ($counted == count($this->searchCriteria));
 210
 211                 // Return the result
 212                 return $matches;
 213         }
 214 }
 215
 216 // [EOF]
 217 ?>