IToken.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2019 Julius Härtl <jus@bitgrid.net>
  4. *
  5. * @author Julius Härtl <jus@bitgrid.net>
  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\DirectEditing;
  24. use OCP\Files\File;
  25. use OCP\Files\NotFoundException;
  26. /**
  27. * @since 18.0.0
  28. */
  29. interface IToken {
  30. /**
  31. * Extend the token validity time
  32. *
  33. * @since 18.0.0
  34. */
  35. public function extend(): void;
  36. /**
  37. * Invalidate the token
  38. *
  39. * @since 18.0.0
  40. */
  41. public function invalidate(): void;
  42. /**
  43. * Check if the token has already been used
  44. *
  45. * @since 18.0.0
  46. * @return bool
  47. */
  48. public function hasBeenAccessed(): bool;
  49. /**
  50. * Change to the user scope of the token
  51. *
  52. * @since 18.0.0
  53. */
  54. public function useTokenScope(): void;
  55. /**
  56. * Get the file that is related to the token
  57. *
  58. * @since 18.0.0
  59. * @return File
  60. * @throws NotFoundException
  61. */
  62. public function getFile(): File;
  63. /**
  64. * @since 18.0.0
  65. * @return string
  66. */
  67. public function getEditor(): string;
  68. /**
  69. * @since 18.0.0
  70. * @return string
  71. */
  72. public function getUser(): string;
  73. }