1. class
  2. Drupal
  3. \
  4. views
  5. \
  6. EventSubscriber
  7. \
  8. ViewsEntitySchemaSubscriber

ViewsEntitySchemaSubscriber

class ViewsEntitySchemaSubscriber implements EntityTypeListenerInterface, EventSubscriberInterface (View source)

Reacts to changes on entity types to update all views entities.

Traits

EntityTypeEventSubscriberTrait

Helper methods for EntityTypeListenerInterface.

Constants

BASE_TABLE_RENAME

Indicates that a base table got renamed.
DATA_TABLE_RENAME

Indicates that a data table got renamed.
DATA_TABLE_ADDITION

Indicates that a data table got added.
DATA_TABLE_REMOVAL

Indicates that a data table got removed.
REVISION_TABLE_RENAME

Indicates that a revision table got renamed.
REVISION_TABLE_ADDITION

Indicates that a revision table got added.
REVISION_TABLE_REMOVAL

Indicates that a revision table got removed.
REVISION_DATA_TABLE_RENAME

Indicates that a revision data table got renamed.
REVISION_DATA_TABLE_ADDITION

Indicates that a revision data table got added.
REVISION_DATA_TABLE_REMOVAL

Indicates that a revision data table got removed.

Properties

protected EntityTypeManagerInterface $entityTypeManager

The entity type manager.
protected LoggerInterface $logger

The default logger service.

Methods

static array
getEntityTypeEvents()

Gets the subscribed events.

from  EntityTypeEventSubscriberTrait
onEntityTypeEvent(EntityTypeEvent $event, string $event_name)

Listener method for any entity type definition event.

from  EntityTypeEventSubscriberTrait
onEntityTypeCreate(EntityTypeInterface $entity_type)

{@inheritdoc}

from  EntityTypeEventSubscriberTrait
onFieldableEntityTypeCreate(EntityTypeInterface $entity_type, array $field_storage_definitions)

{@inheritdoc}

from  EntityTypeEventSubscriberTrait
onEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeInterface $original)

Reacts to the update of the entity type.

onFieldableEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeInterface $original, array $field_storage_definitions, array $original_field_storage_definitions, array $sandbox = NULL)

{@inheritdoc}

from  EntityTypeEventSubscriberTrait
onEntityTypeDelete(EntityTypeInterface $entity_type)

Reacts to the deletion of the entity type.

__construct(EntityTypeManagerInterface $entity_type_manager, LoggerInterface $logger)

Constructs a ViewsEntitySchemaSubscriber.

static array
getSubscribedEvents()

{@inheritdoc}

processHandlers(array $all_views, callable $process)

Applies a callable onto all handlers of all passed in views.

baseTableRename(View[] $all_views, string $entity_type_id, string $old_base_table, string $new_base_table)

Updates views if a base table is renamed.

dataTableRename(View[] $all_views, string $entity_type_id, string $old_data_table, string $new_data_table)

Updates views if a data table is renamed.

dataTableAddition(View[] $all_views, EntityTypeInterface $entity_type, string $new_data_table, string $base_table)

Updates views if a data table is added.

dataTableRemoval(View[] $all_views, string $entity_type_id, string $old_data_table, string $base_table)

Updates views if a data table is removed.

revisionRemoval(View[] $all_views, EntityTypeInterface $original)

Updates views if revision support is removed.

Details

in EntityTypeEventSubscriberTrait at line 24
static array getEntityTypeEvents()

Gets the subscribed events.

Return Value

array

An array of subscribed event names.

See also

\Symfony\Component\EventDispatcher\EventSubscriberInterface::getSubscribedEvents()

in EntityTypeEventSubscriberTrait at line 40
onEntityTypeEvent(EntityTypeEvent $event, string $event_name)

Listener method for any entity type definition event.

Parameters

EntityTypeEvent $event

The field storage definition event object.
string $event_name

The event name.

in EntityTypeEventSubscriberTrait at line 59
onEntityTypeCreate(EntityTypeInterface $entity_type)

{@inheritdoc}

Parameters

EntityTypeInterface $entity_type

in EntityTypeEventSubscriberTrait at line 65
onFieldableEntityTypeCreate(EntityTypeInterface $entity_type, array $field_storage_definitions)

{@inheritdoc}

Parameters

EntityTypeInterface $entity_type
array $field_storage_definitions

at line 109
onEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeInterface $original)

Reacts to the update of the entity type.

Parameters

EntityTypeInterface $entity_type

The updated entity type definition.
EntityTypeInterface $original

The original entity type definition.

in EntityTypeEventSubscriberTrait at line 77
onFieldableEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeInterface $original, array $field_storage_definitions, array $original_field_storage_definitions, array $sandbox = NULL)

{@inheritdoc}

Parameters

EntityTypeInterface $entity_type
EntityTypeInterface $original
array $field_storage_definitions
array $original_field_storage_definitions
array $sandbox

at line 239
onEntityTypeDelete(EntityTypeInterface $entity_type)

Reacts to the deletion of the entity type.

Parameters

EntityTypeInterface $entity_type

The entity type being deleted.

at line 94
__construct(EntityTypeManagerInterface $entity_type_manager, LoggerInterface $logger)

Constructs a ViewsEntitySchemaSubscriber.

Parameters

EntityTypeManagerInterface $entity_type_manager

The entity type manager.
LoggerInterface $logger

A logger instance.

at line 102
static array getSubscribedEvents()

{@inheritdoc}

Return Value

array

at line 267
protected processHandlers(array $all_views, callable $process)

Applies a callable onto all handlers of all passed in views.

Parameters

array $all_views

All views entities.
callable $process

A callable which retrieves a handler config array.

at line 299
protected baseTableRename(View[] $all_views, string $entity_type_id, string $old_base_table, string $new_base_table)

Updates views if a base table is renamed.

Parameters

View[] $all_views

All views.
string $entity_type_id

The entity type ID.
string $old_base_table

The old base table name.
string $new_base_table

The new base table name.

at line 327
protected dataTableRename(View[] $all_views, string $entity_type_id, string $old_data_table, string $new_data_table)

Updates views if a data table is renamed.

Parameters

View[] $all_views

All views.
string $entity_type_id

The entity type ID.
string $old_data_table

The old data table name.
string $new_data_table

The new data table name.

at line 355
protected dataTableAddition(View[] $all_views, EntityTypeInterface $entity_type, string $new_data_table, string $base_table)

Updates views if a data table is added.

Parameters

View[] $all_views

All views.
EntityTypeInterface $entity_type

The entity type.
string $new_data_table

The new data table.
string $base_table

The base table.

at line 389
protected dataTableRemoval(View[] $all_views, string $entity_type_id, string $old_data_table, string $base_table)

Updates views if a data table is removed.

Parameters

View[] $all_views

All views.
string $entity_type_id

The entity type ID.
string $old_data_table

The name of the previous existing data table.
string $base_table

The name of the base table.

at line 409
protected revisionRemoval(View[] $all_views, EntityTypeInterface $original)

Updates views if revision support is removed.

Parameters

View[] $all_views

All views.
EntityTypeInterface $original

The origin entity type.