class YamlFormToWebformMigrateForm in YAML Form 8

YAML Form to Webform migrate form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
  - class \Drupal\yamlform_to_webform\Form\YamlFormToWebformMigrateForm

Expanded class hierarchy of YamlFormToWebformMigrateForm

1 string reference to 'YamlFormToWebformMigrateForm'

yamlform_to_webform.routing.yml in modules/yamlform_to_webform/yamlform_to_webform.routing.yml: modules/yamlform_to_webform/yamlform_to_webform.routing.yml

File

modules/yamlform_to_webform/src/Form/YamlFormToWebformMigrateForm.php, line 18

Namespace

Drupal\yamlform_to_webform\Form

View source

class YamlFormToWebformMigrateForm extends ConfirmFormBase {

  /**
   * The YAML Form to Webform migrate manager.
   *
   * @var \Drupal\yamlform_to_webform\YamlFormToWebformMigrateManager
   */
  protected $migrateManager;

  /**
   * Constructs a new YamlFormToWebformMigrateForm.
   *
   * @param \Drupal\yamlform_to_webform\YamlFormToWebformMigrateManagerInterface $migrate_manager
   *   The YAML Form to Webform migrate manager.
   */
  public function __construct(YamlFormToWebformMigrateManagerInterface $migrate_manager) {
    $this->migrateManager = $migrate_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to migrate from YAML Form 8.x-1.x to Webform 8.x-5.x?');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $build = [
      'description' => [
        '#markup' => '<p>' . $this
          ->t('This will immediately migrate all YAML Form related configuration and submissions to the Webform module.') . '</p>' . '<p>' . $this
          ->t('The migration may take a few minutes.') . '</p>',
      ],
      'items' => [
        '#theme' => 'item_list',
        '#title' => $this
          ->t('After the migration has completed, please review all...'),
        '#items' => [
          $this
            ->t('Forms'),
          $this
            ->t('Blocks'),
          $this
            ->t('Content types'),
          $this
            ->t('Fields'),
          $this
            ->t('Links'),
          $this
            ->t('etc...'),
        ],
      ],
    ];
    return \Drupal::service('renderer')
      ->render($build);
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Migrate');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return Url::fromRoute('entity.yamlform.collection');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    if ($requirements = $this->migrateManager
      ->requirements()) {
      $build = [
        'title' => [
          '#markup' => $this
            ->t('Please review the below requirements'),
        ],
        'requirements' => [
          '#theme' => 'item_list',
          '#items' => $requirements,
        ],
      ];
      drupal_set_message($build, 'error');
      return [];
    }
    if ($this
      ->getRequest()
      ->getMethod() == 'GET') {
      drupal_set_message($this
        ->t('Please make sure to test and <a href="https://www.drupal.org/docs/7/backing-up-and-migrating-a-site">backup your site</a>. <strong>This cannot be undone.</strong>'), 'warning');
    }
    $form = parent::buildForm($form, $form_state);
    $form['confirm'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Yes, I will thoroughly test this migration and back up my site.'),
      '#required' => TRUE,
      '#weight' => 10,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->migrateManager
      ->migrate();

    // DEBUG:

    /*
    $messages = $this->migrateManager->migrate();
    $build = [
      'database' => [
        '#theme' => 'item_list',
        '#items' => $messages,
        '#title' => $this->t('Database changes'),
      ],
    ];
    drupal_set_message($build);
    */

    // Clear Drupal's cache via a new request.
    // @see drush_cache_rebuild()
    $autoloader = (require DRUPAL_ROOT . '/autoload.php');
    require_once DRUPAL_ROOT . '/core/includes/utility.inc';
    $request = Request::createFromGlobals();
    DrupalKernel::bootEnvironment();
    $root = DRUPAL_ROOT;
    $site_path = DrupalKernel::findSitePath($request);
    Settings::initialize($root, $site_path, $autoloader);
    drupal_rebuild($autoloader, $request);

    // Redirect the new Webform page using a simple header redirect because
    // Drupal routing has not been updated.
    drupal_set_message($this
      ->t("YAML Form to Webform migration has completed. Please review your forms and entire site."));
    global $base_url;
    header("Location: {$base_url}/admin/structure/webform");
    die;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	1
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
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.
YamlFormToWebformMigrateForm::$migrateManager	protected	property	The YAML Form to Webform migrate manager.
YamlFormToWebformMigrateForm::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
YamlFormToWebformMigrateForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
YamlFormToWebformMigrateForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
YamlFormToWebformMigrateForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
YamlFormToWebformMigrateForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
YamlFormToWebformMigrateForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
YamlFormToWebformMigrateForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
YamlFormToWebformMigrateForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
YamlFormToWebformMigrateForm::__construct	public	function	Constructs a new YamlFormToWebformMigrateForm.

You are here

class YamlFormToWebformMigrateForm in YAML Form 8

Hierarchy

File

Namespace

Members

API Navigation