You are here

Home » API reference » Content Synchronizer 8 » LaunchImportForm.php

class LaunchImportForm in Content Synchronizer 8

Same name and namespace in other branches
  1. 8.2 src/Form/LaunchImportForm.php \Drupal\content_synchronizer\Form\LaunchImportForm
  2. 3.x src/Form/LaunchImportForm.php \Drupal\content_synchronizer\Form\LaunchImportForm

Launch Import Form.

Hierarchy

Expanded class hierarchy of LaunchImportForm

2 files declare their use of LaunchImportForm
ContentSynchronizerCommands.php in src/Commands/ContentSynchronizerCommands.php
content_synchronizer.drush.inc in ./content_synchronizer.drush.inc
Drush commands for content_synchronizer module.

File

src/Form/LaunchImportForm.php, line 14

Namespace

Drupal\content_synchronizer\Form
View source 
class LaunchImportForm extends FormBase {
  const CREATION_ACTION_LABEL = 'Action on entity creation';
  const CREATION_ACTION_PUBLISH_LABEL = 'Publish created content';
  const CREATION_ACTION_UNPUBLISH_LABEL = 'Do not publish created content';
  const UPDATE_ACTION_LABEL = 'Action on entity update';
  const UPDATE_ACTION_SYSTEMATIC_LABEL = 'Always update existing entity with importing content';
  const UPDATE_ACTION_IF_RECENT_LABEL = 'Update existing entity with importing content only if the last change date of importing content is more recent than the last change date of the corresponding existing entity';
  const UPDATE_ACTION_NO_UPDATE_LABEL = 'Do not update existing content';

  /**
   * The import entity.
   *
   * @var \Drupal\content_synchronizer\Entity\ImportEntity
   */
  protected $import;

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'content_synchronizer.import.launch';
  }

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

    /** @var \Drupal\content_synchronizer\Entity\ImportEntity $import */
    $this->import = $form_state
      ->getBuildInfo()['import'];
    if ($this->import
      ->getProcessingStatus() === ImportEntity::STATUS_NOT_STARTED) {

      // Settings.
      $form['settings'] = [
        '#type' => 'fieldset',
        '#title' => t('Settings'),
      ];
      $form['settings']['creationType'] = [
        '#type' => 'radios',
        '#title' => t(static::CREATION_ACTION_LABEL),
        '#options' => static::getCreateOptions(),
        '#default_value' => ImportProcessor::PUBLICATION_PUBLISH,
      ];
      $form['settings']['updateType'] = [
        '#type' => 'radios',
        '#title' => t(static::UPDATE_ACTION_LABEL),
        '#options' => static::getUpdateOptions(),
        '#default_value' => ImportProcessor::UPDATE_IF_RECENT,
      ];
    }

    // Entity list.
    $this
      ->initRootEntitiesList($form);
    if ($this->import
      ->getProcessingStatus() === ImportEntity::STATUS_NOT_STARTED) {
      $form['launch'] = [
        '#type' => 'submit',
        '#value' => t('Import selected entities'),
        '#button_type' => 'primary',
      ];
    }
    return $form;
  }

  /**
   * Return create Options.
   *
   * @return array
   *   The create options.
   */
  public static function getCreateOptions() {
    return [
      ImportProcessor::PUBLICATION_PUBLISH => t(static::CREATION_ACTION_PUBLISH_LABEL),
      ImportProcessor::PUBLICATION_UNPUBLISH => t(static::CREATION_ACTION_UNPUBLISH_LABEL),
    ];
  }

  /**
   * Return update options.
   *
   * @return array
   *   The update options.
   */
  public static function getUpdateOptions() {
    return [
      ImportProcessor::UPDATE_SYSTEMATIC => t(static::UPDATE_ACTION_SYSTEMATIC_LABEL),
      ImportProcessor::UPDATE_IF_RECENT => t(static::UPDATE_ACTION_IF_RECENT_LABEL),
      ImportProcessor::UPDATE_NO_UPDATE => t(static::UPDATE_ACTION_NO_UPDATE_LABEL),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $batchImport = new BatchImportProcessor();
    $batchImport
      ->import($this->import, array_intersect_key($this->import
      ->getRootsEntities(), array_flip($form_state
      ->getUserInput()['entities_to_import'])), [
      $this,
      'onBatchEnd',
    ], $form_state
      ->getValue('creationType'), $form_state
      ->getValue('updateType'));
  }

  /**
   * The callback after batch process.
   */
  public function onBatchEnd($data) {
    $this->import
      ->removeArchive();
  }

  /**
   * Init the root entities list for display.
   */
  protected function initRootEntitiesList(array &$form) {
    $rootEntities = $this->import
      ->getRootsEntities();
    $build = [
      '#theme' => 'entities_list_table',
      '#entities' => $rootEntities,
      '#status_or_bundle' => t('status'),
      '#checkbox_name' => 'entities_to_import[]',
      '#title' => t('Entities to import'),
      '#attached' => [
        'library' => [
          'content_synchronizer/list',
        ],
      ],
    ];
    $form['entities_list'] = $build;
  }

}

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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LaunchImportForm::$import protected property The import entity.
LaunchImportForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
LaunchImportForm::CREATION_ACTION_LABEL constant
LaunchImportForm::CREATION_ACTION_PUBLISH_LABEL constant
LaunchImportForm::CREATION_ACTION_UNPUBLISH_LABEL constant
LaunchImportForm::getCreateOptions public static function Return create Options.
LaunchImportForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LaunchImportForm::getUpdateOptions public static function Return update options.
LaunchImportForm::initRootEntitiesList protected function Init the root entities list for display.
LaunchImportForm::onBatchEnd public function The callback after batch process.
LaunchImportForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
LaunchImportForm::UPDATE_ACTION_IF_RECENT_LABEL constant
LaunchImportForm::UPDATE_ACTION_LABEL constant
LaunchImportForm::UPDATE_ACTION_NO_UPDATE_LABEL constant
LaunchImportForm::UPDATE_ACTION_SYSTEMATIC_LABEL constant
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.