RegisterWidgetEvent.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
  5. *
  6. * @author Julius Härtl <jus@bitgrid.net>
  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. use OCP\EventDispatcher\Event;
  26. /**
  27. * Class RegisterPanelEvent
  28. *
  29. * This event is dispatched to allow apps supporting older Nextcloud versions to
  30. * still register their dashboard panels so that they are only constructed when
  31. * they are needed. Deprecated right away so we can drop it again after 19 is EOL
  32. * and backward compatible apps can use OCP\AppFramework\Bootstrap\IBootstrap
  33. *
  34. * @since 20.0.0
  35. * @deprecated 20.0.0
  36. */
  37. class RegisterWidgetEvent extends Event {
  38. private $manager;
  39. public function __construct(IManager $manager) {
  40. parent::__construct();
  41. $this->manager = $manager;
  42. }
  43. /**
  44. * @param string $panelClass
  45. * @since 20.0.0
  46. */
  47. public function registerWidget(string $panelClass) {
  48. $this->manager->lazyRegisterWidget($panelClass);
  49. }
  50. }