You are here

Home » API reference » Field tools 8 » FieldBulkCloneForm.php

class FieldBulkCloneForm in Field tools 8

Provides a form to clone multiple fields from an entity bundle.

Hierarchy

Expanded class hierarchy of FieldBulkCloneForm

File

src/Form/FieldBulkCloneForm.php, line 15

Namespace

Drupal\field_tools\Form
View source 
class FieldBulkCloneForm extends FormBase {
  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 getFormId() {
    return 'field_tools_field_clone_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL, $bundle = NULL) {
    $field_ids = $this->entityTypeManager
      ->getStorage('field_config')
      ->getQuery()
      ->condition('entity_type', $entity_type_id)
      ->condition('bundle', $bundle)
      ->execute();
    $current_bundle_fields = $this->entityTypeManager
      ->getStorage('field_config')
      ->loadMultiple($field_ids);
    $field_options = array();
    foreach ($current_bundle_fields as $field_id => $field) {
      $field_options[$field_id] = $this
        ->t("@field-label (machine name: @field-name)", array(
        '@field-label' => $field
          ->getLabel(),
        '@field-name' => $field
          ->getName(),
      ));
    }
    asort($field_options);
    $form['fields'] = array(
      '#title' => $this
        ->t('Fields to clone'),
      '#type' => 'checkboxes',
      '#options' => $field_options,
      '#description' => $this
        ->t("Select fields to clone onto one or more bundles."),
    );
    $form['destinations'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t("Bundles to clone the fields to"),
      '#options' => $this
        ->getDestinationOptions($this->entityTypeManager, $this->entityTypeBundleInfo),
    ];

    // Mark the current bundle as disabled.
    $form['destinations']["{$entity_type_id}::{$bundle}"]['#disabled'] = TRUE;
    $form['destinations']["{$entity_type_id}::{$bundle}"]['#description'] = $this
      ->t("This is the current bundle.");
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Clone fields'),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Get the original parameters given to buildForm().
    // TODO: is this the right way to do this?
    $build_info = $form_state
      ->getBuildInfo();
    list($entity_type_id, $bundle) = $build_info['args'];
    $destinations = array_filter($form_state
      ->getValue('destinations'));
    $fields_to_clone = array_filter($form_state
      ->getValue('fields'));
    foreach ($destinations as $destination) {
      list($destination_entity_type, $destination_bundle) = explode('::', $destination);
      foreach ($fields_to_clone as $field_id) {
        $field_config = $this->entityTypeManager
          ->getStorage('field_config')
          ->load($field_id);

        // Check the field is not already on the destination bundle.
        $field_ids = $this->entityTypeManager
          ->getStorage('field_config')
          ->getQuery()
          ->condition('entity_type', $destination_entity_type)
          ->condition('bundle', $destination_bundle)
          ->condition('field_name', $field_config
          ->getName())
          ->execute();
        if ($field_ids) {
          $this
            ->messenger()
            ->addMessage($this
            ->t("Field @name is already on @entity_type @bundle, skipping.", [
            '@name' => $field_config
              ->getName(),
            // TODO: use labels!
            '@entity_type' => $destination_entity_type,
            '@bundle' => $destination_bundle,
          ]));
          continue;
        }

        // Check the field is not already on the destination entity type but
        // with a different type.
        $existing_destination_field_storage_ids = $this->entityTypeManager
          ->getStorage('field_storage_config')
          ->getQuery()
          ->condition('entity_type', $destination_entity_type)
          ->condition('field_name', $field_config
          ->getName())
          ->execute();
        if ($existing_destination_field_storage_ids) {

          // There will be only one.
          $existing_field_storage_config = $this->entityTypeManager
            ->getStorage('field_storage_config')
            ->load(reset($existing_destination_field_storage_ids));
          if ($existing_field_storage_config
            ->getType() != $field_config
            ->getType()) {
            $this
              ->messenger()
              ->addMessage($this
              ->t("Field @name is already on @entity_type with a different field type, skipping.", [
              '@name' => $field_config
                ->getName(),
              // TODO: use labels!
              '@entity_type' => $destination_entity_type,
            ]));
            continue;
          }
        }
        $this->fieldCloner
          ->cloneField($field_config, $destination_entity_type, $destination_bundle);
      }
    }
    $this
      ->messenger()
      ->addMessage($this
      ->t("The fields have been cloned."));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BundleDestinationOptionsTrait::getDestinationOptions protected function Gets the options for the destination entity types and bundles form element.
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
FieldBulkCloneForm::$entityTypeBundleInfo protected property The entity type bundle info service.
FieldBulkCloneForm::$entityTypeManager protected property The entity type manager.
FieldBulkCloneForm::$fieldCloner protected property The field cloner.
FieldBulkCloneForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
FieldBulkCloneForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
FieldBulkCloneForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FieldBulkCloneForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FieldBulkCloneForm::__construct public function Creates a Clone instance.
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.
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.