You are here

Home » API reference » WordPress Migrate 8.3 » SourceSelectForm.php

class SourceSelectForm in WordPress Migrate 8.3

Simple wizard step form.

Hierarchy

Expanded class hierarchy of SourceSelectForm

File

wordpress_migrate_ui/src/Form/SourceSelectForm.php, line 13

Namespace

Drupal\wordpress_migrate_ui\Form
View source 
class SourceSelectForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // @todo Make sure we have a private directory configured.
    // @link https://www.drupal.org/node/2742291
    // @todo Support importing directly from WP admin interface.
    // @link https://www.drupal.org/node/2742293
    // @todo Support importing from the directory directly.
    // @link https://www.drupal.org/node/2742295
    // @todo Support importing from a database.
    // @link https://www.drupal.org/node/2742299
    $form['overview'] = [
      '#markup' => $this
        ->t('This wizard supports importing into your Drupal site from a WordPress blog. To be able to use this wizard, you must have an XML file exported from the blog.'),
    ];
    $form['description'] = [
      '#markup' => $this
        ->t('<br /><br />You will be led through a series of steps, allowing you to customize what will be imported into Drupal and how it will be mapped. At the end of this process, a migration group will be generated.'),
    ];
    $form['wxr_file'] = [
      '#type' => 'file',
      '#title' => $this
        ->t('WordPress exported file (WXR)'),
      '#description' => $this
        ->t('Select an exported WordPress file (.xml extension). Maximum file size is @size.', [
        '@size' => format_size(Environment::getUploadMaxSize()),
      ]),
    ];
    $form['keep_wxr_file'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Permanently save uploaded WXR file'),
      '#description' => $this
        ->t('The uploaded WXR file will be kept in your site permanently. It will always be visible on the "Files" section of the Content administration area.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $all_files = $this
      ->getRequest()->files
      ->get('files', []);
    if (empty($all_files['wxr_file'])) {
      $form_state
        ->setErrorByName('wxr_file', $this
        ->t('You must upload a file to continue.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $validators = [
      'file_validate_extensions' => [
        'xml',
      ],
    ];

    // file_save_upload renames if file already exists (default behavior)
    $file = file_save_upload('wxr_file', $validators, 'public://', 0);
    if ($file) {
      $cached_values = $form_state
        ->getTemporaryValue('wizard');
      $cached_values['file_uri'] = $file
        ->getFileUri();
      if ($form_state
        ->getValue('keep_wxr_file')) {

        /* Set the status flag permanent of the file object */
        $file
          ->setPermanent();

        /* Save the file in database */
        try {
          $file
            ->save();
        } catch (EntityStorageException $e) {
          $this
            ->messenger()
            ->addError('The WXR file failed to upload. Please try again.');
          $this
            ->logger('wordpress_migrate')
            ->error('The WXR file failed to upload. (EntityStorageException)');
        }
      }
      $form_state
        ->setTemporaryValue('wizard', $cached_values);

      // @todo: Preprocess the file
      // @link https://www.drupal.org/node/2742301
    }
    else {
      $form_state
        ->setRebuild();
      $this
        ->messenger()
        ->addError($this
        ->t('WXR file upload failed. Please try again. Your log messages may have additional information.'));
      $this
        ->logger('wordpress_migrate')
        ->error('The WXR file failed to upload.');
    }
  }

}

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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
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.
SourceSelectForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SourceSelectForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SourceSelectForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SourceSelectForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.