You are here

Home » API reference » Flag Lists 4.0.x » FlaggingCollectionRevisionRevertForm.php

class FlaggingCollectionRevisionRevertForm in Flag Lists 4.0.x

Same name and namespace in other branches
  1. 8 src/Form/FlaggingCollectionRevisionRevertForm.php \Drupal\flag_lists\Form\FlaggingCollectionRevisionRevertForm

Provides a form for reverting a Flagging collection revision.

Hierarchy

Expanded class hierarchy of FlaggingCollectionRevisionRevertForm

File

src/Form/FlaggingCollectionRevisionRevertForm.php, line 18

Namespace

Drupal\flag_lists\Form
View source 
class FlaggingCollectionRevisionRevertForm extends ConfirmFormBase {

  /**
   * The Flagging collection revision.
   *
   * @var \Drupal\flag_lists\Entity\FlaggingCollectionInterface
   */
  protected $revision;

  /**
   * The Flagging collection storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $flaggingCollectionStorage;

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

  /**
   * Constructs a new FlaggingCollectionRevisionRevertForm.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $entity_storage
   *   The Flagging collection storage.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   */
  public function __construct(EntityStorageInterface $entity_storage, DateFormatterInterface $date_formatter) {
    $this->flaggingCollectionStorage = $entity_storage;
    $this->dateFormatter = $date_formatter;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('entity.flagging_collection.version_history', [
      'flagging_collection' => $this->revision
        ->id(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Revert');
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $flagging_collection_revision = NULL) {
    $this->revision = $this->flaggingCollectionStorage
      ->loadRevision($flagging_collection_revision);
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

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

    // 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->revision = $this
      ->prepareRevertedRevision($this->revision, $form_state);
    $this->revision->revision_log = $this
      ->t('Copy of the revision from %date.', [
      '%date' => $this->dateFormatter
        ->format($original_revision_timestamp),
    ]);
    $this->revision
      ->save();
    $this
      ->logger('content')
      ->notice('Flagging collection: reverted %title revision %revision.', [
      '%title' => $this->revision
        ->label(),
      '%revision' => $this->revision
        ->getRevisionId(),
    ]);
    $this
      ->messenger()
      ->addMessage(t('Flagging collection %title has been reverted to the revision from %revision-date.', [
      '%title' => $this->revision
        ->label(),
      '%revision-date' => $this->dateFormatter
        ->format($original_revision_timestamp),
    ]));
    $form_state
      ->setRedirect('entity.flagging_collection.version_history', [
      'flagging_collection' => $this->revision
        ->id(),
    ]);
  }

  /**
   * Prepares a revision to be reverted.
   *
   * @param \Drupal\flag_lists\Entity\FlaggingCollectionInterface $revision
   *   The revision to be reverted.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\flag_lists\Entity\FlaggingCollectionInterface
   *   The prepared revision ready to be stored.
   */
  protected function prepareRevertedRevision(FlaggingCollectionInterface $revision, FormStateInterface $form_state) {
    $revision
      ->setNewRevision();
    $revision
      ->isDefaultRevision(TRUE);
    $revision
      ->setRevisionCreationTime(\Drupal::time()
      ->getRequestTime());
    return $revision;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FlaggingCollectionRevisionRevertForm::$dateFormatter protected property The date formatter service.
FlaggingCollectionRevisionRevertForm::$flaggingCollectionStorage protected property The Flagging collection storage.
FlaggingCollectionRevisionRevertForm::$revision protected property The Flagging collection revision.
FlaggingCollectionRevisionRevertForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm 1
FlaggingCollectionRevisionRevertForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create 1
FlaggingCollectionRevisionRevertForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
FlaggingCollectionRevisionRevertForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
FlaggingCollectionRevisionRevertForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
FlaggingCollectionRevisionRevertForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 1
FlaggingCollectionRevisionRevertForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion 1
FlaggingCollectionRevisionRevertForm::prepareRevertedRevision protected function Prepares a revision to be reverted. 1
FlaggingCollectionRevisionRevertForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FlaggingCollectionRevisionRevertForm::__construct public function Constructs a new FlaggingCollectionRevisionRevertForm. 1
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 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.