blob: 4b9f2b72e7c2a20fe74ae83800271a084658ce51 (
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
|
<?php
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Collaboration\AutoComplete;
/**
* Interface ISorter
*
* Sorts the list of .e.g users for auto completion
*
* @since 13.0.0
*/
interface ISorter {
/**
* @return string The ID of the sorter, e.g. commenters
* @since 13.0.0
*/
public function getId();
/**
* executes the sort action
*
* @param array $sortArray the array to be sorted, provided as reference
* @param array{itemType: string, itemId: string, search?: string} $context carries key 'itemType' and 'itemId' of the source object (e.g. a file)
* @since 13.0.0
*/
public function sort(array &$sortArray, array $context);
}
|