EntityTypeEvent.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/Entity/EntityTypeEvent.php
  2. 8.9.x core/lib/Drupal/Core/Entity/EntityTypeEvent.php
  3. 10 core/lib/Drupal/Core/Entity/EntityTypeEvent.php

Namespace

Drupal\Core\Entity

File

core/lib/Drupal/Core/Entity/EntityTypeEvent.php

View source
<?php

namespace Drupal\Core\Entity;

use Drupal\Component\EventDispatcher\Event;

/**
 * Defines a base class for all entity type events.
 */
class EntityTypeEvent extends Event {
  
  /**
   * The entity type.
   *
   * @var \Drupal\Core\Entity\EntityTypeInterface
   */
  protected $entityType;
  
  /**
   * The original entity type.
   *
   * @var \Drupal\Core\Entity\EntityTypeInterface
   */
  protected $original;
  
  /**
   * Constructs a new EntityTypeEvent.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The field storage definition.
   * @param \Drupal\Core\Entity\EntityTypeInterface $original
   *   (optional) The original entity type. This should be passed only when
   *   updating the entity type.
   */
  public function __construct(EntityTypeInterface $entity_type, ?EntityTypeInterface $original = NULL) {
    $this->entityType = $entity_type;
    $this->original = $original;
  }
  
  /**
   * The entity type the event refers to.
   *
   * @return \Drupal\Core\Entity\EntityTypeInterface
   *   The entity type.
   */
  public function getEntityType() {
    return $this->entityType;
  }
  
  /**
   * The original entity type.
   *
   * @return \Drupal\Core\Entity\EntityTypeInterface
   *   The original entity type.
   */
  public function getOriginal() {
    return $this->original;
  }

}

Classes

Title Deprecated Summary
EntityTypeEvent Defines a base class for all entity type events.

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