class DiscardLayoutChangesForm

Same name and namespace in other branches
  1. 11.x core/modules/layout_builder/src/Form/DiscardLayoutChangesForm.php \Drupal\layout_builder\Form\DiscardLayoutChangesForm
  2. 10 core/modules/layout_builder/src/Form/DiscardLayoutChangesForm.php \Drupal\layout_builder\Form\DiscardLayoutChangesForm
  3. 9 core/modules/layout_builder/src/Form/DiscardLayoutChangesForm.php \Drupal\layout_builder\Form\DiscardLayoutChangesForm
  4. 8.9.x core/modules/layout_builder/src/Form/DiscardLayoutChangesForm.php \Drupal\layout_builder\Form\DiscardLayoutChangesForm

Discards any pending changes to the layout.

@internal Form classes are internal.

Hierarchy

Expanded class hierarchy of DiscardLayoutChangesForm

File

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

Namespace

Drupal\layout_builder\Form
View source
class DiscardLayoutChangesForm extends ConfirmFormBase implements WorkspaceDynamicSafeFormInterface {
  use WorkspaceSafeFormTrait;
  
  /**
   * 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 DiscardLayoutChangesForm.
   *
   * @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_discard_changes';
  }
  
  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this->t('Discard unsaved changes');
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    try {
      $entity = $this->sectionStorage
        ->getContextValue('entity');
      return $this->t('Any unsaved changes to the layout for %label will be discarded. This action cannot be undone.', [
        '%label' => $entity->label(),
      ]);
    } catch (ContextException) {
      // If the entity is not available, just return a generic message.
      return $this->t('Any unsaved changes to the layout will be discarded. This action cannot be undone.');
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return $this->sectionStorage
      ->getLayoutBuilderUrl();
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, ?SectionStorageInterface $section_storage = NULL) {
    $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) {
    $this->layoutTempstoreRepository
      ->delete($this->sectionStorage);
    $this->messenger
      ->addMessage($this->t('The changes to the layout have been discarded.'));
    $form_state->setRedirectUrl($this->sectionStorage
      ->getRedirectUrl());
  }

}

Members

Title Sort descending 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::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText 23
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 2
DependencySerializationTrait::__wakeup public function 2
DiscardLayoutChangesForm::$layoutTempstoreRepository protected property The layout tempstore repository.
DiscardLayoutChangesForm::$messenger protected property The messenger service. Overrides MessengerTrait::$messenger
DiscardLayoutChangesForm::$sectionStorage protected property The section storage.
DiscardLayoutChangesForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
DiscardLayoutChangesForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
DiscardLayoutChangesForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
DiscardLayoutChangesForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
DiscardLayoutChangesForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DiscardLayoutChangesForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
DiscardLayoutChangesForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DiscardLayoutChangesForm::__construct public function Constructs a new DiscardLayoutChangesForm.
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. Overrides HtmxRequestInfoTrait::getRequest
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 54
HtmxRequestInfoTrait::getHtmxCurrentUrl protected function Retrieves the URL of the requesting page from an HTMX request header.
HtmxRequestInfoTrait::getHtmxPrompt protected function Retrieves the prompt from an HTMX request header.
HtmxRequestInfoTrait::getHtmxTarget protected function Retrieves the target identifier from an HTMX request header.
HtmxRequestInfoTrait::getHtmxTrigger protected function Retrieves the trigger identifier from an HTMX request header.
HtmxRequestInfoTrait::getHtmxTriggerName protected function Retrieves the trigger name from an HTMX request header.
HtmxRequestInfoTrait::isHtmxBoosted protected function Determines if the request is boosted by HTMX.
HtmxRequestInfoTrait::isHtmxHistoryRestoration protected function Determines if if the request is for history restoration.
HtmxRequestInfoTrait::isHtmxRequest protected function Determines if the request is sent by HTMX.
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. 25
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.
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. 1
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.