class DsLayout in Display Suite 8.2
Same name and namespace in other branches
- 8.4 src/Plugin/DsLayout.php \Drupal\ds\Plugin\DsLayout
- 8.3 src/Plugin/DsLayout.php \Drupal\ds\Plugin\DsLayout
Layout class for all Display Suite layouts.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\layout_plugin\Plugin\Layout\LayoutBase implements ConfigurablePluginInterface, PluginFormInterface, LayoutInterface
- class \Drupal\ds\Plugin\DsLayout
- class \Drupal\layout_plugin\Plugin\Layout\LayoutBase implements ConfigurablePluginInterface, PluginFormInterface, LayoutInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DsLayout
2 string references to 'DsLayout'
- ds.layouts.yml in ./
ds.layouts.yml - ds.layouts.yml
- ds_test.layouts.yml in tests/
modules/ ds_test/ ds_test.layouts.yml - tests/modules/ds_test/ds_test.layouts.yml
File
- src/
Plugin/ DsLayout.php, line 14
Namespace
Drupal\ds\PluginView source
class DsLayout extends LayoutBase {
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return parent::defaultConfiguration() + [
'wrappers' => [],
'outer_wrapper' => 'div',
'attributes' => '',
'link_attribute' => '',
'link_custom' => '',
'classes' => [
'layout_class' => [],
],
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
$configuration = $this
->getConfiguration();
$regions = $this
->getRegionDefinitions();
// Add wrappers.
$wrapper_options = array(
'div' => 'Div',
'span' => 'Span',
'section' => 'Section',
'article' => 'Article',
'header' => 'Header',
'footer' => 'Footer',
'aside' => 'Aside',
'figure' => 'Figure',
);
$form['region_wrapper'] = array(
'#group' => 'additional_settings',
'#type' => 'details',
'#title' => $this
->t('Custom wrappers'),
'#description' => $this
->t('Choose a wrapper. All Display Suite layouts support this option.'),
'#tree' => TRUE,
);
foreach ($regions as $region_name => $region_definition) {
$form['region_wrapper'][$region_name] = array(
'#type' => 'select',
'#options' => $wrapper_options,
'#title' => $this
->t('Wrapper for @region', array(
'@region' => $region_definition['label'],
)),
'#default_value' => !empty($configuration['wrappers'][$region_name]) ? $configuration['wrappers'][$region_name] : 'div',
);
}
$form['region_wrapper']['outer_wrapper'] = array(
'#type' => 'select',
'#options' => $wrapper_options,
'#title' => $this
->t('Outer wrapper'),
'#default_value' => $configuration['outer_wrapper'],
'#weight' => 10,
);
$form['region_wrapper']['attributes'] = array(
'#type' => 'textfield',
'#title' => $this
->t('Layout attributes'),
'#description' => 'E.g. role|navigation,data-something|some value',
'#default_value' => $configuration['attributes'],
'#weight' => 11,
);
$form['region_wrapper']['link_attribute'] = array(
'#type' => 'select',
'#options' => array(
'' => $this
->t('No link'),
'content' => $this
->t('Link to content'),
'custom' => $this
->t('Custom'),
'tokens' => $this
->t('Tokens'),
),
'#title' => $this
->t('Add link'),
'#description' => $this
->t('This will add an onclick attribute on the layout wrapper.'),
'#default_value' => $configuration['link_attribute'],
'#weight' => 12,
);
$form['region_wrapper']['link_custom'] = array(
'#type' => 'textfield',
'#title' => $this
->t('Custom link'),
'#description' => $this
->t('You may use tokens for this link if you selected tokens.'),
'#default_value' => $configuration['link_custom'],
'#weight' => 13,
'#states' => array(
'visible' => array(
array(
':input[name="layout_configuration[region_wrapper][link_attribute]"]' => array(
array(
"value" => "tokens",
),
array(
"value" => "custom",
),
),
),
),
),
);
if (\Drupal::moduleHandler()
->moduleExists('token')) {
$form['region_wrapper']['tokens'] = array(
'#title' => $this
->t('Tokens'),
'#type' => 'container',
'#weight' => 14,
'#states' => array(
'visible' => array(
':input[name="layout_configuration[region_wrapper][link_attribute]"]' => array(
"value" => "tokens",
),
),
),
);
$form['region_wrapper']['tokens']['help'] = array(
'#theme' => 'token_tree_link',
'#token_types' => 'all',
'#global_types' => FALSE,
'#dialog' => TRUE,
);
}
// Add extra classes for the regions to have more control while theming.
$form['ds_classes'] = array(
'#group' => 'additional_settings',
'#type' => 'details',
'#title' => $this
->t('Custom classes'),
'#tree' => TRUE,
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$classes_access = \Drupal::currentUser()
->hasPermission('admin_classes');
$classes = Ds::getClasses();
if (!empty($classes)) {
$form['ds_classes']['layout_class'] = array(
'#type' => 'select',
'#multiple' => TRUE,
'#options' => $classes,
'#title' => $this
->t('Class for layout'),
'#default_value' => !empty($configuration['classes']['layout_class']) ? $configuration['classes']['layout_class'] : [],
);
foreach ($regions as $region_name => $region_definition) {
$form['ds_classes'][$region_name] = array(
'#type' => 'select',
'#multiple' => TRUE,
'#options' => $classes,
'#title' => $this
->t('Class for @region', array(
'@region' => $region_definition['label'],
)),
'#default_value' => isset($configuration['classes'][$region_name]) ? $configuration['classes'][$region_name] : [],
);
}
if ($classes_access) {
$url = Url::fromRoute('ds.classes');
$destination = \Drupal::destination()
->getAsArray();
$url
->setOption('query', $destination);
$form['ds_classes']['info'] = array(
'#markup' => \Drupal::l($this
->t('Manage region and field CSS classes'), $url),
);
}
}
else {
if ($classes_access) {
$url = Url::fromRoute('ds.classes');
$destination = \Drupal::destination()
->getAsArray();
$url
->setOption('query', $destination);
$form['ds_classes']['info'] = array(
'#markup' => '<p>' . $this
->t('You have not defined any CSS classes which can be used on regions.') . '</p><p>' . \Drupal::l($this
->t('Manage region and field CSS classes'), $url) . '</p>',
);
}
else {
$form['ds_classes']['#access'] = FALSE;
}
}
return $form;
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
$this->configuration['wrappers'] = $form_state
->getValue('region_wrapper');
foreach ([
'outer_wrapper',
'attributes',
'link_attribute',
'link_custom',
] as $name) {
$this->configuration[$name] = $this->configuration['wrappers'][$name];
unset($this->configuration['wrappers'][$name]);
}
// Apply Xss::filter to attributes.
$this->configuration['attributes'] = Xss::filter($this->configuration['attributes']);
// In case classes is missing entirely, use the defaults.
$defaults = $this
->defaultConfiguration();
$this->configuration['classes'] = $form_state
->getValue('ds_classes', $defaults['classes']);
// Do not save empty classes.
foreach ($this->configuration['classes'] as $region_name => &$classes) {
foreach ($classes as $class) {
if (empty($class)) {
unset($classes[$class]);
}
}
}
}
}
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 | |
DsLayout:: |
public | function |
Form constructor. Overrides LayoutBase:: |
|
DsLayout:: |
public | function |
Gets default configuration for this plugin. Overrides LayoutBase:: |
|
DsLayout:: |
public | function |
Form submission handler. Overrides LayoutBase:: |
|
LayoutBase:: |
protected | property |
The layout configuration. Overrides PluginBase:: |
|
LayoutBase:: |
public | function |
Build a render array for layout with regions. Overrides LayoutInterface:: |
|
LayoutBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
LayoutBase:: |
public | function | Gets the path to resources like icon or template. | |
LayoutBase:: |
public | function | Gets the human-readable category. | |
LayoutBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurablePluginInterface:: |
|
LayoutBase:: |
public | function | Gets the optional description for advanced layouts. | |
LayoutBase:: |
public | function | Gets the path to the preview image. | |
LayoutBase:: |
public | function | Gets the human-readable name. | |
LayoutBase:: |
public | function | Get the asset library. | |
LayoutBase:: |
public | function | Gets information on regions keyed by machine name. | |
LayoutBase:: |
public | function | Gets human-readable list of regions keyed by machine name. | |
LayoutBase:: |
public | function | Gets the theme hook used to render this layout. | |
LayoutBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface:: |
|
LayoutBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
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. |