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, 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 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 final static 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()->readConfig($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          * Getter for limit
 102          *
 103          * @return      $limit  Search limit
 104          */
 105         public final function getLimit () {
 106                 return $this->limit;
 107         }
 108
 109         /**
 110          * Setter for skip
 111          *
 112          * @param       $skip   Search skip
 113          * @return      void
 114          * @todo        Find a nice casting here. (int) allows until and including 32766.
 115          */
 116         public final function setSkip ($skip) {
 117                 $this->skip = $skip;
 118         }
 119
 120         /**
 121          * Getter for skip
 122          *
 123          * @return      $skip   Search skip
 124          */
 125         public final function getSkip () {
 126                 return $this->skip;
 127         }
 128
 129         /**
 130          * "Getter" for a cache key
 131          *
 132          * @return      $cacheKey       The key suitable for the cache system
 133          */
 134         public function getCacheKey () {
 135                 // Initialize the key
 136                 $cacheKey = "";
 137
 138                 // Now walk through all criterias
 139                 foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
 140                         // Add the value URL encoded to avoid any trouble with special characters
 141                         $cacheKey .= sprintf("%s=%s;",
 142                                 $criteriaKey,
 143                                 urlencode($criteriaValue)
 144                         );
 145                 }
 146
 147                 // Add limit and skip values
 148                 $cacheKey .= sprintf("%%limit%%=%s;%%skip%%=%s",
 149                         $this->limit,
 150                         $this->skip
 151                 );
 152
 153                 // Return the cache key
 154                 return $cacheKey;
 155         }
 156
 157         /**
 158          * Get criteria element or null if not found
 159          *
 160          * @param       $criteria       The criteria we want to have
 161          * @return      $value          Wether the value of the critera or null
 162          */
 163         public function getCriteriaElemnent ($criteria) {
 164                 // Default is not found
 165                 $value = null;
 166
 167                 // Is the criteria there?
 168                 if (isset($this->searchCriteria[$criteria])) {
 169                         // Then use it
 170                         $value = $this->searchCriteria[$criteria];
 171                 }
 172
 173                 // Return the value
 174                 return $value;
 175         }
 176
 177         /**
 178          * Checks wether given array entry matches
 179          *
 180          * @param       $entryArray             Array with the entries to find
 181          * @return      $matches                Wether the entry matches or not
 182          */
 183         public function ifEntryMatches (array $entryArray) {
 184                 // First nothing matches and nothing is counted
 185                 $matches = false;
 186                 $counted = 0;
 187
 188                 // Walk through all entries
 189                 foreach ($entryArray as $key => $entry) {
 190                         // Then walk through all search criteria
 191                         foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
 192                                 // Is the element found and does it match?
 193                                 if (($key == $criteriaKey) && ($criteriaValue == $entry)) {
 194                                         // Then count this one up
 195                                         $counted++;
 196                                 } // END - if
 197                         } // END - foreach
 198                 } // END - foreach
 199
 200                 // Now check if expected criteria counts match
 201                 $matches = ($counted == count($this->searchCriteria));
 202
 203                 // Return the result
 204                 return $matches;
 205         }
 206 }
 207
 208 // [EOF]
 209 ?>