1
0

IMigrationStep.php 2.0 KB

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