]> git.mxchange.org Git - core.git/blob - framework/main/interfaces/criteria/extended/class_LocalSearchCriteria.php
Some updates:
[core.git] / framework / main / interfaces / criteria / extended / class_LocalSearchCriteria.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Criteria\Local;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Criteria\Criteria;
7
8 /**
9  * An interface for local criterias
10  *
11  * @author              Roland Haeder <webmaster@shipsimu.org>
12  * @version             0.0.0
13 <<<<<<< HEAD:framework/main/interfaces/criteria/extended/class_LocalSearchCriteria.php
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15 =======
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
20  *
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.
25  *
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.
30  *
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/>.
33  */
34 interface LocalSearchCriteria extends Criteria {
35         /**
36          * Setter for limit
37          *
38          * @param       $limit  Search limit
39          * @return      void
40          * @todo        Find a nice casting here. (int) allows until and including 32766.
41          */
42         function setLimit ($limit);
43
44         /**
45          * "Setter" for limit from a configuration entry
46          *
47          * @param       $configEntry    The configuration entry which hold a number as limit
48          * @return      void
49          */
50         function setConfiguredLimit ($configEntry);
51
52         /**
53          * Getter for limit
54          *
55          * @return      $limit  Search limit
56          */
57         function getLimit ();
58
59         /**
60          * Setter for skip
61          *
62          * @param       $skip   Search skip
63          * @return      void
64          * @todo        Find a nice casting here. (int) allows until and including 32766.
65          */
66         function setSkip ($skip);
67
68         /**
69          * Getter for skip
70          *
71          * @return      $skip   Search skip
72          */
73         function getSkip ();
74
75         /**
76          * Checks whether the given key/value pair is matching with 'default' and one of 'choice' and
77          * never with in 'exclude'.
78          *
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
83          */
84         function isCriteriaMatching ($key, $value, $separator = ',');
85
86 }