class WebformPluginVariantController in Webform 6.x
Same name and namespace in other branches
- 8.5 src/Controller/WebformPluginVariantController.php \Drupal\webform\Controller\WebformPluginVariantController
Controller for all webform variants.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\webform\Controller\WebformPluginVariantController implements ContainerInjectionInterface
Expanded class hierarchy of WebformPluginVariantController
File
- src/
Controller/ WebformPluginVariantController.php, line 18
Namespace
Drupal\webform\ControllerView source
class WebformPluginVariantController extends ControllerBase implements ContainerInjectionInterface {
/**
* The webform variant plugin manager.
*
* @var \Drupal\Component\Plugin\PluginManagerInterface
*/
protected $pluginManager;
/**
* Constructs a WebformPluginVariantController object.
*
* @param \Drupal\Component\Plugin\PluginManagerInterface $plugin_manager
* A webform variant plugin manager.
*/
public function __construct(PluginManagerInterface $plugin_manager) {
$this->pluginManager = $plugin_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('plugin.manager.webform.variant'));
}
/**
* {@inheritdoc}
*/
public function index() {
$excluded_variants = $this
->config('webform.settings')
->get('variant.excluded_variants');
$used_by = [];
/** @var \Drupal\webform\WebformInterface[] $webforms */
$webforms = Webform::loadMultiple();
foreach ($webforms as $webform) {
$variants = $webform
->getVariants();
foreach ($variants as $variant) {
$used_by[$variant
->getPluginId()][$webform
->id()] = $webform
->toLink()
->toRenderable();
}
}
$definitions = $this->pluginManager
->getDefinitions();
$definitions = $this->pluginManager
->getSortedDefinitions($definitions);
$rows = [];
foreach ($definitions as $plugin_id => $definition) {
$row = [];
$row[] = $plugin_id;
$row[] = [
'data' => [
'#markup' => $definition['label'],
'#prefix' => '<span class="webform-form-filter-text-source">',
'#suffix' => '</span>',
],
];
$row[] = $definition['description'];
$row[] = $definition['category'];
$row[] = isset($excluded_variants[$plugin_id]) ? $this
->t('Yes') : $this
->t('No');
$row[] = isset($used_by[$plugin_id]) ? [
'data' => [
'#theme' => 'item_list',
'#items' => $used_by[$plugin_id],
],
] : '';
$row[] = $definition['provider'];
$rows[$plugin_id] = [
'data' => $row,
];
if (isset($excluded_variants[$plugin_id])) {
$rows[$plugin_id]['class'] = [
'color-warning',
];
}
}
ksort($rows);
$build = [];
// Filter.
$build['filter'] = [
'#type' => 'search',
'#title' => $this
->t('Filter'),
'#title_display' => 'invisible',
'#size' => 30,
'#placeholder' => $this
->t('Filter by variant label'),
'#attributes' => [
'class' => [
'webform-form-filter-text',
],
'data-element' => '.webform-variant-plugin-table',
'data-summary' => '.webform-variant-plugin-summary',
'data-item-singlular' => $this
->t('variant'),
'data-item-plural' => $this
->t('variants'),
'title' => $this
->t('Enter a part of the variant label to filter by.'),
'autofocus' => 'autofocus',
],
];
// Settings.
$build['settings'] = [
'#type' => 'link',
'#title' => $this
->t('Edit configuration'),
'#url' => Url::fromRoute('webform.config.variants'),
'#attributes' => [
'class' => [
'button',
'button--small',
],
'style' => 'float: right',
],
];
// Display info.
$build['info'] = [
'#markup' => $this
->t('@total variants', [
'@total' => count($rows),
]),
'#prefix' => '<p class="webform-variant-plugin-summary">',
'#suffix' => '</p>',
];
// Variants.
$build['webform_variants'] = [
'#type' => 'table',
'#header' => [
$this
->t('ID'),
$this
->t('Label'),
$this
->t('Description'),
$this
->t('Category'),
$this
->t('Excluded'),
$this
->t('Used by'),
$this
->t('Provided by'),
],
'#rows' => $rows,
'#sticky' => TRUE,
'#attributes' => [
'class' => [
'webform-variant-plugin-table',
],
],
];
$build['#attached']['library'][] = 'webform/webform.admin';
return $build;
}
/**
* Shows a list of webform variants that can be added to a webform.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The current request.
* @param \Drupal\webform\WebformInterface $webform
* A webform.
*
* @return array
* A render array as expected by the renderer.
*/
public function listVariants(Request $request, WebformInterface $webform) {
// Get enabled variant types.
$elements = $webform
->getElementsVariant();
$variant_types = [];
foreach ($elements as $element_key) {
$element = $webform
->getElement($element_key);
if (isset($element['#variant'])) {
$variant_types[$element['#variant']] = $element['#variant'];
}
}
$headers = [
[
'data' => $this
->t('Variant'),
'width' => '20%',
],
[
'data' => $this
->t('Description'),
'width' => '40%',
],
[
'data' => $this
->t('Category'),
'width' => '20%',
],
[
'data' => $this
->t('Operations'),
'width' => '20%',
],
];
$definitions = $this->pluginManager
->getDefinitions();
$definitions = $this->pluginManager
->getSortedDefinitions($definitions);
$definitions = $this->pluginManager
->removeExcludeDefinitions($definitions);
$rows = [];
foreach ($definitions as $plugin_id => $definition) {
// Make sure variant type is enabled.
if (!isset($variant_types[$plugin_id])) {
continue;
}
/** @var \Drupal\webform\Plugin\WebformVariantInterface $variant_plugin */
$variant_plugin = $this->pluginManager
->createInstance($plugin_id);
$row = [];
$row['title']['data'] = [
'#type' => 'link',
'#title' => $definition['label'],
'#url' => Url::fromRoute('entity.webform.variant.add_form', [
'webform' => $webform
->id(),
'webform_variant' => $plugin_id,
]),
'#attributes' => WebformDialogHelper::getOffCanvasDialogAttributes($variant_plugin
->getOffCanvasWidth()),
'#prefix' => '<div class="webform-form-filter-text-source">',
'#suffix' => '</div>',
];
$row['description'] = [
'data' => [
'#markup' => $definition['description'],
],
];
$row['category'] = $definition['category'];
$links['add'] = [
'title' => $this
->t('Add variant'),
'url' => Url::fromRoute('entity.webform.variant.add_form', [
'webform' => $webform
->id(),
'webform_variant' => $plugin_id,
]),
'attributes' => WebformDialogHelper::getOffCanvasDialogAttributes($variant_plugin
->getOffCanvasWidth()),
];
$row['operations']['data'] = [
'#type' => 'operations',
'#links' => $links,
'#prefix' => '<div class="webform-dropbutton">',
'#suffix' => '</div>',
];
$rows[] = $row;
}
$build['filter'] = [
'#type' => 'search',
'#title' => $this
->t('Filter'),
'#title_display' => 'invisible',
'#size' => 30,
'#placeholder' => $this
->t('Filter by variant name'),
'#attributes' => [
'class' => [
'webform-form-filter-text',
],
'data-element' => '.webform-variant-add-table',
'data-item-singlular' => $this
->t('variant'),
'data-item-plural' => $this
->t('variants'),
'title' => $this
->t('Enter a part of the variant name to filter by.'),
'autofocus' => 'autofocus',
],
];
$build['variants'] = [
'#type' => 'table',
'#header' => $headers,
'#rows' => $rows,
'#sticky' => TRUE,
'#empty' => $this
->t('No variant available.'),
'#attributes' => [
'class' => [
'webform-variant-add-table',
],
],
];
$build['#attached']['library'][] = 'webform/webform.form';
$build['#attached']['library'][] = 'webform/webform.filter';
return $build;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function | Returns a redirect response object for the specified route. | |
ControllerBase:: |
protected | function | Returns the state storage 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. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
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. | 4 |
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. | |
WebformPluginVariantController:: |
protected | property | The webform variant plugin manager. | |
WebformPluginVariantController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
WebformPluginVariantController:: |
public | function | ||
WebformPluginVariantController:: |
public | function | Shows a list of webform variants that can be added to a webform. | |
WebformPluginVariantController:: |
public | function | Constructs a WebformPluginVariantController object. |