1
0

IChange.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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\Notify;
  25. /**
  26. * Represents a detected change in the storage
  27. *
  28. * @since 12.0.0
  29. */
  30. interface IChange {
  31. public const ADDED = 1;
  32. public const REMOVED = 2;
  33. public const MODIFIED = 3;
  34. public const RENAMED = 4;
  35. /**
  36. * Get the type of the change
  37. *
  38. * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED
  39. *
  40. * @since 12.0.0
  41. */
  42. public function getType();
  43. /**
  44. * Get the path of the file that was changed relative to the root of the storage
  45. *
  46. * Note, for rename changes this path is the old path for the file
  47. *
  48. * @return mixed
  49. *
  50. * @since 12.0.0
  51. */
  52. public function getPath();
  53. }