abstract class MigrateUIWizardExtender in Migrate 7.2

Hierarchy

• class \MigrateUIWizardExtender

File

migrate_ui/migrate_ui.wizard.inc, line 644

Migration wizard framework.

abstract class MigrateUIWizardExtender {

  /**
   * Reference to the wizard object that this extender applies to.
   */
  protected $wizard;

  /**
   * Class constructor.
   *
   * Wizard extenders should override this to add their steps to the wizard.
   */
  public function __construct(MigrateUIWizard $wizard, array $wizard_steps) {
    $this->wizard = $wizard;
  }

  /**
   * Alter the arguments to a migration before it is registered, or potentially
   * reject it.
   *
   * @param string $machine_name
   *  Machine name for the migration class.
   * @param string $class_name
   *  Name of the Migration class to instantiate.
   * @param array $arguments
   *  Further information configuring the migration.
   * @param MigrateUIWizard $wizard
   *  The wizard class performing the registration.
   *
   * @return bool
   *  Return FALSE to prevent registration of this migration.
   */
  public function addMigrationAlter($machine_name, $class_name, &$arguments, $wizard) {
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateUIWizardExtender::$wizard	protected	property	Reference to the wizard object that this extender applies to.
MigrateUIWizardExtender::addMigrationAlter	public	function	Alter the arguments to a migration before it is registered, or potentially reject it.
MigrateUIWizardExtender::__construct	public	function	Class constructor.