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, 2009 - 2011 Core Developer Team
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 BaseCriteria 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__);
53 * Create an instance of this class
55 * @return $criteriaInstance An instance of this criteria
57 public static final function createSearchCriteria () {
59 $criteriaInstance = new SearchCriteria();
61 // Return this instance
62 return $criteriaInstance;
68 * @param $criteriaKey Criteria key
69 * @param $criteriaValue Criteria value
72 public final function addCriteria ($criteriaKey, $criteriaValue) {
73 $this->searchCriteria[(string)$criteriaKey] = (string)$criteriaValue;
77 * Add configured criteria
79 * @param $criteriaKey Criteria key
80 * @param $configEntry Configuration entry
83 public final function addConfiguredCriteria ($criteriaKey, $configEntry) {
84 // Add the configuration entry as a criteria
85 $value = $this->getConfigInstance()->getConfigEntry($configEntry);
86 $this->addCriteria($criteriaKey, $value);
92 * @param $limit Search limit
94 * @todo Find a nice casting here. (int) allows until and including 32766.
96 public final function setLimit ($limit) {
97 $this->limit = $limit;
101 * "Setter" for limit from a configuration entry
103 * @param $configEntry The configuration entry which hold a number as limit
106 public final function setConfiguredLimit ($configEntry) {
107 // Get the limit from config entry and set it
108 $limit = $this->getConfigInstance()->getConfigEntry($configEntry);
109 $this->setLimit($limit);
115 * @return $limit Search limit
117 public final function getLimit () {
124 * @param $skip Search skip
126 * @todo Find a nice casting here. (int) allows until and including 32766.
128 public final function setSkip ($skip) {
135 * @return $skip Search skip
137 public final function getSkip () {
142 * "Getter" for a cache key
144 * @return $cacheKey The key suitable for the cache system
146 public function getCacheKey () {
147 // Initialize the key
150 // Now walk through all criterias
151 foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
152 // Add the value URL encoded to avoid any trouble with special characters
153 $cacheKey .= sprintf("%s=%s;",
155 urlencode($criteriaValue)
159 // Add limit and skip values
160 $cacheKey .= sprintf("%%limit%%=%s;%%skip%%=%s",
165 // Return the cache key
170 * Get criteria element or null if not found
172 * @param $criteria The criteria we want to have
173 * @return $value Wether the value of the critera or null
175 public function getCriteriaElemnent ($criteria) {
176 // Default is not found
179 // Is the criteria there?
180 if (isset($this->searchCriteria[$criteria])) {
182 $value = $this->searchCriteria[$criteria];
190 * Checks wether given array entry matches
192 * @param $entryArray Array with the entries to find
193 * @return $matches Wether the entry matches or not
195 public function ifEntryMatches (array $entryArray) {
196 // First nothing matches and nothing is counted
200 // Walk through all entries
201 foreach ($entryArray as $key => $entry) {
202 // Then walk through all search criteria
203 foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
204 // Is the element found and does it match?
205 if (($key == $criteriaKey) && ($criteriaValue == $entry)) {
206 // Then count this one up
212 // Now check if expected criteria counts match
213 $matches = ($counted == count($this->searchCriteria));