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 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface LocalSearchCriteria extends Criteria {
34 * @param $limit Search limit
36 * @todo Find a nice casting here. (int) allows until and including 32766.
38 function setLimit (int $limit);
41 * "Setter" for limit from a configuration entry
43 * @param $configEntry The configuration entry which hold a number as limit
46 function setConfiguredLimit (string $configEntry);
51 * @return $limit Search limit
58 * @param $skip Search skip
60 * @todo Find a nice casting here. (int) allows until and including 32766.
62 function setSkip (int $skip);
67 * @return $skip Search skip
72 * Checks whether the given key/value pair is matching with 'default' and one of 'choice' and
73 * never with in 'exclude'.
75 * @param $key Key element to check
76 * @param $value Value to check
77 * @param $separator Separator for "exploding" $value (default: ',')
78 * @return $isMatching Whether the key/value is matching or excluded
79 * @throws InvalidArgumentException If parameter is invalid
81 function isCriteriaMatching (string $key, $value, string $separator = ',');