You are here

Home » API reference » Drupal-to-Drupal data migration 8.3 » FileForm.php

class FileForm in Drupal-to-Drupal data migration 8.3

Simple wizard step form.

Hierarchy

Expanded class hierarchy of FileForm

File

migrate_d2d_ui/src/Form/FileForm.php, line 11

Namespace

Drupal\migrate_d2d_ui\Form
View source 
class FileForm extends DrupalMigrateForm {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');
    if ($this
      ->connection($form_state)
      ->schema()
      ->tableExists('file_managed')) {
      $file_table = 'file_managed';
    }
    else {
      $file_table = 'files';
    }
    $file_count = $this
      ->connection($form_state)
      ->select($file_table, 'f')
      ->fields('f', array(
      'fid',
    ))
      ->countQuery()
      ->execute()
      ->fetchField();
    if ($file_count) {
      if ($cached_values['user_migration'] && $cached_values['version'] == 6) {
        $form['picture_migration'] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('Perform import of user pictures'),
          '#default_value' => TRUE,
        ];
      }
      else {
        $form['picture_migration'] = array(
          '#type' => 'value',
          '#value' => FALSE,
        );
      }
      if ($cached_values['version'] == 6) {
        $title = $this
          ->t('Perform import of files other than user pictures');
      }
      else {
        $title = $this
          ->t('Perform import of files');
      }
      $form['file_migration'] = [
        '#type' => 'checkbox',
        '#title' => $title,
        '#default_value' => TRUE,
      ];
      if ($cached_values['version'] == 7) {
        $form['instructions'] = [
          '#markup' => $this
            ->t('To be able to retrieve any uploaded files from your legacy site, we need to know where to find them. If your legacy site is on the same web server as the destination site, or you have copied your file directory to the web server, please provide the full file directory - for example, <em>/var/www/drupal/sites/example.com/files/</em>. Otherwise, we need the web address of that directory. To determine that address:
<ol><li>Please visit a node on the site containing images, or a user profile with an uploaded picture. Try to find an example where the full resolution image is displayed.</li>
<li>Right-click on the picture and look for an operation such as <em>View Image</em>.</li>
<li>Choose that function and look at the URL of the image - it will usually look something like <em>http://example.com/sites/default/files/pictures/picture-3.jpg</em> (for user pictures) or <em>http://example.com/sites/default/files/my-photo.jpg</em> (for files uploaded to nodes).</li>
<li>If you see after the <em>files</em> portion of the path something like <em>styles</em> or <em>imagecache</em>, you are most likely looking at an automatically generated variation of the image, not the original. It will take some trial and error, removing intermediate portions of the path (such as <em>styles/medium/</em>) to find the original image.</li>
<li>Please enter the full address of the files directory (<em>http://example.com/sites/default/files/</em>) below. Leave the field empty to skip migrating files.</li></ol>'),
        ];
      }
      else {
        $form['instructions'] = [
          '#markup' => $this
            ->t('To be able to retrieve any uploaded files from your legacy site, we need to know where to find them. If your legacy site is on the same web server as the destination site, or you have copied your file directory to the web server, please provide the full file directory - for example, <em>/var/www/drupal/sites/example.com/files/</em>. Otherwise, please provide the address of your legacy site (e.g., <em>http://example.com/</em> below. Leave the field empty to skip migrating files.'),
        ];
      }
      $form['description'] = [
        '#markup' => $this
          ->t('There are @count files (including user pictures) available to be migrated.', [
          '@count' => $file_count,
        ]),
      ];
      $form['source_base_path'] = [
        '#type' => 'textfield',
        '#size' => 60,
        '#title' => $this
          ->t('File prefix'),
      ];
    }
    else {
      $form['description'] = [
        '#markup' => $this
          ->t('There are no files to be migrated from your source site.'),
      ];
    }
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');
    $cached_values['file_migration'] = $form_state
      ->getValue('file_migration');
    $cached_values['picture_migration'] = $form_state
      ->getValue('picture_migration');
    $cached_values['source_base_path'] = $form_state
      ->getValue('source_base_path');
    $form_state
      ->setTemporaryValue('wizard', $cached_values);
  }

}

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
DrupalMigrateForm::$sourceConnection protected property Cached database connection.
DrupalMigrateForm::connection protected function Gets the database connection for the source Drupal database.
FileForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FileForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FileForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FileForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.
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.