You are here

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

class FieldConfigCloneForm in Field tools 8

Provides a form for cloning a field.

Hierarchy

Expanded class hierarchy of FieldConfigCloneForm

File

src/Form/FieldConfigCloneForm.php, line 15

Namespace

Drupal\field_tools\Form
View source 
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
  }

}

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
EntityForm::$entity protected property The entity being used by this form. 7
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 10
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::save public function Form submission handler for the 'save' action. Overrides EntityFormInterface::save 41
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::__get public function
EntityForm::__set public function
FieldConfigCloneForm::$entityTypeBundleInfo protected property The entity type bundle info service.
FieldConfigCloneForm::$entityTypeManager protected property The entity type manager. Overrides EntityForm::$entityTypeManager
FieldConfigCloneForm::$fieldCloner protected property The field cloner.
FieldConfigCloneForm::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
FieldConfigCloneForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
FieldConfigCloneForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
FieldConfigCloneForm::submitForm public function Form submission handler for the 'clone' action. Overrides EntityForm::submitForm
FieldConfigCloneForm::__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.