class PopulateForm in Bibliography & Citation 8

Same name and namespace in other branches

2.0.x modules/bibcite_import/src/Form/PopulateForm.php \Drupal\bibcite_import\Form\PopulateForm

Populate values to Reference form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\bibcite_import\Form\PopulateForm

Expanded class hierarchy of PopulateForm

1 string reference to 'PopulateForm'

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/PopulateForm.php, line 17

Namespace

Drupal\bibcite_import\Form

View source

class PopulateForm extends FormBase {

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

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

  /**
   * Module temp store.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStore
   */
  protected $tempStore;

  /**
   * Create new PopulateForm class.
   *
   * @param \Symfony\Component\Serializer\Serializer $serializer
   *   Serializer service.
   * @param \Drupal\bibcite\Plugin\BibciteFormatManagerInterface $format_manager
   *   Format manager service.
   * @param \Drupal\Core\TempStore\PrivateTempStore $temp_store
   *   Module temp store.
   */
  public function __construct(Serializer $serializer, BibciteFormatManagerInterface $format_manager, PrivateTempStore $temp_store) {
    $this->serializer = $serializer;
    $this->formatManager = $format_manager;
    $this->tempStore = $temp_store;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Format'),
      '#options' => array_map(function ($definition) {
        return $definition['label'];
      }, $this->formatManager
        ->getImportDefinitions()),
      '#required' => TRUE,
    ];
    $form['data'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Paste your bibliographic entry here'),
      '#description' => $this
        ->t('If you paste multiple entries first will be used.'),
      '#rows' => 20,
      '#required' => TRUE,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Populate'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $format_id = $form_state
      ->getValue('format');
    $data = $form_state
      ->getValue('data');
    $format = $this->formatManager
      ->getDefinition($format_id);
    try {
      $decoded = $this->serializer
        ->decode($data, $format_id);
      $config = \Drupal::config('bibcite_import.settings');
      $denormalize_context = [
        'contributor_deduplication' => $config
          ->get('settings.contributor_deduplication'),
        'keyword_deduplication' => $config
          ->get('settings.keyword_deduplication'),
      ];
      $entity = $this->serializer
        ->denormalize(reset($decoded), Reference::class, $format_id, $denormalize_context);
      $form_state
        ->setValue('entity', $entity);
    } catch (\Exception $exception) {
      $err_string = $this
        ->t('@format entry is not valid. Please check pasted text.<br>%ex', [
        '@format' => $format['label'],
        '%ex' => $exception
          ->getMessage(),
      ]);
      $form_state
        ->setErrorByName('data', $err_string);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $entity = $form_state
      ->getValue('entity');
    if ($entity) {
      $this->tempStore
        ->set(\Drupal::currentUser()
        ->id(), $entity);
      $redirect_url = Url::fromRoute("entity.bibcite_reference.add_form", [
        'bibcite_reference_type' => $entity
          ->bundle(),
      ]);
      $form_state
        ->setRedirectUrl($redirect_url);
    }
  }

}

Members

Name	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::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.
PopulateForm::$formatManager	protected	property	Format manager service.
PopulateForm::$serializer	protected	property	Serializer service.
PopulateForm::$tempStore	protected	property	Module temp store.
PopulateForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
PopulateForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
PopulateForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PopulateForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
PopulateForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
PopulateForm::__construct	public	function	Create new PopulateForm class.
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.

You are here

class PopulateForm in Bibliography & Citation 8

Hierarchy

File

Namespace

Members

API Navigation