1
0

AddMissingColumnsEvent.php 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2023 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\DB\Events;
  25. /**
  26. * Event to allow apps to register information about missing database columns
  27. *
  28. * This event will be dispatched for checking on the admin settings and when running
  29. * occ db:add-missing-columns which will then create those columns
  30. *
  31. * @since 28.0.0
  32. */
  33. class AddMissingColumnsEvent extends \OCP\EventDispatcher\Event {
  34. /** @var array<array-key, array{tableName: string, columnName: string, typeName: string, options: array{}}> */
  35. private array $missingColumns = [];
  36. /**
  37. * @param mixed[] $options
  38. * @since 28.0.0
  39. */
  40. public function addMissingColumn(string $tableName, string $columnName, string $typeName, array $options): void {
  41. $this->missingColumns[] = [
  42. 'tableName' => $tableName,
  43. 'columnName' => $columnName,
  44. 'typeName' => $typeName,
  45. 'options' => $options,
  46. ];
  47. }
  48. /**
  49. * @since 28.0.0
  50. * @return array<array-key, array{tableName: string, columnName: string, typeName: string, options: array{}}>
  51. */
  52. public function getMissingColumns(): array {
  53. return $this->missingColumns;
  54. }
  55. }