class RemoveBlockForm

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

Provides a form to confirm the removal of a block.

@internal Form classes are internal.

Hierarchy

Expanded class hierarchy of RemoveBlockForm

1 string reference to 'RemoveBlockForm'
layout_builder.routing.yml in core/modules/layout_builder/layout_builder.routing.yml
core/modules/layout_builder/layout_builder.routing.yml

File

core/modules/layout_builder/src/Form/RemoveBlockForm.php, line 14

Namespace

Drupal\layout_builder\Form
View source
class RemoveBlockForm extends LayoutRebuildConfirmFormBase {
    
    /**
     * The current region.
     *
     * @var string
     */
    protected $region;
    
    /**
     * The UUID of the block being removed.
     *
     * @var string
     */
    protected $uuid;
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        $label = $this->sectionStorage
            ->getSection($this->delta)
            ->getComponent($this->uuid)
            ->getPlugin()
            ->label();
        return $this->t('Are you sure you want to remove the %label block?', [
            '%label' => $label,
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Remove');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'layout_builder_remove_block';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?SectionStorageInterface $section_storage = NULL, $delta = NULL, $region = NULL, $uuid = NULL) {
        $this->region = $region;
        $this->uuid = $uuid;
        return parent::buildForm($form, $form_state, $section_storage, $delta);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function handleSectionStorage(SectionStorageInterface $section_storage, FormStateInterface $form_state) {
        $section_storage->getSection($this->delta)
            ->removeComponent($this->uuid);
    }

}

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 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. 2
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. 2
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
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::create public static function Instantiates a new instance of this class. Overrides FormBase::create
LayoutRebuildConfirmFormBase::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
LayoutRebuildConfirmFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
LayoutRebuildConfirmFormBase::successfulAjaxSubmit protected function Allows the form to respond to a successful AJAX submission. 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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
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.
RemoveBlockForm::$region protected property The current region.
RemoveBlockForm::$uuid protected property The UUID of the block being removed.
RemoveBlockForm::buildForm public function Form constructor. Overrides LayoutRebuildConfirmFormBase::buildForm
RemoveBlockForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
RemoveBlockForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RemoveBlockForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
RemoveBlockForm::handleSectionStorage protected function Performs any actions on the section storage before saving. Overrides LayoutRebuildConfirmFormBase::handleSectionStorage
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.
WorkspaceSafeFormTrait::$workspaceInfo protected property The workspace information service.
WorkspaceSafeFormTrait::getSectionStorageFromFormState protected function Retrieves the section storage from a form state object, if it exists.
WorkspaceSafeFormTrait::getWorkspaceInfo protected function Retrieves the workspace information service.
WorkspaceSafeFormTrait::isWorkspaceSafeEntity protected function Determines whether an entity used in a form is workspace-safe.
WorkspaceSafeFormTrait::isWorkspaceSafeEntityType protected function Determines whether an entity type used in a form is workspace-safe.
WorkspaceSafeFormTrait::isWorkspaceSafeForm public function Determines whether the current form is safe to be submitted in a workspace.

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