80 lines
2.2 KiB
PHP
80 lines
2.2 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
declare(strict_types=1);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @copyright Copyright (c) 2017 Joas Schilling <coding@schilljs.com>
|
||
|
|
*
|
||
|
|
* @author Joas Schilling <coding@schilljs.com>
|
||
|
|
* @author Robin Appelman <robin@icewind.nl>
|
||
|
|
*
|
||
|
|
* @license GNU AGPL version 3 or any later version
|
||
|
|
*
|
||
|
|
* This program is free software: you can redistribute it and/or modify
|
||
|
|
* it under the terms of the GNU Affero General Public License as
|
||
|
|
* published by the Free Software Foundation, either version 3 of the
|
||
|
|
* License, or (at your option) any later version.
|
||
|
|
*
|
||
|
|
* This program is distributed in the hope that it will be useful,
|
||
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
* GNU Affero General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Affero General Public License
|
||
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace OCP\Migration;
|
||
|
|
|
||
|
|
use OCP\DB\ISchemaWrapper;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @since 13.0.0
|
||
|
|
*/
|
||
|
|
interface IMigrationStep {
|
||
|
|
/**
|
||
|
|
* Human readable name of the migration step
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
* @since 14.0.0
|
||
|
|
*/
|
||
|
|
public function name(): string;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Human readable description of the migration steps
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
* @since 14.0.0
|
||
|
|
*/
|
||
|
|
public function description(): string;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param IOutput $output
|
||
|
|
* @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
|
||
|
|
* @psalm-param Closure():ISchemaWrapper $schemaClosure
|
||
|
|
* @param array $options
|
||
|
|
* @since 13.0.0
|
||
|
|
*/
|
||
|
|
public function preSchemaChange(IOutput $output, \Closure $schemaClosure, array $options);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param IOutput $output
|
||
|
|
* @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
|
||
|
|
* @psalm-param Closure():ISchemaWrapper $schemaClosure
|
||
|
|
* @param array $options
|
||
|
|
* @return null|ISchemaWrapper
|
||
|
|
* @since 13.0.0
|
||
|
|
*/
|
||
|
|
public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param IOutput $output
|
||
|
|
* @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
|
||
|
|
* @psalm-param Closure():ISchemaWrapper $schemaClosure
|
||
|
|
* @param array $options
|
||
|
|
* @since 13.0.0
|
||
|
|
*/
|
||
|
|
public function postSchemaChange(IOutput $output, \Closure $schemaClosure, array $options);
|
||
|
|
}
|