class WebformAdminConfigVariantsForm in Webform 6.x
Same name and namespace in other branches
- 8.5 src/Form/AdminConfig/WebformAdminConfigVariantsForm.php \Drupal\webform\Form\AdminConfig\WebformAdminConfigVariantsForm
Configure webform admin settings for variants.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
- class \Drupal\webform\Form\AdminConfig\WebformAdminConfigBaseForm
- class \Drupal\webform\Form\AdminConfig\WebformAdminConfigVariantsForm
- class \Drupal\webform\Form\AdminConfig\WebformAdminConfigBaseForm
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of WebformAdminConfigVariantsForm
1 string reference to 'WebformAdminConfigVariantsForm'
File
- src/
Form/ AdminConfig/ WebformAdminConfigVariantsForm.php, line 13
Namespace
Drupal\webform\Form\AdminConfigView source
class WebformAdminConfigVariantsForm extends WebformAdminConfigBaseForm {
/**
* The webform variant manager.
*
* @var \Drupal\webform\Plugin\WebformVariantManagerInterface
*/
protected $variantManager;
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'webform_admin_config_variants_form';
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
$instance = parent::create($container);
$instance->variantManager = $container
->get('plugin.manager.webform.variant');
return $instance;
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$config = $this
->config('webform.settings');
// Display warning about needing 'Edit webform variants' permission.
$t_args = [
'@href' => Url::fromRoute('user.admin_permissions', [], [
'fragment' => 'module-webform',
])
->toString(),
];
if (!$this
->currentUser()
->hasPermission('edit webform variants')) {
$form['message'] = [
'#type' => 'webform_message',
'#message_message' => $this
->t('You need to be assigned <a href="@href">Edit webform variants</a> permission to be able create and manage variants.', $t_args),
'#message_type' => 'warning',
];
}
else {
$form['message'] = [
'#type' => 'webform_message',
'#message_message' => $this
->t('Users need to be assigned <a href="@href">Edit webform variants</a> permission to be able create and manage variants.', $t_args),
'#message_type' => 'info',
'#message_close' => TRUE,
'#message_storage' => WebformMessage::STORAGE_SESSION,
];
}
// Variant: Types.
$form['variant_types'] = [
'#type' => 'details',
'#title' => $this
->t('Variants'),
'#description' => $this
->t('Select available variants'),
'#open' => TRUE,
'#weight' => 10,
];
$form['variant_types']['excluded_variants'] = $this
->buildExcludedPlugins($this->variantManager, $config
->get('variant.excluded_variants') ?: []);
$excluded_variant_checkboxes = [];
foreach ($form['variant_types']['excluded_variants']['#options'] as $variant_id => $option) {
if ($excluded_variant_checkboxes) {
$excluded_variant_checkboxes[] = 'or';
}
$excluded_variant_checkboxes[] = [
':input[name="excluded_variants[' . $variant_id . ']"]' => [
'checked' => FALSE,
],
];
}
$form['variant_types']['excluded_variants_message'] = [
'#type' => 'webform_message',
'#message_message' => $this
->t('All excluded variants must be manually removed from existing webforms.'),
'#message_type' => 'warning',
'#states' => [
'visible' => $excluded_variant_checkboxes,
],
];
return parent::buildForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$excluded_variants = $this
->convertIncludedToExcludedPluginIds($this->variantManager, $form_state
->getValue('excluded_variants'));
// Update config and submit form.
$config = $this
->config('webform.settings');
$config
->set('variant', [
'excluded_variants' => $excluded_variants,
]);
parent::submitForm($form, $form_state);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigFormBase:: |
public | function | Constructs a \Drupal\system\ConfigFormBase object. | 16 |
ConfigFormBaseTrait:: |
protected | function | Retrieves a configuration object. | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
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. | |
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. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
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. | |
WebformAdminConfigBaseForm:: |
protected | function | Build bulk operation settings for webforms and submissions. | |
WebformAdminConfigBaseForm:: |
protected | function | Build excluded plugins element. | |
WebformAdminConfigBaseForm:: |
protected | function | Convert included ids returned from table select element to excluded ids. | |
WebformAdminConfigBaseForm:: |
protected | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
WebformAdminConfigBaseForm:: |
protected | function | Get plugin definitions. | |
WebformAdminConfigBaseForm:: |
public static | function | Form API callback. Validate bulk form actions. | |
WebformAdminConfigVariantsForm:: |
protected | property | The webform variant manager. | |
WebformAdminConfigVariantsForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
WebformAdminConfigVariantsForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ConfigFormBase:: |
|
WebformAdminConfigVariantsForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
WebformAdminConfigVariantsForm:: |
public | function |
Form submission handler. Overrides WebformAdminConfigBaseForm:: |