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.
7 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
26 class SearchCriteria extends BaseFrameworkSystem implements LocalSearchCriteria {
30 private $searchCriteria = array();
33 * Limitation for the search
38 * Skip these entries before using them
43 * Protected constructor
47 protected function __construct () {
48 // Call parent constructor
49 parent::__construct(__CLASS__);
52 $this->removeNumberFormaters();
53 $this->removeSystemArray();
57 * Create an instance of this class
59 * @return $criteriaInstance An instance of this criteria
61 public final static function createSearchCriteria () {
63 $criteriaInstance = new SearchCriteria();
65 // Return this instance
66 return $criteriaInstance;
72 * @param $criteriaKey Criteria key
73 * @param $criteriaValue Criteria value
76 public final function addCriteria ($criteriaKey, $criteriaValue) {
77 $this->searchCriteria[(string)$criteriaKey] = (string)$criteriaValue;
81 * Add configured criteria
83 * @param $criteriaKey Criteria key
84 * @param $configEntry Configuration entry
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);
96 * @param $limit Search limit
98 * @todo Find a nice casting here. (int) allows until and including 32766.
100 public final function setLimit ($limit) {
101 $this->limit = $limit;
107 * @return $limit Search limit
109 public final function getLimit () {
116 * @param $skip Search skip
118 * @todo Find a nice casting here. (int) allows until and including 32766.
120 public final function setSkip ($skip) {
127 * @return $skip Search skip
129 public final function getSkip () {
134 * "Getter" for a cache key
136 * @return $cacheKey The key suitable for the cache system
138 public function getCacheKey () {
139 // Initialize the key
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;",
147 urlencode($criteriaValue)
151 // Add limit and skip values
152 $cacheKey .= sprintf("%%limit%%=%s;%%skip%%=%s",
157 // Return the cache key
162 * Get criteria element or null if not found
164 * @param $criteria The criteria we want to have
165 * @return $value Wether the value of the critera or null
167 public function getCriteriaElemnent ($criteria) {
168 // Default is not found
171 // Is the criteria there?
172 if (isset($this->searchCriteria[$criteria])) {
174 $value = $this->searchCriteria[$criteria];
182 * Checks wether given array entry matches
184 * @param $entryArray Array with the entries to find
185 * @return $matches Wether the entry matches or not
187 public function ifEntryMatches (array $entryArray) {
188 // First nothing matches and nothing is counted
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
204 // Now check if the criteria matches
205 $matches = ($counted == count($this->searchCriteria));