class WebformUiElementTypeSelectForm in Webform 8.5

Same name and namespace in other branches

6.x modules/webform_ui/src/Form/WebformUiElementTypeSelectForm.php \Drupal\webform_ui\Form\WebformUiElementTypeSelectForm

Provides a select element type webform for a webform element.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\webform_ui\Form\WebformUiElementTypeFormBase uses WebformDialogFormTrait
  - class \Drupal\webform_ui\Form\WebformUiElementTypeSelectForm

Expanded class hierarchy of WebformUiElementTypeSelectForm

1 string reference to 'WebformUiElementTypeSelectForm'

webform_ui.routing.yml in modules/webform_ui/webform_ui.routing.yml: modules/webform_ui/webform_ui.routing.yml

File

modules/webform_ui/src/Form/WebformUiElementTypeSelectForm.php, line 12

Namespace

Drupal\webform_ui\Form

View source

class WebformUiElementTypeSelectForm extends WebformUiElementTypeFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'webform_ui_element_type_select_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL) {
    $parent = $this
      ->getRequest()->query
      ->get('parent');
    if ($parent) {
      $parent_element = $webform
        ->getElement($parent);
      $t_args = [
        '@parent' => $parent_element['#admin_title'] ?: $parent_element['#title'] ?: $parent_element['#webform_key'],
      ];
      $form['#title'] = $this
        ->t('Select an element to add to "@parent"', $t_args);
    }
    $elements = $this->elementManager
      ->getInstances();
    $definitions = $this
      ->getDefinitions();
    $category_index = 0;
    $categories = [];
    $form = parent::buildForm($form, $form_state, $webform);
    foreach (array_keys($definitions) as $element_type) {

      /** @var \Drupal\webform\Plugin\WebformElementInterface $webform_element */
      $webform_element = $elements[$element_type];

      // Skip disabled or hidden.
      if ($webform_element
        ->isDisabled() || $webform_element
        ->isHidden()) {
        continue;
      }
      $category_name = (string) $webform_element
        ->getPluginCategory();
      if (!isset($categories[$category_name])) {
        $categories[$category_name] = $category_index++;
        $category_id = $categories[$category_name];
        $form[$category_id] = [
          '#type' => 'details',
          '#title' => $webform_element
            ->getPluginCategory(),
          '#open' => TRUE,
          '#attributes' => [
            'data-webform-element-id' => 'webform-ui-element-type-' . $category_id,
          ],
        ];
        $form[$category_id]['elements'] = [
          '#type' => 'table',
          '#header' => $this
            ->getHeader(),
          '#rows' => [],
          '#empty' => $this
            ->t('No element available.'),
          '#attributes' => [
            'class' => [
              'webform-ui-element-type-table',
            ],
          ],
        ];
      }
      else {
        $category_id = $categories[$category_name];
      }
      $url = Url::fromRoute('entity.webform_ui.element.add_form', [
        'webform' => $webform
          ->id(),
        'type' => $element_type,
      ], $parent ? [
        'query' => [
          'parent' => $parent,
        ],
      ] : []);
      $form[$category_id]['elements'][$element_type] = $this
        ->buildRow($webform_element, $url, $this
        ->t('Add element'));
    }
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::config	protected	function	Retrieves a configuration object.
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.
WebformAjaxFormTrait::announce	protected	function	Queue announcement with Ajax response.
WebformAjaxFormTrait::buildAjaxForm	protected	function	Add Ajax support to a form.
WebformAjaxFormTrait::createAjaxResponse	protected	function	Create an AjaxResponse or WebformAjaxResponse object.
WebformAjaxFormTrait::getAnnouncements	protected	function	Get announcements.
WebformAjaxFormTrait::getDefaultAjaxSettings	protected	function	Get default ajax callback settings.	1
WebformAjaxFormTrait::getFormStateRedirectUrl	protected	function	Get redirect URL from the form's state.
WebformAjaxFormTrait::getWrapperId	protected	function	Get the form's Ajax wrapper id.	1
WebformAjaxFormTrait::isCallableAjaxCallback	protected	function	Determine if Ajax callback is callable.
WebformAjaxFormTrait::isDialog	protected	function	Is the current request for an Ajax modal/dialog.
WebformAjaxFormTrait::isOffCanvasDialog	protected	function	Is the current request for an off canvas dialog.
WebformAjaxFormTrait::missingAjaxCallback	protected	function	Handle missing Ajax callback.
WebformAjaxFormTrait::replaceForm	protected	function	Replace form via an Ajax response.	1
WebformAjaxFormTrait::resetAnnouncements	protected	function	Reset announcements.
WebformAjaxFormTrait::setAnnouncements	protected	function	Set announcements.
WebformAjaxFormTrait::validateAjaxForm	public	function	Validate form #ajax callback.	1
WebformDialogFormTrait::buildDialogConfirmForm	protected	function	Add modal dialog support to a confirm form.
WebformDialogFormTrait::buildDialogDeleteAction	protected	function	Build webform dialog delete link.
WebformDialogFormTrait::buildDialogForm	protected	function	Add modal dialog support to a form.
WebformDialogFormTrait::cancelAjaxForm	public	function	Cancel form #ajax callback. Overrides WebformAjaxFormTrait::cancelAjaxForm	1
WebformDialogFormTrait::closeDialog	public	function	Close dialog.
WebformDialogFormTrait::isAjax	protected	function	Returns if webform is using Ajax. Overrides WebformAjaxFormTrait::isAjax	1
WebformDialogFormTrait::noSubmit	public	function	Empty submit callback used to only have the submit button to use an #ajax submit callback. Overrides WebformAjaxFormTrait::noSubmit
WebformUiElementTypeFormBase::$currentUser	protected	property	The current user.
WebformUiElementTypeFormBase::$elementManager	protected	property	The webform element manager.
WebformUiElementTypeFormBase::$userData	protected	property	The user data service.
WebformUiElementTypeFormBase::$webform	protected	property	A temp webform.
WebformUiElementTypeFormBase::$webformSubmission	protected	property	A temp webform submission.
WebformUiElementTypeFormBase::buildElementPreview	protected	function	Build and fully initialize and prepare a preview of a webform element.
WebformUiElementTypeFormBase::buildElementPreviewPlaceholder	protected	function	Build preview placeholder for webform element.
WebformUiElementTypeFormBase::buildRow	protected	function	Build element type row.
WebformUiElementTypeFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
WebformUiElementTypeFormBase::getDefinitions	protected	function	Gets the sorted definition of all WebformElement plugins.
WebformUiElementTypeFormBase::getHeader	protected	function	Get table header.
WebformUiElementTypeFormBase::isPreviewEnabled	protected	function	Determine if webform element type preview is enabled.
WebformUiElementTypeFormBase::noValidate	public	function	Never trigger validation. Overrides WebformDialogFormTrait::noValidate
WebformUiElementTypeFormBase::submitAjaxForm	public	function	Submit form #ajax callback. Overrides WebformAjaxFormTrait::submitAjaxForm
WebformUiElementTypeFormBase::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
WebformUiElementTypeFormBase::__construct	public	function	Constructs a WebformUiElementTypeFormBase object.
WebformUiElementTypeSelectForm::buildForm	public	function	Form constructor. Overrides WebformUiElementTypeFormBase::buildForm
WebformUiElementTypeSelectForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId

You are here

class WebformUiElementTypeSelectForm in Webform 8.5

Hierarchy

File

Namespace

Members

API Navigation