class NodeRevisionRevertForm

Same name in other branches
  1. 9 core/modules/node/src/Form/NodeRevisionRevertForm.php \Drupal\node\Form\NodeRevisionRevertForm
  2. 8.9.x core/modules/node/src/Form/NodeRevisionRevertForm.php \Drupal\node\Form\NodeRevisionRevertForm
  3. 11.x core/modules/node/src/Form/NodeRevisionRevertForm.php \Drupal\node\Form\NodeRevisionRevertForm

Provides a form for reverting a node revision.

@internal

Hierarchy

Expanded class hierarchy of NodeRevisionRevertForm

1 string reference to 'NodeRevisionRevertForm'
node.routing.yml in core/modules/node/node.routing.yml
core/modules/node/node.routing.yml

File

core/modules/node/src/Form/NodeRevisionRevertForm.php, line 19

Namespace

Drupal\node\Form
View source
class NodeRevisionRevertForm extends ConfirmFormBase {
    
    /**
     * The node revision.
     *
     * @var \Drupal\node\NodeInterface
     */
    protected $revision;
    
    /**
     * The node storage.
     *
     * @var \Drupal\node\NodeStorageInterface
     */
    protected $nodeStorage;
    
    /**
     * The date formatter service.
     *
     * @var \Drupal\Core\Datetime\DateFormatterInterface
     */
    protected $dateFormatter;
    
    /**
     * The time service.
     *
     * @var \Drupal\Component\Datetime\TimeInterface
     */
    protected $time;
    
    /**
     * Constructs a new NodeRevisionRevertForm.
     *
     * @param \Drupal\Core\Entity\EntityStorageInterface $node_storage
     *   The node 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 $node_storage, DateFormatterInterface $date_formatter, TimeInterface $time) {
        $this->nodeStorage = $node_storage;
        $this->dateFormatter = $date_formatter;
        $this->time = $time;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.manager')
            ->getStorage('node'), $container->get('date.formatter'), $container->get('datetime.time'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'node_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.node.version_history', [
            'node' => $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, ?NodeInterface $node_revision = NULL) {
        $this->revision = $node_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
            ->setRevisionUserId($this->currentUser()
            ->id());
        $this->revision
            ->setRevisionCreationTime($this->time
            ->getRequestTime());
        $this->revision
            ->setChangedTime($this->time
            ->getRequestTime());
        $this->revision
            ->save();
        $this->logger('content')
            ->info('@type: reverted %title revision %revision.', [
            '@type' => $this->revision
                ->bundle(),
            '%title' => $this->revision
                ->label(),
            '%revision' => $this->revision
                ->getRevisionId(),
        ]);
        $this->messenger()
            ->addStatus($this->t('@type %title has been reverted to the revision from %revision-date.', [
            '@type' => node_get_type_label($this->revision),
            '%title' => $this->revision
                ->label(),
            '%revision-date' => $this->dateFormatter
                ->format($original_revision_timestamp),
        ]));
        $form_state->setRedirect('entity.node.version_history', [
            'node' => $this->revision
                ->id(),
        ]);
    }
    
    /**
     * Prepares a revision to be reverted.
     *
     * @param \Drupal\node\NodeInterface $revision
     *   The revision to be reverted.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     *
     * @return \Drupal\node\NodeInterface
     *   The prepared revision ready to be stored.
     */
    protected function prepareRevertedRevision(NodeInterface $revision, FormStateInterface $form_state) {
        $revision->setNewRevision();
        $revision->isDefaultRevision(TRUE);
        return $revision;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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 1
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. 2
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 57
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
NodeRevisionRevertForm::$dateFormatter protected property The date formatter service.
NodeRevisionRevertForm::$nodeStorage protected property The node storage.
NodeRevisionRevertForm::$revision protected property The node revision.
NodeRevisionRevertForm::$time protected property The time service.
NodeRevisionRevertForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm 1
NodeRevisionRevertForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create 1
NodeRevisionRevertForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
NodeRevisionRevertForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
NodeRevisionRevertForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription 1
NodeRevisionRevertForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 1
NodeRevisionRevertForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion 1
NodeRevisionRevertForm::prepareRevertedRevision protected function Prepares a revision to be reverted. 1
NodeRevisionRevertForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
NodeRevisionRevertForm::__construct public function Constructs a new NodeRevisionRevertForm. 1
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.