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 - 2012 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 $criteria = 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 $limit Search limit
70 * @todo Find a nice casting here. (int) allows until and including 32766.
72 public final function setLimit ($limit) {
73 $this->limit = $limit;
77 * "Setter" for limit from a configuration entry
79 * @param $configEntry The configuration entry which hold a number as limit
82 public final function setConfiguredLimit ($configEntry) {
83 // Get the limit from config entry and set it
84 $limit = $this->getConfigInstance()->getConfigEntry($configEntry);
85 $this->setLimit($limit);
91 * @return $limit Search limit
93 public final function getLimit () {
100 * @param $skip Search skip
102 * @todo Find a nice casting here. (int) allows until and including 32766.
104 public final function setSkip ($skip) {
111 * @return $skip Search skip
113 public final function getSkip () {
118 * Checks whether the given key/value pair is matching with 'default' and one of 'choice' and
119 * never with in 'exclude'.
121 * @param $key Key element to check
122 * @param $value Value to check
123 * @param $separator Separator for "exploding" $value (default: ',')
124 * @return $isMatching Whether the key/value is matching or excluded
126 public function isCriteriaMatching ($key, $value, $separator = ',') {
127 // $value cannot be array
128 assert(!is_array($value));
131 $valueArray = explode($separator, $value);
134 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: key=' . $key . ',value=' . $value . ' - ENTERED!');
136 // Get 'default' search value
137 $searchDefault = $this->getCriteriaElemnent($key);
140 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: getCriteriaElement(' . $key . ')[' . gettype($searchDefault) . ']=' . $searchDefault);
143 $isMatching = ((!is_null($searchDefault)) && ($searchDefault == $value));
146 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: getCriteriaElement(' . $key . ')[' . gettype($searchDefault) . ']=' . $searchDefault . ',isMatching=' . intval($isMatching));
148 // Get 'choice' search value (can be NULL or $separator-separated string)
149 $searchChoice = $this->getCriteriaChoiceElemnent($key);
152 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[' . gettype($searchChoice) . ']=' . print_r($searchChoice, TRUE));
155 if ((is_array($searchChoice)) && (count($valueArray) == 1)) {
156 // $value is a single-search value, so use in_array()
157 $isMatching = (((is_null($searchDefault)) || ($isMatching === TRUE)) && ((is_null($searchChoice)) || ((is_array($searchChoice)) && (in_array($value, $searchChoice)))));
160 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[]=' . gettype($searchChoice) . ',value=' . $value . ',isMatching=' . intval($isMatching) . ' - SINGLE-MATCH');
161 } elseif ((is_array($searchChoice)) && (count($valueArray) > 1)) {
162 // $value is choice-search value, so check all entries
163 $isMatching = ((is_null($searchDefault)) || ($isMatching === TRUE));
165 foreach ($valueArray as $idx => $match) {
167 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: match=' . $match . ',count(searchChoice)=' . count($searchChoice));
169 // Is it found? (one is okay)
170 $isMatching = (($isMatching === TRUE) && (in_array($match, $searchChoice)));
173 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: match=' . $match . ',isMatching=' . intval($isMatching));
177 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[]=' . gettype($searchChoice) . ',valueArray()=' . count($valueArray) . ',idx=' . $idx . ',isMatching=' . intval($isMatching) . ' - CHOICE-MATCH');
179 // Choice-match is NULL?
180 $isMatching = (($isMatching === TRUE) || (is_null($searchChoice)));
183 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[]=' . gettype($searchChoice) . ',value=' . $value . ',isMatching=' . intval($isMatching) . ' - NULL-MATCH');
187 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[]=' . gettype($searchChoice) . ',isMatching=' . intval($isMatching));
189 // Get 'exclude' search value
190 $searchExclude = $this->getCriteriaExcludeElemnent($key);
193 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: getCriteriaExcludeElement(' . $key . ')[' . gettype($searchExclude) . ']=' . $searchExclude);
196 $isMatching = (((is_null($searchChoice)) || ($isMatching === TRUE)) && ((is_null($searchExclude)) || ($searchExclude != $value)));
199 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SEARCH-CRITERIA[' . __LINE__ . ']: key=' . $key . ',value=' . $value . ',isMatching=' . intval($isMatching) . ' - EXIT!');