FieldConfigCloneForm.php in Field tools 8

Namespace

Drupal\field_tools\Form

File

src/Form/FieldConfigCloneForm.php

<?php

namespace Drupal\field_tools\Form;

use Drupal\Core\Entity\EntityForm;
use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\field_tools\FieldCloner;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a form for cloning a field.
 */
class FieldConfigCloneForm extends EntityForm {
  use BundleDestinationOptionsTrait;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity type bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * The field cloner.
   *
   * @var \Drupal\field_tools\FieldCloner
   */
  protected $fieldCloner;

  /**
   * Creates a Clone instance.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle info service.
   * @param \Drupal\field_tools\FieldCloner $field_cloner
   *   The field cloner.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, FieldCloner $field_cloner) {
    $this->entityTypeManager = $entity_type_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->fieldCloner = $field_cloner;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('entity_type.bundle.info'), $container
      ->get('field_tools.field_cloner'));
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $field_config = $this
      ->getEntity();
    $field_config_target_entity_type_id = $field_config
      ->getTargetEntityTypeId();
    $field_config_target_bundle = $field_config
      ->getTargetBundle();
    $form['#title'] = t("Clone field %field", [
      '%field' => $field_config
        ->getLabel(),
    ]);
    $form['destinations'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t("Bundles to clone this field to"),
      '#options' => $this
        ->getDestinationOptions($this->entityTypeManager, $this->entityTypeBundleInfo),
    ];

    // Get all the fields with the same name on the same entity type, to mark
    // their checkboxes as disabled.
    $field_ids = $this->entityTypeManager
      ->getStorage('field_config')
      ->getQuery()
      ->condition('field_name', $field_config
      ->getName())
      ->execute();
    $other_bundle_fields = $this->entityTypeManager
      ->getStorage('field_config')
      ->loadMultiple($field_ids);
    $other_bundles = [];
    foreach ($other_bundle_fields as $field) {
      $form_option_key = $field
        ->getTargetEntityTypeId() . '::' . $field
        ->getTargetBundle();
      if ($form_option_key == "{$field_config_target_entity_type_id}::{$field_config_target_bundle}") {

        // Mark the current bundle as disabled.
        $form['destinations'][$form_option_key]['#disabled'] = TRUE;
        $form['destinations'][$form_option_key]['#description'] = $this
          ->t("This is the current bundle.");
      }
      elseif ($field
        ->getType() == $field_config
        ->getType()) {

        // The other field's type is the same as the current field, so just
        // mark this bundle as unavailable because it already has the field.
        $form['destinations'][$form_option_key]['#disabled'] = TRUE;
        $form['destinations'][$form_option_key]['#description'] = $this
          ->t("The field is already on this bundle.");
      }
      else {

        // The other field is of a different type from the current field. This
        // bundle is not a valid destination, and furthermore, ALL bundles on
        // this entity type are invalid, because of the underlying field storage
        // which will have a different type.
        // $field->getTargetEntityTypeId()
        $other_entity_type_bundles = $this->entityTypeBundleInfo
          ->getBundleInfo($field
          ->getTargetEntityTypeId());
        foreach (array_keys($other_entity_type_bundles) as $other_bundle_name) {
          $form_option_key = $field
            ->getTargetEntityTypeId() . '::' . $other_bundle_name;
          $form['destinations'][$form_option_key]['#disabled'] = TRUE;
          $form['destinations'][$form_option_key]['#description'] = $this
            ->t("A field of a different type is already on this entity type.");
        }
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $actions['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Clone field'),
    );
    return $actions;
  }

  /**
   * Form submission handler for the 'clone' action.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   A reference to a keyed array containing the current state of the form.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $destinations = array_filter($form_state
      ->getValue('destinations'));
    foreach ($destinations as $destination) {
      list($destination_entity_type, $destination_bundle) = explode('::', $destination);
      $this->fieldCloner
        ->cloneField($this->entity, $destination_entity_type, $destination_bundle);
    }
    $this
      ->messenger()
      ->addMessage($this
      ->t("The field has been cloned."));

    // TODO: redirect
  }

}

Classes

Name	Description
FieldConfigCloneForm	Provides a form for cloning a field.