ConfigEntityRevisionsFormAlterInterface.php in Config Entity Revisions 8.2

Namespace

Drupal\config_entity_revisions

File

src/ConfigEntityRevisionsFormAlterInterface.php

<?php

namespace Drupal\config_entity_revisions;

use Drupal\Core\Form\FormStateInterface;

/**
 * Interface ConfigEntityRevisionsFormAlterInterface.
 *
 * @package 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();

}

Interfaces

Name	Description
ConfigEntityRevisionsFormAlterInterface	Interface ConfigEntityRevisionsFormAlterInterface.