1
0

ISearchOrder.php 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
  4. *
  5. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  6. * @author Maxence Lange <maxence@artificial-owl.com>
  7. * @author Robin Appelman <robin@icewind.nl>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\Files\Search;
  26. use OCP\Files\FileInfo;
  27. /**
  28. * @since 12.0.0
  29. */
  30. interface ISearchOrder {
  31. /**
  32. * @since 12.0.0
  33. */
  34. public const DIRECTION_ASCENDING = 'asc';
  35. /**
  36. * @since 12.0.0
  37. */
  38. public const DIRECTION_DESCENDING = 'desc';
  39. /**
  40. * The direction to sort in, either ISearchOrder::DIRECTION_ASCENDING or ISearchOrder::DIRECTION_DESCENDING
  41. *
  42. * @return string
  43. * @since 12.0.0
  44. */
  45. public function getDirection(): string;
  46. /**
  47. * The field to sort on
  48. *
  49. * @return string
  50. * @since 12.0.0
  51. */
  52. public function getField(): string;
  53. /**
  54. * extra means data are not related to the main files table
  55. *
  56. * @return string
  57. * @since 28.0.0
  58. */
  59. public function getExtra(): string;
  60. /**
  61. * Apply the sorting on 2 FileInfo objects
  62. *
  63. * @param FileInfo $a
  64. * @param FileInfo $b
  65. * @return int -1 if $a < $b, 0 if $a = $b, 1 if $a > $b (for ascending, reverse for descending)
  66. * @since 22.0.0
  67. */
  68. public function sortFileInfo(FileInfo $a, FileInfo $b): int;
  69. }