class NodeRevisionDeleteForm

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

Provides a form for deleting a node revision.

@internal

Hierarchy

Expanded class hierarchy of NodeRevisionDeleteForm

1 file declares its use of NodeRevisionDeleteForm
NodeDeprecationTest.php in core/modules/node/tests/src/Kernel/NodeDeprecationTest.php
1 string reference to 'NodeRevisionDeleteForm'
node.routing.yml in core/modules/node/node.routing.yml
core/modules/node/node.routing.yml

File

core/modules/node/src/Form/NodeRevisionDeleteForm.php, line 20

Namespace

Drupal\node\Form
View source
class NodeRevisionDeleteForm extends ConfirmFormBase {
    
    /**
     * The node revision.
     *
     * @var \Drupal\node\NodeInterface
     */
    protected $revision;
    
    /**
     * The node storage.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $nodeStorage;
    
    /**
     * The node type storage.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $nodeTypeStorage;
    
    /**
     * The access manager.
     *
     * @var \Drupal\Core\Access\AccessManagerInterface
     */
    protected $accessManager;
    
    /**
     * The database connection.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $connection;
    
    /**
     * The date formatter service.
     *
     * @var \Drupal\Core\Datetime\DateFormatterInterface
     */
    protected $dateFormatter;
    
    /**
     * Constructs a new NodeRevisionDeleteForm.
     *
     * @param \Drupal\Core\Entity\EntityStorageInterface $node_storage
     *   The node storage.
     * @param \Drupal\Core\Entity\EntityStorageInterface $node_type_storage
     *   The node type storage.
     * @param \Drupal\Core\Access\AccessManagerInterface|\Drupal\Core\Database\Connection $access_manager
     *   The access manager.
     * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
     *   The date formatter service.
     */
    public function __construct(EntityStorageInterface $node_storage, EntityStorageInterface $node_type_storage, AccessManagerInterface|Connection $access_manager, DateFormatterInterface $date_formatter) {
        $this->nodeStorage = $node_storage;
        $this->nodeTypeStorage = $node_type_storage;
        $this->accessManager = $access_manager;
        $this->dateFormatter = $date_formatter;
        if ($access_manager instanceof Connection) {
            $this->connection = $access_manager;
            $this->accessManager = func_get_arg(3);
            @trigger_error('Calling ' . __CLASS__ . '::_construct() with the $connection argument is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. See https://www.drupal.org/node/3343754', E_USER_DEPRECATED);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        $entity_type_manager = $container->get('entity_type.manager');
        return new static($entity_type_manager->getStorage('node'), $entity_type_manager->getStorage('node_type'), $container->get('access_manager'), $container->get('date.formatter'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'node_revision_delete_confirm';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Are you sure you want to delete 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('Delete');
    }
    
    /**
     * {@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) {
        
        /** @var \Drupal\Core\Entity\RevisionableStorageInterface $storage */
        $storage = $this->nodeStorage;
        $storage->deleteRevision($this->revision
            ->getRevisionId());
        $this->logger('content')
            ->info('@type: deleted %title revision %revision.', [
            '@type' => $this->revision
                ->bundle(),
            '%title' => $this->revision
                ->label(),
            '%revision' => $this->revision
                ->getRevisionId(),
        ]);
        $node_type = $this->nodeTypeStorage
            ->load($this->revision
            ->bundle())
            ->label();
        $this->messenger()
            ->addStatus($this->t('Revision from %revision-date of @type %title has been deleted.', [
            '%revision-date' => $this->dateFormatter
                ->format($this->revision
                ->getRevisionCreationTime()),
            '@type' => $node_type,
            '%title' => $this->revision
                ->label(),
        ]));
        // Set redirect to the revisions history page.
        $route_name = 'entity.node.version_history';
        $parameters = [
            'node' => $this->revision
                ->id(),
        ];
        // If no revisions found, or the user does not have access to the revisions
        // page, then redirect to the canonical node page instead.
        if (!$this->accessManager
            ->checkNamedRoute($route_name, $parameters) || count($this->nodeStorage
            ->revisionIds($this->revision)) === 1) {
            $route_name = 'entity.node.canonical';
        }
        $form_state->setRedirect($route_name, $parameters);
    }

}

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::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 17
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.
NodeRevisionDeleteForm::$accessManager protected property The access manager.
NodeRevisionDeleteForm::$connection protected property The database connection.
NodeRevisionDeleteForm::$dateFormatter protected property The date formatter service.
NodeRevisionDeleteForm::$nodeStorage protected property The node storage.
NodeRevisionDeleteForm::$nodeTypeStorage protected property The node type storage.
NodeRevisionDeleteForm::$revision protected property The node revision.
NodeRevisionDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
NodeRevisionDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
NodeRevisionDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
NodeRevisionDeleteForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
NodeRevisionDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
NodeRevisionDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
NodeRevisionDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
NodeRevisionDeleteForm::__construct public function Constructs a new NodeRevisionDeleteForm.
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.