ICollection.php 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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. *
  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\Collaboration\Resources;
  25. use OCP\IUser;
  26. /**
  27. * @since 16.0.0
  28. */
  29. interface ICollection {
  30. /**
  31. * @return int
  32. * @since 16.0.0
  33. */
  34. public function getId(): int;
  35. /**
  36. * @return string
  37. * @since 16.0.0
  38. */
  39. public function getName(): string;
  40. /**
  41. * @param string $name
  42. * @since 16.0.0
  43. */
  44. public function setName(string $name): void;
  45. /**
  46. * @return IResource[]
  47. * @since 16.0.0
  48. */
  49. public function getResources(): array;
  50. /**
  51. * Adds a resource to a collection
  52. *
  53. * @param IResource $resource
  54. * @throws ResourceException when the resource is already part of the collection
  55. * @since 16.0.0
  56. */
  57. public function addResource(IResource $resource): void;
  58. /**
  59. * Removes a resource from a collection
  60. *
  61. * @param IResource $resource
  62. * @since 16.0.0
  63. */
  64. public function removeResource(IResource $resource): void;
  65. /**
  66. * Can a user/guest access the collection
  67. *
  68. * @param IUser|null $user
  69. * @return bool
  70. * @since 16.0.0
  71. */
  72. public function canAccess(?IUser $user): bool;
  73. }