ICapability.php 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Roeland Jago Douma <roeland@famdouma.nl>
  6. *
  7. * @license AGPL-3.0
  8. *
  9. * This code is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License, version 3,
  11. * as published by the Free Software Foundation.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU Affero General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU Affero General Public License, version 3,
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>
  20. *
  21. */
  22. namespace OCP\Capabilities;
  23. /**
  24. * Minimal interface that has to be implemented for a class to be considered
  25. * a capability.
  26. *
  27. * In an application use:
  28. * $this->getContainer()->registerCapability('OCA\MY_APP\Capabilities');
  29. * To register capabilities.
  30. *
  31. * The class 'OCA\MY_APP\Capabilities' must then implement ICapability
  32. *
  33. * @since 8.2.0
  34. */
  35. interface ICapability {
  36. /**
  37. * Function an app uses to return the capabilities
  38. *
  39. * @return array Array containing the apps capabilities
  40. * @since 8.2.0
  41. */
  42. public function getCapabilities();
  43. }