View source
<?php
namespace Drupal\bootstrap_layouts\Plugin\Layout;
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\NestedArray;
use Drupal\Component\Utility\Xss;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Form\SubformStateInterface;
use Drupal\Core\Plugin\PluginFormInterface;
use Drupal\Core\Layout\LayoutDefault;
class BootstrapLayoutsBase extends LayoutDefault implements PluginFormInterface {
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
protected function getRegionDefaults() {
return [
'wrapper' => 'div',
'classes' => [],
'attributes' => '',
'add_region_classes' => TRUE,
];
}
public function defaultConfiguration() {
$configuration = parent::defaultConfiguration();
$configuration += [
'layout' => [
'wrapper' => 'div',
'classes' => [
'row',
],
'attributes' => '',
'add_layout_class' => TRUE,
],
'regions' => [],
];
foreach ($this
->getPluginDefinition()
->getRegions() as $region => $info) {
$region_configuration = [];
foreach ([
'wrapper',
'classes',
'attributes',
] as $key) {
if (isset($info[$key])) {
$region_configuration[$key] = $info[$key];
}
}
$configuration['regions'][$region] = $region_configuration + $this
->getRegionDefaults();
}
return $configuration;
}
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$complete_form_state = $form_state instanceof SubformStateInterface ? $form_state
->getCompleteFormState() : $form_state;
$configuration = $this
->getConfiguration();
$manager = \Drupal::getContainer()
->get('plugin.manager.bootstrap_layouts');
$classes = $manager
->getClassOptions();
$tokens = FALSE;
if (\Drupal::moduleHandler()
->moduleExists('token')) {
$tokens = [
'#title' => $this
->t('Tokens'),
'#type' => 'container',
];
$tokens['help'] = [
'#theme' => 'token_tree_link',
'#token_types' => 'all',
'#global_types' => FALSE,
'#dialog' => TRUE,
];
}
$wrapper_options = [
'div' => 'Div',
'span' => 'Span',
'section' => 'Section',
'article' => 'Article',
'header' => 'Header',
'footer' => 'Footer',
'aside' => 'Aside',
'figure' => 'Figure',
];
$form['layout'] = [
'#type' => 'container',
'#tree' => TRUE,
];
$form['layout']['wrapper'] = [
'#type' => 'select',
'#title' => $this
->t('Wrapper'),
'#options' => $wrapper_options,
'#default_value' => $complete_form_state
->getValue([
'layout',
'wrapper',
], $configuration['layout']['wrapper']),
];
$form['layout']['classes'] = [
'#type' => 'select',
'#title' => $this
->t('Classes'),
'#options' => $classes,
'#default_value' => $complete_form_state
->getValue([
'layout',
'classes',
], $configuration['layout']['classes']) ?: [],
'#multiple' => TRUE,
];
$form['layout']['add_layout_class'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Add layout specific class: <code>@class</code>', [
'@class' => Html::cleanCssIdentifier($this
->getPluginId()),
]),
'#default_value' => (int) $complete_form_state
->getValue([
'layout',
'add_layout_class',
], $configuration['layout']['add_layout_class']),
];
$form['layout']['attributes'] = [
'#type' => 'textfield',
'#title' => $this
->t('Additional attributes'),
'#description' => 'E.g. id|custom-id,role|navigation,data-something|some value',
'#default_value' => $complete_form_state
->getValue([
'layout',
'attributes',
], $configuration['layout']['attributes']),
];
if ($tokens) {
$form['layout']['tokens'] = $tokens;
}
foreach ($this
->getPluginDefinition()
->getRegions() as $region => $region_info) {
$region_label = $region_info['label'];
$default_values = NestedArray::mergeDeep($this
->getRegionDefaults(), isset($configuration['regions'][$region]) ? $configuration['regions'][$region] : [], $complete_form_state
->getValue([
'regions',
$region,
], []));
$form[$region] = [
'#group' => 'additional_settings',
'#type' => 'details',
'#open' => TRUE,
'#title' => $this
->t('Region: @region', [
'@region' => $region_label,
]),
'#weight' => 20,
];
$form[$region]['wrapper'] = [
'#type' => 'select',
'#title' => $this
->t('Wrapper'),
'#options' => $wrapper_options,
'#default_value' => $default_values['wrapper'],
];
$form[$region]['classes'] = [
'#type' => 'select',
'#title' => $this
->t('Classes'),
'#options' => $classes,
'#default_value' => $default_values['classes'],
'#multiple' => TRUE,
];
$form[$region]['add_region_classes'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Add region specific classes: <code>bs-region</code> and <code>bs-region--@region</code>', [
'@region' => $region,
]),
'#default_value' => (int) $default_values['add_region_classes'],
];
$form[$region]['attributes'] = [
'#type' => 'textfield',
'#title' => $this
->t('Additional attributes'),
'#description' => 'E.g. id|custom-id,role|navigation,data-something|some value',
'#default_value' => $default_values['attributes'],
];
if ($tokens) {
$form[$region]['tokens'] = $tokens;
}
}
return $form;
}
public function setConfiguration(array $configuration) {
$default = $this
->defaultConfiguration();
$configuration += $default;
$configuration['layout'] += $default['layout'];
$configuration['regions'] += $default['regions'];
$regions = $this
->getPluginDefinition()
->getRegions();
foreach (array_keys($configuration['regions']) as $region) {
if (!isset($regions[$region])) {
unset($configuration['regions'][$region]);
}
}
$this->configuration = $configuration;
}
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
$defaults = $this
->getRegionDefaults();
if ($layout = $form_state
->getValue('layout', $defaults)) {
$layout['attributes'] = Xss::filter($layout['attributes']);
$this->configuration['layout'] = $layout;
}
$regions = [];
foreach ($this
->getPluginDefinition()
->getRegionNames() as $name) {
if ($region = $form_state
->getValue($name, $defaults)) {
$region['attributes'] = Xss::filter($region['attributes']);
$regions[$name] = $region;
}
}
$this->configuration['regions'] = $regions;
}
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
}
}