interface DeletedFieldsRepositoryInterface in Drupal 9

Provides an interface for a deleted fields repository.

@internal

Hierarchy

• interface \Drupal\Core\Field\DeletedFieldsRepositoryInterface

2 files declare their use of DeletedFieldsRepositoryInterface

FieldConfigStorage.php in core/modules/field/src/FieldConfigStorage.php

FieldStorageConfigStorage.php in core/modules/field/src/FieldStorageConfigStorage.php

File

core/lib/Drupal/Core/Field/DeletedFieldsRepositoryInterface.php, line 10

Namespace

Drupal\Core\Field

interface DeletedFieldsRepositoryInterface {

  /**
   * Returns a list of deleted field definitions.
   *
   * @param string $field_storage_unique_id
   *   (optional) A unique ID of field storage definition for filtering the
   *   deleted fields. Defaults to NULL.
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface[]
   *   An array of field definition objects, keyed by their unique identifier.
   */
  public function getFieldDefinitions($field_storage_unique_id = NULL);

  /**
   * Returns a list of deleted field storage definitions.
   *
   * @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
   *   An array of field storage definition objects, keyed by their unique
   *   storage identifier.
   */
  public function getFieldStorageDefinitions();

  /**
   * Adds a field definition object to the deleted list.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   A field definition object.
   *
   * @return $this
   */
  public function addFieldDefinition(FieldDefinitionInterface $field_definition);

  /**
   * Adds a field storage definition object to the deleted list.
   *
   * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_storage_definition
   *   A field storage definition object.
   *
   * @return $this
   */
  public function addFieldStorageDefinition(FieldStorageDefinitionInterface $field_storage_definition);

  /**
   * Removes a field definition object from the deleted list.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   A field definition object.
   *
   * @return $this
   */
  public function removeFieldDefinition(FieldDefinitionInterface $field_definition);

  /**
   * Removes a field storage definition object from the deleted list.
   *
   * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_storage_definition
   *   A field storage definition object.
   *
   * @return $this
   */
  public function removeFieldStorageDefinition(FieldStorageDefinitionInterface $field_storage_definition);

}

Members

Name	Modifiers	Type	Description	Overrides
DeletedFieldsRepositoryInterface::addFieldDefinition	public	function	Adds a field definition object to the deleted list.	1
DeletedFieldsRepositoryInterface::addFieldStorageDefinition	public	function	Adds a field storage definition object to the deleted list.	1
DeletedFieldsRepositoryInterface::getFieldDefinitions	public	function	Returns a list of deleted field definitions.	1
DeletedFieldsRepositoryInterface::getFieldStorageDefinitions	public	function	Returns a list of deleted field storage definitions.	1
DeletedFieldsRepositoryInterface::removeFieldDefinition	public	function	Removes a field definition object from the deleted list.	1
DeletedFieldsRepositoryInterface::removeFieldStorageDefinition	public	function	Removes a field storage definition object from the deleted list.	1