]> git.mxchange.org Git - core.git/blob - inc/classes/interfaces/criteria/extended/class_LocalSearchCriteria.php
Copyright year updated, converted double->single quotes
[core.git] / inc / classes / interfaces / criteria / extended / class_LocalSearchCriteria.php
1 <?php
2 /**
3  * An interface for local criterias
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 interface LocalSearchCriteria extends Criteria {
25         /**
26          * Setter for limit
27          *
28          * @param       $limit  Search limit
29          * @return      void
30          * @todo        Find a nice casting here. (int) allows until and including 32766.
31          */
32         function setLimit ($limit);
33
34         /**
35          * "Setter" for limit from a configuration entry
36          *
37          * @param       $configEntry    The configuration entry which hold a number as limit
38          * @return      void
39          */
40         function setConfiguredLimit ($configEntry);
41
42         /**
43          * Getter for limit
44          *
45          * @return      $limit  Search limit
46          */
47         function getLimit ();
48
49         /**
50          * Setter for skip
51          *
52          * @param       $skip   Search skip
53          * @return      void
54          * @todo        Find a nice casting here. (int) allows until and including 32766.
55          */
56         function setSkip ($skip);
57
58         /**
59          * Getter for skip
60          *
61          * @return      $skip   Search skip
62          */
63         function getSkip ();
64
65         /**
66          * Checks whether the given key/value pair is matching with 'default' and one of 'choice' and
67          * never with in 'exclude'.
68          *
69          * @param       $key                    Key element to check
70          * @param       $value                  Value to check
71          * @param       $separator              Separator for "exploding" $value (default: ',')
72          * @return      $isMatching             Whether the key/value is matching or excluded
73          */
74         function isCriteriaMatching ($key, $value, $separator = ',');
75 }
76
77 // [EOF]
78 ?>