interface FieldStorageDefinitionListenerInterface

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/FieldStorageDefinitionListenerInterface.php \Drupal\Core\Field\FieldStorageDefinitionListenerInterface
  2. 10 core/lib/Drupal/Core/Field/FieldStorageDefinitionListenerInterface.php \Drupal\Core\Field\FieldStorageDefinitionListenerInterface
  3. 11.x core/lib/Drupal/Core/Field/FieldStorageDefinitionListenerInterface.php \Drupal\Core\Field\FieldStorageDefinitionListenerInterface

Defines an interface for reacting to field storage definition creation, deletion, and updates.

Hierarchy

Expanded class hierarchy of FieldStorageDefinitionListenerInterface

All classes that implement FieldStorageDefinitionListenerInterface

4 files declare their use of FieldStorageDefinitionListenerInterface
DynamicallyFieldableEntityStorageInterface.php in core/lib/Drupal/Core/Entity/DynamicallyFieldableEntityStorageInterface.php
DynamicallyFieldableEntityStorageSchemaInterface.php in core/lib/Drupal/Core/Entity/Schema/DynamicallyFieldableEntityStorageSchemaInterface.php
EntityDefinitionUpdateManager.php in core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManager.php
EntityTestDefinitionSubscriber.php in core/modules/system/tests/modules/entity_test/src/EntityTestDefinitionSubscriber.php

File

core/lib/Drupal/Core/Field/FieldStorageDefinitionListenerInterface.php, line 8

Namespace

Drupal\Core\Field
View source
interface FieldStorageDefinitionListenerInterface {
    
    /**
     * Reacts to the creation of a field storage definition.
     *
     * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition
     *   The definition being created.
     */
    public function onFieldStorageDefinitionCreate(FieldStorageDefinitionInterface $storage_definition);
    
    /**
     * Reacts to the update of a field storage definition.
     *
     * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition
     *   The field being updated.
     * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $original
     *   The original storage definition; i.e., the definition before the update.
     *
     * @throws \Drupal\Core\Entity\Exception\FieldStorageDefinitionUpdateForbiddenException
     *   Thrown when the update to the field is forbidden.
     */
    public function onFieldStorageDefinitionUpdate(FieldStorageDefinitionInterface $storage_definition, FieldStorageDefinitionInterface $original);
    
    /**
     * Reacts to the deletion of a field storage definition.
     *
     * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition
     *   The field being deleted.
     */
    public function onFieldStorageDefinitionDelete(FieldStorageDefinitionInterface $storage_definition);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionCreate public function Reacts to the creation of a field storage definition. 2
FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionDelete public function Reacts to the deletion of a field storage definition. 2
FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionUpdate public function Reacts to the update of a field storage definition. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.