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@shipsimu.org>
9 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.shipsimu.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 UpdateCriteria extends BaseCriteria implements LocalUpdateCriteria {
30 private $updateCriteria = array();
33 * Limitation for the update
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 createUpdateCriteria () {
59 $criteriaInstance = new UpdateCriteria();
61 // Return this instance
62 return $criteriaInstance;
66 * Add criteria, this method converts dashes to underscores because dashes
67 * are not valid for criteria keys.
69 * @param $criteriaKey Criteria key
70 * @param $criteriaValue Criteria value
71 * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude'
74 public function addCriteria ($criteriaKey, $criteriaValue, $criteriaType = 'default') {
75 $this->updateCriteria[$criteriaKey] = $criteriaValue;
79 * Add configured criteria
81 * @param $criteriaKey Criteria key
82 * @param $configEntry Configuration entry
85 public function addConfiguredCriteria ($criteriaKey, $configEntry) {
86 // Add the configuration entry as a criteria
87 $value = $this->getConfigInstance()->getConfigEntry($configEntry);
88 $this->addCriteria($criteriaKey, $value);
92 * Getter for update criteria array
94 * @return $updateCriteria Array holding the update criteria
96 public final function getUpdateCriteria () {
97 return $this->updateCriteria;