You are here

Home » API reference » Data Policy 8 » DataPolicyRevisionRevertForm.php

class DataPolicyRevisionRevertForm in Data Policy 8

Provides a form for reverting a Data policy revision.

Hierarchy

Expanded class hierarchy of DataPolicyRevisionRevertForm

File

src/Form/DataPolicyRevisionRevertForm.php, line 19

Namespace

Drupal\data_policy\Form
View source 
class DataPolicyRevisionRevertForm extends ConfirmFormBase {

  /**
   * The Data policy revision.
   *
   * @var \Drupal\data_policy\Entity\DataPolicyInterface
   */
  protected $revision;

  /**
   * The Data policy storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $dataPolicyStorage;

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

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

  /**
   * Constructs a new DataPolicyRevisionRevertForm.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $entity_storage
   *   The Data policy storage.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   */
  public function __construct(EntityStorageInterface $entity_storage, DateFormatterInterface $date_formatter, TimeInterface $time) {
    $this->dataPolicyStorage = $entity_storage;
    $this->dateFormatter = $date_formatter;
    $this->time = $time;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'data_policy_data_policy_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.data_policy.version_history', [
      'entity_id' => $this->revision
        ->id(),
    ]);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('After making this revision active users will be asked again to agree with this revision.');
  }

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

  /**
   * {@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('Data policy: reverted revision %revision.', [
      '%revision' => $this->revision
        ->getRevisionId(),
    ]);
    $this
      ->messenger()
      ->addStatus($this
      ->t('Data policy has been reverted to the revision from %revision-date.', [
      '%revision-date' => $this->dateFormatter
        ->format($original_revision_timestamp),
    ]));
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

  /**
   * Prepares a revision to be reverted.
   *
   * @param \Drupal\data_policy\Entity\DataPolicyInterface $revision
   *   The revision to be reverted.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\data_policy\Entity\DataPolicyInterface
   *   The prepared revision ready to be stored.
   */
  protected function prepareRevertedRevision(DataPolicyInterface $revision, FormStateInterface $form_state) {
    $revision
      ->setNewRevision();
    $revision
      ->isDefaultRevision(FALSE);
    $revision
      ->setRevisionCreationTime($this->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 1
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DataPolicyRevisionRevertForm::$dataPolicyStorage protected property The Data policy storage.
DataPolicyRevisionRevertForm::$dateFormatter protected property The date formatter service.
DataPolicyRevisionRevertForm::$revision protected property The Data policy revision.
DataPolicyRevisionRevertForm::$time protected property The time service.
DataPolicyRevisionRevertForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm 1
DataPolicyRevisionRevertForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create 1
DataPolicyRevisionRevertForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
DataPolicyRevisionRevertForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
DataPolicyRevisionRevertForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
DataPolicyRevisionRevertForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 1
DataPolicyRevisionRevertForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion 1
DataPolicyRevisionRevertForm::prepareRevertedRevision protected function Prepares a revision to be reverted. 1
DataPolicyRevisionRevertForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DataPolicyRevisionRevertForm::__construct public function Constructs a new DataPolicyRevisionRevertForm. 1
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
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. 1
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. Overrides UrlGeneratorTrait::redirect
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 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator 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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.