class NodeRevisionRevertTranslationForm

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

Provides a form for reverting a node revision for a single translation.

@internal

Hierarchy

Expanded class hierarchy of NodeRevisionRevertTranslationForm

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

File

core/modules/node/src/Form/NodeRevisionRevertTranslationForm.php, line 18

Namespace

Drupal\node\Form
View source
class NodeRevisionRevertTranslationForm extends NodeRevisionRevertForm {
    
    /**
     * The language to be reverted.
     *
     * @var string
     */
    protected $langcode;
    
    /**
     * The language manager.
     *
     * @var \Drupal\Core\Language\LanguageManagerInterface
     */
    protected $languageManager;
    
    /**
     * Constructs a new NodeRevisionRevertTranslationForm.
     *
     * @param \Drupal\Core\Entity\EntityStorageInterface $node_storage
     *   The node storage.
     * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
     *   The date formatter service.
     * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
     *   The language manager.
     * @param \Drupal\Component\Datetime\TimeInterface $time
     *   The time service.
     */
    public function __construct(EntityStorageInterface $node_storage, DateFormatterInterface $date_formatter, LanguageManagerInterface $language_manager, TimeInterface $time) {
        parent::__construct($node_storage, $date_formatter, $time);
        $this->languageManager = $language_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.manager')
            ->getStorage('node'), $container->get('date.formatter'), $container->get('language_manager'), $container->get('datetime.time'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'node_revision_revert_translation_confirm';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return t('Are you sure you want to revert @language translation to the revision from %revision-date?', [
            '@language' => $this->languageManager
                ->getLanguageName($this->langcode),
            '%revision-date' => $this->dateFormatter
                ->format($this->revision
                ->getRevisionCreationTime()),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, $node_revision = NULL, $langcode = NULL) {
        $this->langcode = $langcode;
        $form = parent::buildForm($form, $form_state, $node_revision);
        // Unless untranslatable fields are configured to affect only the default
        // translation, we need to ask the user whether they should be included in
        // the revert process.
        $default_translation_affected = $this->revision
            ->isDefaultTranslationAffectedOnly();
        $form['revert_untranslated_fields'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Revert content shared among translations'),
            '#default_value' => $default_translation_affected && $this->revision
                ->getTranslation($this->langcode)
                ->isDefaultTranslation(),
            '#access' => !$default_translation_affected,
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function prepareRevertedRevision(NodeInterface $revision, FormStateInterface $form_state) {
        $revert_untranslated_fields = (bool) $form_state->getValue('revert_untranslated_fields');
        $translation = $revision->getTranslation($this->langcode);
        return $this->nodeStorage
            ->createRevision($translation, TRUE, $revert_untranslated_fields);
    }

}

Members

Title Sort descending Deprecated 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 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. 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. 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 73
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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::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::submitForm public function Form submission handler. Overrides FormInterface::submitForm
NodeRevisionRevertTranslationForm::$langcode protected property The language to be reverted.
NodeRevisionRevertTranslationForm::$languageManager protected property The language manager.
NodeRevisionRevertTranslationForm::buildForm public function Form constructor. Overrides NodeRevisionRevertForm::buildForm
NodeRevisionRevertTranslationForm::create public static function Instantiates a new instance of this class. Overrides NodeRevisionRevertForm::create
NodeRevisionRevertTranslationForm::getDescription public function Returns additional text to display as a description. Overrides NodeRevisionRevertForm::getDescription
NodeRevisionRevertTranslationForm::getFormId public function Returns a unique string identifying the form. Overrides NodeRevisionRevertForm::getFormId
NodeRevisionRevertTranslationForm::getQuestion public function Returns the question to ask the user. Overrides NodeRevisionRevertForm::getQuestion
NodeRevisionRevertTranslationForm::prepareRevertedRevision protected function Prepares a revision to be reverted. Overrides NodeRevisionRevertForm::prepareRevertedRevision
NodeRevisionRevertTranslationForm::__construct public function Constructs a new NodeRevisionRevertTranslationForm. Overrides NodeRevisionRevertForm::__construct
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.
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.

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