FieldConfig.php 11.2 KB
Newer Older
1
2
<?php

3
namespace Drupal\field\Entity;
4

5
use Drupal\Core\Entity\EntityStorageInterface;
6
use Drupal\Core\Field\FieldConfigBase;
7
use Drupal\Core\Field\FieldException;
8
use Drupal\field\FieldStorageConfigInterface;
9
use Drupal\field\FieldConfigInterface;
10
11

/**
12
 * Defines the Field entity.
13
 *
14
 * @ConfigEntityType(
15
16
 *   id = "field_config",
 *   label = @Translation("Field"),
17
 *   handlers = {
18
19
 *     "access" = "Drupal\field\FieldConfigAccessControlHandler",
 *     "storage" = "Drupal\field\FieldConfigStorage"
20
 *   },
21
 *   config_prefix = "field",
22
23
 *   entity_keys = {
 *     "id" = "id",
24
 *     "label" = "label"
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 *   },
 *   config_export = {
 *     "id",
 *     "field_name",
 *     "entity_type",
 *     "bundle",
 *     "label",
 *     "description",
 *     "required",
 *     "translatable",
 *     "default_value",
 *     "default_value_callback",
 *     "settings",
 *     "field_type",
39
40
41
 *   }
 * )
 */
42
class FieldConfig extends FieldConfigBase implements FieldConfigInterface {
43
44

  /**
45
   * Flag indicating whether the field is deleted.
46
   *
47
   * The delete() method marks the field as "deleted" and removes the
48
49
50
51
   * corresponding entry from the config storage, but keeps its definition in
   * the state storage while field data is purged by a separate
   * garbage-collection process.
   *
52
   * Deleted fields stay out of the regular entity lifecycle (notably, their
53
54
55
56
   * values are not populated in loaded entities, and are not saved back).
   *
   * @var bool
   */
57
  protected $deleted = FALSE;
58

59
  /**
60
   * The associated FieldStorageConfig entity.
61
   *
62
   * @var \Drupal\field\Entity\FieldStorageConfig
63
   */
64
  protected $fieldStorage;
65

66
  /**
67
   * Constructs a FieldConfig object.
68
   *
69
   * In most cases, Field entities are created via
70
   * FieldConfig::create($values), where $values is the same
71
72
   * parameter as in this constructor.
   *
73
   * @param array $values
74
   *   An array of field properties, keyed by property name. The
75
   *   storage associated with the field can be specified either with:
76
77
78
   *   - field_storage: the FieldStorageConfigInterface object,
   *   or by referring to an existing field storage in the current configuration
   *   with:
79
80
81
   *   - field_name: The field name.
   *   - entity_type: The entity type.
   *   Additionally, a 'bundle' property is required to indicate the entity
82
   *   bundle to which the field is attached to. Other array elements will be
83
84
85
   *   used to set the corresponding properties on the class; see the class
   *   property documentation for details.
   *
86
   * @see entity_create()
87
   */
88
  public function __construct(array $values, $entity_type = 'field_config') {
89
    // Allow either an injected FieldStorageConfig object, or a field_name and
90
    // entity_type.
91
92
    if (isset($values['field_storage'])) {
      if (!$values['field_storage'] instanceof FieldStorageConfigInterface) {
93
        throw new FieldException('Attempt to create a configurable field for a non-configurable field storage.');
94
      }
95
96
97
      $field_storage = $values['field_storage'];
      $values['field_name'] = $field_storage->getName();
      $values['entity_type'] = $field_storage->getTargetEntityTypeId();
98
99
100
      // The internal property is fieldStorage, not field_storage.
      unset($values['field_storage']);
      $values['fieldStorage'] = $field_storage;
101
    }
102
103
    else {
      if (empty($values['field_name'])) {
104
        throw new FieldException('Attempt to create a field without a field_name.');
105
106
      }
      if (empty($values['entity_type'])) {
107
        throw new FieldException("Attempt to create a field '{$values['field_name']}' without an entity_type.");
108
      }
109
    }
110
    // 'bundle' is required in either case.
111
    if (empty($values['bundle'])) {
112
      throw new FieldException("Attempt to create a field '{$values['field_name']}' without a bundle.");
113
114
115
116
117
    }

    parent::__construct($values, $entity_type);
  }

118
119
120
121
  /**
   * {@inheritdoc}
   */
  public function postCreate(EntityStorageInterface $storage) {
122
123
    parent::postCreate($storage);

124
    // Validate that we have a valid storage for this field. This throws an
125
    // exception if the storage is invalid.
126
    $this->getFieldStorageDefinition();
127

128
129
    // 'Label' defaults to the field name (mostly useful for fields created in
    // tests).
130
    if (empty($this->label)) {
131
      $this->label = $this->getName();
132
133
134
    }
  }

135
  /**
136
   * Overrides \Drupal\Core\Entity\Entity::preSave().
137
   *
138
   * @throws \Drupal\Core\Field\FieldException
139
   *   If the field definition is invalid.
140
141
   * @throws \Drupal\Core\Entity\EntityStorageException
   *   In case of failures at the configuration storage level.
142
   */
143
  public function preSave(EntityStorageInterface $storage) {
144
145
146
    $entity_manager = \Drupal::entityManager();
    $field_type_manager = \Drupal::service('plugin.manager.field.field_type');

147
    $storage_definition = $this->getFieldStorageDefinition();
148

149
150
151
    // Filter out unknown settings and make sure all settings are present, so
    // that a complete field definition is passed to the various hooks and
    // written to config.
152
    $default_settings = $field_type_manager->getDefaultFieldSettings($storage_definition->getType());
153
154
    $this->settings = array_intersect_key($this->settings, $default_settings) + $default_settings;

155
    if ($this->isNew()) {
156
      // Notify the entity storage.
157
      $entity_manager->onFieldDefinitionCreate($this);
158
159
    }
    else {
160
161
      // Some updates are always disallowed.
      if ($this->entity_type != $this->original->entity_type) {
162
        throw new FieldException("Cannot change an existing field's entity_type.");
163
      }
164
      if ($this->bundle != $this->original->bundle) {
165
        throw new FieldException("Cannot change an existing field's bundle.");
166
      }
167
      if ($storage_definition->uuid() != $this->original->getFieldStorageDefinition()->uuid()) {
168
        throw new FieldException("Cannot change an existing field's storage.");
169
      }
170
      // Notify the entity storage.
171
      $entity_manager->onFieldDefinitionUpdate($this, $this->original);
172
    }
173
174

    parent::preSave($storage);
175
176
177
178
179
180
181
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();
182
    // Mark the field_storage_config as a dependency.
183
    $this->addDependency('config', $this->getFieldStorageDefinition()->getConfigDependencyName());
184
    return $this;
185
  }
186

187
  /**
188
   * {@inheritdoc}
189
   */
190
  public static function preDelete(EntityStorageInterface $storage, array $fields) {
191
192
    $state = \Drupal::state();

193
    parent::preDelete($storage, $fields);
194
    // Keep the field definitions in the state storage so we can use them
195
    // later during field_purge_batch().
196
197
198
199
    $deleted_fields = $state->get('field.field.deleted') ?: array();
    foreach ($fields as $field) {
      if (!$field->deleted) {
        $config = $field->toArray();
200
        $config['deleted'] = TRUE;
201
202
        $config['field_storage_uuid'] = $field->getFieldStorageDefinition()->uuid();
        $deleted_fields[$field->uuid()] = $config;
203
      }
204
    }
205
    $state->set('field.field.deleted', $deleted_fields);
206
207
  }

208
  /**
209
   * {@inheritdoc}
210
   */
211
  public static function postDelete(EntityStorageInterface $storage, array $fields) {
212
    // Clear the cache upfront, to refresh the results of getBundles().
213
    \Drupal::entityManager()->clearCachedFieldDefinitions();
214

215
    // Notify the entity storage.
216
217
    foreach ($fields as $field) {
      if (!$field->deleted) {
218
        \Drupal::entityManager()->onFieldDefinitionDelete($field);
219
      }
220
    }
221

222
223
    // If this is part of a configuration synchronization then the following
    // configuration updates are not necessary.
224
    $entity = reset($fields);
225
226
227
228
    if ($entity->isSyncing()) {
      return;
    }

229
230
    // Delete the associated field storages if they are not used anymore and are
    // not persistent.
231
    $storages_to_delete = array();
232
233
    foreach ($fields as $field) {
      $storage_definition = $field->getFieldStorageDefinition();
234
      if (!$field->deleted && !$field->isUninstalling() && $storage_definition->isDeletable()) {
235
236
        // Key by field UUID to avoid deleting the same storage twice.
        $storages_to_delete[$storage_definition->uuid()] = $storage_definition;
237
      }
238
    }
239
240
    if ($storages_to_delete) {
      \Drupal::entityManager()->getStorage('field_storage_config')->delete($storages_to_delete);
241
    }
242
243
  }

244
245
246
  /**
   * {@inheritdoc}
   */
247
248
249
  protected function linkTemplates() {
    $link_templates = parent::linkTemplates();
    if (\Drupal::moduleHandler()->moduleExists('field_ui')) {
250
251
252
      $link_templates["{$this->entity_type}-field-edit-form"] = 'entity.field_config.' . $this->entity_type . '_field_edit_form';
      $link_templates["{$this->entity_type}-storage-edit-form"] = 'entity.field_config.' . $this->entity_type . '_storage_edit_form';
      $link_templates["{$this->entity_type}-field-delete-form"] = 'entity.field_config.' . $this->entity_type . '_field_delete_form';
253

254
255
      if (isset($link_templates['config-translation-overview'])) {
        $link_templates["config-translation-overview.{$this->entity_type}"] = "entity.field_config.config_translation_overview.{$this->entity_type}";
256
      }
257
    }
258
259
    return $link_templates;
  }
260

261
262
263
  /**
   * {@inheritdoc}
   */
264
265
  protected function urlRouteParameters($rel) {
    $parameters = parent::urlRouteParameters($rel);
266
    $entity_type = \Drupal::entityManager()->getDefinition($this->entity_type);
267
268
    $bundle_parameter_key = $entity_type->getBundleEntityType() ?: 'bundle';
    $parameters[$bundle_parameter_key] = $this->bundle;
269
    return $parameters;
270
271
  }

272
273
274
  /**
   * {@inheritdoc}
   */
275
276
  public function isDeleted() {
    return $this->deleted;
277
278
  }

279
280
281
  /**
   * {@inheritdoc}
   */
282
283
284
285
  public function getFieldStorageDefinition() {
    if (!$this->fieldStorage) {
      $fields = $this->entityManager()->getFieldStorageDefinitions($this->entity_type);
      if (!isset($fields[$this->field_name])) {
286
        throw new FieldException("Attempt to create a field {$this->field_name} that does not exist on entity type {$this->entity_type}.");
287
      }
288
      if (!$fields[$this->field_name] instanceof FieldStorageConfigInterface) {
289
        throw new FieldException("Attempt to create a configurable field of non-configurable field storage {$this->field_name}.");
290
291
      }
      $this->fieldStorage = $fields[$this->field_name];
292
    }
293
294

    return $this->fieldStorage;
295
296
  }

297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
  /**
   * {@inheritdoc}
   */
  public function isDisplayConfigurable($context) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getDisplayOptions($display_context) {
    // Hide configurable fields by default.
    return array('type' => 'hidden');
  }

312
313
314
315
316
317
318
319
320
321
322
323
324
325
  /**
   * {@inheritdoc}
   */
  public function isReadOnly() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function isComputed() {
    return FALSE;
  }

326
327
328
329
330
331
332
333
334
335
336
  /**
   * Loads a field config entity based on the entity type and field name.
   *
   * @param string $entity_type_id
   *   ID of the entity type.
   * @param string $bundle
   *   Bundle name.
   * @param string $field_name
   *   Name of the field.
   *
   * @return static
337
   *   The field config entity if one exists for the provided field
338
339
340
   *   name, otherwise NULL.
   */
  public static function loadByName($entity_type_id, $bundle, $field_name) {
341
    return \Drupal::entityManager()->getStorage('field_config')->load($entity_type_id . '.' . $bundle . '.' . $field_name);
342
343
  }

344
}