class MigrateUIStep in Migrate 7.2

Class representing one step of a wizard.

Hierarchy

• class \MigrateUIStep

File

migrate_ui/migrate_ui.wizard.inc, line 555

Migration wizard framework.

class MigrateUIStep {

  /**
   * A translatable string briefly describing this step, to be used in the page
   * title for the step form.
   *
   * @var string
   */
  protected $name;
  public function getName() {
    return $this->name;
  }

  /**
   * Callable that returns the form array for this step.
   *
   * @var string
   */
  protected $formMethod;
  public function getFormMethod() {
    return $this->formMethod;
  }

  /**
   * The form values ($form_state['values']) submitted for this step, saved in
   * case we need to restore them on a Previous action.
   *
   * @var array
   */
  protected $formValues;
  public function getFormValues() {
    return $this->formValues;
  }
  public function setFormValues($form_values) {
    $this->formValues = $form_values;
  }

  /**
   * Any contextual data needed by the form for this step. For example, a
   * field mapping form would need to know the source and destination content
   * types so it can determine what fields to expose.
   *
   * @var mixed
   */
  protected $context;
  public function getContext() {
    return $this->context;
  }

  /**
   * The step object is a node in a doubly-linked list - it links to its
   * predecessor and successor steps.
   *
   * @var MigrateUIStep
   */
  public $nextStep;

  /**
   * @var MigrateUIStep
   */
  public $previousStep;

  /**
   * Class constructor.
   *
   * @param $name
   *  The machine name of the wizard step.
   * @param $form_method
   *  A callable for the form array for this step. The validation method is
   *  formed from the method name with the suffix 'Validate' added, regardless
   *  of which object it is on.
   * @param $context = NULL
   *  Contextual data needed by the form for this step.
   */
  public function __construct($name, $form_method, $context = NULL) {
    $this->name = $name;
    $this->formMethod = $form_method;
    $this->context = $context;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateUIStep::$context	protected	property	Any contextual data needed by the form for this step. For example, a field mapping form would need to know the source and destination content types so it can determine what fields to expose.
MigrateUIStep::$formMethod	protected	property	Callable that returns the form array for this step.
MigrateUIStep::$formValues	protected	property	The form values ($form_state['values']) submitted for this step, saved in case we need to restore them on a Previous action.
MigrateUIStep::$name	protected	property	A translatable string briefly describing this step, to be used in the page title for the step form.
MigrateUIStep::$nextStep	public	property	The step object is a node in a doubly-linked list - it links to its predecessor and successor steps.
MigrateUIStep::$previousStep	public	property
MigrateUIStep::getContext	public	function
MigrateUIStep::getFormMethod	public	function
MigrateUIStep::getFormValues	public	function
MigrateUIStep::getName	public	function
MigrateUIStep::setFormValues	public	function
MigrateUIStep::__construct	public	function	Class constructor.