public function YamlFormPluginElementController::index in YAML Form 8

1 string reference to 'YamlFormPluginElementController::index'

yamlform.routing.yml in ./yamlform.routing.yml

yamlform.routing.yml

File

src/Controller/YamlFormPluginElementController.php, line 71

Class

YamlFormPluginElementController

Controller for all form elements.

Namespace

Drupal\yamlform\Controller

Code

public function index() {
  $yamlform_form_element_rows = [];
  $element_rows = [];
  $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 YAML Form Devel and UI module are
  // enabled.
  $test_element_enabled = $this->moduleHandler
    ->moduleExists('yamlform_devel') && $this->moduleHandler
    ->moduleExists('yamlform_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\yamlform\YamlFormElementInterface $yamlform_element */
      $yamlform_element = $this->elementManager
        ->createInstance($element_plugin_id);
      $yamlform_element_plugin_definition = $this->elementManager
        ->getDefinition($element_plugin_id);
      $yamlform_element_info = $yamlform_element
        ->getInfo();
      $parent_classes = YamlFormReflectionHelper::getParentClasses($yamlform_element, 'YamlFormElementBase');
      $default_format = $yamlform_element
        ->getDefaultFormat();
      $format_names = array_keys($yamlform_element
        ->getFormats());
      $formats = array_combine($format_names, $format_names);
      if (isset($formats[$default_format])) {
        $formats[$default_format] = '<b>' . $formats[$default_format] . '</b>';
      }
      $related_types = $yamlform_element
        ->getRelatedTypes($element);
      $yamlform_info_definitions = [
        'input' => $yamlform_element
          ->isInput($element),
        'container' => $yamlform_element
          ->isContainer($element),
        'root' => $yamlform_element
          ->isRoot(),
        'hidden' => $yamlform_element
          ->isHidden(),
        'multiline' => $yamlform_element
          ->isMultiline($element),
        'multiple' => $yamlform_element
          ->hasMultipleValues($element),
        'states_wrapper' => $yamlform_element_plugin_definition['states_wrapper'],
      ];
      $yamlform_info = [];
      foreach ($yamlform_info_definitions as $key => $value) {
        $yamlform_info[] = '<b>' . $key . '</b>: ' . ($value ? $this
          ->t('Yes') : $this
          ->t('No'));
      }
      $element_info_definitions = [
        'input' => empty($yamlform_element_info['#input']) ? $this
          ->t('No') : $this
          ->t('Yes'),
        'theme' => isset($yamlform_element_info['#theme']) ? $yamlform_element_info['#theme'] : 'N/A',
        'theme_wrappers' => isset($yamlform_element_info['#theme_wrappers']) ? implode('; ', $yamlform_element_info['#theme_wrappers']) : 'N/A',
      ];
      $element_info = [];
      foreach ($element_info_definitions as $key => $value) {
        $element_info[] = '<b>' . $key . '</b>: ' . $value;
      }
      $properties = [];
      $element_default_properties = array_keys($yamlform_element
        ->getDefaultProperties());
      foreach ($element_default_properties as $key => $value) {
        if (!isset($default_properties[$value])) {
          $properties[$key] = '<b>#' . $value . '</b>';
          unset($element_default_properties[$key]);
        }
        else {
          $element_default_properties[$key] = '#' . $value;
        }
      }
      $properties += $element_default_properties;
      if (count($properties) >= 20) {
        $properties = array_slice($properties, 0, 20) + [
          '...' => '...',
        ];
      }
      $operations = [];
      if ($test_element_enabled) {
        $operations['test'] = [
          'title' => $this
            ->t('Test'),
          'url' => new Url('yamlform.element_plugins.test', [
            'type' => $element_plugin_id,
          ]),
        ];
      }
      if ($api_url = $yamlform_element
        ->getPluginApiUrl()) {
        $operations['documentation'] = [
          'title' => $this
            ->t('API Docs'),
          'url' => $api_url,
        ];
      }
      $yamlform_form_element_rows[$element_plugin_id] = [
        'data' => [
          new FormattableMarkup('<div class="yamlform-form-filter-text-source">@id</div>', [
            '@id' => $element_plugin_id,
          ]),
          $yamlform_element
            ->getPluginLabel(),
          [
            'data' => [
              '#markup' => implode('<br/> → ', $parent_classes),
            ],
            'nowrap' => 'nowrap',
          ],
          [
            'data' => [
              '#markup' => implode('<br/>', $yamlform_info),
            ],
            'nowrap' => 'nowrap',
          ],
          [
            'data' => [
              '#markup' => implode('<br/>', $element_info),
            ],
            'nowrap' => 'nowrap',
          ],
          [
            'data' => [
              '#markup' => implode('<br/>', $properties),
            ],
          ],
          $formats ? [
            'data' => [
              '#markup' => '• ' . implode('<br/>• ', $formats),
            ],
            'nowrap' => 'nowrap',
          ] : '',
          $related_types ? [
            'data' => [
              '#markup' => '• ' . implode('<br/>• ', $related_types),
            ],
            'nowrap' => 'nowrap',
          ] : '<' . $this
            ->t('none') . '>',
          $element_plugin_definition['provider'],
          $yamlform_element_plugin_definition['provider'],
          $operations ? [
            'data' => [
              '#type' => 'operations',
              '#links' => $operations,
            ],
          ] : '',
        ],
      ];
    }
    else {
      $element_rows[$element_plugin_id] = [
        $element_plugin_id,
        $element_plugin_definition['provider'],
      ];
    }
  }
  $build = [];
  $build['filter'] = [
    '#type' => 'search',
    '#title' => $this
      ->t('Filter'),
    '#title_display' => 'invisible',
    '#size' => 30,
    '#placeholder' => $this
      ->t('Filter by element name'),
    '#attributes' => [
      'class' => [
        'yamlform-form-filter-text',
      ],
      'data-element' => '.yamlform-element-plugin',
      'title' => $this
        ->t('Enter a part of the element type to filter by.'),
      'autofocus' => 'autofocus',
    ],
  ];
  ksort($yamlform_form_element_rows);
  $build['yamlform_elements'] = [
    '#type' => 'table',
    '#header' => [
      $this
        ->t('Name'),
      $this
        ->t('Label'),
      $this
        ->t('Class hierarchy'),
      $this
        ->t('YAML Form info'),
      $this
        ->t('Element info'),
      $this
        ->t('Properties'),
      $this
        ->t('Formats'),
      $this
        ->t('Related'),
      $this
        ->t('Provided by'),
      $this
        ->t('Integrated by'),
      $this
        ->t('Operations'),
    ],
    '#rows' => $yamlform_form_element_rows,
    '#attributes' => [
      'class' => [
        'yamlform-element-plugin',
      ],
    ],
  ];
  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 YAML Form 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'][] = 'yamlform/yamlform.admin';
  $build['#attached']['library'][] = 'yamlform/yamlform.form';
  return $build;
}