class WebformAdminConfigVariantsForm in Webform 8.5

Same name and namespace in other branches

6.x 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, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\webform\Form\AdminConfig\WebformAdminConfigBaseForm
    class \Drupal\webform\Form\AdminConfig\WebformAdminConfigVariantsForm

Expanded class hierarchy of WebformAdminConfigVariantsForm

1 string reference to 'WebformAdminConfigVariantsForm'

webform.routing.yml in ./webform.routing.yml: webform.routing.yml

File

src/Form/AdminConfig/WebformAdminConfigVariantsForm.php, line 15

Namespace

Drupal\webform\Form\AdminConfig

View 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';
  }

  /**
   * Constructs a WebformAdminConfigVariantsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\webform\Plugin\WebformVariantManagerInterface $variant_manager
   *   The webform variant manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, WebformVariantManagerInterface $variant_manager) {
    parent::__construct($config_factory);
    $this->variantManager = $variant_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('plugin.manager.webform.variant'));
  }

  /**
   * {@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
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.
WebformAdminConfigBaseForm::buildBulkOperations	protected	function	Build bulk operation settings for webforms and submissions.
WebformAdminConfigBaseForm::buildExcludedPlugins	protected	function	Build excluded plugins element.
WebformAdminConfigBaseForm::convertIncludedToExcludedPluginIds	protected	function	Convert included ids returned from table select element to excluded ids.
WebformAdminConfigBaseForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
WebformAdminConfigBaseForm::getPluginDefinitions	protected	function	Get plugin definitions.
WebformAdminConfigBaseForm::validateBulkFormActions	public static	function	Form API callback. Validate bulk form actions.
WebformAdminConfigVariantsForm::$variantManager	protected	property	The webform variant manager.
WebformAdminConfigVariantsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
WebformAdminConfigVariantsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
WebformAdminConfigVariantsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformAdminConfigVariantsForm::submitForm	public	function	Form submission handler. Overrides WebformAdminConfigBaseForm::submitForm
WebformAdminConfigVariantsForm::__construct	public	function	Constructs a WebformAdminConfigVariantsForm object. Overrides ConfigFormBase::__construct

You are here

class WebformAdminConfigVariantsForm in Webform 8.5

Hierarchy

File

Namespace

Members

API Navigation