interface ConfigEntityRevisionsFormAlterInterface in Config Entity Revisions 8.2

Interface ConfigEntityRevisionsFormAlterInterface.

@package Drupal\config_entity_revisions

Hierarchy

• interface \Drupal\config_entity_revisions\ConfigEntityRevisionsFormAlterInterface

2 files declare their use of ConfigEntityRevisionsFormAlterInterface

ViewRevisionsFormAlter.php in modules/view_revisions/src/ViewRevisionsFormAlter.php

WebformRevisionsFormAlter.php in modules/webform_revisions/src/WebformRevisionsFormAlter.php

File

src/ConfigEntityRevisionsFormAlterInterface.php, line 12

Namespace

Drupal\config_entity_revisions

interface ConfigEntityRevisionsFormAlterInterface {

  /**
   * Route parameter name.
   *
   * @return string
   *   The name of the route parameter used to access the config entity.
   */
  public static function getRouteParameterName();

  /**
   * ViewRevisions routes that provide an add form.
   *
   * @return array
   *   ViewRevisions routes that provide an add form.
   */
  public static function getAddFormRoutes();

  /**
   * ViewRevisions routes that provide add or edit forms.
   *
   * @return array
   *   ViewRevisions routes that provide add or edit forms.
   */
  public static function getEditFormRoutes();

  /**
   * Additional routes (to $add_edit_form_routes) that need a revision id.
   *
   * @return array
   *   Additional routes (to $add_edit_form_routes) that need a revision id.
   */
  public static function getRevisionRoutes();

  /**
   * Common form_alter hook code.
   */
  public static function formAlter(&$form, FormStateInterface $form_state, $form_id);

  /**
   * Do we create a new revision by default? (Generally no for config entities).
   *
   * @return bool
   *   Whether the 'New revision' checkbox should default on.
   */
  public static function getNewRevisionDefault();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityRevisionsFormAlterInterface::formAlter	public static	function	Common form_alter hook code.	1
ConfigEntityRevisionsFormAlterInterface::getAddFormRoutes	public static	function	ViewRevisions routes that provide an add form.	1
ConfigEntityRevisionsFormAlterInterface::getEditFormRoutes	public static	function	ViewRevisions routes that provide add or edit forms.	1
ConfigEntityRevisionsFormAlterInterface::getNewRevisionDefault	public static	function	Do we create a new revision by default? (Generally no for config entities).	1
ConfigEntityRevisionsFormAlterInterface::getRevisionRoutes	public static	function	Additional routes (to $add_edit_form_routes) that need a revision id.	1
ConfigEntityRevisionsFormAlterInterface::getRouteParameterName	public static	function	Route parameter name.	2