class RemoveSectionForm in Drupal 9

Provides a form to confirm the removal of a section.

@internal Form classes are internal.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
    • class \Drupal\layout_builder\Form\LayoutRebuildConfirmFormBase uses AjaxFormHelperTrait, LayoutRebuildTrait, LayoutBuilderHighlightTrait
      • class \Drupal\layout_builder\Form\RemoveSectionForm

1 string reference to 'RemoveSectionForm'

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/RemoveSectionForm.php, line 14

Namespace

Drupal\layout_builder\Form

class RemoveSectionForm extends LayoutRebuildConfirmFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'layout_builder_remove_section';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    $configuration = $this->sectionStorage
      ->getSection($this->delta)
      ->getLayoutSettings();

    // Layouts may choose to use a class that might not have a label
    // configuration.
    if (!empty($configuration['label'])) {
      return $this
        ->t('Are you sure you want to remove @section?', [
        '@section' => $configuration['label'],
      ]);
    }
    return $this
      ->t('Are you sure you want to remove section @section?', [
      '@section' => $this->delta + 1,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Remove');
  }

  /**
   * {@inheritdoc}
   */
  protected function handleSectionStorage(SectionStorageInterface $section_storage, FormStateInterface $form_state) {
    $section_storage
      ->removeSection($this->delta);
  }

}

Members

Name	Modifiers	Type	Description	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	14
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		2
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	Form validation handler. Overrides FormInterface::validateForm	72
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	Form constructor. Overrides ConfirmFormBase::buildForm	1
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.
RemoveSectionForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
RemoveSectionForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
RemoveSectionForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
RemoveSectionForm::handleSectionStorage	protected	function	Performs any actions on the section storage before saving. Overrides LayoutRebuildConfirmFormBase::handleSectionStorage
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.