From 8237e02cf7b98f076f8fd89cf69fad36170119f6 Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Tue, 6 Dec 2022 11:40:10 +0100 Subject: [PATCH] fix(database): Explicitly inherit stricly typed database schema closure Signed-off-by: Christoph Wurst --- lib/public/Migration/IMigrationStep.php | 17 +++++++------ lib/public/Migration/SimpleMigrationStep.php | 26 ++++++++++++++------ 2 files changed, 27 insertions(+), 16 deletions(-) diff --git a/lib/public/Migration/IMigrationStep.php b/lib/public/Migration/IMigrationStep.php index 1b5aa828994..da9f62e861e 100644 --- a/lib/public/Migration/IMigrationStep.php +++ b/lib/public/Migration/IMigrationStep.php @@ -27,6 +27,7 @@ declare(strict_types=1); */ namespace OCP\Migration; +use Closure; use OCP\DB\ISchemaWrapper; /** @@ -34,7 +35,7 @@ use OCP\DB\ISchemaWrapper; */ interface IMigrationStep { /** - * Human readable name of the migration step + * Human-readable name of the migration step * * @return string * @since 14.0.0 @@ -42,7 +43,7 @@ interface IMigrationStep { public function name(): string; /** - * Human readable description of the migration steps + * Human-readable description of the migration step * * @return string * @since 14.0.0 @@ -51,29 +52,29 @@ interface IMigrationStep { /** * @param IOutput $output - * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` + * @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); + public function preSchemaChange(IOutput $output, Closure $schemaClosure, array $options); /** * @param IOutput $output - * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` + * @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); + public function changeSchema(IOutput $output, Closure $schemaClosure, array $options); /** * @param IOutput $output - * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` + * @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); + public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options); } diff --git a/lib/public/Migration/SimpleMigrationStep.php b/lib/public/Migration/SimpleMigrationStep.php index e8d19f533ac..ee657cda470 100644 --- a/lib/public/Migration/SimpleMigrationStep.php +++ b/lib/public/Migration/SimpleMigrationStep.php @@ -28,12 +28,15 @@ declare(strict_types=1); */ namespace OCP\Migration; +use Closure; +use OCP\DB\ISchemaWrapper; + /** * @since 13.0.0 */ abstract class SimpleMigrationStep implements IMigrationStep { /** - * Human readable name of the migration step + * Human-readable name of the migration step * * @return string * @since 14.0.0 @@ -43,7 +46,7 @@ abstract class SimpleMigrationStep implements IMigrationStep { } /** - * Human readable description of the migration step + * Human-readable description of the migration step * * @return string * @since 14.0.0 @@ -53,16 +56,21 @@ abstract class SimpleMigrationStep implements IMigrationStep { } /** - * {@inheritDoc} - * + * @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) { } /** - * {@inheritDoc} - * + * @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) { @@ -70,8 +78,10 @@ abstract class SimpleMigrationStep implements IMigrationStep { } /** - * {@inheritDoc} - * + * @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) { -- 2.39.5