mirror of
https://github.com/nextcloud/server.git
synced 2025-02-07 09:59:46 +00:00
60 lines
1.5 KiB
PHP
60 lines
1.5 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/**
|
|
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
namespace OCP\Migration;
|
|
|
|
use Closure;
|
|
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 step
|
|
*
|
|
* @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);
|
|
}
|