IResource.php 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com>
  5. *
  6. * @author Joas Schilling <coding@schilljs.com>
  7. * @author Julius Härtl <jus@bitgrid.net>
  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\Collaboration\Resources;
  26. use OCP\IUser;
  27. /**
  28. * @since 16.0.0
  29. */
  30. interface IResource {
  31. /**
  32. * @return string
  33. * @since 16.0.0
  34. */
  35. public function getType(): string;
  36. /**
  37. * @return string
  38. * @since 16.0.0
  39. */
  40. public function getId(): string;
  41. /**
  42. * @return array
  43. * @since 16.0.0
  44. */
  45. public function getRichObject(): array;
  46. /**
  47. * Can a user/guest access the resource
  48. *
  49. * @param IUser|null $user
  50. * @return bool
  51. * @since 16.0.0
  52. */
  53. public function canAccess(?IUser $user): bool;
  54. /**
  55. * @return ICollection[]
  56. * @since 16.0.0
  57. */
  58. public function getCollections(): array;
  59. }