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__);
51 // Set part description
52 $this->setObjectDescription("Search criteria class");
54 // Create unique ID number
55 $this->generateUniqueId();
58 $this->removeNumberFormaters();
59 $this->removeSystemArray();
63 * Create an instance of this class
65 * @return $criteriaInstance An instance of this criteria
67 public final static function createSearchCriteria () {
69 $criteriaInstance = new SearchCriteria();
71 // Return this instance
72 return $criteriaInstance;
78 * @param $criteriaKey Criteria key
79 * @param $criteriaValue Criteria value
82 public function addCriteria ($criteriaKey, $criteriaValue) {
83 $this->searchCriteria[$criteriaKey] = $criteriaValue;
87 * Add configured criteria
89 * @param $criteriaKey Criteria key
90 * @param $configEntry Configuration entry
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);
102 * @param $limit Search limit
105 public final function setLimit ($limit) {
106 $this->limit = $limit;
112 * @return $limit Search limit
114 public final function getLimit () {
121 * @param $skip Search skip
124 public final function setSkip ($skip) {
131 * @return $skip Search skip
133 public final function getSkip () {
138 * "Getter" for a cache key
140 * @return $cacheKey The key suitable for the cache system
142 public function getCacheKey () {
143 // Initialize the key
146 // Now walk through all criterias
147 foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
148 // Add the value URL encoded to avoid any trouble with special characters
149 $cacheKey .= sprintf("%s=%s;",
151 urlencode($criteriaValue)
155 // Add limit and skip values
156 $cacheKey .= sprintf("%%limit%%=%s;%%skip%%=%s",
161 // Return the cache key
166 * Get criteria element or null if not found
168 * @param $criteria The criteria we want to have
169 * @return $value Wether the value of the critera or null
171 public function getCriteriaElemnent ($criteria) {
172 // Default is not found
175 // Is the criteria there?
176 if (isset($this->searchCriteria[$criteria])) {
178 $value = $this->searchCriteria[$criteria];
186 * Checks wether given array entry matches
188 * @param $entryArray Array with the entries to find
189 * @return $matches Wether the entry matches or not
191 public function ifEntryMatches (array $entryArray) {
192 // First nothing matches and nothing is counted
196 // Walk through all entries
197 foreach ($entryArray as $key=>$entry) {
198 // Then walk through all search criteria
199 foreach ($this->searchCriteria as $criteriaKey=>$criteriaValue) {
200 // Is the element found and does it match?
201 if (($key == $criteriaKey) && ($criteriaValue == $entry)) {
202 // Then count this one up
208 // Now check if the criteria matches
209 $matches = ($counted == count($this->searchCriteria));