You are here

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

class ConfigEntityRevisionsRevertFormBase in Config Entity Revisions 1.x

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

Provides a form for reverting / publishing a revision.

Hierarchy

Expanded class hierarchy of ConfigEntityRevisionsRevertFormBase

3 files declare their use of ConfigEntityRevisionsRevertFormBase
ConfigEntityRevisionsRevertFormBaseTest.php in tests/src/Unit/ConfigEntityRevisionsRevertFormBaseTest.php
ViewsRevisionsRevertForm.php in modules/views_revisions/src/Form/ViewsRevisionsRevertForm.php
WebformRevisionsRevertForm.php in modules/webform_revisions/src/Form/WebformRevisionsRevertForm.php

File

src/ConfigEntityRevisionsRevertFormBase.php, line 18

Namespace

Drupal\config_entity_revisions
View source 
class ConfigEntityRevisionsRevertFormBase extends ConfirmFormBase {

  /**
   * The entity type manager.
   *
   * @var EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The time service.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * The time service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * The content entity revision.
   *
   * @var ConfigEntityRevisionsEntityInterface
   */
  protected $revision;

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

  /**
   * The revision ID to be reverted.
   *
   * @var int
   */
  protected $revision_id;

  /**
   * The action (publish or revert).
   *
   * @var string
   */
  protected $action;

  /**
   * The array of configuration strings.
   *
   * @var array
   */
  protected $config;

  /**
   * Constructs a new class instance.
   *
   * @param \Drupal\Core\Entity\EntityTypeManager $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(EntityTypeManager $entity_type_manager, DateFormatterInterface $date_formatter, TimeInterface $time, MessengerInterface $messenger) {
    $this->entityTypeManager = $entity_type_manager;
    $this->dateFormatter = $date_formatter;
    $this->time = $time;
    $this->messenger = $messenger;
    $match = \Drupal::service('router')
      ->matchRequest(\Drupal::request());
    $this->config_entity = $match['config_entity']
      ->revisioned_entity();
    $this->revision_id = $match['revision_id'];
    $this->revision = $this->config_entity
      ->contentEntityStorage()
      ->loadRevision($this->revision_id);
    $revisionsID = $this->config_entity
      ->getContentEntityID();
    $latest_published = $this->config_entity
      ->contentEntityStorage()
      ->getLatestPublishedRevision($revisionsID);
    $publish = is_null($latest_published) || $this->revision
      ->getRevisionId() > $latest_published
      ->getRevisionId();
    $this->action = $publish ? 'publish' : 'revert';
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('date.formatter'), $container
      ->get('datetime.time'), $container
      ->get('messenger'));
  }

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

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

  /**
   * {@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 $this
      ->t(ucfirst($this->action));
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * Prepares a revision to be reverted.
   *
   * @param ConfigEntityRevisionsEntityInterface $revision
   *   The revision to be reverted.
   *
   * @return ConfigEntityRevisionsEntityInterface
   *   The prepared revision ready to be stored.
   */
  public function prepareRevertedRevision(ConfigEntityRevisionsEntityInterface $revision) {
    $revision
      ->setNewRevision();
    $revision
      ->isDefaultRevision(TRUE);

    // The revision timestamp will be updated when the revision is saved. Keep
    // the original one for the confirmation message.
    $original_revision_timestamp = $revision
      ->getRevisionCreationTime();
    $originalLogMessage = $revision
      ->getRevisionLogMessage();
    $logMessage = $originalLogMessage ? $this
      ->t('Copy of the revision from %date (%message).', [
      '%date' => $this->dateFormatter
        ->format($original_revision_timestamp),
      '%message' => $originalLogMessage,
    ]) : $this
      ->t('Copy of the revision from %date.', [
      '%date' => $this->dateFormatter
        ->format($original_revision_timestamp),
    ]);
    $revision
      ->setRevisionLogMessage($logMessage);
    $revision
      ->setRevisionUserId($this
      ->currentUser()
      ->id());
    $revision
      ->setRevisionCreationTime($this->time
      ->getRequestTime());
    $revision
      ->setChangedTime($this->time
      ->getRequestTime());
    $revision
      ->set('moderation_state', 'draft');
    $revision
      ->setUnpublished();
    return $revision;
  }

  /**
   * Modify the revision's fields so that it becomes published.
   *
   * @param ConfigEntityRevisionsEntityInterface $revision
   *   The revision to be published.
   *
   * @return ConfigEntityRevisionsEntityInterface
   *   The resulting revision record, ready to be saved.
   */
  public function prepareToPublishCurrentRevision(ConfigEntityRevisionsEntityInterface $revision) {
    $revision
      ->set('moderation_state', 'published');
    $revision
      ->setPublished();
    $revision
      ->isDefaultRevision(TRUE);
    return $revision;
  }

  /**
   * Apply the revision insert/update.
   */
  public function applyRevisionChange() {
    if ($this->action == 'revert') {
      $this->revision = $this
        ->prepareRevertedRevision($this->revision);
    }
    else {
      $this->revision = $this
        ->prepareToPublishCurrentRevision($this->revision);
    }
    $this->revision
      ->save();
  }

  /**
   * Update config entity.
   */
  public function updateConfigEntity() {
    $this->config_entity = \Drupal::getContainer()
      ->get('serializer')
      ->deserialize($this->revision
      ->get('configuration')->value, get_class($this->config_entity), 'json');
    $this->config_entity
      ->enforceIsNew(FALSE);
    $this->config_entity
      ->set('settingsOriginal', $this->config_entity
      ->get('settings'));
    $this->config_entity
      ->set('revision_id', $this->revision
      ->getRevisionId());
    $this->config_entity
      ->save();
  }

  /**
   * Log the update.
   */
  public function logUpdate() {
    $this
      ->logger('content')
      ->notice('@form: set @form to revision %revision.', [
      '@form' => $this->config_entity
        ->label(),
      '%revision' => $this->revision
        ->getRevisionId(),
    ]);
  }

  /**
   * Add a message to the page loaded next.
   */
  public function displayUpdate() {

    // The revision timestamp will be updated when the revision is saved. Keep
    // the original one for the confirmation message.
    $original_revision_timestamp = $this->revision
      ->getRevisionCreationTime();
    $this->messenger
      ->addMessage($this
      ->t('%entity_title %title has been set to the revision from %revision-date.', [
      '%entity_title' => $this->config_entity
        ->title(),
      '%title' => $this->config_entity
        ->label(),
      '%revision-date' => $this->dateFormatter
        ->format($original_revision_timestamp),
    ]));
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->applyRevisionChange();
    $this
      ->updateConfigEntity();
    $this
      ->logUpdate();
    $this
      ->displayUpdate();
    $this
      ->setRedirect($form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityRevisionsRevertFormBase::$action protected property The action (publish or revert).
ConfigEntityRevisionsRevertFormBase::$config protected property The array of configuration strings.
ConfigEntityRevisionsRevertFormBase::$config_entity protected property The config entity.
ConfigEntityRevisionsRevertFormBase::$dateFormatter protected property The date formatter service.
ConfigEntityRevisionsRevertFormBase::$entityTypeManager protected property The entity type manager.
ConfigEntityRevisionsRevertFormBase::$messenger protected property The time service. Overrides MessengerTrait::$messenger
ConfigEntityRevisionsRevertFormBase::$revision protected property The content entity revision.
ConfigEntityRevisionsRevertFormBase::$revision_id protected property The revision ID to be reverted.
ConfigEntityRevisionsRevertFormBase::$time protected property The time service.
ConfigEntityRevisionsRevertFormBase::applyRevisionChange public function Apply the revision insert/update. 1
ConfigEntityRevisionsRevertFormBase::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
ConfigEntityRevisionsRevertFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConfigEntityRevisionsRevertFormBase::displayUpdate public function Add a message to the page loaded next. 1
ConfigEntityRevisionsRevertFormBase::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ConfigEntityRevisionsRevertFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ConfigEntityRevisionsRevertFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
ConfigEntityRevisionsRevertFormBase::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigEntityRevisionsRevertFormBase::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ConfigEntityRevisionsRevertFormBase::logUpdate public function Log the update. 1
ConfigEntityRevisionsRevertFormBase::prepareRevertedRevision public function Prepares a revision to be reverted. 1
ConfigEntityRevisionsRevertFormBase::prepareToPublishCurrentRevision public function Modify the revision's fields so that it becomes published. 1
ConfigEntityRevisionsRevertFormBase::setRedirect public function Redirect the user back to the revisions overview page. 1
ConfigEntityRevisionsRevertFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ConfigEntityRevisionsRevertFormBase::updateConfigEntity public function Update config entity. 1
ConfigEntityRevisionsRevertFormBase::__construct public function Constructs a new class instance.
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::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 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.