SimpleMigrationStep.php 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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. abstract class SimpleMigrationStep implements 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. return '';
  37. }
  38. /**
  39. * Human readable description of the migration step
  40. *
  41. * @return string
  42. * @since 14.0.0
  43. */
  44. public function description(): string {
  45. return '';
  46. }
  47. /**
  48. * @param IOutput $output
  49. * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
  50. * @param array $options
  51. * @since 13.0.0
  52. */
  53. public function preSchemaChange(IOutput $output, \Closure $schemaClosure, array $options) {
  54. }
  55. /**
  56. * @param IOutput $output
  57. * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
  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. return null;
  64. }
  65. /**
  66. * @param IOutput $output
  67. * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
  68. * @param array $options
  69. * @since 13.0.0
  70. */
  71. public function postSchemaChange(IOutput $output, \Closure $schemaClosure, array $options) {
  72. }
  73. }