class EntityTypeListener in Zircon Profile 8

Reacts to entity type CRUD on behalf of the Entity system.

Hierarchy

• class \Drupal\Core\Entity\EntityTypeListener implements EntityTypeListenerInterface

See also

\Drupal\Core\Entity\EntityTypeEvents

1 string reference to 'EntityTypeListener'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses EntityTypeListener

entity_type.listener in core/core.services.yml

Drupal\Core\Entity\EntityTypeListener

File

core/lib/Drupal/Core/Entity/EntityTypeListener.php, line 17

Contains \Drupal\Core\Entity\EntityTypeListener.

Namespace

Drupal\Core\Entity

class EntityTypeListener implements EntityTypeListenerInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * The entity last installed schema repository.
   *
   * @var \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface
   */
  protected $entityLastInstalledSchemaRepository;

  /**
   * Constructs a new EntityTypeListener.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
   * @param \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface $entity_last_installed_schema_repository
   *   The entity last installed schema repository.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, EventDispatcherInterface $event_dispatcher, EntityLastInstalledSchemaRepositoryInterface $entity_last_installed_schema_repository) {
    $this->entityTypeManager = $entity_type_manager;
    $this->entityFieldManager = $entity_field_manager;
    $this->eventDispatcher = $event_dispatcher;
    $this->entityLastInstalledSchemaRepository = $entity_last_installed_schema_repository;
  }

  /**
   * {@inheritdoc}
   */
  public function onEntityTypeCreate(EntityTypeInterface $entity_type) {
    $entity_type_id = $entity_type
      ->id();

    // @todo Forward this to all interested handlers, not only storage, once
    //   iterating handlers is possible: https://www.drupal.org/node/2332857.
    $storage = $this->entityTypeManager
      ->getStorage($entity_type_id);
    if ($storage instanceof EntityTypeListenerInterface) {
      $storage
        ->onEntityTypeCreate($entity_type);
    }
    $this->eventDispatcher
      ->dispatch(EntityTypeEvents::CREATE, new EntityTypeEvent($entity_type));
    $this->entityLastInstalledSchemaRepository
      ->setLastInstalledDefinition($entity_type);
    if ($entity_type
      ->isSubclassOf(FieldableEntityInterface::class)) {
      $this->entityLastInstalledSchemaRepository
        ->setLastInstalledFieldStorageDefinitions($entity_type_id, $this->entityFieldManager
        ->getFieldStorageDefinitions($entity_type_id));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function onEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeInterface $original) {
    $entity_type_id = $entity_type
      ->id();

    // @todo Forward this to all interested handlers, not only storage, once
    //   iterating handlers is possible: https://www.drupal.org/node/2332857.
    $storage = $this->entityTypeManager
      ->getStorage($entity_type_id);
    if ($storage instanceof EntityTypeListenerInterface) {
      $storage
        ->onEntityTypeUpdate($entity_type, $original);
    }
    $this->eventDispatcher
      ->dispatch(EntityTypeEvents::UPDATE, new EntityTypeEvent($entity_type, $original));
    $this->entityLastInstalledSchemaRepository
      ->setLastInstalledDefinition($entity_type);
  }

  /**
   * {@inheritdoc}
   */
  public function onEntityTypeDelete(EntityTypeInterface $entity_type) {
    $entity_type_id = $entity_type
      ->id();

    // @todo Forward this to all interested handlers, not only storage, once
    //   iterating handlers is possible: https://www.drupal.org/node/2332857.
    $storage = $this->entityTypeManager
      ->getStorage($entity_type_id);
    if ($storage instanceof EntityTypeListenerInterface) {
      $storage
        ->onEntityTypeDelete($entity_type);
    }
    $this->eventDispatcher
      ->dispatch(EntityTypeEvents::DELETE, new EntityTypeEvent($entity_type));
    $this->entityLastInstalledSchemaRepository
      ->deleteLastInstalledDefinition($entity_type_id);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityTypeListener::$entityFieldManager	protected	property	The entity field manager.
EntityTypeListener::$entityLastInstalledSchemaRepository	protected	property	The entity last installed schema repository.
EntityTypeListener::$entityTypeManager	protected	property	The entity type manager.
EntityTypeListener::$eventDispatcher	protected	property	The event dispatcher.
EntityTypeListener::onEntityTypeCreate	public	function	Reacts to the creation of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeCreate
EntityTypeListener::onEntityTypeDelete	public	function	Reacts to the deletion of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeDelete
EntityTypeListener::onEntityTypeUpdate	public	function	Reacts to the update of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeUpdate
EntityTypeListener::__construct	public	function	Constructs a new EntityTypeListener.