Add human readable description to migration steps

Signed-off-by: Robin Appelman <robin@icewind.nl>

2 files changed, 32 insertions, 0 deletions

diff --git a/lib/public/Migration/IMigrationStep.php b/lib/public/Migration/IMigrationStep.php
index e12d962683e..6b9da280d78 100644
--- a/lib/public/Migration/IMigrationStep.php
+++ b/lib/public/Migration/IMigrationStep.php
@@ -29,6 +29,21 @@ 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
diff --git a/lib/public/Migration/SimpleMigrationStep.php b/lib/public/Migration/SimpleMigrationStep.php
index da46c687644..c515592bde9 100644
--- a/lib/public/Migration/SimpleMigrationStep.php
+++ b/lib/public/Migration/SimpleMigrationStep.php
@@ -29,6 +29,23 @@ use OCP\DB\ISchemaWrapper;
  * @since 13.0.0
  */
 abstract class SimpleMigrationStep implements IMigrationStep {
+	/**
+	 * Human readable name of the migration step
+	 *
+	 * @return string
+	 */
+	public function name(): string {
+		return '';
+	}
+
+	/**
+	 * Human readable description of the migration step
+	 *
+	 * @return string
+	 */
+	public function description(): string {
+		return '';
+	}
 
 	/**
 	 * @param IOutput $output