Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
1 | <?php |
2 | |
3 | /** |
4 | * Interface SorterInterface |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Moravian Library 2022. |
9 | * |
10 | * This program is free software; you can redistribute it and/or modify |
11 | * it under the terms of the GNU General Public License version 2, |
12 | * as published by the Free Software Foundation. |
13 | * |
14 | * This program is distributed in the hope that it will be useful, |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
17 | * GNU General Public License for more details. |
18 | * |
19 | * You should have received a copy of the GNU General Public License |
20 | * along with this program; if not, write to the Free Software |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
22 | * |
23 | * @category VuFind |
24 | * @package I18n |
25 | * @author Josef Moravec <moravec@mzk.cz> |
26 | * @license https://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org/wiki/development Wiki |
28 | */ |
29 | |
30 | declare(strict_types=1); |
31 | |
32 | namespace VuFind\I18n; |
33 | |
34 | /** |
35 | * Interface SorterInterface |
36 | * |
37 | * @category VuFind |
38 | * @package I18n |
39 | * @author Josef Moravec <moravec@mzk.cz> |
40 | * @license https://opensource.org/licenses/gpl-2.0.php GNU General Public License |
41 | * @link https://vufind.org/wiki/development Wiki |
42 | */ |
43 | interface SorterInterface |
44 | { |
45 | /** |
46 | * Compare function |
47 | * |
48 | * @param string $string1 First string to compare |
49 | * @param string $string2 Second string to compare |
50 | * |
51 | * @return int |
52 | */ |
53 | public function compare(string $string1, string $string2): int; |
54 | |
55 | /** |
56 | * Sort array by values |
57 | * |
58 | * @param array $array Array to sort |
59 | * |
60 | * @return bool |
61 | */ |
62 | public function sort(array &$array): bool; |
63 | |
64 | /** |
65 | * Sort array by values and maintain index association |
66 | * |
67 | * @param array $array Array to sort |
68 | * |
69 | * @return bool |
70 | */ |
71 | public function asort(array &$array): bool; |
72 | |
73 | /** |
74 | * Natural sort by values and maintain index association |
75 | * |
76 | * @param array $array Array to sort |
77 | * |
78 | * @return bool |
79 | */ |
80 | public function natsort(array &$array): bool; |
81 | } |