class TamperListForm in Feeds Tamper 8.2

Provides a form to manage tamper plugins for a feed type.

@package Drupal\feeds_tamper\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\feeds_tamper\Form\TamperListForm uses TamperFormTrait

Expanded class hierarchy of TamperListForm

1 string reference to 'TamperListForm'

feeds_tamper.routing.yml in ./feeds_tamper.routing.yml: feeds_tamper.routing.yml

File

src/Form/TamperListForm.php, line 17

Namespace

Drupal\feeds_tamper\Form

View source

class TamperListForm extends FormBase {
  use TamperFormTrait;

  /**
   * An array of the feed type's tamper plugins.
   *
   * @var array
   */
  protected $tampers;

  /**
   * An array of the feed type's sources.
   *
   * @var array
   */
  protected $sources;

  /**
   * An array of the feed type's targets.
   *
   * @var array
   */
  protected $targets;

  /**
   * An array of the grouped mappings.
   *
   * @var array
   */
  protected $groupedMappings;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var self $form */
    $form = parent::create($container);
    $form
      ->setTamperMetaManager($container
      ->get('feeds_tamper.feed_type_tamper_manager'));
    return $form;
  }

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

  /**
   * Form constructor.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param \Drupal\feeds\FeedTypeInterface $feeds_feed_type
   *   The feed that we are adding a tamper plugin to.
   *
   * @return array
   *   The form structure.
   */
  public function buildForm(array $form, FormStateInterface $form_state, FeedTypeInterface $feeds_feed_type = NULL) {
    $this->feedsFeedType = $feeds_feed_type;
    $tamper_meta = $this->feedTypeTamperManager
      ->getTamperMeta($this->feedsFeedType);
    $this->tampers = $tamper_meta
      ->getTampersGroupedBySource();
    $this->sources = $this->feedsFeedType
      ->getMappingSources();
    $this->targets = $this->feedsFeedType
      ->getMappingTargets();
    $mappings = $this->feedsFeedType
      ->getMappings();
    $args = [
      '@url' => Url::fromRoute('entity.feeds_feed_type.mapping', [
        'feeds_feed_type' => $this->feedsFeedType
          ->id(),
      ])
        ->toString(),
    ];
    if (!$mappings) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('There are no <a href="@url">mappings</a> defined for this importer.', $args));
      return $form;
    }

    // Help message at the top. I have a seceret, I added the link back to the
    // mappings because it makes my life a lot easier while testing this.
    $message = $this
      ->t('Configure plugins to modify Feeds data before it gets saved. Each <a href="@url">mapping</a> can be manipulated individually.', $args);
    $form['help'] = [
      '#type' => 'item',
      '#markup' => '<div class="help"><p>' . $message . '</p></div>',
    ];

    // Build mapping grouped by source>targets>columns.
    foreach ($mappings as $mapping) {
      foreach ($mapping['map'] as $column => $source) {
        if ($source == '') {
          continue;
        }
        $this->groupedMappings[$source][$mapping['target']][$column] = $mapping;
      }
    }
    $i = 0;
    $form['#tree'] = TRUE;
    foreach ($this->groupedMappings as $source => $targets) {
      $form[$source] = $this
        ->buildTampersTable($form, $form_state, $source, $targets);
      $i++;
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    ];
    return $form;
  }

  /**
   * Builds a table of tampers for the specified source -> targets.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param string $source
   *   The source name.
   * @param array $targets
   *   An array of the source targets.
   *
   * @return array
   *   Form table element.
   */
  protected function buildTampersTable(array $form, FormStateInterface $form_state, $source, array $targets) {
    $header = [
      'label' => $this
        ->t('Label'),
      'description' => $this
        ->t('Description'),
      'weight' => $this
        ->t('Weight'),
      'plugin' => $this
        ->t('Plugin'),
      'operations' => $this
        ->t('Operations'),
    ];
    $url_parameters = [
      'feeds_feed_type' => $this->feedsFeedType
        ->id(),
    ];
    $view_tampers_url = Url::fromRoute('entity.feeds_feed_type.tamper', $url_parameters)
      ->toString();
    $destination_query = [
      'destination' => $view_tampers_url,
    ];
    $target_labels = [];
    $item = [
      '#type' => 'table',
      '#header' => $header,
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'tamper-weight',
        ],
      ],
    ];
    foreach ($targets as $target_key => $columns) {

      /* @var \Drupal\feeds\FieldTargetDefinition $target */
      $target = $this->targets[$target_key];
      $source_label = Html::escape($this->sources[$source]['label']);
      $label = Html::escape($target
        ->getLabel()) . ': ';
      foreach ($columns as $column => $mapping) {
        if (count($mapping['map']) > 1) {
          $target_labels[] = $label . $target
            ->getPropertyLabel($column);
        }
        else {
          $target_labels[] = $label . ($target
            ->getDescription() ?: $column);
        }
      }
    }
    $item['#caption'] = $source_label . ' -> ' . implode(', ', $target_labels);
    $add_plugin_weight = 0;
    if (!empty($this->tampers[$source])) {

      // Calculate the range (delta) needed for the weight field. By default,
      // the range is from -10 to 10, which means 21 slots in total. If there
      // are however more than 21 tamper instances, the range should increase in
      // order to be able to assign an unique weight to each tamper instance.
      $tampers_count = round(count($this->tampers[$source]) / 2);
      $tamper_weight_delta = $tampers_count < 10 ? 10 : $tampers_count;

      /** @var \Drupal\tamper\TamperInterface $tamper */
      foreach ($this->tampers[$source] as $id => $tamper) {
        $row = [
          '#attributes' => [
            'class' => [
              'draggable',
            ],
          ],
          '#weight' => $tamper
            ->getSetting('weight'),
        ];

        // Label.
        $row['label'] = [
          '#plain_text' => $tamper
            ->getSetting('label') ? $tamper
            ->getSetting('label') : '',
        ];

        // Plugin instance description.
        $row['description'] = [
          '#plain_text' => $tamper
            ->getPluginDefinition()['description'],
        ];

        // Weight field.
        $row['weight'] = [
          '#title' => $this
            ->t('Weight'),
          '#title_display' => 'invisible',
          '#type' => 'weight',
          '#default_value' => $tamper
            ->getSetting('weight'),
          '#attributes' => [
            'class' => [
              'tamper-weight',
            ],
          ],
          '#delta' => $tamper_weight_delta,
        ];
        $row['plugin'] = [
          '#plain_text' => $tamper
            ->getPluginDefinition()['label'],
        ];
        $operations_params = $url_parameters + [
          'tamper_uuid' => $id,
        ];
        $row['operations'] = [
          '#type' => 'operations',
          '#links' => [
            'edit' => [
              'title' => $this
                ->t('Edit'),
              'url' => Url::fromRoute('entity.feeds_feed_type.tamper_edit', $operations_params, [
                'query' => $destination_query,
              ]),
            ],
            'delete' => [
              'title' => $this
                ->t('Delete'),
              'url' => Url::fromRoute('entity.feeds_feed_type.tamper_delete', $operations_params),
            ],
          ],
        ];

        // @todo Implement enabled.
        // $row['enabled'] = '';
        $item[$id] = $row;
        $add_plugin_weight = $tamper
          ->getSetting('weight') + 1;
      }
    }
    $add_tamper_url = Url::fromRoute('entity.feeds_feed_type.tamper_add', $url_parameters + [
      'source_field' => $source,
    ], [
      'query' => array_merge($destination_query, [
        'weight' => $add_plugin_weight,
      ]),
    ]);
    $item['add']['link'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Add plugin'),
      '#url' => $add_tamper_url,
      '#wrapper_attributes' => [
        'colspan' => count($header),
      ],
    ];
    return $item;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    foreach ($this->groupedMappings as $source => $targets) {
      if ($tampers = $form_state
        ->getValue($source)) {
        foreach ($tampers as $tamper_uuid => $values) {

          // @todo Implement enabled.
          $tamper_meta = $this->feedTypeTamperManager
            ->getTamperMeta($this->feedsFeedType);
          $tamper = $tamper_meta
            ->getTamper($tamper_uuid);
          $tamper_meta
            ->setTamperConfig($tamper_uuid, array_merge($tamper
            ->getConfiguration(), [
            'weight' => $values['weight'],
          ]));
        }
      }
    }
    $this->feedsFeedType
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('Your changes have been saved.'));
  }

}

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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
TamperFormTrait::$feedsFeedType	protected	property	The feed item we are adding a tamper plugin to.
TamperFormTrait::$feedTypeTamperManager	protected	property	The feeds tamper metadata manager.
TamperFormTrait::$plugin	protected	property	The tamper plugin instance.
TamperFormTrait::$tamperManager	protected	property	The tamper plugin manager.
TamperFormTrait::assertTamper	protected	function	Makes sure that the tamper exists.
TamperFormTrait::checkAccess	public	function	Checks access for the form page.
TamperFormTrait::setTamperManager	public	function	Sets the tamper manager.
TamperFormTrait::setTamperMetaManager	public	function	Sets the feed type tamper manager.
TamperListForm::$groupedMappings	protected	property	An array of the grouped mappings.
TamperListForm::$sources	protected	property	An array of the feed type's sources.
TamperListForm::$tampers	protected	property	An array of the feed type's tamper plugins.
TamperListForm::$targets	protected	property	An array of the feed type's targets.
TamperListForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
TamperListForm::buildTampersTable	protected	function	Builds a table of tampers for the specified source -> targets.
TamperListForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
TamperListForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
TamperListForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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 TamperListForm in Feeds Tamper 8.2

Hierarchy

File

Namespace

Members

API Navigation