class CheckboxTree in Taxonomy Term Reference Tree Widget 8

Provides a form element for term reference tree.

Plugin annotation

@FormElement("checkbox_tree");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\term_reference_tree\Element\CheckboxTree uses CompositeFormElementTrait

File

src/Element/CheckboxTree.php, line 14

Namespace

Drupal\term_reference_tree\Element

class CheckboxTree extends FormElement {
  use CompositeFormElementTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#tree' => TRUE,
      '#process' => [
        [
          $class,
          'processCheckboxTree',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderCompositeFormElement',
        ],
      ],
      '#default_value' => [],
      '#attached' => [
        'library' => [
          'term_reference_tree/term_reference_tree_js',
          'term_reference_tree/term_reference_tree_css',
        ],
      ],
      '#theme' => 'checkbox_tree',
    ];
  }

  /**
   * Processes a checkboxes form element.
   */
  public static function processCheckboxTree(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = is_array($element['#value']) ? $element['#value'] : [];
    $allowed = [];
    $filter = FALSE;
    if (!empty($element['#max_choices']) && $element['#max_choices'] != '-1') {
      $element['#attached']['drupalSettings'] = [
        'term_reference_tree' => [
          'trees' => [
            $element['#id'] => [
              'max_choices' => $element['#max_choices'],
            ],
          ],
        ],
      ];
    }
    if (!empty($element['#allowed'])) {
      $allowed = $element['#allowed'];
      $filter = TRUE;
    }
    if (empty($element['#options'])) {
      $options_tree = [];
      foreach ($element['#vocabularies'] as $vocabulary) {
        $options = _term_reference_tree_get_term_hierarchy(0, $vocabulary
          ->id(), $allowed, $filter, '', $value);
        $options_tree = array_merge($options_tree, $options);
      }
      $element['#options_tree'] = $options_tree;
      $element['#options'] = _term_reference_tree_get_options($element['#options_tree'], $allowed, $filter);
    }
    $terms = !empty($element['#options_tree']) ? $element['#options_tree'] : [];
    $tree = new \stdClass();
    $tree->children = $terms;
    unset($element['#needs_validation']);
    $element[] = _term_reference_tree_build_level($element, $tree, $form_state, $value, $element['#max_choices'], [], 1);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    $value = [];
    $element += [
      '#default_value' => [],
    ];
    foreach ($element['#default_value'] as $key) {
      if (isset($key['target_id'])) {
        $value[$key['target_id']] = $key['target_id'];
      }
    }
    return $value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CheckboxTree::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
CheckboxTree::processCheckboxTree	public static	function	Processes a checkboxes form element.
CheckboxTree::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	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::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.	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::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.	92
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.	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.