3 namespace Org\Mxchange\CoreFramework\Criteria\Local;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Criteria\Criteria;
9 * An interface for local criterias
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 <<<<<<< HEAD:framework/main/interfaces/criteria/extended/class_LocalSearchCriteria.php
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
17 >>>>>>> Some updates::inc/main/interfaces/criteria/extended/class_LocalSearchCriteria.php
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 interface LocalSearchCriteria extends Criteria {
38 * @param $limit Search limit
40 * @todo Find a nice casting here. (int) allows until and including 32766.
42 function setLimit ($limit);
45 * "Setter" for limit from a configuration entry
47 * @param $configEntry The configuration entry which hold a number as limit
50 function setConfiguredLimit ($configEntry);
55 * @return $limit Search limit
62 * @param $skip Search skip
64 * @todo Find a nice casting here. (int) allows until and including 32766.
66 function setSkip ($skip);
71 * @return $skip Search skip
76 * Checks whether the given key/value pair is matching with 'default' and one of 'choice' and
77 * never with in 'exclude'.
79 * @param $key Key element to check
80 * @param $value Value to check
81 * @param $separator Separator for "exploding" $value (default: ',')
82 * @return $isMatching Whether the key/value is matching or excluded
84 function isCriteriaMatching ($key, $value, $separator = ',');