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