IConditionalWidget.php 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2022 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\Dashboard;
  25. /**
  26. * interface IConditionalWidget
  27. *
  28. * Allows an app to lazy-register a widget and in the lazy part of the code
  29. * it can decide if the widget should really be registered.
  30. *
  31. * @since 26.0.0
  32. */
  33. interface IConditionalWidget extends IWidget {
  34. /**
  35. * @return bool Whether the widget is enabled and should be registered
  36. * @since 26.0.0
  37. */
  38. public function isEnabled(): bool;
  39. }