class LayoutBuilderForm in Page Manager 8.4
Provides a form containing the Layout Builder UI for Page Manager.
@todo Refactor this after https://www.drupal.org/node/3035189 is resolved.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\page_manager\Form\LayoutBuilderForm uses PreviewToggleTrait
Expanded class hierarchy of LayoutBuilderForm
2 files declare their use of LayoutBuilderForm
- LayoutBuilderDisplayVariant.php in src/
Plugin/ DisplayVariant/ LayoutBuilderDisplayVariant.php - page_manager.module in ./
page_manager.module - Provides a way to place blocks on a custom page.
File
- src/
Form/ LayoutBuilderForm.php, line 19
Namespace
Drupal\page_manager\FormView source
class LayoutBuilderForm extends FormBase {
use PreviewToggleTrait;
/**
* Layout tempstore repository.
*
* @var \Drupal\layout_builder\LayoutTempstoreRepositoryInterface
*/
protected $layoutTempstoreRepository;
/**
* The Section Storage Manager.
*
* @var \Drupal\layout_builder\SectionStorage\SectionStorageManager
*/
protected $sectionStorageManager;
/**
* The section storage.
*
* @var \Drupal\layout_builder\SectionStorageInterface
*/
protected $sectionStorage;
/**
* The tempstore directory.
*
* @var \Drupal\Core\TempStore\SharedTempStoreFactory
*/
protected $tempstore;
/**
* Constructs a new LayoutBuilderForm.
*
* @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository
* The layout tempstore repository.
* @param \Drupal\layout_builder\SectionStorage\SectionStorageManager $section_storage_manager
* The section storage manager.
* @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
* The tempstore factory.
*/
public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository, SectionStorageManager $section_storage_manager, SharedTempStoreFactory $tempstore) {
$this->layoutTempstoreRepository = $layout_tempstore_repository;
$this->sectionStorageManager = $section_storage_manager;
$this->tempstore = $tempstore;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('layout_builder.tempstore_repository'), $container
->get('plugin.manager.layout_builder.section_storage'), $container
->get('tempstore.shared'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'page_manager_layout_builder_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$cached_values = $form_state
->getTemporaryValue('wizard');
/** @var \Drupal\page_manager\PageVariantInterface $page_variant */
$page_variant = $cached_values['page_variant'];
// If this is a new variant, put it in the tempstore so that we can
// retrieve it by id later.
// @see \Drupal\page_manager\Plugin\SectionStorage\PageManagerSectionStorage::deriveContextsFromRoute.
if ($page_variant
->isNew()) {
$this->tempstore
->get('page_manager.layout_builder')
->set($page_variant
->id(), $page_variant);
}
$section_storage = $this->sectionStorageManager
->load('page_manager', [
'entity' => EntityContext::fromEntity($page_variant),
]);
$this->sectionStorage = $this->layoutTempstoreRepository
->get($section_storage);
$form['preview_toggle'] = $this
->buildContentPreviewToggle();
$form['layout_builder'] = [
'#type' => 'layout_builder',
'#section_storage' => $this->sectionStorage,
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$cached_values = $form_state
->getTemporaryValue('wizard');
/** @var \Drupal\page_manager\Entity\PageVariant $page_variant */
$page_variant = $this->sectionStorage
->getContextValue('entity');
// Pass down the variant settings and let the plugin handle saving it.
/** @var \Drupal\page_manager\Plugin\DisplayVariant\LayoutBuilderDisplayVariant $variant_plugin */
$variant_plugin = $cached_values['plugin'];
$variant_plugin
->setConfiguration($page_variant
->get('variant_settings'));
// The form wizard takes care of saving the variant.
// Clear the layout tempstore.
$this->layoutTempstoreRepository
->delete($this->sectionStorage);
$this
->messenger()
->addMessage($this
->t('The layout has been saved.'));
// Clean up the tempstore.
$this->tempstore
->get('page_manager.layout_builder')
->delete($page_variant
->id());
$this->tempstore
->get('page_manager.page_variant')
->delete($page_variant
->id());
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LayoutBuilderForm:: |
protected | property | Layout tempstore repository. | |
LayoutBuilderForm:: |
protected | property | The section storage. | |
LayoutBuilderForm:: |
protected | property | The Section Storage Manager. | |
LayoutBuilderForm:: |
protected | property | The tempstore directory. | |
LayoutBuilderForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
LayoutBuilderForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
LayoutBuilderForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
LayoutBuilderForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
LayoutBuilderForm:: |
public | function | Constructs a new LayoutBuilderForm. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PreviewToggleTrait:: |
protected | function | Builds the content preview toggle input. | |
PreviewToggleTrait:: |
abstract protected | function | Gets the current user. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |