aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Collaboration/AutoComplete/IManager.php
blob: cec703edc998fe7dca1c1cf3116fad3d6394f1a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?php
/**
 * @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
 *
 * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCP\Collaboration\AutoComplete;

/**
 * Interface IManager
 *
 * @since 13.0.0
 */
interface IManager {
	/**
	 * @param string $className – class name of the ISorter implementation
	 * @since 13.0.0
	 */
	public function registerSorter($className);

	/**
	 * @param array $sorters	list of sorter IDs, seperated by "|"
	 * @param array $sortArray	array representation of OCP\Collaboration\Collaborators\ISearchResult
	 * @param array $context	context info of the search, keys: itemType, itemId
	 * @since 13.0.0
	 */
	public function runSorters(array $sorters, array &$sortArray, array $context);
}