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 $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 () {