You are here

class WebformTermCheckboxes in Webform 6.x

Same name in this branch
  1. 6.x src/Element/WebformTermCheckboxes.php \Drupal\webform\Element\WebformTermCheckboxes
  2. 6.x src/Plugin/WebformElement/WebformTermCheckboxes.php \Drupal\webform\Plugin\WebformElement\WebformTermCheckboxes
Same name and namespace in other branches
  1. 8.5 src/Element/WebformTermCheckboxes.php \Drupal\webform\Element\WebformTermCheckboxes

Provides a webform element for term checkboxes.

Plugin annotation

@FormElement("webform_term_checkboxes");

Hierarchy

Expanded class hierarchy of WebformTermCheckboxes

1 file declares its use of WebformTermCheckboxes
WebformTermCheckboxes.php in src/Plugin/WebformElement/WebformTermCheckboxes.php

File

src/Element/WebformTermCheckboxes.php, line 13

Namespace

Drupal\webform\Element
View source
class WebformTermCheckboxes extends Checkboxes {
  use WebformTermReferenceTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#vocabulary' => '',
      '#tree_delimiter' => '   ',
      '#breadcrumb' => FALSE,
      '#breadcrumb_delimiter' => ' › ',
      '#scroll' => TRUE,
      '#depth' => NULL,
    ] + parent::getInfo();
  }

  /**
   * {@inheritdoc}
   */
  public static function processCheckboxes(&$element, FormStateInterface $form_state, &$complete_form) {
    static::setOptions($element);
    $element = parent::processCheckboxes($element, $form_state, $complete_form);
    if (!\Drupal::moduleHandler()
      ->moduleExists('taxonomy')) {
      return $element;
    }

    /** @var \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository */
    $entity_repository = \Drupal::service('entity.repository');
    $tree = static::loadTree($element['#vocabulary']);
    if (empty($element['#breadcrumb'])) {
      foreach ($tree as $item) {
        $item = $entity_repository
          ->getTranslationFromContext($item);
        $element[$item
          ->id()]['#title'] = $item
          ->label();
        $element[$item
          ->id()]['#field_prefix'] = str_repeat($element['#tree_delimiter'], $item->depth);
      }
    }
    $element['#attributes']['class'][] = 'js-webform-term-checkboxes';
    $element['#attributes']['class'][] = 'webform-term-checkboxes';
    if (!empty($element['#scroll'])) {
      $element['#attributes']['class'][] = 'webform-term-checkboxes-scroll';
    }
    $element['#attached']['library'][] = 'webform/webform.element.term_checkboxes';
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  protected static function getOptionsTree(array $element, $language) {
    $element += [
      '#tree_delimiter' => '-',
    ];

    /** @var \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository */
    $entity_repository = \Drupal::service('entity.repository');
    $tree = static::loadTree($element['#vocabulary']);
    $options = [];
    foreach ($tree as $item) {

      // Set the item in the correct language for display.
      $item = $entity_repository
        ->getTranslationFromContext($item);
      if (!$item
        ->access('view')) {
        continue;
      }

      // Check depth.
      if (!empty($element['#depth']) && $item->depth >= $element['#depth']) {
        continue;
      }
      $options[$item
        ->id()] = $item
        ->getName();
    }
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Checkboxes::detectEmptyCheckboxes public static function Determines if all checkboxes in a set are unchecked.
Checkboxes::getCheckedCheckboxes public static function Determines which checkboxes were checked when a form is submitted.
Checkboxes::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
CompositeFormElementTrait::preRenderCompositeFormElement public static function Adds form element theming to an element if its title or description is set.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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::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 2
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. 98
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
WebformTermCheckboxes::getInfo public function Returns the element properties for this element. Overrides Checkboxes::getInfo
WebformTermCheckboxes::getOptionsTree protected static function Get options to term tree. Overrides WebformTermReferenceTrait::getOptionsTree
WebformTermCheckboxes::processCheckboxes public static function Processes a checkboxes form element. Overrides Checkboxes::processCheckboxes
WebformTermReferenceTrait::getOptionsBreadcrumb protected static function Get options to term breadcrumb.
WebformTermReferenceTrait::loadTree protected static function Finds all terms in a given vocabulary ID.
WebformTermReferenceTrait::setOptions public static function Set referencable term entities as options for an element.