You are here

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

abstract class ConfigEntityRevisionsDeleteFormBase in Config Entity Revisions 1.x

Same name and namespace in other branches
  1. 8.2 src/ConfigEntityRevisionsDeleteFormBase.php \Drupal\config_entity_revisions\ConfigEntityRevisionsDeleteFormBase
  2. 8 src/ConfigEntityRevisionsDeleteFormBase.php \Drupal\config_entity_revisions\ConfigEntityRevisionsDeleteFormBase

Provides a form for reverting a config entity revision.

Hierarchy

Expanded class hierarchy of ConfigEntityRevisionsDeleteFormBase

2 files declare their use of ConfigEntityRevisionsDeleteFormBase
ViewsRevisionsDeleteForm.php in modules/views_revisions/src/Form/ViewsRevisionsDeleteForm.php
WebformRevisionsDeleteForm.php in modules/webform_revisions/src/Form/WebformRevisionsDeleteForm.php

File

src/ConfigEntityRevisionsDeleteFormBase.php, line 19

Namespace

Drupal\config_entity_revisions
View source 
abstract class ConfigEntityRevisionsDeleteFormBase extends ConfirmFormBase implements ContainerInjectionInterface {

  /**
   * The config entity.
   *
   * @var ConfigEntityRevisionsInterface;
   */
  protected $config_entity;

  /**
   * The database connection.
   *
   * @var Connection
   */
  protected $connection;

  /**
   * The Date Formatter service.
   *
   * @var DateFormatter
   */
  protected $dateFormatter;

  /**
   * The revision to be deleted.
   *
   * @var ContentEntityInterface
   */
  protected $revision;

  /**
   * The content entity storage.
   *
   * @var ContentEntityStorageInterface
   */
  protected $configEntityRevisionsStorage;

  /**
   * The controller.
   *
   * @var ConfigEntityRevisionsControllerInterface
   */
  protected $controller;

  /**
   * Constructs a new ConfigEntityRevisionsRevisionDeleteForm.
   *
   * @param EntityStorageInterface $storage
   *   The ConfigEntityRevisions storage.
   * @param Connection $connection
   *   The database connection.
   * @param DateFormatter $dateFormatter
   *   The date formatter service.
   * @param ConfigEntityRevisionsControllerInterface
   *   The controller interface.
   */
  public function __construct(EntityStorageInterface $storage, Connection $connection, $dateFormatter, ConfigEntityRevisionsControllerInterface $controller) {
    $this->connection = $connection;
    $this->dateFormatter = $dateFormatter;
    $match = \Drupal::service('router')
      ->matchRequest(\Drupal::request());
    $this->config_entity = $match['config_entity']
      ->revisioned_entity();
    $this->configEntityRevisionsStorage = $storage;
    $this->revision = $storage
      ->loadRevision($match['revision_id']);
    $this->controller = $controller;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return $this->config_entity
      ->module_name() . '_revision_delete_confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return t('Are you sure you want to delete the revision from %revision-date?', [
      '%revision-date' => $this->dateFormatter
        ->format($this->revision
        ->getRevisionCreationTime()),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url("entity." . $this->config_entity
      ->getEntityTypeId() . ".revisions", [
      $this->config_entity
        ->getEntityTypeId() => $this->config_entity
        ->id(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return t('Delete');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    if ($this->config_entity
      ->has_own_content()) {
      $count = $this->config_entity
        ->contentEntityCount($this->revision->revision->value);
      if ($count) {
        return \Drupal::service('string_translation')
          ->formatPlural($count, '1 submission will be deleted.', '@count submissions will be deleted.');
      }
    }
    return '';
  }

  /**
   * Redirect the user back to the revisions overview page.
   *
   * @param FormStateInterface $form_state
   *   The form state to be modified.
   */
  public function setRevisionsFormRedirect(FormStateInterface &$form_state) {
    $form_state
      ->setRedirect('entity.' . $this->config_entity
      ->config_entity_name() . '.revisions', [
      $this->config_entity
        ->config_entity_name() => $this->config_entity
        ->id(),
    ]);
  }

  /**
   * Delete the current revision.
   */
  public function performDeletion() {
    $this->controller
      ->deleteRevision($this->revision);
  }

  /**
   * Log a revision deletion.
   */
  public function logUpdate() {
    $this
      ->logger('content')
      ->notice('Deleted %label revision %revision.', [
      '%label' => $this->config_entity
        ->label(),
      '%revision' => $this->revision
        ->getRevisionId(),
    ]);
  }

  /**
   * Display a message to the user.
   */
  public function displayUpdate() {
    \Drupal::messenger()
      ->addWarning(t('Revision from %revision-date of %form has been deleted.', [
      '%revision-date' => $this->dateFormatter
        ->format($this->revision
        ->getRevisionCreationTime()),
      '%form' => $this->config_entity
        ->label(),
    ]));
  }

  /**
   * Redirect the user back to the config entity build page.
   *
   * @param FormStateInterface $form_state
   *   The form state to be modified.
   */
  public function setBuildFormRedirect(FormStateInterface &$form_state) {
    $form_state
      ->setRedirect('entity.' . $this->config_entity
      ->config_entity_name() . '.edit_form', [
      $this->config_entity
        ->config_entity_name() => $this->config_entity
        ->id(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Someone else may have deleted a revision so we can't assume the state
    // when the form was rendered is still valid.
    $revisions = $this->controller
      ->getRevisionIds($this->config_entity
      ->getContentEntityID());
    if (count($revisions) == 1) {
      \Drupal::messenger()
        ->addError(t('There is only one revision remaining. You may not delete it, sorry.'));
    }
    else {
      if ($this->config_entity
        ->has_own_content()) {
        $this->config_entity
          ->deleteRelatedContentEntities($this->revision->revision->value);
      }
      $this->controller
        ->deleteRevision($this->revision);
      $this
        ->logUpdate();
      $this
        ->displayUpdate();
    }
    if (count($revisions) > 2) {
      $this
        ->setRevisionsFormRedirect($form_state);
    }
    else {
      $this
        ->setBuildFormRedirect($form_state);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityRevisionsDeleteFormBase::$configEntityRevisionsStorage protected property The content entity storage.
ConfigEntityRevisionsDeleteFormBase::$config_entity protected property The config entity.
ConfigEntityRevisionsDeleteFormBase::$connection protected property The database connection.
ConfigEntityRevisionsDeleteFormBase::$controller protected property The controller.
ConfigEntityRevisionsDeleteFormBase::$dateFormatter protected property The Date Formatter service.
ConfigEntityRevisionsDeleteFormBase::$revision protected property The revision to be deleted.
ConfigEntityRevisionsDeleteFormBase::displayUpdate public function Display a message to the user.
ConfigEntityRevisionsDeleteFormBase::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ConfigEntityRevisionsDeleteFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ConfigEntityRevisionsDeleteFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
ConfigEntityRevisionsDeleteFormBase::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigEntityRevisionsDeleteFormBase::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ConfigEntityRevisionsDeleteFormBase::logUpdate public function Log a revision deletion.
ConfigEntityRevisionsDeleteFormBase::performDeletion public function Delete the current revision.
ConfigEntityRevisionsDeleteFormBase::setBuildFormRedirect public function Redirect the user back to the config entity build page.
ConfigEntityRevisionsDeleteFormBase::setRevisionsFormRedirect public function Redirect the user back to the revisions overview page.
ConfigEntityRevisionsDeleteFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ConfigEntityRevisionsDeleteFormBase::__construct public function Constructs a new ConfigEntityRevisionsRevisionDeleteForm.
ConfirmFormBase::buildForm public function Form constructor. Overrides FormInterface::buildForm 25
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
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.