abstract class PanelsBlockConfigureFormBase in Panels 8.3
Same name and namespace in other branches
- 8.4 src/Form/PanelsBlockConfigureFormBase.php \Drupal\panels\Form\PanelsBlockConfigureFormBase
Provides a base form for configuring a block as part of a variant.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\panels\Form\PanelsBlockConfigureFormBase uses ContextAwarePluginAssignmentTrait, CachedValuesGetterTrait
Expanded class hierarchy of PanelsBlockConfigureFormBase
File
- src/
Form/ PanelsBlockConfigureFormBase.php, line 21
Namespace
Drupal\panels\FormView source
abstract class PanelsBlockConfigureFormBase extends FormBase {
use ContextAwarePluginAssignmentTrait;
use CachedValuesGetterTrait;
/**
* Tempstore factory.
*
* @var \Drupal\user\SharedTempStoreFactory
*/
protected $tempstore;
/**
* The tempstore id.
*
* @var string
*/
protected $tempstore_id;
/**
* The variant plugin.
*
* @var \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant
*/
protected $variantPlugin;
/**
* The plugin being configured.
*
* @var \Drupal\Core\Block\BlockPluginInterface
*/
protected $block;
/**
* Constructs a new VariantPluginConfigureBlockFormBase.
*
* @param \Drupal\user\SharedTempStoreFactory $tempstore
* The tempstore factory.
*/
public function __construct(SharedTempStoreFactory $tempstore) {
$this->tempstore = $tempstore;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('user.shared_tempstore'));
}
/**
* Get the tempstore id.
*
* @return string
*/
protected function getTempstoreId() {
return $this->tempstore_id;
}
/**
* Get the tempstore.
*
* @return \Drupal\user\SharedTempStore
*/
protected function getTempstore() {
return $this->tempstore
->get($this
->getTempstoreId());
}
/**
* Prepares the block plugin based on the block ID.
*
* @param string $block_id
* Either a block ID, or the plugin ID used to create a new block.
*
* @return \Drupal\Core\Block\BlockPluginInterface
* The block plugin.
*/
protected abstract function prepareBlock($block_id);
/**
* Returns the text to use for the submit button.
*
* @return string
* The submit button text.
*/
protected abstract function submitText();
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, $tempstore_id = NULL, $machine_name = NULL, $block_id = NULL) {
$this->tempstore_id = $tempstore_id;
$cached_values = $this
->getCachedValues($this->tempstore, $tempstore_id, $machine_name);
$this->variantPlugin = $cached_values['plugin'];
$contexts = $this->variantPlugin
->getPattern()
->getDefaultContexts($this->tempstore, $this
->getTempstoreId(), $machine_name);
$this->variantPlugin
->setContexts($contexts);
$form_state
->setTemporaryValue('gathered_contexts', $contexts);
$this->block = $this
->prepareBlock($block_id);
$form_state
->set('machine_name', $machine_name);
$form_state
->set('block_id', $this->block
->getConfiguration()['uuid']);
// Some Block Plugins rely on the block_theme value to load theme settings.
// @see \Drupal\system\Plugin\Block\SystemBrandingBlock::blockForm().
$form_state
->set('block_theme', $this
->config('system.theme')
->get('default'));
$form['#tree'] = TRUE;
$form['settings'] = $this->block
->buildConfigurationForm([], $form_state);
$form['settings']['id'] = [
'#type' => 'value',
'#value' => $this->block
->getPluginId(),
];
$form['region'] = [
'#title' => $this
->t('Region'),
'#type' => 'select',
'#options' => $this->variantPlugin
->getRegionNames(),
'#default_value' => $this->variantPlugin
->getRegionAssignment($this->block
->getConfiguration()['uuid']),
'#required' => TRUE,
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->submitText(),
'#button_type' => 'primary',
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
// The page might have been serialized, resulting in a new variant
// collection. Refresh the block object.
$this->block = $this
->getVariantPlugin()
->getBlock($form_state
->get('block_id'));
$settings = (new FormState())
->setValues($form_state
->getValue('settings'));
// Call the plugin validate handler.
$this->block
->validateConfigurationForm($form, $settings);
// Update the original form values.
$form_state
->setValue('settings', $settings
->getValues());
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$settings = (new FormState())
->setValues($form_state
->getValue('settings'));
// Call the plugin submit handler.
$this->block
->submitConfigurationForm($form, $settings);
// Update the original form values.
$form_state
->setValue('settings', $settings
->getValues());
if ($this->block instanceof ContextAwarePluginInterface) {
$this->block
->setContextMapping($settings
->getValue('context_mapping', []));
}
$configuration = $this->block
->getConfiguration();
$configuration['region'] = $form_state
->getValue('region');
$this
->getVariantPlugin()
->updateBlock($this->block
->getConfiguration()['uuid'], $configuration);
$cached_values = $this
->getCachedValues($this->tempstore, $this->tempstore_id, $form_state
->get('machine_name'));
$cached_values['plugin'] = $this
->getVariantPlugin();
// PageManager specific handling.
if (isset($cached_values['page_variant'])) {
$cached_values['page_variant']
->getVariantPlugin()
->setConfiguration($cached_values['plugin']
->getConfiguration());
}
$this
->getTempstore()
->set($cached_values['id'], $cached_values);
}
/**
* Gets the variant plugin for this page variant entity.
*
* @return \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant
*/
protected function getVariantPlugin() {
return $this->variantPlugin;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CachedValuesGetterTrait:: |
protected | function | Gets cached values for non-wizard classes that interact with a wizard. | |
ContextAwarePluginAssignmentTrait:: |
protected | function | Builds a form element for assigning a context to a given slot. | |
ContextAwarePluginAssignmentTrait:: |
protected | function | Wraps the context handler. | |
ContextAwarePluginAssignmentTrait:: |
abstract protected | function | Ensures the t() method is available. | |
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 current user. | |
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. | |
FormInterface:: |
public | function | Returns a unique string identifying the form. | 236 |
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. | |
PanelsBlockConfigureFormBase:: |
protected | property | The plugin being configured. | |
PanelsBlockConfigureFormBase:: |
protected | property | Tempstore factory. | |
PanelsBlockConfigureFormBase:: |
protected | property | The tempstore id. | |
PanelsBlockConfigureFormBase:: |
protected | property | The variant plugin. | |
PanelsBlockConfigureFormBase:: |
public | function |
Form constructor. Overrides FormInterface:: |
1 |
PanelsBlockConfigureFormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
1 |
PanelsBlockConfigureFormBase:: |
protected | function | Get the tempstore. | |
PanelsBlockConfigureFormBase:: |
protected | function | Get the tempstore id. | |
PanelsBlockConfigureFormBase:: |
protected | function | Gets the variant plugin for this page variant entity. | |
PanelsBlockConfigureFormBase:: |
abstract protected | function | Prepares the block plugin based on the block ID. | 2 |
PanelsBlockConfigureFormBase:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
PanelsBlockConfigureFormBase:: |
abstract protected | function | Returns the text to use for the submit button. | 2 |
PanelsBlockConfigureFormBase:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
PanelsBlockConfigureFormBase:: |
public | function | Constructs a new VariantPluginConfigureBlockFormBase. | 1 |
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 |
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. |