FieldConfig.php 11.3 KB
Newer Older
1
2
3
4
<?php

/**
 * @file
5
 * Contains \Drupal\field\Entity\FieldConfig.
6
7
 */

8
namespace Drupal\field\Entity;
9

10
use Drupal\Component\Utility\SafeMarkup;
11
use Drupal\Core\Entity\EntityStorageInterface;
12
use Drupal\Core\Field\FieldConfigBase;
13
use Drupal\Core\Field\FieldException;
14
use Drupal\field\FieldStorageConfigInterface;
15
use Drupal\field\FieldConfigInterface;
16
17

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

  /**
51
   * Flag indicating whether the field is deleted.
52
   *
53
   * The delete() method marks the field as "deleted" and removes the
54
55
56
57
   * 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.
   *
58
   * Deleted fields stay out of the regular entity lifecycle (notably, their
59
60
61
62
   * values are not populated in loaded entities, and are not saved back).
   *
   * @var bool
   */
63
  protected $deleted = FALSE;
64

65
  /**
66
   * The associated FieldStorageConfig entity.
67
   *
68
   * @var \Drupal\field\Entity\FieldStorageConfig
69
   */
70
  protected $fieldStorage;
71

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

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

124
125
126
127
  /**
   * {@inheritdoc}
   */
  public function postCreate(EntityStorageInterface $storage) {
128
129
    parent::postCreate($storage);

130
    // Validate that we have a valid storage for this field. This throws an
131
    // exception if the storage is invalid.
132
    $this->getFieldStorageDefinition();
133

134
135
    // 'Label' defaults to the field name (mostly useful for fields created in
    // tests).
136
    if (empty($this->label)) {
137
      $this->label = $this->getName();
138
139
140
    }
  }

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

153
    $storage_definition = $this->getFieldStorageDefinition();
154

155
156
157
    // 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.
158
    $default_settings = $field_type_manager->getDefaultFieldSettings($storage_definition->getType());
159
160
    $this->settings = array_intersect_key($this->settings, $default_settings) + $default_settings;

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

    parent::preSave($storage);
181
182
183
184
185
186
187
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();
188
    // Mark the field_storage_config as a a dependency.
189
    $this->addDependency('config', $this->getFieldStorageDefinition()->getConfigDependencyName());
190
    return $this->dependencies;
191
  }
192

193
  /**
194
   * {@inheritdoc}
195
   */
196
  public static function preDelete(EntityStorageInterface $storage, array $fields) {
197
198
    $state = \Drupal::state();

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

214
  /**
215
   * {@inheritdoc}
216
   */
217
  public static function postDelete(EntityStorageInterface $storage, array $fields) {
218
    // Clear the cache upfront, to refresh the results of getBundles().
219
    \Drupal::entityManager()->clearCachedFieldDefinitions();
220

221
    // Notify the entity storage.
222
223
    foreach ($fields as $field) {
      if (!$field->deleted) {
224
        \Drupal::entityManager()->onFieldDefinitionDelete($field);
225
      }
226
    }
227

228
229
    // If this is part of a configuration synchronization then the following
    // configuration updates are not necessary.
230
    $entity = reset($fields);
231
232
233
234
    if ($entity->isSyncing()) {
      return;
    }

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

250
251
252
  /**
   * {@inheritdoc}
   */
253
254
255
  protected function linkTemplates() {
    $link_templates = parent::linkTemplates();
    if (\Drupal::moduleHandler()->moduleExists('field_ui')) {
256
257
258
      $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';
259

260
261
      if (isset($link_templates['config-translation-overview'])) {
        $link_templates["config-translation-overview.{$this->entity_type}"] = "entity.field_config.config_translation_overview.{$this->entity_type}";
262
      }
263
    }
264
265
    return $link_templates;
  }
266

267
268
269
  /**
   * {@inheritdoc}
   */
270
271
  protected function urlRouteParameters($rel) {
    $parameters = parent::urlRouteParameters($rel);
272
    $entity_type = \Drupal::entityManager()->getDefinition($this->entity_type);
273
274
    $bundle_parameter_key = $entity_type->getBundleEntityType() ?: 'bundle';
    $parameters[$bundle_parameter_key] = $this->bundle;
275
    return $parameters;
276
277
  }

278
279
280
  /**
   * {@inheritdoc}
   */
281
282
  public function isDeleted() {
    return $this->deleted;
283
284
  }

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

    return $this->fieldStorage;
301
302
  }

303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
  /**
   * {@inheritdoc}
   */
  public function isDisplayConfigurable($context) {
    return TRUE;
  }

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

318
319
320
321
322
323
324
325
326
327
328
329
330
331
  /**
   * {@inheritdoc}
   */
  public function isReadOnly() {
    return FALSE;
  }

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

332
333
334
335
336
337
338
339
340
341
342
  /**
   * 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
343
   *   The field config entity if one exists for the provided field
344
345
346
   *   name, otherwise NULL.
   */
  public static function loadByName($entity_type_id, $bundle, $field_name) {
347
    return \Drupal::entityManager()->getStorage('field_config')->load($entity_type_id . '.' . $bundle . '.' . $field_name);
348
349
  }

350
}