ITrashItem.php 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2018 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 OCA\Files_Trashbin\Trash;
  24. use OCP\Files\FileInfo;
  25. use OCP\IUser;
  26. /**
  27. * @since 15.0.0
  28. */
  29. interface ITrashItem extends FileInfo {
  30. /**
  31. * Get the trash backend for this item
  32. *
  33. * @return ITrashBackend
  34. * @since 15.0.0
  35. */
  36. public function getTrashBackend(): ITrashBackend;
  37. /**
  38. * Get the original location for the trash item
  39. *
  40. * @return string
  41. * @since 15.0.0
  42. */
  43. public function getOriginalLocation(): string;
  44. /**
  45. * Get the timestamp that the file was moved to trash
  46. *
  47. * @return int
  48. * @since 15.0.0
  49. */
  50. public function getDeletedTime(): int;
  51. /**
  52. * Get the path of the item relative to the users trashbin
  53. *
  54. * @return string
  55. * @since 15.0.0
  56. */
  57. public function getTrashPath(): string;
  58. /**
  59. * Whether the item is a deleted item in the root of the trash, or a file in a subfolder
  60. *
  61. * @return bool
  62. * @since 15.0.0
  63. */
  64. public function isRootItem(): bool;
  65. /**
  66. * Get the user for which this trash item applies
  67. *
  68. * @return IUser
  69. * @since 15.0.0
  70. */
  71. public function getUser(): IUser;
  72. public function getTitle(): string;
  73. }