3 * A general crtieria class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class BaseCriteria extends BaseFrameworkSystem {
26 * Wrapper class name stored in config entry
28 private $wrapperConfigEntry = '';
33 private $criteria = array();
36 * Protected constructor
38 * @param $className Name of the class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
47 * Setter for wrapper class name
49 * @param $wrapperConfigEntry Configuration entry which hold the wrapper class' name
52 public final function setWrapperConfigEntry ($wrapperConfigEntry) {
53 $this->wrapperConfigEntry = (string) $wrapperConfigEntry;
57 * Getter for wrapper class name
59 * @return $wrapperConfigEntry Configuration entry which hold the wrapper class' name
61 public final function getWrapperConfigEntry () {
62 return $this->wrapperConfigEntry;
66 * Getter for criteria array
70 public final function getCriteriaArray () {
71 return $this->criteria;
75 * Add criteria, this method converts dashes to underscores because dashes
76 * are not valid for criteria keys.
78 * @param $criteriaKey Criteria key
79 * @param $criteriaValue Criteria value
82 public final function addCriteria ($criteriaKey, $criteriaValue) {
84 if (strpos($criteriaKey, 'my-') !== false) $this->debugBackTrace('criteriaKey=' . $criteriaKey);
85 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CRITERIA: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue);
88 $this->criteria[$this->convertDashesToUnderscores($criteriaKey)] = (string)$criteriaValue;
92 * Add configured criteria
94 * @param $criteriaKey Criteria key
95 * @param $configEntry Configuration entry
98 public final function addConfiguredCriteria ($criteriaKey, $configEntry) {
99 // Add the configuration entry as a criteria
100 $value = $this->getConfigInstance()->getConfigEntry($configEntry);
101 $this->addCriteria($criteriaKey, $value);
105 * Get criteria element or null if not found
107 * @param $criteriaKey The requested criteria key
108 * @return $value Whether the value of the critera or null
110 public function getCriteriaElemnent ($criteriaKey) {
111 // Convert dashes to underscore
112 $criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
115 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CRITERIA: criteriaKey=' . $criteriaKey . ',criteria()=' . count($this->criteria));
117 // Default is not found
120 // Is the criteria there?
121 if (isset($this->criteria[$criteriaKey])) {
123 $value = $this->criteria[$criteriaKey];
131 * Checks whether given array entry matches
133 * @param $entryArray Array with the entries to find
134 * @return $matches Whether the entry matches or not
136 public function ifEntryMatches (array $entryArray) {
137 // First nothing matches and nothing is counted
141 // Walk through all entries
142 foreach ($entryArray as $key => $entry) {
143 // Convert dashes to underscore
144 $key = $this->convertDashesToUnderscores($key);
146 // Then walk through all search criteria
147 foreach ($this->criteria as $criteriaKey => $criteriaValue) {
148 // Convert dashes to underscore
149 $criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
151 // Is the element found and does it match?
152 if (($key == $criteriaKey) && ($criteriaValue == $entry)) {
153 // Then count this one up
159 // Now check if expected criteria counts match
160 $matches = ($counted == count($this->criteria));
167 * "Getter" for a cache key
169 * @param $onlyKeys Only use these keys for a cache key
170 * @return $cacheKey The key suitable for the cache system
172 public function getCacheKey ($onlyKeys = array()) {
173 // Initialize the key
176 // Now walk through all criterias
177 foreach ($this->criteria as $criteriaKey => $criteriaValue) {
178 // Convert dashes to underscore
179 $criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
181 // Is the value in array or is $onlyKeys empty?
182 if ((isset($onlyKeys[$criteriaKey])) || (count($onlyKeys) == 0)) {
183 // Add the value URL encoded to avoid any trouble with special characters
184 $cacheKey .= sprintf("%s=%s;",
186 urlencode($criteriaValue)
191 // Remove last semicolon
192 $cacheKey = substr($cacheKey, 0, -1);
194 // Is the instance SearchCriteria?
195 if ($this instanceof SearchCriteria) {
196 // Check if 'limit' and 'skip' are in
197 if (((isset($onlyKeys['limit'])) && (isset($onlyKeys['skip']))) || (count($onlyKeys) == 0)) {
198 // Add limit and skip values
199 $cacheKey .= sprintf(";%%limit%%=%s;%%skip%%=%s",
206 // Return the cache key
211 * Count the criteria, e.g. useful to find out if a database query has no limitation (search criteria)
213 * @return $count Count of all criteria entries
215 public final function count () {
217 return count($this->criteria);