You are here

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

class ConfigFieldsExportToCodeForm in Field tools 8

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

Hierarchy

Expanded class hierarchy of ConfigFieldsExportToCodeForm

File

src/Form/ConfigFieldsExportToCodeForm.php, line 15

Namespace

Drupal\field_tools\Form
View source 
class ConfigFieldsExportToCodeForm extends FormBase {

  /**
   * 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_export_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL, $bundle = NULL) {
    $this->entityTypeId = $entity_type_id;
    $this->bundle = $bundle;
    $field_manager = \Drupal::service('entity_field.manager');
    $field_definitions = $field_manager
      ->getFieldDefinitions($entity_type_id, $bundle);
    $code = [];
    if (!empty($form_state
      ->getValues())) {
      $code = [];
      foreach (array_filter($form_state
        ->getValues()['fields']) as $field_name) {
        $this
          ->getBaseFieldCode($code, $field_definitions[$field_name]);

        // TODO: bundle fields and config field conversion.
        $code[] = '';
      }
      $form['code'] = [
        '#type' => 'textarea',
        '#value' => implode("\n", $code),
        '#rows' => count($code) + 1,
      ];
    }
    $field_options = [];
    foreach ($field_definitions 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 export to code'),
      '#type' => 'checkboxes',
      '#options' => $field_options,
      '#description' => $this
        ->t("Select fields to export as entity class code."),
    );
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Export field definitions to code'),
    );
    return $form;
  }
  protected function getBaseFieldCode(&$code, $field) {
    $code[] = sprintf("\$fields['%s'] = \\Drupal\\Core\\Field\\BaseFieldDefinition::create('%s')", $field
      ->getName(), $field
      ->getType());
    $code[] = sprintf("->setLabel(t('%s'))", $field
      ->getLabel());
    $code[] = sprintf("->setDescription(t('%s'))", $field
      ->getDescription());
    if ($field
      ->isRequired()) {
      $code[] = "  ->setRequired(TRUE)";
    }
    if ($field instanceof \Drupal\Core\Field\FieldStorageDefinitionInterface) {
      if ($field
        ->isRevisionable()) {
        $code[] = "  ->setRevisionable(TRUE)";
      }
    }
    if ($field
      ->isTranslatable()) {
      $code[] = "  ->setTranslatable(TRUE)";
    }
    foreach ($field
      ->getSettings() as $setting => $value) {
      if (is_string($value)) {
        $code[] = "  ->setSetting('{$setting}' => '{$value}')";
      }
      elseif (is_bool($value)) {
        $code[] = "  ->setSetting('{$setting}' => " . ($value ? 'TRUE' : 'FALSE') . ")";
      }
      else {

        // TODO: format the output code properly!
        $code[] = "  ->setSetting('{$setting}' => " . var_export($value, TRUE) . ")";
      }
    }
    foreach ([
      'form',
      'view',
    ] as $display_type) {
      $display = $this->entityTypeManager
        ->getStorage("entity_{$display_type}_display")
        ->load($this->entityTypeId . '.' . $this->bundle . '.' . 'default');
      if ($display) {
        $display_settings = $display
          ->getComponent($field
          ->getName());
        $code[] = "  ->setDisplayOptions('{$display_type}', [";
        $code[] = "    'type' => '{$display_settings['type']}',";
        $code[] = "    'weight' => '{$display_settings['weight']}',";
        if (!empty($display_settings['label'])) {
          $code[] = "    'label' => '{$display_settings['label']}',";
        }
        if (!empty($display_settings['settings'])) {
          $code[] = "    'settings' => [";
          foreach ($display_settings['settings'] as $key => $value) {
            $code[] = "      '{$key}' => '{$value}',";
          }
          $code[] = "    ],";
        }
        $code[] = "  ])";
        $code[] = "  ->setDisplayConfigurable('{$display_type}', TRUE)";
      }
    }
  }

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

}

Members

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