class Controls in Views Slideshow 8.4
Provides a control widget type.
Plugin annotation
@ViewsSlideshowWidgetType(
id = "views_slideshow_controls",
label = @Translation("Controls"),
accepts = {"pause" = {"required" = TRUE}, "play" = {"required" = TRUE}},
calls = {"nextSlide", "pause", "play", "previousSlide"}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\views_slideshow\ViewsSlideshowWidgetTypeBase implements ViewsSlideshowWidgetTypeInterface uses StringTranslationTrait
- class \Drupal\views_slideshow\Plugin\ViewsSlideshowWidgetType\Controls
- class \Drupal\views_slideshow\ViewsSlideshowWidgetTypeBase implements ViewsSlideshowWidgetTypeInterface uses StringTranslationTrait
Expanded class hierarchy of Controls
File
- src/
Plugin/ ViewsSlideshowWidgetType/ Controls.php, line 18
Namespace
Drupal\views_slideshow\Plugin\ViewsSlideshowWidgetTypeView source
class Controls extends ViewsSlideshowWidgetTypeBase {
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return parent::defaultConfiguration() + [
'type' => [
'default' => 0,
],
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
/* @var \Drupal\Component\Plugin\PluginManagerInterface */
$widgetManager = \Drupal::service('plugin.manager.views_slideshow.widget');
$widgets = $widgetManager
->getDefinitions($this
->getPluginId());
if (!empty($widgets)) {
$options = [];
foreach ($widgets as $widgetId => $widgetInfo) {
$options[$widgetId] = $widgetInfo['label'];
}
// Need to wrap this so it indents correctly.
$form['views_slideshow_controls_wrapper'] = [
'#markup' => '<div class="vs-dependent">',
];
// Create the widget type field.
$form['type'] = [
'#type' => 'select',
'#title' => $this
->t('Controls Type'),
'#description' => $this
->t('Style of the controls'),
'#default_value' => $this
->getConfiguration()['type'],
'#options' => $options,
'#states' => [
'visible' => [
':input[name="' . $this
->getConfiguration()['dependency'] . '[enable]"]' => [
'checked' => TRUE,
],
],
],
];
foreach ($widgets as $widget_id => $widget_info) {
// Get the current configuration of this widget.
$configuration = [];
if (!empty($this
->getConfiguration()[$widget_id])) {
$configuration = $this
->getConfiguration()[$widget_id];
}
$configuration['dependency'] = $this
->getConfiguration()['dependency'];
$instance = $widgetManager
->createInstance($widget_id, $configuration);
// Get the configuration form of this widget type.
$form[$widget_id] = isset($form[$widget_id]) ? $form[$widget_id] : [];
$form[$widget_id] = $instance
->buildConfigurationForm($form[$widget_id], $form_state);
}
$form['controls_wrapper_close'] = [
'#markup' => '</div>',
];
}
else {
$form['enable_controls'] = [
'#markup' => 'There are no controls available.',
];
}
return $form;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Controls:: |
public | function |
Form constructor. Overrides ViewsSlideshowWidgetTypeBase:: |
|
Controls:: |
public | function |
Gets default configuration for this plugin. Overrides ViewsSlideshowWidgetTypeBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
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. | |
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. | |
ViewsSlideshowWidgetTypeBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
ViewsSlideshowWidgetTypeBase:: |
public | function |
Check if the widget type is compatible with the selected slideshow. Overrides ViewsSlideshowWidgetTypeInterface:: |
|
ViewsSlideshowWidgetTypeBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
ViewsSlideshowWidgetTypeBase:: |
public | function | ||
ViewsSlideshowWidgetTypeBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
ViewsSlideshowWidgetTypeBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
|
ViewsSlideshowWidgetTypeBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
|
ViewsSlideshowWidgetTypeBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |