class RevertOverridesForm

Same name in other branches
  1. 8.9.x core/modules/layout_builder/src/Form/RevertOverridesForm.php \Drupal\layout_builder\Form\RevertOverridesForm
  2. 10 core/modules/layout_builder/src/Form/RevertOverridesForm.php \Drupal\layout_builder\Form\RevertOverridesForm
  3. 11.x core/modules/layout_builder/src/Form/RevertOverridesForm.php \Drupal\layout_builder\Form\RevertOverridesForm

Reverts the overridden layout to the defaults.

@internal Form classes are internal.

Hierarchy

Expanded class hierarchy of RevertOverridesForm

File

core/modules/layout_builder/src/Form/RevertOverridesForm.php, line 19

Namespace

Drupal\layout_builder\Form
View source
class RevertOverridesForm extends ConfirmFormBase {
    
    /**
     * The layout tempstore repository.
     *
     * @var \Drupal\layout_builder\LayoutTempstoreRepositoryInterface
     */
    protected $layoutTempstoreRepository;
    
    /**
     * The messenger service.
     *
     * @var \Drupal\Core\Messenger\MessengerInterface
     */
    protected $messenger;
    
    /**
     * The section storage.
     *
     * @var \Drupal\layout_builder\SectionStorageInterface
     */
    protected $sectionStorage;
    
    /**
     * Constructs a new RevertOverridesForm.
     *
     * @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository
     *   The layout tempstore repository.
     * @param \Drupal\Core\Messenger\MessengerInterface $messenger
     *   The messenger service.
     */
    public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository, MessengerInterface $messenger) {
        $this->layoutTempstoreRepository = $layout_tempstore_repository;
        $this->messenger = $messenger;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('layout_builder.tempstore_repository'), $container->get('messenger'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'layout_builder_revert_overrides';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Are you sure you want to revert this to defaults?');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Revert');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return $this->sectionStorage
            ->getLayoutBuilderUrl();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL) {
        if (!$section_storage instanceof OverridesSectionStorageInterface) {
            throw new \InvalidArgumentException(sprintf('The section storage with type "%s" and ID "%s" does not provide overrides', $section_storage->getStorageType(), $section_storage->getStorageId()));
        }
        $this->sectionStorage = $section_storage;
        // Mark this as an administrative page for JavaScript ("Back to site" link).
        $form['#attached']['drupalSettings']['path']['currentPathIsAdmin'] = TRUE;
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        // Remove all sections.
        $this->sectionStorage
            ->removeAllSections()
            ->save();
        $this->layoutTempstoreRepository
            ->delete($this->sectionStorage);
        $this->messenger
            ->addMessage($this->t('The layout has been reverted back to defaults.'));
        $form_state->setRedirectUrl($this->sectionStorage
            ->getRedirectUrl());
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfirmFormBase::getCancelText public function Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getDescription public function Overrides ConfirmFormInterface::getDescription 15
ConfirmFormBase::getFormName public function 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.
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 Overrides FormInterface::validateForm 73
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 public function Gets the messenger. 17
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.
RevertOverridesForm::$layoutTempstoreRepository protected property The layout tempstore repository.
RevertOverridesForm::$messenger protected property The messenger service. Overrides MessengerTrait::$messenger
RevertOverridesForm::$sectionStorage protected property The section storage.
RevertOverridesForm::buildForm public function Overrides ConfirmFormBase::buildForm
RevertOverridesForm::create public static function Overrides FormBase::create
RevertOverridesForm::getCancelUrl public function Overrides ConfirmFormInterface::getCancelUrl
RevertOverridesForm::getConfirmText public function Overrides ConfirmFormBase::getConfirmText
RevertOverridesForm::getFormId public function Overrides FormInterface::getFormId
RevertOverridesForm::getQuestion public function Overrides ConfirmFormInterface::getQuestion
RevertOverridesForm::submitForm public function Overrides FormInterface::submitForm
RevertOverridesForm::__construct public function Constructs a new RevertOverridesForm.
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.