3 namespace Drupal\Core\Field;
6 * Provides an interface for a deleted fields repository.
10 interface DeletedFieldsRepositoryInterface {
13 * Returns a list of deleted field definitions.
15 * @param string $field_storage_unique_id
16 * (optional) A unique ID of field storage definition for filtering the
17 * deleted fields. Defaults to NULL.
19 * @return \Drupal\Core\Field\FieldDefinitionInterface[]
20 * An array of field definition objects, keyed by their unique identifier.
22 public function getFieldDefinitions($field_storage_unique_id = NULL);
25 * Returns a list of deleted field storage definitions.
27 * @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
28 * An array of field storage definition objects, keyed by their unique
31 public function getFieldStorageDefinitions();
34 * Adds a field definition object to the deleted list.
36 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
37 * A field definition object.
41 public function addFieldDefinition(FieldDefinitionInterface $field_definition);
44 * Adds a field storage definition object to the deleted list.
46 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_storage_definition
47 * A field storage definition object.
51 public function addFieldStorageDefinition(FieldStorageDefinitionInterface $field_storage_definition);
54 * Removes a field definition object from the deleted list.
56 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
57 * A field definition object.
61 public function removeFieldDefinition(FieldDefinitionInterface $field_definition);
64 * Removes a field storage definition object from the deleted list.
66 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_storage_definition
67 * A field storage definition object.
71 public function removeFieldStorageDefinition(FieldStorageDefinitionInterface $field_storage_definition);