IMigrationStep

interface OCP\Migration\IMigrationStep
Implemented by:OCP\Migration\SimpleMigrationStep
Source:lib/public/Migration/IMigrationStep.php#36

Methods

public OCP\Migration\IMigrationStep::name()
Human readable name of the migration step
Source:lib/public/Migration/IMigrationStep.php#43
Returns:string
Since:14.0.0
public OCP\Migration\IMigrationStep::description()
Human readable description of the migration steps
Source:lib/public/Migration/IMigrationStep.php#51
Returns:string
Since:14.0.0
public OCP\Migration\IMigrationStep::preSchemaChange($output, $schemaClosure, $options)
Source:

lib/public/Migration/IMigrationStep.php#60

Parameters:
  • $output (OCP\Migration\IOutput)
  • $schemaClosure (Closure) The Closure returns a ISchemaWrapper
  • $options (array)
Since:

13.0.0

public OCP\Migration\IMigrationStep::changeSchema($output, $schemaClosure, $options)
Source:

lib/public/Migration/IMigrationStep.php#70

Parameters:
  • $output (OCP\Migration\IOutput)
  • $schemaClosure (Closure) The Closure returns a ISchemaWrapper
  • $options (array)
Returns:

null | \OCP\DB\ISchemaWrapper

Since:

13.0.0

public OCP\Migration\IMigrationStep::postSchemaChange($output, $schemaClosure, $options)
Source:

lib/public/Migration/IMigrationStep.php#79

Parameters:
  • $output (OCP\Migration\IOutput)
  • $schemaClosure (Closure) The Closure returns a ISchemaWrapper
  • $options (array)
Since:

13.0.0