diff options
author | Arthur Schiwon <blizzz@arthur-schiwon.de> | 2017-08-30 11:56:02 +0300 |
---|---|---|
committer | Arthur Schiwon <blizzz@arthur-schiwon.de> | 2017-10-22 15:13:32 +0300 |
commit | fd6daf8d195b985fcdec82c0c53e8ba230765f41 (patch) | |
tree | dbfbbfb8424604daeb0fba63a8e0d2b7cda9a3ac /lib/public/Collaboration | |
parent | 2b31b8289169e35be7bb1b129e9a978ddcd8f478 (diff) |
AutoCompletion backend
* introduce a Controller for requests
* introduce result sorting mechanism
* extend Comments to retrieve commentors (actors) in a tree
* add commenters sorter
* add share recipients sorter
Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
Diffstat (limited to 'lib/public/Collaboration')
-rw-r--r-- | lib/public/Collaboration/AutoComplete/IManager.php | 46 | ||||
-rw-r--r-- | lib/public/Collaboration/AutoComplete/ISorter.php | 50 |
2 files changed, 96 insertions, 0 deletions
diff --git a/lib/public/Collaboration/AutoComplete/IManager.php b/lib/public/Collaboration/AutoComplete/IManager.php new file mode 100644 index 00000000000..e9f33727cd2 --- /dev/null +++ b/lib/public/Collaboration/AutoComplete/IManager.php @@ -0,0 +1,46 @@ +<?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 + * + * @package OCP\Collaboration\AutoComplete + * @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); +} diff --git a/lib/public/Collaboration/AutoComplete/ISorter.php b/lib/public/Collaboration/AutoComplete/ISorter.php new file mode 100644 index 00000000000..538ca41003d --- /dev/null +++ b/lib/public/Collaboration/AutoComplete/ISorter.php @@ -0,0 +1,50 @@ +<?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 ISorter + * + * Sorts the list of .e.g users for auto completion + * + * @package OCP\Collaboration\AutoComplete + * @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 $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); +} |