ISearchPlugin.php 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  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 Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\Collaboration\Collaborators;
  24. /**
  25. * Interface ISearchPlugin
  26. *
  27. * @since 13.0.0
  28. */
  29. interface ISearchPlugin {
  30. /**
  31. * @param string $search
  32. * @param int $limit
  33. * @param int $offset
  34. * @param ISearchResult $searchResult
  35. * @return bool whether the plugin has more results
  36. * @since 13.0.0
  37. */
  38. public function search($search, $limit, $offset, ISearchResult $searchResult);
  39. }