class LaunchImportForm in Content Synchronizer 3.x

Launch Import Form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\content_synchronizer\Form\LaunchImportForm

3 files declare their use of LaunchImportForm

ContentSynchronizerCommands.php in src/Commands/ContentSynchronizerCommands.php

ContentSynchronizerManager.php in src/Service/ContentSynchronizerManager.php

ImportEntityViewBuilder.php in src/Entity/ImportEntityViewBuilder.php

File

src/Form/LaunchImportForm.php, line 14

Namespace

Drupal\content_synchronizer\Form

class LaunchImportForm extends FormBase {

  /**
   * 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' => $this
          ->t('Settings'),
      ];
      $form['settings']['creationType'] = [
        '#type' => 'radios',
        '#title' => $this
          ->t('Action on entity creation'),
        '#options' => static::getCreateOptions(),
        '#default_value' => ImportProcessor::DEFAULT_PUBLICATION_TYPE,
      ];
      $form['settings']['updateType'] = [
        '#type' => 'radios',
        '#title' => $this
          ->t('Action on entity update'),
        '#options' => static::getUpdateOptions(),
        '#default_value' => ImportProcessor::DEFAULT_UPDATE_TYPE,
      ];
    }

    // Entity list.
    $this
      ->initRootEntitiesList($form);
    if ($this->import
      ->getProcessingStatus() === ImportEntity::STATUS_NOT_STARTED) {
      $form['launch'] = [
        '#type' => 'submit',
        '#value' => $this
          ->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('Publish created content'),
      ImportProcessor::PUBLICATION_UNPUBLISH => t('Do not publish created content'),
    ];
  }

  /**
   * Return update options.
   *
   * @return array
   *   The update options.
   */
  public static function getUpdateOptions() {
    return [
      ImportProcessor::UPDATE_SYSTEMATIC => t('Always update existing entity with importing content'),
      ImportProcessor::UPDATE_IF_RECENT => t('Update existing entity only if the last change date of new content is more recent than the last change date of the corresponding existing entity'),
      ImportProcessor::UPDATE_NO_UPDATE => t('Do not update existing content'),
    ];
  }

  /**
   * {@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' => $this
        ->t('status'),
      '#checkbox_name' => 'entities_to_import[]',
      '#title' => $this
        ->t('Entities to import'),
      '#attached' => [
        'library' => [
          'content_synchronizer/list',
        ],
      ],
    ];
    $form['entities_list'] = $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	105
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.
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	72
LaunchImportForm::$import	protected	property	The import entity.
LaunchImportForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
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
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.