class ConfigureSectionForm
Same name in other branches
- 9 core/modules/layout_builder/src/Form/ConfigureSectionForm.php \Drupal\layout_builder\Form\ConfigureSectionForm
- 10 core/modules/layout_builder/src/Form/ConfigureSectionForm.php \Drupal\layout_builder\Form\ConfigureSectionForm
- 11.x core/modules/layout_builder/src/Form/ConfigureSectionForm.php \Drupal\layout_builder\Form\ConfigureSectionForm
Provides a form for configuring a layout section.
@internal Form classes are internal.
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Routing\LinkGeneratorTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\Routing\UrlGeneratorTrait
- class \Drupal\layout_builder\Form\ConfigureSectionForm extends \Drupal\Core\Form\FormBase uses \Drupal\Core\Ajax\AjaxFormHelperTrait, \Drupal\layout_builder\LayoutBuilderHighlightTrait, \Drupal\layout_builder\Controller\LayoutRebuildTrait
Expanded class hierarchy of ConfigureSectionForm
1 string reference to 'ConfigureSectionForm'
- 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/ ConfigureSectionForm.php, line 26
Namespace
Drupal\layout_builder\FormView source
class ConfigureSectionForm extends FormBase {
use AjaxFormHelperTrait;
use LayoutBuilderHighlightTrait;
use LayoutRebuildTrait;
/**
* The layout tempstore repository.
*
* @var \Drupal\layout_builder\LayoutTempstoreRepositoryInterface
*/
protected $layoutTempstoreRepository;
/**
* The plugin being configured.
*
* @var \Drupal\Core\Layout\LayoutInterface|\Drupal\Core\Plugin\PluginFormInterface
*/
protected $layout;
/**
* The plugin form manager.
*
* @var \Drupal\Core\Plugin\PluginFormFactoryInterface
*/
protected $pluginFormFactory;
/**
* The section storage.
*
* @var \Drupal\layout_builder\SectionStorageInterface
*/
protected $sectionStorage;
/**
* The field delta.
*
* @var int
*/
protected $delta;
/**
* Indicates whether the section is being added or updated.
*
* @var bool
*/
protected $isUpdate;
/**
* Constructs a new ConfigureSectionForm.
*
* @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository
* The layout tempstore repository.
* @param \Drupal\Core\Plugin\PluginFormFactoryInterface $plugin_form_manager
* The plugin form manager.
*/
public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository, PluginFormFactoryInterface $plugin_form_manager) {
$this->layoutTempstoreRepository = $layout_tempstore_repository;
$this->pluginFormFactory = $plugin_form_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('layout_builder.tempstore_repository'), $container->get('plugin_form.factory'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'layout_builder_configure_section';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL, $plugin_id = NULL) {
$this->sectionStorage = $section_storage;
$this->delta = $delta;
$this->isUpdate = is_null($plugin_id);
if ($this->isUpdate) {
$section = $this->sectionStorage
->getSection($this->delta);
if ($label = $section->getLayoutSettings()['label']) {
$form['#title'] = $this->t('Configure @section', [
'@section' => $label,
]);
}
}
else {
$section = new Section($plugin_id);
}
$this->layout = $section->getLayout();
$form['#tree'] = TRUE;
$form['layout_settings'] = [];
$subform_state = SubformState::createForSubform($form['layout_settings'], $form, $form_state);
$form['layout_settings'] = $this->getPluginForm($this->layout)
->buildConfigurationForm($form['layout_settings'], $subform_state);
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->isUpdate ? $this->t('Update') : $this->t('Add section'),
'#button_type' => 'primary',
];
if ($this->isAjax()) {
$form['actions']['submit']['#ajax']['callback'] = '::ajaxSubmit';
}
$target_highlight_id = $this->isUpdate ? $this->sectionUpdateHighlightId($delta) : $this->sectionAddHighlightId($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 validateForm(array &$form, FormStateInterface $form_state) {
$subform_state = SubformState::createForSubform($form['layout_settings'], $form, $form_state);
$this->getPluginForm($this->layout)
->validateConfigurationForm($form['layout_settings'], $subform_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Call the plugin submit handler.
$subform_state = SubformState::createForSubform($form['layout_settings'], $form, $form_state);
$this->getPluginForm($this->layout)
->submitConfigurationForm($form['layout_settings'], $subform_state);
$plugin_id = $this->layout
->getPluginId();
$configuration = $this->layout
->getConfiguration();
if ($this->isUpdate) {
$this->sectionStorage
->getSection($this->delta)
->setLayoutSettings($configuration);
}
else {
$this->sectionStorage
->insertSection($this->delta, new Section($plugin_id, $configuration));
}
$this->layoutTempstoreRepository
->set($this->sectionStorage);
$form_state->setRedirectUrl($this->sectionStorage
->getLayoutBuilderUrl());
}
/**
* {@inheritdoc}
*/
protected function successfulAjaxSubmit(array $form, FormStateInterface $form_state) {
return $this->rebuildAndClose($this->sectionStorage);
}
/**
* Retrieves the plugin form for a given layout.
*
* @param \Drupal\Core\Layout\LayoutInterface $layout
* The layout plugin.
*
* @return \Drupal\Core\Plugin\PluginFormInterface
* The plugin form for the layout.
*/
protected function getPluginForm(LayoutInterface $layout) {
if ($layout instanceof PluginWithFormsInterface) {
return $this->pluginFormFactory
->createInstance($layout, 'configure');
}
if ($layout instanceof PluginFormInterface) {
return $layout;
}
throw new \InvalidArgumentException(sprintf('The "%s" layout does not provide a configuration form', $layout->getPluginId()));
}
/**
* Retrieve the section storage property.
*
* @return \Drupal\layout_builder\SectionStorageInterface
* The section storage for the current form.
*/
public function getSectionStorage() {
return $this->sectionStorage;
}
}
Members
Title Sort descending | Deprecated | 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. | |||
ConfigureSectionForm::$delta | protected | property | The field delta. | |||
ConfigureSectionForm::$isUpdate | protected | property | Indicates whether the section is being added or updated. | |||
ConfigureSectionForm::$layout | protected | property | The plugin being configured. | |||
ConfigureSectionForm::$layoutTempstoreRepository | protected | property | The layout tempstore repository. | |||
ConfigureSectionForm::$pluginFormFactory | protected | property | The plugin form manager. | |||
ConfigureSectionForm::$sectionStorage | protected | property | The section storage. | |||
ConfigureSectionForm::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | ||
ConfigureSectionForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | ||
ConfigureSectionForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | ||
ConfigureSectionForm::getPluginForm | protected | function | Retrieves the plugin form for a given layout. | |||
ConfigureSectionForm::getSectionStorage | public | function | Retrieve the section storage property. | |||
ConfigureSectionForm::submitForm | public | function | Form submission handler. | Overrides FormInterface::submitForm | ||
ConfigureSectionForm::successfulAjaxSubmit | protected | function | Allows the form to respond to a successful AJAX submission. | Overrides AjaxFormHelperTrait::successfulAjaxSubmit | ||
ConfigureSectionForm::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm | ||
ConfigureSectionForm::__construct | public | function | Constructs a new ConfigureSectionForm. | |||
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 | 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. | Overrides UrlGeneratorTrait::redirect | ||
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. | |||
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. | |||
LayoutRebuildTrait::rebuildAndClose | protected | function | Rebuilds the layout. | |||
LayoutRebuildTrait::rebuildLayout | protected | function | Rebuilds the layout. | |||
LinkGeneratorTrait::$linkGenerator | protected | property | The link generator. | 1 | ||
LinkGeneratorTrait::getLinkGenerator | Deprecated | protected | function | Returns the link generator. | ||
LinkGeneratorTrait::l | Deprecated | protected | function | Renders a link to a route given a route name and its parameters. | ||
LinkGeneratorTrait::setLinkGenerator | Deprecated | public | function | Sets the link generator service. | ||
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. | |||
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. | |||
UrlGeneratorTrait::$urlGenerator | protected | property | The url generator. | |||
UrlGeneratorTrait::getUrlGenerator | Deprecated | protected | function | Returns the URL generator service. | ||
UrlGeneratorTrait::setUrlGenerator | Deprecated | public | function | Sets the URL generator service. | ||
UrlGeneratorTrait::url | Deprecated | protected | function | Generates a URL or path for a specific route based on the given parameters. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.