You are here

Home » API reference » Bibliography & Citation 2.0.x » ImportForm.php

class ImportForm in Bibliography & Citation 2.0.x

Same name and namespace in other branches
  1. 8 modules/bibcite_import/src/Form/ImportForm.php \Drupal\bibcite_import\Form\ImportForm

Common import form.

Hierarchy

Expanded class hierarchy of ImportForm

1 string reference to 'ImportForm'
bibcite_import.routing.yml in modules/bibcite_import/bibcite_import.routing.yml
modules/bibcite_import/bibcite_import.routing.yml

File

modules/bibcite_import/src/Form/ImportForm.php, line 14

Namespace

Drupal\bibcite_import\Form
View source 
class ImportForm extends FormBase {

  /**
   * Bibcite format manager service.
   *
   * @var \Drupal\bibcite\Plugin\BibciteFormatManagerInterface
   */
  protected $formatManager;

  /**
   * Serializer service.
   *
   * @var \Symfony\Component\Serializer\Serializer
   */
  protected $serializer;

  /**
   * Import form constructor.
   *
   * @param \Symfony\Component\Serializer\SerializerInterface $serializer
   *   Import plugins manager.
   * @param \Drupal\bibcite\Plugin\BibciteFormatManagerInterface $format_manager
   *   Bibcite format manager service.
   */
  public function __construct(SerializerInterface $serializer, BibciteFormatManagerInterface $format_manager) {
    $this->serializer = $serializer;
    $this->formatManager = $format_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('serializer'), $container
      ->get('plugin.manager.bibcite_format'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['file'] = [
      '#type' => 'file',
      '#title' => $this
        ->t('File'),
      '#multiple' => FALSE,
    ];
    $form['format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Format'),
      '#options' => array_map(function ($definition) {
        return $definition['label'];
      }, $this->formatManager
        ->getImportDefinitions()),
      '#required' => TRUE,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Import'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $all_files = $this
      ->getRequest()->files
      ->get('files', []);
    if (!empty($all_files['file'])) {

      /** @var \Symfony\Component\HttpFoundation\File\UploadedFile $file_upload */
      $file_upload = $all_files['file'];
      if ($file_upload
        ->isValid()) {
        $form_state
          ->setValue('file', $file_upload
          ->getRealPath());
        $format_id = $form_state
          ->getValue('format');
        $format = $this->formatManager
          ->getDefinition($format_id);
        try {
          $data = file_get_contents($form_state
            ->getValue('file'));
          $decoded = $this->serializer
            ->decode($data, $format_id);
          $form_state
            ->setValue('decoded', $decoded);
        } catch (\Exception $exception) {
          $err_string = $this
            ->t('@format file content is not valid.<br>%ex', [
            '@format' => $format['label'],
            '%ex' => $exception
              ->getMessage(),
          ]);
          $form_state
            ->setErrorByName('file', $err_string);
        }
        return;
      }
    }
    else {
      $form_state
        ->setErrorByName('file', $this
        ->t('The file could not be uploaded.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $format_id = $form_state
      ->getValue('format');

    /** @var \Drupal\bibcite\Plugin\BibciteFormatInterface $format */
    $format = $this->formatManager
      ->createInstance($format_id);
    $decoded = $form_state
      ->getValue('decoded');
    $chunks = array_chunk($decoded, 50);
    $batch = [
      'title' => t('Import reference data'),
      'operations' => [],
      'finished' => 'bibcite_import_batch_finished',
      'file' => drupal_get_path('module', 'bibcite_import') . '/bibcite_import.batch.inc',
    ];
    foreach ($chunks as $chunk) {
      $batch['operations'][] = [
        'bibcite_import_batch_callback',
        [
          $chunk,
          $format,
        ],
      ];
    }
    batch_set($batch);
  }

}

Members

Namesort descending 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::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.
ImportForm::$formatManager protected property Bibcite format manager service.
ImportForm::$serializer protected property Serializer service.
ImportForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ImportForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ImportForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ImportForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ImportForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
ImportForm::__construct public function Import form constructor.
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.