HookEventDispatcherInterface.php in Hook Event Dispatcher 8

Namespace

Drupal\hook_event_dispatcher

File

src/HookEventDispatcherInterface.php

<?php

namespace Drupal\hook_event_dispatcher;


/**
 * Interface HookEventDispatcherInterface.
 */
interface HookEventDispatcherInterface {

  // ENTITY EVENTS.

  /**
   * Respond to creation of a new entity.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_insert()
   * @see hook_entity_insert()
   *
   * @var string
   */
  const ENTITY_INSERT = 'hook_event_dispatcher.entity.insert';

  /**
   * Respond to updates to an entity.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_update()
   * @see hook_entity_update()
   *
   * @var string
   */
  const ENTITY_UPDATE = 'hook_event_dispatcher.entity.update';

  /**
   * Act before entity deletion.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_predelete()
   * @see hook_entity_predelete()
   *
   * @var string
   */
  const ENTITY_PRE_DELETE = 'hook_event_dispatcher.entity.predelete';

  /**
   * Respond to entity deletion.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_delete()
   * @see hook_entity_delete()
   *
   * @var string
   */
  const ENTITY_DELETE = 'hook_event_dispatcher.entity.delete';

  /**
   * Act on an entity before it is created or updated.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_presave()
   * @see hook_entity_presave()
   *
   * @var string
   */
  const ENTITY_PRE_SAVE = 'hook_event_dispatcher.entity.presave';

  /**
   * Alter entity renderable values before cache checking in drupal_render().
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_build_defaults_alter()
   * @see hook_entity_build_defaults_alter()
   *
   * @var string
   */
  const ENTITY_BUILD_DEFAULTS_ALTER = 'hook_event_dispatcher.entity.build_defaults_alter';

  /**
   * Act on entities being assembled before rendering.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_view()
   * @see hook_entity_view()
   *
   * @var string
   */
  const ENTITY_VIEW = 'hook_event_dispatcher.entity.view';

  /**
   * Alter a entity being assembled right before rendering.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_view_alter()
   * @see hook_entity_view_alter()
   *
   * @var string
   */
  const ENTITY_VIEW_ALTER = 'hook_event_dispatcher.entity.view_alter';

  /**
   * Control entity operation access.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_access()
   * @see hook_entity_access()
   *
   * @var string
   */
  const ENTITY_ACCESS = 'hook_event_dispatcher.entity.access';

  /**
   * Acts when creating a new entity.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_create()
   * @see hook_entity_create()
   *
   * @var string
   */
  const ENTITY_CREATE = 'hook_event_dispatcher.entity.create';

  /**
   * Act on entities when loaded.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_load()
   * @see hook_entity_load()
   *
   * @var string
   */
  const ENTITY_LOAD = 'hook_event_dispatcher.entity.load';

  /**
   * Respond to creation of a new entity translation.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_translation_insert()
   * @see hook_entity_translation_insert()
   *
   * @var string
   */
  const ENTITY_TRANSLATION_INSERT = 'hook_event_dispatcher.entity.translation_insert';

  /**
   * Respond to deletion of a new entity translation.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_translation_delete()
   * @see hook_entity_translation_delete()
   *
   * @var string
   */
  const ENTITY_TRANSLATION_DELETE = 'hook_event_dispatcher.entity.translation_delete';

  // ENTITY FIELD EVENTS.

  /**
   * Control access to fields.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_field_access()
   * @see hook_entity_field_access()
   *
   * @var string
   */
  const ENTITY_FIELD_ACCESS = 'hook_event_dispatcher.entity_field.access';

  // ENTITY EXTRA FIELD EVENTS.

  /**
   * Exposes "pseudo-field" components on content entities.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_extra_field_info()
   * @see hook_entity_extra_field_info()
   *
   * @var string
   */
  const ENTITY_EXTRA_FIELD_INFO = 'hook_event_dispatcher.entity_extra_field.info';

  /**
   * Alter "pseudo-field" components on content entities.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_extra_field_info_alter()
   * @see hook_entity_extra_field_info_alter()
   *
   * @var string
   */
  const ENTITY_EXTRA_FIELD_INFO_ALTER = 'hook_event_dispatcher.entity_extra_field.info_alter';

  // ENTITY TYPE EVENTS.

  /**
   * Provides custom base field definitions for a content entity type.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_base_field_info()
   * @see hook_entity_base_field_info()
   *
   * @var string
   */
  const ENTITY_BASE_FIELD_INFO = 'hook_event_dispatcher.entity_base.field_info';

  /**
   * Alter base field definitions for a content entity type.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_base_field_info_alter()
   * @see hook_entity_base_field_info_alter()
   *
   * @var string
   */
  const ENTITY_BASE_FIELD_INFO_ALTER = 'hook_event_dispatcher.entity_base.field_info_alter';

  /**
   * Alter bundle field definitions.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_bundle_field_info_alter()
   * @see hook_entity_bundle_field_info_alter()
   *
   * @var string
   */
  const ENTITY_BUNDLE_FIELD_INFO_ALTER = 'hook_event_dispatcher.entity_bundle.field_info_alter';

  /**
   * Entity operation.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_operation()
   * @see hook_entity_operation()
   *
   * @var string
   */
  const ENTITY_OPERATION = 'hook_event_dispatcher.entity.operation';

  /**
   * Entity operation alter.
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_operation_alter()
   * @see hook_entity_operation_alter()
   *
   * @var string
   */
  const ENTITY_OPERATION_ALTER = 'hook_event_dispatcher.entity.operation_alter';

  /**
   * Add to entity type definitions..
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_type_alter()
   * @see hook_entity_type_alter()
   *
   * @var string
   */
  const ENTITY_TYPE_ALTER = 'hook_event_dispatcher.entity_type.alter';

  /**
   * Add to entity type definitions..
   *
   * @Event
   *
   * @see hook_event_dispatcher_entity_type_build()
   * @see hook_entity_type_build()
   *
   * @var string
   */
  const ENTITY_TYPE_BUILD = 'hook_event_dispatcher.entity_type.build';

  // FORM EVENTS.

  /**
   * Perform alterations before a form is rendered.
   *
   * @Event
   *
   * @see hook_event_dispatcher_form_alter()
   * @see hook_form_alter()
   *
   * @var string
   */
  const FORM_ALTER = 'hook_event_dispatcher.form.alter';

  /**
   * Alter forms for field widgets provided by other modules.
   *
   * @Event
   *
   * @see hook_event_dispatcher_field_widget_form_alter()
   * @see hook_field_widget_form_alter()
   *
   * @var string
   */
  const WIDGET_FORM_ALTER = 'hook_event_dispatcher.widget_form.alter';

  // BLOCK EVENTS.

  /**
   * Alter the result of \Drupal\Core\Block\BlockBase::build().
   *
   * @Event
   *
   * @see hook_event_dispatcher_block_build_alter()
   * @see hook_block_build_alter()
   *
   * @var string
   */
  const BLOCK_BUILD_ALTER = 'hook_event_dispatcher.block_build.alter';

  // TOKEN EVENTS.

  /**
   * Provide replacement values for placeholder tokens.
   *
   * @Event
   *
   * @see hook_event_dispatcher_tokens()
   * @see hook_tokens()
   *
   * @var string
   */
  const TOKEN_REPLACEMENT = 'hook_event_dispatcher.token.replacement';

  /**
   * Provide information about available placeholder tokens and token types.
   *
   * @Event
   *
   * @see hook_event_dispatcher_token_info()
   * @see hook_token_info()
   *
   * @var string
   */
  const TOKEN_INFO = 'hook_event_dispatcher.token.info';

  // PATH EVENTS.

  /**
   * Respond to a path being inserted.
   *
   * @Event
   *
   * @see hook_event_dispatcher_path_insert()
   * @see hook_path_insert()
   *
   * @var string
   */
  const PATH_INSERT = 'hook_event_dispatcher.path.insert';

  /**
   * Respond to a path being deleted.
   *
   * @Event
   *
   * @see hook_event_dispatcher_path_delete()
   * @see hook_path_delete()
   *
   * @var string
   */
  const PATH_DELETE = 'hook_event_dispatcher.path.delete';

  /**
   * Respond to a path being updated.
   *
   * @Event
   *
   * @see hook_event_dispatcher_path_update()
   * @see hook_path_update()
   *
   * @var string
   */
  const PATH_UPDATE = 'hook_event_dispatcher.path.update';

  // VIEWS EVENTS.

  /**
   * Describe data tables and fields (or the equivalent) to Views.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_data()
   * @see hook_views_data()
   *
   * @var string
   */
  const VIEWS_DATA = 'hook_event_dispatcher.views.data';

  /**
   * Alter the table and field information from hook_views_data().
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_data_alter()
   * @see hook_views_data_alter()
   *
   * @var string
   */
  const VIEWS_DATA_ALTER = 'hook_event_dispatcher.views.data_alter';

  /**
   * Alter a view at the very beginning of Views processing.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_pre_view()
   * @see hook_views_pre_view()
   *
   * @var string
   */
  const VIEWS_PRE_VIEW = 'hook_event_dispatcher.views.pre_view';

  /**
   * Act on the view after the query is built and just before it is executed.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_pre_execute()
   * @see hook_views_pre_execute()
   *
   * @var string
   */
  const VIEWS_PRE_EXECUTE = 'hook_event_dispatcher.views.pre_execute';

  /**
   * Act on the view immediately before rendering it.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_pre_render()
   * @see hook_views_pre_render()
   *
   * @var string
   */
  const VIEWS_PRE_RENDER = 'hook_event_dispatcher.views.pre_render';

  /**
   * Act on the view immediately after the query has been executed.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_post_execute()
   * @see hook_views_post_execute()
   *
   * @var string
   */
  const VIEWS_POST_EXECUTE = 'hook_event_dispatcher.views.post_execute';

  /**
   * Post-process any rendered data.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_post_render()
   * @see hook_views_post_render()
   *
   * @var string
   */
  const VIEWS_POST_RENDER = 'hook_event_dispatcher.views.post_render';

  /**
   * Act on the view before the query is built, but after displays are attached.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_pre_build()
   * @see hook_views_pre_build()
   *
   * @var string
   */
  const VIEWS_PRE_BUILD = 'hook_event_dispatcher.views.pre_build';

  /**
   * Act on the view immediately after the query is built.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_post_build()
   * @see hook_views_post_build()
   *
   * @var string
   */
  const VIEWS_POST_BUILD = 'hook_event_dispatcher.views.post_build';

  /**
   * Alter the query before it is executed.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_query_alter()
   * @see hook_views_query_alter()
   */
  const VIEWS_QUERY_ALTER = 'hook_event_dispatcher.views.query_alter';

  /**
   * Replace special strings in the query before it is executed.
   *
   * @Event
   *
   * @see hook_event_dispatcher_views_query_substitutions()
   * @see hook_views_query_substitutions()
   */
  const VIEWS_QUERY_SUBSTITUTIONS = 'hook_event_dispatcher.views.query_substitutions';

  // THEME EVENTS.

  /**
   * Register a module or theme's theme implementations.
   *
   * @Event
   *
   * @see hook_event_dispatcher_theme()
   * @see hook_theme()
   *
   * @var string
   */
  const THEME = 'hook_event_dispatcher.theme';

  /**
   * Alter the theme registry information returned from hook_theme().
   *
   * @Event
   *
   * @see hook_event_dispatcher_theme_registry_alter()
   * @see hook_theme_registry_alter()
   *
   * @var string
   */
  const THEME_REGISTRY_ALTER = 'hook_event_dispatcher.theme.registry_alter';

  /**
   * Alters named suggestions for all theme hooks.
   *
   * @Event
   *
   * @see hook_event_dispatcher_theme_suggestions_alter()
   * @see hook_theme_suggestions_alter()
   *
   * @var string
   */
  const THEME_SUGGESTIONS_ALTER = 'hook_event_dispatcher.theme.suggestions_alter';

  /**
   * Respond to themes being installed.
   *
   * @Event
   *
   * @see hook_event_dispatcher_themes_installed()
   * @see hook_themes_installed()
   *
   * @var string
   */
  const THEMES_INSTALLED = 'hook_event_dispatcher.theme.installed';

  /**
   * Alter the default, hook-independent variables for all templates.
   *
   * @Event
   *
   * @see hook_event_dispatcher_template_preprocess_default_variables_alter()
   * @see hook_template_preprocess_default_variables_alter()
   *
   * @var string
   */
  const TEMPLATE_PREPROCESS_DEFAULT_VARIABLES_ALTER = 'hook_event_dispatcher.theme.template_preprocess_default_variables_alter';

  /**
   * Perform necessary alterations to the JS before it is presented on the page.
   *
   * @Event
   *
   * @see hook_event_dispatcher_js_alter()
   * @see hook_js_alter()
   *
   * @var string
   */
  const JS_ALTER = 'hook_event_dispatcher.js.alter';

  /**
   * Alter the library info provided by an extension.
   *
   * @Event
   *
   * @see hook_event_dispatcher_library_info_alter()
   * @see hook_library_info_alter()
   *
   * @var string
   */
  const LIBRARY_INFO_ALTER = 'hook_event_dispatcher.library.info_alter';

  // USER EVENTS.

  /**
   * Act on user account cancellations.
   *
   * @Event
   *
   * @see hook_event_dispatcher_user_cancel()
   * @see hook_user_cancel()
   *
   * @var string
   */
  const USER_CANCEL = 'hook_event_dispatcher.user.cancel';

  /**
   * Modify account cancellation methods.
   *
   * @Event
   *
   * @see hook_event_dispatcher_user_cancel_methods_alter()
   * @see hook_user_cancel_methods_alter()
   *
   * @var string
   */
  const USER_CANCEL_METHODS_ALTER = 'hook_event_dispatcher.user.cancel_methods_alter';

  /**
   * The user just logged in.
   *
   * @Event
   *
   * @see hook_event_dispatcher_user_login()
   * @see hook_user_login()
   *
   * @var string
   */
  const USER_LOGIN = 'hook_event_dispatcher.user.login';

  /**
   * The user just logged out.
   *
   * @Event
   *
   * @see hook_event_dispatcher_user_logout()
   * @see hook_user_logout()
   *
   * @var string
   */
  const USER_LOGOUT = 'hook_event_dispatcher.user.logout';

  /**
   * Alter the username that is displayed for a user.
   *
   * @Event
   *
   * @see hook_event_dispatcher_user_format_name_alter()
   * @see hook_user_format_name_alter()
   *
   * @var string
   */
  const USER_FORMAT_NAME_ALTER = 'hook_event_dispatcher.user.format_name_alter';

  // TOOLBAR EVENTS.

  /**
   * Alter the toolbar menu after hook_toolbar() is invoked.
   *
   * @Event
   *
   * @see hook_event_dispatcher_toolbar_alter()
   * @see hook_toolbar_alter()
   *
   * @var string
   */
  const TOOLBAR_ALTER = 'hook_event_dispatcher.toolbar.alter';

  // PAGE EVENTS.

  /**
   * Add a renderable array to the top of the page.
   *
   * @Event
   *
   * @see hook_event_dispatcher_page_top()
   * @see hook_page_top()
   *
   * @var string
   */
  const PAGE_TOP = 'hook_event_dispatcher.page.top';

  /**
   * Add a renderable array to the bottom of the page.
   *
   * @Event
   *
   * @see hook_event_dispatcher_page_bottom()
   * @see hook_page_bottom()
   *
   * @var string
   */
  const PAGE_BOTTOM = 'hook_event_dispatcher.page.bottom';

  /**
   * Add attachments (typically assets) to a page before it is rendered.
   *
   * Attachments should be added to individual element render arrays whenever
   * possible, as per Drupal best practices, so only use this when that isn't
   * practical or you need to target the page itself.
   *
   * @Event
   *
   * @see hook_event_dispatcher_page_attachments()
   * @see hook_page_attachments()
   *
   * @var string
   */
  const PAGE_ATTACHMENTS = 'hook_event_dispatcher.page.attachments';

  // CRON EVENTS.

  /**
   * Perform periodic actions.
   *
   * @Event
   *
   * @see hook_event_dispatcher_cron()
   * @see hook_cron()
   *
   * @var string
   */
  const CRON = 'hook_event_dispatcher.cron';

  // LANGUAGE EVENTS.

  /**
   * Alter the links generated to switch languages.
   *
   * @Event
   *
   * @see hook_event_dispatcher_language_switch_links_alter()
   * @see hook_language_switch_links_alter()
   *
   * @var string
   */
  const LANGUAGE_SWITCH_LINKS_ALTER = 'hook_event_dispatcher.language.switch_links_alter';

  // WEBFORM EVENTS.

  /**
   * Respond to webform elements being rendered.
   *
   * @Event
   *
   * @see webform_event_dispatcher_webform_element_alter()
   * @see hook_webform_element_alter()
   *
   * @var string
   */
  const WEBFORM_ELEMENT_ALTER = 'hook_event_dispatcher.webform.element.alter';

  /**
   * Respond to webform element info being initialized.
   *
   * @Event
   *
   * @see webform_event_dispatcher_webform_element_info_alter()
   * @see hook_webform_element_info_alter()
   *
   * @var string
   */
  const WEBFORM_ELEMENT_INFO_ALTER = 'hook_event_dispatcher.webform.element.info.alter';

}

Interfaces

Name	Description
HookEventDispatcherInterface	Interface HookEventDispatcherInterface.