1
0

ISearchOrder.php 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
  4. *
  5. * @author Robin Appelman <robin@icewind.nl>
  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\Files\Search;
  24. /**
  25. * @since 12.0.0
  26. */
  27. interface ISearchOrder {
  28. const DIRECTION_ASCENDING = 'asc';
  29. const DIRECTION_DESCENDING = 'desc';
  30. /**
  31. * The direction to sort in, either ISearchOrder::DIRECTION_ASCENDING or ISearchOrder::DIRECTION_DESCENDING
  32. *
  33. * @return string
  34. * @since 12.0.0
  35. */
  36. public function getDirection();
  37. /**
  38. * The field to sort on
  39. *
  40. * @return string
  41. * @since 12.0.0
  42. */
  43. public function getField();
  44. }