IMigrationStep.php 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2017 Joas Schilling <coding@schilljs.com>
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Joas Schilling <coding@schilljs.com>
  8. * @author Robin Appelman <robin@icewind.nl>
  9. *
  10. * @license GNU AGPL version 3 or any later version
  11. *
  12. * This program is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License as
  14. * published by the Free Software Foundation, either version 3 of the
  15. * License, or (at your option) any later version.
  16. *
  17. * This program is distributed in the hope that it will be useful,
  18. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. * GNU Affero General Public License for more details.
  21. *
  22. * You should have received a copy of the GNU Affero General Public License
  23. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24. *
  25. */
  26. namespace OCP\Migration;
  27. use OCP\DB\ISchemaWrapper;
  28. /**
  29. * @since 13.0.0
  30. */
  31. interface IMigrationStep {
  32. /**
  33. * Human readable name of the migration step
  34. *
  35. * @return string
  36. * @since 14.0.0
  37. */
  38. public function name(): string;
  39. /**
  40. * Human readable description of the migration steps
  41. *
  42. * @return string
  43. * @since 14.0.0
  44. */
  45. public function description(): string;
  46. /**
  47. * @param IOutput $output
  48. * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
  49. * @psalm-param Closure():ISchemaWrapper $schemaClosure
  50. * @param array $options
  51. * @since 13.0.0
  52. */
  53. public function preSchemaChange(IOutput $output, \Closure $schemaClosure, array $options);
  54. /**
  55. * @param IOutput $output
  56. * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
  57. * @psalm-param Closure():ISchemaWrapper $schemaClosure
  58. * @param array $options
  59. * @return null|ISchemaWrapper
  60. * @since 13.0.0
  61. */
  62. public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options);
  63. /**
  64. * @param IOutput $output
  65. * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
  66. * @psalm-param Closure():ISchemaWrapper $schemaClosure
  67. * @param array $options
  68. * @since 13.0.0
  69. */
  70. public function postSchemaChange(IOutput $output, \Closure $schemaClosure, array $options);
  71. }