class FieldStorageDefinitionEvent

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Field/FieldStorageDefinitionEvent.php \Drupal\Core\Field\FieldStorageDefinitionEvent
  2. 8.9.x core/lib/Drupal/Core/Field/FieldStorageDefinitionEvent.php \Drupal\Core\Field\FieldStorageDefinitionEvent
  3. 11.x core/lib/Drupal/Core/Field/FieldStorageDefinitionEvent.php \Drupal\Core\Field\FieldStorageDefinitionEvent

Defines a base class for all field storage definition events.

Hierarchy

Expanded class hierarchy of FieldStorageDefinitionEvent

File

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

Namespace

Drupal\Core\Field
View source
class FieldStorageDefinitionEvent extends Event {
  
  /**
   * The field storage definition.
   *
   * @var \Drupal\Core\Field\FieldStorageDefinitionInterface
   */
  protected $fieldStorageDefinition;
  
  /**
   * The original field storage definition.
   *
   * @var \Drupal\Core\Field\FieldStorageDefinitionInterface
   */
  protected $original;
  
  /**
   * Constructs a new FieldStorageDefinitionEvent.
   *
   * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_storage_definition
   *   The field storage definition.
   * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $original
   *   (optional) The original field storage definition. This should be passed
   *   only when updating the storage definition.
   */
  public function __construct(FieldStorageDefinitionInterface $field_storage_definition, ?FieldStorageDefinitionInterface $original = NULL) {
    $this->fieldStorageDefinition = $field_storage_definition;
    $this->original = $original;
  }
  
  /**
   * The field storage definition.
   *
   * @return \Drupal\Core\Field\FieldStorageDefinitionInterface
   */
  public function getFieldStorageDefinition() {
    return $this->fieldStorageDefinition;
  }
  
  /**
   * The original field storage definition.
   *
   * @return \Drupal\Core\Field\FieldStorageDefinitionInterface
   */
  public function getOriginal() {
    return $this->original;
  }

}

Members

Title Sort descending Modifiers Object type Summary
FieldStorageDefinitionEvent::$fieldStorageDefinition protected property The field storage definition.
FieldStorageDefinitionEvent::$original protected property The original field storage definition.
FieldStorageDefinitionEvent::getFieldStorageDefinition public function The field storage definition.
FieldStorageDefinitionEvent::getOriginal public function The original field storage definition.
FieldStorageDefinitionEvent::__construct public function Constructs a new FieldStorageDefinitionEvent.

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