ISetupCheck.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2022 Carl Schwan <carl@carlschwan.eu>
  5. *
  6. * @author Carl Schwan <carl@carlschwan.eu>
  7. * @author Côme Chilliet <come.chilliet@nextcloud.com>
  8. *
  9. * @license AGPL-3.0
  10. *
  11. * This code is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License, version 3,
  13. * as published by the Free Software Foundation.
  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, version 3,
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>
  22. *
  23. */
  24. namespace OCP\SetupCheck;
  25. /**
  26. * This interface needs to be implemented if you want to provide custom
  27. * setup checks in your application. The results of these checks will them
  28. * be displayed in the admin overview.
  29. *
  30. * @since 28.0.0
  31. */
  32. interface ISetupCheck {
  33. /**
  34. * @since 28.0.0
  35. * @return string Category id, one of security/system/accounts, or a custom one which will be merged in system
  36. */
  37. public function getCategory(): string;
  38. /**
  39. * @since 28.0.0
  40. * @return string Translated name to display to the user
  41. */
  42. public function getName(): string;
  43. /**
  44. * @since 28.0.0
  45. */
  46. public function run(): SetupResult;
  47. }