You are here

Home » API reference » Express 8 » FormElement.php

class FormElement in Express 8

Pre-processes variables for the "form_element" theme hook.

Plugin annotation

@BootstrapPreprocess("form_element");

Hierarchy

Expanded class hierarchy of FormElement

File

themes/contrib/bootstrap/src/Plugin/Preprocess/FormElement.php, line 20
Contains \Drupal\bootstrap\Plugin\Preprocess\FormElement.

Namespace

Drupal\bootstrap\Plugin\Preprocess
View source 
class FormElement extends PreprocessBase implements PreprocessInterface {

  /**
   * {@inheritdoc}
   */
  public function preprocessElement(Element $element, Variables $variables) {

    // Set has_error flag.
    $variables['has_error'] = $element
      ->getProperty('has_error');
    if ($element
      ->getProperty('autocomplete_route_name')) {
      $variables['is_autocomplete'] = TRUE;
    }

    // See http://getbootstrap.com/css/#forms-controls.
    $checkbox = $variables['is_checkbox'] = $element
      ->isType('checkbox');
    $radio = $variables['is_radio'] = $element
      ->isType('radio');

    // Determine if the form element should have the "form-group" class added.
    // Use an explicitly set property from the element or use its other
    // properties as the criteria to determine if it should be set.
    $variables['is_form_group'] = $element
      ->getProperty('form_group', !$variables['is_checkbox'] && !$variables['is_radio'] && !$element
      ->isType([
      'hidden',
      'textarea',
    ]));

    // Add label_display and label variables to template.
    $display = $variables['label_display'] = $variables['title_display'] = $element
      ->getProperty('title_display');

    // Place single checkboxes and radios in the label field.
    if ($checkbox || $radio) {
      $label = Element::create($variables['label']);
      $children =& $label
        ->getProperty('children', '');
      $children .= $variables['children'];
      if ($label
        ->getProperty('title_display') != 'none') {
        unset($variables['children']);
      }

      // Inform label if it is in checkbox/radio context.
      $label
        ->setProperty('is_checkbox', $checkbox);
      $label
        ->setProperty('is_radio', $radio);

      // Pass the label attributes to the label, if available.
      if ($element
        ->hasProperty('label_attributes')) {
        $label
          ->setAttributes($element
          ->getProperty('label_attributes'));
      }
    }

    // Remove the #field_prefix and #field_suffix values set in
    // template_preprocess_form_element(). These are handled at the input level.
    // @see \Drupal\bootstrap\Plugin\Preprocess\Input::preprocess().
    unset($variables['prefix']);
    unset($variables['suffix']);
  }

}

Members

Namesort descending 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
FormElement::preprocessElement public function Preprocess the variables array if an element is present. Overrides PreprocessBase::preprocessElement
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$theme protected property The currently set theme object.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 1
PreprocessBase::$hook protected property The theme hook invoked.
PreprocessBase::$info protected property The theme hook info array from the theme registry.
PreprocessBase::$variables protected property The Variables object.
PreprocessBase::preprocess public function Preprocess theme hook variables. Overrides PreprocessInterface::preprocess
PreprocessBase::preprocessAttributes protected function Ensures all attributes have been converted to an Attribute object.
PreprocessBase::preprocessDescription protected function Converts any set description variable into a traversable array.
PreprocessBase::preprocessVariables protected function Preprocess the variables array. 15
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.