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