ISearchService.php 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
  5. *
  6. * @author Maxence Lange <maxence@artificial-owl.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\FullTextSearch\Service;
  25. use OCP\FullTextSearch\Model\ISearchRequest;
  26. use OCP\FullTextSearch\Model\ISearchResult;
  27. /**
  28. * Interface ISearchService
  29. *
  30. * @since 15.0.0
  31. *
  32. */
  33. interface ISearchService {
  34. /**
  35. * generate a search request, based on an array:
  36. *
  37. * $request =
  38. * [
  39. * 'providers' => (string/array) 'all'
  40. * 'author' => (string) owner of the document.
  41. * 'search' => (string) search string,
  42. * 'size' => (int) number of items to be return
  43. * 'page' => (int) page
  44. * 'parts' => (array) parts of document to search within,
  45. * 'options' = (array) search options,
  46. * 'tags' => (array) tags,
  47. * 'metatags' => (array) metatags,
  48. * 'subtags' => (array) subtags
  49. * ]
  50. *
  51. * 'providers' can be an array of providerIds
  52. *
  53. * @since 15.0.0
  54. *
  55. * @param array $request
  56. *
  57. * @return ISearchRequest
  58. */
  59. public function generateSearchRequest(array $request): ISearchRequest;
  60. /**
  61. * Search documents
  62. *
  63. * @since 15.0.0
  64. *
  65. * @param string $userId
  66. * @param ISearchRequest $searchRequest
  67. *
  68. * @return ISearchResult[]
  69. */
  70. public function search(string $userId, ISearchRequest $searchRequest): array;
  71. }