class LayoutRebuildConfirmFormBase

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

Provides a base class for confirmation forms that rebuild the Layout Builder.

@internal Form classes are internal.

Hierarchy

Expanded class hierarchy of LayoutRebuildConfirmFormBase

File

core/modules/layout_builder/src/Form/LayoutRebuildConfirmFormBase.php, line 20

Namespace

Drupal\layout_builder\Form
View source
abstract class LayoutRebuildConfirmFormBase extends ConfirmFormBase {
    use AjaxFormHelperTrait;
    use LayoutBuilderHighlightTrait;
    use LayoutRebuildTrait;
    
    /**
     * The layout tempstore repository.
     *
     * @var \Drupal\layout_builder\LayoutTempstoreRepositoryInterface
     */
    protected $layoutTempstoreRepository;
    
    /**
     * The section storage.
     *
     * @var \Drupal\layout_builder\SectionStorageInterface
     */
    protected $sectionStorage;
    
    /**
     * The field delta.
     *
     * @var int
     */
    protected $delta;
    
    /**
     * Constructs a new RemoveSectionForm.
     *
     * @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository
     *   The layout tempstore repository.
     */
    public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository) {
        $this->layoutTempstoreRepository = $layout_tempstore_repository;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('layout_builder.tempstore_repository'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return $this->sectionStorage
            ->getLayoutBuilderUrl();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL) {
        $this->sectionStorage = $section_storage;
        $this->delta = $delta;
        $form = parent::buildForm($form, $form_state);
        if ($this->isAjax()) {
            $form['actions']['submit']['#ajax']['callback'] = '::ajaxSubmit';
            $form['actions']['cancel']['#attributes']['class'][] = 'dialog-cancel';
            $target_highlight_id = !empty($this->uuid) ? $this->blockUpdateHighlightId($this->uuid) : $this->sectionUpdateHighlightId($delta);
            $form['#attributes']['data-layout-builder-target-highlight-id'] = $target_highlight_id;
        }
        // Mark this as an administrative page for JavaScript ("Back to site" link).
        $form['#attached']['drupalSettings']['path']['currentPathIsAdmin'] = TRUE;
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $this->handleSectionStorage($this->sectionStorage, $form_state);
        $this->layoutTempstoreRepository
            ->set($this->sectionStorage);
        $form_state->setRedirectUrl($this->getCancelUrl());
    }
    
    /**
     * {@inheritdoc}
     */
    protected function successfulAjaxSubmit(array $form, FormStateInterface $form_state) {
        return $this->rebuildAndClose($this->sectionStorage);
    }
    
    /**
     * Performs any actions on the section storage before saving.
     *
     * @param \Drupal\layout_builder\SectionStorageInterface $section_storage
     *   The section storage.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     */
    protected abstract function handleSectionStorage(SectionStorageInterface $section_storage, FormStateInterface $form_state);

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AjaxFormHelperTrait::ajaxSubmit public function Submit form dialog #ajax callback.
AjaxHelperTrait::getRequestWrapperFormat protected function Gets the wrapper format of the current request.
AjaxHelperTrait::isAjax protected function Determines if the current request is via AJAX.
ConfirmFormBase::getCancelText public function Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getConfirmText public function Overrides ConfirmFormInterface::getConfirmText 22
ConfirmFormBase::getDescription public function Overrides ConfirmFormInterface::getDescription 15
ConfirmFormBase::getFormName public function Overrides ConfirmFormInterface::getFormName
ConfirmFormInterface::getQuestion public function Returns the question to ask the user. 39
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
FormInterface::getFormId public function Returns a unique string identifying the form. 270
LayoutBuilderHighlightTrait::blockAddHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::blockUpdateHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::sectionAddHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::sectionUpdateHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutRebuildConfirmFormBase::$delta protected property The field delta.
LayoutRebuildConfirmFormBase::$layoutTempstoreRepository protected property The layout tempstore repository.
LayoutRebuildConfirmFormBase::$sectionStorage protected property The section storage.
LayoutRebuildConfirmFormBase::buildForm public function Overrides ConfirmFormBase::buildForm 1
LayoutRebuildConfirmFormBase::create public static function Overrides FormBase::create
LayoutRebuildConfirmFormBase::getCancelUrl public function Overrides ConfirmFormInterface::getCancelUrl
LayoutRebuildConfirmFormBase::handleSectionStorage abstract protected function Performs any actions on the section storage before saving. 2
LayoutRebuildConfirmFormBase::submitForm public function Overrides FormInterface::submitForm
LayoutRebuildConfirmFormBase::successfulAjaxSubmit protected function Overrides AjaxFormHelperTrait::successfulAjaxSubmit
LayoutRebuildConfirmFormBase::__construct public function Constructs a new RemoveSectionForm.
LayoutRebuildTrait::rebuildAndClose protected function Rebuilds the layout.
LayoutRebuildTrait::rebuildLayout protected function Rebuilds the layout.
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.
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. 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.