You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

63 lines
1.7 KiB

3 years ago
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
  4. *
  5. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  6. * @author Robin Appelman <robin@icewind.nl>
  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\Files\Search;
  25. /**
  26. * @since 12.0.0
  27. */
  28. interface ISearchComparison extends ISearchOperator {
  29. public const COMPARE_EQUAL = 'eq';
  30. public const COMPARE_GREATER_THAN = 'gt';
  31. public const COMPARE_GREATER_THAN_EQUAL = 'gte';
  32. public const COMPARE_LESS_THAN = 'lt';
  33. public const COMPARE_LESS_THAN_EQUAL = 'lte';
  34. public const COMPARE_LIKE = 'like';
  35. /**
  36. * Get the type of comparison, one of the ISearchComparison::COMPARE_* constants
  37. *
  38. * @return string
  39. * @since 12.0.0
  40. */
  41. public function getType();
  42. /**
  43. * Get the name of the field to compare with
  44. *
  45. * i.e. 'size', 'name' or 'mimetype'
  46. *
  47. * @return string
  48. * @since 12.0.0
  49. */
  50. public function getField();
  51. /**
  52. * Get the value to compare the field with
  53. *
  54. * @return string|integer|\DateTime
  55. * @since 12.0.0
  56. */
  57. public function getValue();
  58. }