ExpenseRevisionRevertForm.php in Drupal PM (Project Management) 4.x

Namespace

Drupal\pm_expense\Form

File

modules/pm_expense/src/Form/ExpenseRevisionRevertForm.php

<?php

namespace Drupal\pm_expense\Form;

use Drupal\Core\Form\ConfirmFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Drupal\pm_expense\Entity\ExpenseInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a form for reverting a Expense revision.
 *
 * @ingroup pm_expense
 */
class ExpenseRevisionRevertForm extends ConfirmFormBase {

  /**
   * The Expense revision.
   *
   * @var \Drupal\pm_expense\Entity\ExpenseInterface
   */
  protected $revision;

  /**
   * The Expense storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $expenseStorage;

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->expenseStorage = $container
      ->get('entity_type.manager')
      ->getStorage('pm_expense');
    $instance->dateFormatter = $container
      ->get('date.formatter');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'pm_expense_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.pm_expense.version_history', [
      'pm_expense' => $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, $pm_expense_revision = NULL) {
    $this->revision = $this->ExpenseStorage
      ->loadRevision($pm_expense_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('Expense: reverted %title revision %revision.', [
      '%title' => $this->revision
        ->label(),
      '%revision' => $this->revision
        ->getRevisionId(),
    ]);
    $this
      ->messenger()
      ->addMessage(t('Expense %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.pm_expense.version_history', [
      'pm_expense' => $this->revision
        ->id(),
    ]);
  }

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

}

Classes

Name	Description
ExpenseRevisionRevertForm	Provides a form for reverting a Expense revision.