public function WebformPluginElementController::index in Webform 8.5

Same name and namespace in other branches
6.x src/Controller/WebformPluginElementController.php \Drupal\webform\Controller\WebformPluginElementController::index()
1 string reference to 'WebformPluginElementController::index'
webform.routing.yml in ./webform.routing.yml: webform.routing.yml
File

src/Controller/WebformPluginElementController.php, line 71
Class

WebformPluginElementController: Controller for all webform elements.
Namespace

Drupal\webform\Controller
Code

public function index() {
  $webform_form_element_rows = [];
  $element_rows = [];
  $excluded_elements = $this
    ->config('webform.settings')
    ->get('element.excluded_elements');
  $default_properties = [
    // Element settings.
    'title',
    'description',
    'default_value',
    // Form display.
    'title_display',
    'description_display',
    'field_prefix',
    'field_suffix',
    // Form validation.
    'required',
    'required_error',
    'unique',
    // Submission display.
    'format',
    // Attributes.
    'wrapper_attributes',
    'attributes',
    // Administration.
    'admin_title',
    'private',
    // Flexbox.
    'flex',
    // Conditional logic.
    'states',
    // Element access.
    'access_create_roles',
    'access_create_users',
    'access_update_roles',
    'access_update_users',
    'access_view_roles',
    'access_view_users',
  ];
  $default_properties = array_combine($default_properties, $default_properties);

  // Test element is only enabled if the Webform Devel and UI module are
  // enabled.
  $test_element_enabled = $this->moduleHandler
    ->moduleExists('webform_devel') && $this->moduleHandler
    ->moduleExists('webform_ui') ? TRUE : FALSE;

  // Define a default element used to get default properties.
  $element = [
    '#type' => 'element',
  ];
  $element_plugin_definitions = $this->elementInfo
    ->getDefinitions();
  foreach ($element_plugin_definitions as $element_plugin_id => $element_plugin_definition) {
    if ($this->elementManager
      ->hasDefinition($element_plugin_id)) {

      /** @var \Drupal\webform\Plugin\WebformElementInterface $webform_element */
      $webform_element = $this->elementManager
        ->createInstance($element_plugin_id);
      $webform_element_plugin_definition = $this->elementManager
        ->getDefinition($element_plugin_id);
      $webform_element_info = $webform_element
        ->getInfo();

      // Title.
      if ($test_element_enabled) {
        $title = [
          'data' => [
            '#type' => 'link',
            '#title' => $element_plugin_id,
            '#url' => new Url('webform.reports_plugins.elements.test', [
              'type' => $element_plugin_id,
            ]),
            '#attributes' => [
              'class' => [
                'webform-form-filter-text-source',
              ],
            ],
          ],
        ];
      }
      else {
        $title = new FormattableMarkup('<div class="webform-form-filter-text-source">@id</div>', [
          '@id' => $element_plugin_id,
        ]);
      }

      // Description.
      $description = [
        'data' => [
          'title_description' => [
            '#markup' => new FormattableMarkup('<strong>@label</strong><br />@description', [
              '@label' => $webform_element
                ->getPluginLabel(),
              '@description' => $webform_element
                ->getPluginDescription(),
            ]),
          ],
        ],
      ];

      // Add deprecated warning.
      if (!empty($webform_element_plugin_definition['deprecated'])) {
        $description['data']['deprecated'] = [
          '#type' => 'webform_message',
          '#message_message' => $webform_element_plugin_definition['deprecated_message'],
          '#message_type' => 'warning',
        ];
      }

      // Parent classes.
      $parent_classes = WebformReflectionHelper::getParentClasses($webform_element, 'WebformElementBase');

      // Formats.
      $default_format = $webform_element
        ->getItemDefaultFormat();
      $format_names = array_keys($webform_element
        ->getItemFormats());
      $formats = array_combine($format_names, $format_names);
      if (isset($formats[$default_format])) {
        $formats[$default_format] = '<b>' . $formats[$default_format] . '</b>';
      }

      // Related types.
      $related_types = $webform_element
        ->getRelatedTypes($element);

      // Dependencies.
      $dependencies = $webform_element_plugin_definition['dependencies'];

      // Webform element info.
      $webform_info_definitions = [
        'excluded' => isset($excluded_elements[$element_plugin_id]),
        'input' => $webform_element
          ->isInput($element),
        'container' => $webform_element
          ->isContainer($element),
        'root' => $webform_element
          ->isRoot(),
        'hidden' => $webform_element
          ->isHidden(),
        'composite' => $webform_element
          ->isComposite(),
        'multiple' => $webform_element
          ->supportsMultipleValues(),
        'multiline' => $webform_element
          ->isMultiline($element),
        'default_key' => $webform_element_plugin_definition['default_key'],
        'states_wrapper' => $webform_element_plugin_definition['states_wrapper'],
        'deprecated' => $webform_element_plugin_definition['deprecated'],
      ];
      $webform_info = [];
      foreach ($webform_info_definitions as $key => $value) {
        $webform_info[] = '<b>' . $key . '</b>: ' . ($value ? $this
          ->t('Yes') : $this
          ->t('No'));
      }

      // Element info.
      $element_info_definitions = [
        'input' => empty($webform_element_info['#input']) ? $this
          ->t('No') : $this
          ->t('Yes'),
        'theme' => isset($webform_element_info['#theme']) ? $webform_element_info['#theme'] : 'N/A',
        'theme_wrappers' => isset($webform_element_info['#theme_wrappers']) ? implode('; ', $webform_element_info['#theme_wrappers']) : 'N/A',
      ];
      $element_info = [];
      foreach ($element_info_definitions as $key => $value) {
        $element_info[] = '<b>' . $key . '</b>: ' . $value;
      }

      // Properties.
      $properties = [];
      $element_default_properties = $webform_element
        ->getDefaultProperties();
      foreach ($element_default_properties as $key => $default_value) {
        if (is_bool($default_value)) {
          $data_type = 'boolean';
        }
        elseif (is_array($default_value)) {
          $data_type = 'array';
        }
        elseif (is_numeric($default_value) || is_null($default_value)) {
          $data_type = 'number';
        }
        else {
          $data_type = 'string';
        }
        $default_value = $default_value ? ' ⇒ ' . json_encode($default_value) : '';
        if (!isset($default_properties[$key])) {
          $properties[$key] = '<b>#' . $key . '</b> [' . $data_type . ']' . $default_value;
          unset($element_default_properties[$key]);
        }
        else {
          $element_default_properties[$key] = '#' . $key . ' [' . $data_type . ']' . $default_value;
        }
      }
      $properties += $element_default_properties;

      // Operations.
      $operations = [];
      if ($test_element_enabled) {
        $operations['test'] = [
          'title' => $this
            ->t('Test'),
          'url' => new Url('webform.reports_plugins.elements.test', [
            'type' => $element_plugin_id,
          ]),
        ];
      }
      if ($api_url = $webform_element
        ->getPluginApiUrl()) {
        $operations['documentation'] = [
          'title' => $this
            ->t('API Docs'),
          'url' => $api_url,
        ];
      }
      $webform_form_element_rows[$element_plugin_id] = [
        'data' => [
          $title,
          $description,
          [
            'data' => [
              '#markup' => implode('<br /> → ', $parent_classes),
            ],
            'nowrap' => 'nowrap',
          ],
          [
            'data' => [
              '#markup' => implode('<br />', $webform_info),
            ],
            'nowrap' => 'nowrap',
          ],
          [
            'data' => [
              '#markup' => implode('<br />', $element_info),
            ],
            'nowrap' => 'nowrap',
          ],
          [
            'data' => [
              '#markup' => implode('<br />' . PHP_EOL, $properties),
            ],
            'nowrap' => 'nowrap',
          ],
          $formats ? [
            'data' => [
              '#markup' => '• ' . implode('<br />• ', $formats),
            ],
            'nowrap' => 'nowrap',
          ] : '',
          $related_types ? [
            'data' => [
              '#markup' => '• ' . implode('<br />• ', $related_types),
            ],
            'nowrap' => 'nowrap',
          ] : '<' . $this
            ->t('none') . '>',
          $dependencies ? [
            'data' => [
              '#markup' => '• ' . implode('<br />• ', $dependencies),
            ],
            'nowrap' => 'nowrap',
          ] : '',
          $element_plugin_definition['provider'],
          $webform_element_plugin_definition['provider'],
          $operations ? [
            'data' => [
              '#type' => 'operations',
              '#links' => $operations,
              '#prefix' => '<div class="webform-dropbutton">',
              '#suffix' => '</div>',
            ],
          ] : '',
        ],
      ];
      if (isset($excluded_elements[$element_plugin_id])) {
        $webform_form_element_rows[$element_plugin_id]['class'] = [
          'color-warning',
        ];
      }
    }
    else {
      $element_rows[$element_plugin_id] = [
        $element_plugin_id,
        $element_plugin_definition['provider'],
      ];
    }
  }
  $build = [];

  // Filter.
  $build['filter'] = [
    '#type' => 'search',
    '#title' => $this
      ->t('Filter'),
    '#title_display' => 'invisible',
    '#size' => 30,
    '#placeholder' => $this
      ->t('Filter by element name'),
    '#attributes' => [
      'class' => [
        'webform-form-filter-text',
      ],
      'data-element' => '.webform-element-plugin-table',
      'data-summary' => '.webform-element-plugin-summary',
      'data-item-singlular' => $this
        ->t('element'),
      'data-item-plural' => $this
        ->t('elements'),
      'title' => $this
        ->t('Enter a part of the element type to filter by.'),
      'autofocus' => 'autofocus',
    ],
  ];

  // Settings.
  $build['settings'] = [
    '#type' => 'link',
    '#title' => $this
      ->t('Edit configuration'),
    '#url' => Url::fromRoute('webform.config.elements'),
    '#attributes' => [
      'class' => [
        'button',
        'button--small',
      ],
      'style' => 'float: right',
    ],
  ];

  // Display info.
  $build['info'] = [
    '#markup' => $this
      ->t('@total elements', [
      '@total' => count($webform_form_element_rows),
    ]),
    '#prefix' => '<p class="webform-element-plugin-summary">',
    '#suffix' => '</p>',
  ];
  ksort($webform_form_element_rows);
  $build['webform_elements'] = [
    '#type' => 'table',
    '#header' => [
      $this
        ->t('Name'),
      $this
        ->t('Label/Description'),
      $this
        ->t('Class hierarchy'),
      $this
        ->t('Webform info'),
      $this
        ->t('Element info'),
      $this
        ->t('Properties'),
      $this
        ->t('Formats'),
      $this
        ->t('Related'),
      $this
        ->t('Dependencies'),
      $this
        ->t('Provided by'),
      $this
        ->t('Integrated by'),
      $this
        ->t('Operations'),
    ],
    '#rows' => $webform_form_element_rows,
    '#sticky' => TRUE,
    '#attributes' => [
      'class' => [
        'webform-element-plugin-table',
      ],
    ],
  ];
  ksort($element_rows);
  $build['elements'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Additional elements'),
    '#description' => $this
      ->t('Below are elements that are available but do not have a Webform Element integration plugin.'),
    'table' => [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Name'),
        $this
          ->t('Provided by'),
      ],
      '#rows' => $element_rows,
      '#sticky' => TRUE,
    ],
  ];
  $all_translatable_properties = $this->elementManager
    ->getTranslatableProperties();
  $all_properties = $this->elementManager
    ->getAllProperties();
  foreach ($all_translatable_properties as $key => $value) {
    $all_translatable_properties[$key] = [
      '#markup' => $value,
      '#prefix' => '<strong>',
      '#suffix' => '</strong>',
      '#weight' => -10,
    ];
  }
  foreach ($all_properties as $key => $value) {

    // Remove all composite properties.
    if (strpos($key, '__')) {
      unset($all_properties[$key]);
    }
  }
  $build['properties'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Element properties'),
    '#description' => $this
      ->t('Below are all available element properties with translatable properties in <strong>bold</strong>.'),
    'list' => [
      '#theme' => 'item_list',
      '#items' => $all_translatable_properties + $all_properties,
    ],
  ];
  $build['#attached']['library'][] = 'webform/webform.admin';
  return $build;
}
You are here

public function WebformPluginElementController::index in Webform 8.5

File

Class

Namespace

Code

API Navigation
