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                 // Clean up a little
  52                 $this->removeNumberFormaters();
  53                 $this->removeSystemArray();
  54         }
  55
  56         /**
  57          * Create an instance of this class
  58          *
  59          * @return      $criteriaInstance       An instance of this criteria
  60          */
  61         public final static function createSearchCriteria () {
  62                 // Get a new instance
  63                 $criteriaInstance = new SearchCriteria();
  64
  65                 // Return this instance
  66                 return $criteriaInstance;
  67         }
  68
  69         /**
  70          * Add criteria
  71          *
  72          * @param       $criteriaKey    Criteria key
  73          * @param       $criteriaValue  Criteria value
  74          * @return      void
  75          */
  76         public final function addCriteria ($criteriaKey, $criteriaValue) {
  77                 $this->searchCriteria[(string)$criteriaKey] = (string)$criteriaValue;
  78         }
  79
  80         /**
  81          * Add configured criteria
  82          *
  83          * @param       $criteriaKey    Criteria key
  84          * @param       $configEntry    Configuration entry
  85          * @return      void
  86          */
  87         public final function addConfiguredCriteria ($criteriaKey, $configEntry) {
  88                 // Add the configuration entry as a criteria
  89                 $value = $this->getConfigInstance()->readConfig($configEntry);
  90                 $this->addCriteria($criteriaKey, $value);
  91         }
  92
  93         /**
  94          * Setter for limit
  95          *
  96          * @param       $limit  Search limit
  97          * @return      void
  98          * @todo        Find a nice casting here. (int) allows until and including 32766.
  99          */
 100         public final function setLimit ($limit) {
 101                 $this->limit = $limit;
 102         }
 103
 104         /**
 105          * Getter for limit
 106          *
 107          * @return      $limit  Search limit
 108          */
 109         public final function getLimit () {
 110                 return $this->limit;
 111         }
 112
 113         /**
 114          * Setter for skip
 115          *
 116          * @param       $skip   Search skip
 117          * @return      void
 118          * @todo        Find a nice casting here. (int) allows until and including 32766.
 119          */
 120         public final function setSkip ($skip) {
 121                 $this->skip = $skip;
 122         }
 123
 124         /**
 125          * Getter for skip
 126          *
 127          * @return      $skip   Search skip
 128          */
 129         public final function getSkip () {
 130                 return $this->skip;
 131         }
 132
 133         /**
 134          * "Getter" for a cache key
 135          *
 136          * @return      $cacheKey       The key suitable for the cache system
 137          */
 138         public function getCacheKey () {
 139                 // Initialize the key
 140                 $cacheKey = "";
 141
 142                 // Now walk through all criterias
 143                 foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
 144                         // Add the value URL encoded to avoid any trouble with special characters
 145                         $cacheKey .= sprintf("%s=%s;",
 146                                 $criteriaKey,
 147                                 urlencode($criteriaValue)
 148                         );
 149                 }
 150
 151                 // Add limit and skip values
 152                 $cacheKey .= sprintf("%%limit%%=%s;%%skip%%=%s",
 153                         $this->limit,
 154                         $this->skip
 155                 );
 156
 157                 // Return the cache key
 158                 return $cacheKey;
 159         }
 160
 161         /**
 162          * Get criteria element or null if not found
 163          *
 164          * @param       $criteria       The criteria we want to have
 165          * @return      $value          Wether the value of the critera or null
 166          */
 167         public function getCriteriaElemnent ($criteria) {
 168                 // Default is not found
 169                 $value = null;
 170
 171                 // Is the criteria there?
 172                 if (isset($this->searchCriteria[$criteria])) {
 173                         // Then use it
 174                         $value = $this->searchCriteria[$criteria];
 175                 }
 176
 177                 // Return the value
 178                 return $value;
 179         }
 180
 181         /**
 182          * Checks wether given array entry matches
 183          *
 184          * @param       $entryArray             Array with the entries to find
 185          * @return      $matches                Wether the entry matches or not
 186          */
 187         public function ifEntryMatches (array $entryArray) {
 188                 // First nothing matches and nothing is counted
 189                 $matches = false;
 190                 $counted = 0;
 191
 192                 // Walk through all entries
 193                 foreach ($entryArray as $key => $entry) {
 194                         // Then walk through all search criteria
 195                         foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
 196                                 // Is the element found and does it match?
 197                                 if (($key == $criteriaKey) && ($criteriaValue == $entry)) {
 198                                         // Then count this one up
 199                                         $counted++;
 200                                 } // END - if
 201                         } // END - foreach
 202                 } // END - foreach
 203
 204                 // Now check if expected criteria counts match
 205                 $matches = ($counted == count($this->searchCriteria));
 206
 207                 // Return the result
 208                 return $matches;
 209         }
 210 }
 211
 212 // [EOF]
 213 ?>