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.3.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.mxchange.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          * @param
 113          * @return      $limit  Search limit
 114          */
 115         public final function getLimit () {
 116                 return $this->limit;
 117         }
 118
 119         /**
 120          * Setter for skip
 121          *
 122          * @param       $skip   Search skip
 123          * @return      void
 124          */
 125         public final function setSkip ($skip) {
 126                 $this->skip = $skip;
 127         }
 128
 129         /**
 130          * Getter for skip
 131          *
 132          * @param
 133          * @return      $skip   Search skip
 134          */
 135         public final function getSkip () {
 136                 return $this->skip;
 137         }
 138
 139         /**
 140          * "Getter" for a cache key
 141          *
 142          * @return      $cacheKey       The key suitable for the cache system
 143          */
 144         public function getCacheKey () {
 145                 // Initialize the key
 146                 $cacheKey = "";
 147
 148                 // Now walk through all criterias
 149                 foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
 150                         // Add the value URL encoded to avoid any trouble with special characters
 151                         $cacheKey .= sprintf("%s=%s;",
 152                                 $criteriaKey,
 153                                 urlencode($criteriaValue)
 154                         );
 155                 }
 156
 157                 // Add limit and skip values
 158                 $cacheKey .= sprintf("%%limit%%=%s;%%skip%%=%s",
 159                         $this->limit,
 160                         $this->skip
 161                 );
 162
 163                 // Return the cache key
 164                 return $cacheKey;
 165         }
 166
 167         /**
 168          * Get criteria element or null if not found
 169          *
 170          * @param       $criteria       The criteria we want to have
 171          * @return      $value          Wether the value of the critera or null
 172          */
 173         public function getCriteriaElemnent ($criteria) {
 174                 // Default is not found
 175                 $value = null;
 176
 177                 // Is the criteria there?
 178                 if (isset($this->searchCriteria[$criteria])) {
 179                         // Then use it
 180                         $value = $this->searchCriteria[$criteria];
 181                 }
 182
 183                 // Return the value
 184                 return $value;
 185         }
 186 }
 187
 188 // [EOF]
 189 ?>