View source
<?php
namespace Drupal\field_ui\Form;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Entity\EntityDisplayRepositoryInterface;
use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Field\FieldTypePluginManagerInterface;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\field\FieldStorageConfigInterface;
use Drupal\field_ui\FieldUI;
use Symfony\Component\DependencyInjection\ContainerInterface;
class FieldStorageAddForm extends FormBase {
protected $entityTypeId;
protected $bundle;
protected $entityTypeManager;
protected $entityFieldManager;
protected $entityDisplayRepository;
protected $fieldTypePluginManager;
protected $configFactory;
public function __construct(EntityTypeManagerInterface $entity_type_manager, FieldTypePluginManagerInterface $field_type_plugin_manager, ConfigFactoryInterface $config_factory, EntityFieldManagerInterface $entity_field_manager = NULL, EntityDisplayRepositoryInterface $entity_display_repository = NULL) {
$this->entityTypeManager = $entity_type_manager;
$this->fieldTypePluginManager = $field_type_plugin_manager;
$this->configFactory = $config_factory;
$this->entityFieldManager = $entity_field_manager;
$this->entityDisplayRepository = $entity_display_repository;
}
public function getFormId() {
return 'field_ui_field_storage_add_form';
}
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager'), $container
->get('plugin.manager.field.field_type'), $container
->get('config.factory'), $container
->get('entity_field.manager'), $container
->get('entity_display.repository'));
}
public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL, $bundle = NULL) {
if (!$form_state
->get('entity_type_id')) {
$form_state
->set('entity_type_id', $entity_type_id);
}
if (!$form_state
->get('bundle')) {
$form_state
->set('bundle', $bundle);
}
$this->entityTypeId = $form_state
->get('entity_type_id');
$this->bundle = $form_state
->get('bundle');
$field_type_options = [];
foreach ($this->fieldTypePluginManager
->getGroupedDefinitions($this->fieldTypePluginManager
->getUiDefinitions()) as $category => $field_types) {
foreach ($field_types as $name => $field_type) {
$field_type_options[$category][$name] = $field_type['label'];
}
}
$form['add'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'form--inline',
'clearfix',
],
],
];
$form['add']['new_storage_type'] = [
'#type' => 'select',
'#title' => $this
->t('Add a new field'),
'#options' => $field_type_options,
'#empty_option' => $this
->t('- Select a field type -'),
];
if ($existing_field_storage_options = $this
->getExistingFieldStorageOptions()) {
$form['add']['separator'] = [
'#type' => 'item',
'#markup' => $this
->t('or'),
];
$form['add']['existing_storage_name'] = [
'#type' => 'select',
'#title' => $this
->t('Re-use an existing field'),
'#options' => $existing_field_storage_options,
'#empty_option' => $this
->t('- Select an existing field -'),
];
$form['#attached']['drupalSettings']['existingFieldLabels'] = $this
->getExistingFieldLabels(array_keys($existing_field_storage_options));
}
else {
$form['add']['existing_storage_name'] = [
'#type' => 'value',
'#value' => FALSE,
];
}
$form['new_storage_wrapper'] = [
'#type' => 'container',
'#states' => [
'!visible' => [
':input[name="new_storage_type"]' => [
'value' => '',
],
],
],
];
$form['new_storage_wrapper']['label'] = [
'#type' => 'textfield',
'#title' => $this
->t('Label'),
'#size' => 15,
];
$field_prefix = $this
->config('field_ui.settings')
->get('field_prefix');
$form['new_storage_wrapper']['field_name'] = [
'#type' => 'machine_name',
'#field_prefix' => $field_prefix,
'#size' => 15,
'#description' => $this
->t('A unique machine-readable name containing letters, numbers, and underscores.'),
'#maxlength' => FieldStorageConfig::NAME_MAX_LENGTH - strlen($field_prefix),
'#machine_name' => [
'source' => [
'new_storage_wrapper',
'label',
],
'exists' => [
$this,
'fieldNameExists',
],
],
'#required' => FALSE,
];
if ($existing_field_storage_options) {
$form['existing_storage_label'] = [
'#type' => 'textfield',
'#title' => $this
->t('Label'),
'#size' => 15,
'#states' => [
'!visible' => [
':input[name="existing_storage_name"]' => [
'value' => '',
],
],
],
];
}
$form['translatable'] = [
'#type' => 'value',
'#value' => TRUE,
];
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Save and continue'),
'#button_type' => 'primary',
];
$form['#attached']['library'][] = 'field_ui/drupal.field_ui';
return $form;
}
public function validateForm(array &$form, FormStateInterface $form_state) {
if (!$form_state
->getValue('new_storage_type') && !$form_state
->getValue('existing_storage_name')) {
$form_state
->setErrorByName('new_storage_type', $this
->t('You need to select a field type or an existing field.'));
}
elseif ($form_state
->getValue('new_storage_type') && $form_state
->getValue('existing_storage_name')) {
$form_state
->setErrorByName('new_storage_type', $this
->t('Adding a new field and re-using an existing field at the same time is not allowed.'));
return;
}
$this
->validateAddNew($form, $form_state);
$this
->validateAddExisting($form, $form_state);
}
protected function validateAddNew(array $form, FormStateInterface $form_state) {
if ($form_state
->getValue('new_storage_type')) {
if (!$form_state
->getValue('label')) {
$form_state
->setErrorByName('label', $this
->t('Add new field: you need to provide a label.'));
}
if (!$form_state
->getValue('field_name')) {
$form_state
->setErrorByName('field_name', $this
->t('Add new field: you need to provide a machine name for the field.'));
}
else {
$field_name = $form_state
->getValue('field_name');
$field_name = $this->configFactory
->get('field_ui.settings')
->get('field_prefix') . $field_name;
$form_state
->setValueForElement($form['new_storage_wrapper']['field_name'], $field_name);
}
}
}
protected function validateAddExisting(array $form, FormStateInterface $form_state) {
if ($form_state
->getValue('existing_storage_name')) {
if (!$form_state
->getValue('existing_storage_label')) {
$form_state
->setErrorByName('existing_storage_label', $this
->t('Re-use existing field: you need to provide a label.'));
}
}
}
public function submitForm(array &$form, FormStateInterface $form_state) {
$error = FALSE;
$values = $form_state
->getValues();
$destinations = [];
$entity_type = $this->entityTypeManager
->getDefinition($this->entityTypeId);
if ($values['new_storage_type']) {
$field_storage_values = [
'field_name' => $values['field_name'],
'entity_type' => $this->entityTypeId,
'type' => $values['new_storage_type'],
'translatable' => $values['translatable'],
];
$field_values = [
'field_name' => $values['field_name'],
'entity_type' => $this->entityTypeId,
'bundle' => $this->bundle,
'label' => $values['label'],
'translatable' => FALSE,
];
$widget_id = $formatter_id = NULL;
$widget_settings = $formatter_settings = [];
if (strpos($field_storage_values['type'], 'field_ui:') !== FALSE) {
[
,
$field_type,
$option_key,
] = explode(':', $field_storage_values['type'], 3);
$field_storage_values['type'] = $field_type;
$field_definition = $this->fieldTypePluginManager
->getDefinition($field_type);
$options = $this->fieldTypePluginManager
->getPreconfiguredOptions($field_definition['id']);
$field_options = $options[$option_key];
if (isset($field_options['field_storage_config'])) {
foreach ([
'cardinality',
'settings',
] as $key) {
if (isset($field_options['field_storage_config'][$key])) {
$field_storage_values[$key] = $field_options['field_storage_config'][$key];
}
}
}
if (isset($field_options['field_config'])) {
foreach ([
'required',
'settings',
] as $key) {
if (isset($field_options['field_config'][$key])) {
$field_values[$key] = $field_options['field_config'][$key];
}
}
}
$widget_id = $field_options['entity_form_display']['type'] ?? NULL;
$widget_settings = $field_options['entity_form_display']['settings'] ?? [];
$formatter_id = $field_options['entity_view_display']['type'] ?? NULL;
$formatter_settings = $field_options['entity_view_display']['settings'] ?? [];
}
try {
$this->entityTypeManager
->getStorage('field_storage_config')
->create($field_storage_values)
->save();
$field = $this->entityTypeManager
->getStorage('field_config')
->create($field_values);
$field
->save();
$this
->configureEntityFormDisplay($values['field_name'], $widget_id, $widget_settings);
$this
->configureEntityViewDisplay($values['field_name'], $formatter_id, $formatter_settings);
$route_parameters = [
'field_config' => $field
->id(),
] + FieldUI::getRouteBundleParameter($entity_type, $this->bundle);
$destinations[] = [
'route_name' => "entity.field_config.{$this->entityTypeId}_storage_edit_form",
'route_parameters' => $route_parameters,
];
$destinations[] = [
'route_name' => "entity.field_config.{$this->entityTypeId}_field_edit_form",
'route_parameters' => $route_parameters,
];
$destinations[] = [
'route_name' => "entity.{$this->entityTypeId}.field_ui_fields",
'route_parameters' => $route_parameters,
];
$form_state
->set([
'fields_added',
'_add_new_field',
], $values['field_name']);
} catch (\Exception $e) {
$error = TRUE;
$this
->messenger()
->addError($this
->t('There was a problem creating field %label: @message', [
'%label' => $values['label'],
'@message' => $e
->getMessage(),
]));
}
}
if ($values['existing_storage_name']) {
$field_name = $values['existing_storage_name'];
try {
$field = $this->entityTypeManager
->getStorage('field_config')
->create([
'field_name' => $field_name,
'entity_type' => $this->entityTypeId,
'bundle' => $this->bundle,
'label' => $values['existing_storage_label'],
]);
$field
->save();
$this
->configureEntityFormDisplay($field_name);
$this
->configureEntityViewDisplay($field_name);
$route_parameters = [
'field_config' => $field
->id(),
] + FieldUI::getRouteBundleParameter($entity_type, $this->bundle);
$destinations[] = [
'route_name' => "entity.field_config.{$this->entityTypeId}_field_edit_form",
'route_parameters' => $route_parameters,
];
$destinations[] = [
'route_name' => "entity.{$this->entityTypeId}.field_ui_fields",
'route_parameters' => $route_parameters,
];
$form_state
->set([
'fields_added',
'_add_existing_field',
], $field_name);
} catch (\Exception $e) {
$error = TRUE;
$this
->messenger()
->addError($this
->t('There was a problem creating field %label: @message', [
'%label' => $values['label'],
'@message' => $e
->getMessage(),
]));
}
}
if ($destinations) {
$destination = $this
->getDestinationArray();
$destinations[] = $destination['destination'];
$form_state
->setRedirectUrl(FieldUI::getNextDestination($destinations, $form_state));
}
elseif (!$error) {
$this
->messenger()
->addStatus($this
->t('Your settings have been saved.'));
}
}
protected function configureEntityFormDisplay($field_name, $widget_id = NULL, array $widget_settings = []) {
$options = [];
if ($widget_id) {
$options['type'] = $widget_id;
if (!empty($widget_settings)) {
$options['settings'] = $widget_settings;
}
}
$this->entityDisplayRepository
->getFormDisplay($this->entityTypeId, $this->bundle, 'default')
->setComponent($field_name, $options)
->save();
}
protected function configureEntityViewDisplay($field_name, $formatter_id = NULL, array $formatter_settings = []) {
$options = [];
if ($formatter_id) {
$options['type'] = $formatter_id;
if (!empty($formatter_settings)) {
$options['settings'] = $formatter_settings;
}
}
$this->entityDisplayRepository
->getViewDisplay($this->entityTypeId, $this->bundle)
->setComponent($field_name, $options)
->save();
}
protected function getExistingFieldStorageOptions() {
$options = [];
$field_types = $this->fieldTypePluginManager
->getDefinitions();
foreach ($this->entityFieldManager
->getFieldStorageDefinitions($this->entityTypeId) as $field_name => $field_storage) {
$field_type = $field_storage
->getType();
if ($field_storage instanceof FieldStorageConfigInterface && !$field_storage
->isLocked() && empty($field_types[$field_type]['no_ui']) && !in_array($this->bundle, $field_storage
->getBundles(), TRUE)) {
$options[$field_name] = $this
->t('@type: @field', [
'@type' => $field_types[$field_type]['label'],
'@field' => $field_name,
]);
}
}
asort($options);
return $options;
}
protected function getExistingFieldLabels(array $field_names) {
$field_ids = $this->entityTypeManager
->getStorage('field_config')
->getQuery()
->condition('entity_type', $this->entityTypeId)
->condition('field_name', $field_names)
->execute();
$fields = $this->entityTypeManager
->getStorage('field_config')
->loadMultiple($field_ids);
$labels = [];
foreach ($fields as $field) {
if (!isset($labels[$field
->getName()])) {
$labels[$field
->getName()] = $field
->label();
}
}
$labels += array_combine($field_names, $field_names);
return $labels;
}
public function fieldNameExists($value, $element, FormStateInterface $form_state) {
if ($form_state
->getValue('existing_storage_name')) {
return FALSE;
}
$field_name = $this->configFactory
->get('field_ui.settings')
->get('field_prefix') . $value;
$field_storage_definitions = $this->entityFieldManager
->getFieldStorageDefinitions($this->entityTypeId);
return isset($field_storage_definitions[$field_name]);
}
}