You are here

Home » API reference » Workbench Moderation to Content Moderation 8 » MigrateForm.php

class MigrateForm in Workbench Moderation to Content Moderation 8

A form to trigger batch processing if state is valid.

Hierarchy

Expanded class hierarchy of MigrateForm

1 string reference to 'MigrateForm'
wbm2cm.routing.yml in ./wbm2cm.routing.yml
wbm2cm.routing.yml

File

src/Form/MigrateForm.php, line 13

Namespace

Drupal\wbm2cm\Form
View source 
class MigrateForm extends FormBase {

  /**
   * The WBM2CM migration manager service.
   *
   * @var \Drupal\wbm2cm\MigrateManager
   */
  protected $migrate;

  /**
   * {@inheritdoc}
   */
  public function __construct(MigrateManager $migrate_manager) {
    $this->migrate = $migrate_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('wbm2cm.migrate_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'migrate_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $is_complete = $this->migrate
      ->isComplete();
    if ($is_complete) {
      return $this
        ->buildFormForComplete($form, $form_state);
    }
    else {
      return $this
        ->buildFormForIncomplete($form, $form_state);
    }
  }

  /**
   * Build the form for when the migration is complete.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The form structure.
   */
  protected function buildFormForComplete(array $form, FormStateInterface $form_state) {
    $form['info'] = [
      '#type' => 'html_tag',
      '#tag' => 'div',
      // @todo link the the uninstall page
      '#value' => 'The migration is complete! You may now uninstall this module.',
    ];
    return $form;
  }

  /**
   * Build the form for when the migration is NOT complete.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The form structure.
   */
  protected function buildFormForIncomplete(array $form, FormStateInterface $form_state) {
    $form['info'] = [
      '#type' => 'html_tag',
      '#tag' => 'div',
      // @todo turn the URL into a link
      '#value' => 'This migration is experimental and is designed for Drupal 8.4 alpha, migrating from Workbench Moderation to Content Moderation. There are known issues and many untested scenarios. For more details, see https://www.drupal.org/node/2897870.',
    ];
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Migrate'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $messages = $this->migrate
      ->getValidationMessages();
    foreach ($messages as $message_id => $message) {
      $form_state
        ->setErrorByName($message_id, $message);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('wbm2cm.migrate');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
MigrateForm::$migrate protected property The WBM2CM migration manager service.
MigrateForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
MigrateForm::buildFormForComplete protected function Build the form for when the migration is complete.
MigrateForm::buildFormForIncomplete protected function Build the form for when the migration is NOT complete.
MigrateForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MigrateForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MigrateForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
MigrateForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
MigrateForm::__construct public function
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.