You are here

Home » API reference » Config Entity Revisions 1.x » WebformRevisionsController.php

class WebformRevisionsController in Config Entity Revisions 1.x

Same name and namespace in other branches
  1. 8.2 modules/webform_revisions/src/Controller/WebformRevisionsController.php \Drupal\webform_revisions\Controller\WebformRevisionsController
  2. 8 modules/webform_revisions/src/Controller/WebformRevisionsController.php \Drupal\webform_revisions\Controller\WebformRevisionsController

Controller to make library functions available to various consumers.

Hierarchy

Expanded class hierarchy of WebformRevisionsController

5 files declare their use of WebformRevisionsController
WebformRevisionsDeleteForm.php in modules/webform_revisions/src/Form/WebformRevisionsDeleteForm.php
WebformRevisionsRequest.php in modules/webform_revisions/src/WebformRevisionsRequest.php
WebformRevisionsSubmission.php in modules/webform_revisions/src/Entity/WebformRevisionsSubmission.php
WebformRevisionsSubmissionStorage.php in modules/webform_revisions/src/WebformRevisionsSubmissionStorage.php
webform_revisions.module in modules/webform_revisions/webform_revisions.module

File

modules/webform_revisions/src/Controller/WebformRevisionsController.php, line 15

Namespace

Drupal\webform_revisions\Controller
View source 
class WebformRevisionsController extends ConfigEntityRevisionsControllerBase implements ConfigEntityRevisionsControllerInterface {
  use WebformRevisionsConfigTrait;

  /**
   * Generates a title for the revision.
   *
   * This function is needed because the $webform parameter needs to match
   * the route but the parent's parameter is named $configEntity.
   *
   * @inheritdoc
   */
  public function revisionShowTitle(ConfigEntityInterface $webform) {
    return '"' . $webform
      ->get('title') . '" webform, revision ' . $webform
      ->getRevisionId();
  }

  /**
   * Perform alterations before a webform submission form is rendered.
   *
   * This hook is identical to hook_form_alter() but allows the
   * hook_webform_submission_form_alter() function to be stored in a dedicated
   * include file and it also allows the Webform module to implement webform
   * alter logic on another module's behalf.
   *
   * @param array $form
   *   Nested array of form elements that comprise the webform.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form. The arguments that
   *   \Drupal::formBuilder()->getForm() was originally called with are
   *   available in the array $form_state->getBuildInfo()['args'].
   * @param string $form_id
   *   String representing the webform's id.
   *
   * @see webform.honeypot.inc
   * @see hook_form_BASE_FORM_ID_alter()
   * @see hook_form_FORM_ID_alter()
   *
   * @ingroup form_api
   */
  public static function submission_form_alter(array &$form, FormStateInterface $form_state, $form_id) {
    $form['#entity_builders']['webform_revisions'] = '\\Drupal\\webform_revisions\\Controller\\WebformRevisionsController::entity_builder';
  }

  /**
   * @Implements hook_webform_submission_presave().
   */
  public static function submission_presave(WebformSubmissionInterface $webform_submission) {
    $match = \Drupal::service('router')
      ->matchRequest(\Drupal::request());
    $webform_id = $match['webform'];
    $config_entity = \Drupal::entityTypeManager()
      ->getStorage('webform')
      ->load($webform_id);
    $revisionsEntity = $config_entity
      ->contentEntityStorage()
      ->loadRevision($config_entity
      ->getRevisionID());
  }

  /**
   * Updates the form language to reflect any change to the entity language.
   *
   * There are use cases for modules to act both before and after form language
   * being updated, thus the update is performed through an entity builder
   * callback, which allows to support both cases.
   *
   * @param string $entity_type_id
   *   The entity type identifier.
   * @param \Drupal\webform\Entity\WebformSubmission $entity
   *   The entity updated with the submitted values.
   * @param array $form
   *   The complete form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @see \Drupal\Core\Entity\ContentEntityForm::form()
   */
  public static function entity_builder($entity_type_id, WebformSubmission $entity, array $form, FormStateInterface $form_state) {

    /* @var $webform \Drupal\webform_revisions\Entity\WebformRevisions */
    $webform = $entity
      ->getWebform();
    $entity
      ->set('webform_revision', $webform
      ->getRevisionID());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityRevisionsControllerBase::$config protected property Wrapper object for simple configuration from diff.settings.yml.
ConfigEntityRevisionsControllerBase::$connection protected property The database connection.
ConfigEntityRevisionsControllerBase::$container protected property Container instance.
ConfigEntityRevisionsControllerBase::$dateFormatter protected property Date formatter service.
ConfigEntityRevisionsControllerBase::$entityComparison protected property Wrapper object for simple configuration from diff.settings.yml.
ConfigEntityRevisionsControllerBase::$renderer protected property The renderer service.
ConfigEntityRevisionsControllerBase::$serialiser protected property Serialiser service.
ConfigEntityRevisionsControllerBase::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ConfigEntityRevisionsControllerBase::createInitialRevision public function Create an initial revision record. Overrides ConfigEntityRevisionsControllerInterface::createInitialRevision
ConfigEntityRevisionsControllerBase::createUpdateRevision public function Create revision when a new config entity version is saved. Overrides ConfigEntityRevisionsControllerInterface::createUpdateRevision
ConfigEntityRevisionsControllerBase::deleteRevision public function Delete a single revision.
ConfigEntityRevisionsControllerBase::deleteRevisions public function Delete revisions when a config entity is deleted. Overrides ConfigEntityRevisionsControllerInterface::deleteRevisions
ConfigEntityRevisionsControllerBase::getRevisionIds public function Get a list of revision IDs for a content entity.
ConfigEntityRevisionsControllerBase::loadConfigEntityRevision public function Load a particular revision of a config entity.
ConfigEntityRevisionsControllerBase::resetDefaultRevision public function Make default the most recently published revision or the most recent revision.
ConfigEntityRevisionsControllerBase::__construct public function Constructs a ConfigEntityRevisionsController object. Overrides ConfigEntityRevisionsControllerInterface::__construct
ConfigEntityRevisionsStorageTrait::admin_permission public function
ConfigEntityRevisionsStorageTrait::config_entity_name public function
ConfigEntityRevisionsStorageTrait::content_entity_type public function
ConfigEntityRevisionsStorageTrait::content_parameter_name public function
ConfigEntityRevisionsStorageTrait::content_parent_reference_field public function
ConfigEntityRevisionsStorageTrait::has_canonical_url public function
ConfigEntityRevisionsStorageTrait::has_own_content public function
ConfigEntityRevisionsStorageTrait::module_name public function
ConfigEntityRevisionsStorageTrait::revisions_entity_name public function
ConfigEntityRevisionsStorageTrait::setting_name public function
ConfigEntityRevisionsStorageTrait::title public function
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
WebformRevisionsConfigTrait::$constants private property
WebformRevisionsConfigTrait::contentEntityCount public function Get the number of submissions related to a revision.
WebformRevisionsConfigTrait::deleteRelatedContentEntities public function Delete submissions related to a revision.
WebformRevisionsConfigTrait::revisioned_entity public function Get the entity that actually has revisions.
WebformRevisionsController::entity_builder public static function Updates the form language to reflect any change to the entity language.
WebformRevisionsController::revisionShowTitle public function Generates a title for the revision. Overrides ConfigEntityRevisionsControllerInterface::revisionShowTitle
WebformRevisionsController::submission_form_alter public static function Perform alterations before a webform submission form is rendered.
WebformRevisionsController::submission_presave public static function @Implements hook_webform_submission_presave().