class TermReferenceTree in Taxonomy Term Reference Tree Widget 8

Same name in this branch

8 src/Plugin/Field/FieldFormatter/TermReferenceTree.php \Drupal\term_reference_tree\Plugin\Field\FieldFormatter\TermReferenceTree
8 src/Plugin/Field/FieldWidget/TermReferenceTree.php \Drupal\term_reference_tree\Plugin\Field\FieldWidget\TermReferenceTree

Plugin implementation of the 'term_reference_tree' widget.

Plugin annotation


@FieldWidget(
  id = "term_reference_tree",
  label = @Translation("Term reference tree"),
  field_types = {"entity_reference"},
  multiple_values = TRUE
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\term_reference_tree\Plugin\Field\FieldWidget\TermReferenceTree

Expanded class hierarchy of TermReferenceTree

1 file declares its use of TermReferenceTree

term_reference_tree.module in ./term_reference_tree.module

File

src/Plugin/Field/FieldWidget/TermReferenceTree.php, line 21

Namespace

Drupal\term_reference_tree\Plugin\Field\FieldWidget

View source

class TermReferenceTree extends WidgetBase {
  const CASCADING_SELECTION_NONE = '0';
  const CASCADING_SELECTION_BOTH = '1';
  const CASCADING_SELECTION_SELECT = '2';
  const CASCADING_SELECTION_DESELECT = '3';

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'start_minimized' => TRUE,
      'leaves_only' => FALSE,
      'select_parents' => FALSE,
      'cascading_selection' => self::CASCADING_SELECTION_NONE,
      'max_depth' => 0,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['start_minimized'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Start minimized'),
      '#description' => $this
        ->t('Make the tree appear minimized on the form by default'),
      '#default_value' => $this
        ->getSetting('start_minimized'),
    ];
    $form['leaves_only'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Leaves only'),
      '#description' => $this
        ->t("Don't allow the user to select items that have children"),
      '#default_value' => $this
        ->getSetting('leaves_only'),
      '#return_value' => 1,
    ];
    $form['select_parents'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Select parents automatically'),
      '#description' => $this
        ->t("When turned on, this option causes the widget to automatically select the ancestors of all selected items. In Leaves Only mode, the parents will be added invisibly to the selected value.  <em>This option is only valid if an unlimited number of values can be selected.</em>"),
      '#default_value' => $this
        ->getSetting('select_parents'),
      '#return_value' => 1,
    ];
    $form['cascading_selection'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Cascading selection'),
      '#description' => $this
        ->t('On parent selection, automatically select children if none were selected. Some may then be manually unselected. In the same way, on parent unselection, unselect children if all were selected. <em>This option is only valid if an unlimited number of values can be selected.</em>'),
      '#default_value' => $this
        ->getSetting('cascading_selection'),
      '#options' => [
        self::CASCADING_SELECTION_NONE => $this
          ->t('None'),
        self::CASCADING_SELECTION_BOTH => $this
          ->t('Select / deselect'),
        self::CASCADING_SELECTION_SELECT => $this
          ->t('Only select'),
        self::CASCADING_SELECTION_DESELECT => $this
          ->t('Only deselect'),
      ],
    ];
    if ($this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality() !== FieldStorageConfig::CARDINALITY_UNLIMITED) {
      $form['select_parents']['#disabled'] = TRUE;
      $form['select_parents']['#default_value'] = FALSE;
      $form['select_parents']['#description'] .= ' <em>' . $this
        ->t("This option is only valid if an unlimited number of values can be selected.") . '</em>';
      $form['cascading_selection']['#disabled'] = TRUE;
      $form['cascading_selection']['#default_value'] = self::CASCADING_SELECTION_NONE;
      $form['cascading_selection']['#description'] .= ' <em>' . $this
        ->t("This option is only valid if an unlimited number of values can be selected.") . '</em>';
    }
    $form['max_depth'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum Depth'),
      '#description' => $this
        ->t("Only show items up to this many levels deep."),
      '#default_value' => $this
        ->getSetting('max_depth'),
      '#min' => 0,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('start_minimized')) {
      $summary[] = $this
        ->t('Start minimized');
    }
    if ($this
      ->getSetting('leaves_only')) {
      $summary[] = $this
        ->t('Leaves only');
    }
    if ($this
      ->getSetting('select_parents')) {
      $summary[] = $this
        ->t('Select parents automatically');
    }
    $cascadingSelection = $this
      ->getSetting('cascading_selection');
    if ($cascadingSelection == self::CASCADING_SELECTION_BOTH) {
      $summary[] = $this
        ->t('Cascading selection');
    }
    elseif ($cascadingSelection == self::CASCADING_SELECTION_SELECT) {
      $summary[] = sprintf('%s (%s)', $this
        ->t('Cascading selection'), $this
        ->t('Only select'));
    }
    elseif ($cascadingSelection == self::CASCADING_SELECTION_DESELECT) {
      $summary[] = sprintf('%s (%s)', $this
        ->t('Cascading selection'), $this
        ->t('Only deselect'));
    }
    if ($this
      ->getSetting('max_depth')) {
      $summary[] = $this
        ->formatPlural($this
        ->getSetting('max_depth'), 'Maximum Depth: @count level', 'Maximum Depth: @count levels');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $handler_settings = $this
      ->getFieldSetting('handler_settings');
    $vocabularies = Vocabulary::loadMultiple($handler_settings['target_bundles']);
    $element['#type'] = 'checkbox_tree';
    $element['#default_value'] = $items
      ->getValue();
    $element['#vocabularies'] = $vocabularies;
    $element['#max_choices'] = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality();
    $element['#leaves_only'] = $this
      ->getSetting('leaves_only');
    $element['#select_parents'] = $this
      ->getSetting('select_parents');
    $element['#cascading_selection'] = $this
      ->getSetting('cascading_selection');
    $element['#value_key'] = 'target_id';
    $element['#max_depth'] = $this
      ->getSetting('max_depth');
    $element['#start_minimized'] = $this
      ->getSetting('start_minimized');
    $element['#element_validate'] = [
      [
        get_class($this),
        'validateTermReferenceTreeElement',
      ],
    ];
    return $element;
  }

  /**
   * Form element validation handler for term reference form widget.
   */
  public static function validateTermReferenceTreeElement(&$element, FormStateInterface $form_state) {
    $items = _term_reference_tree_flatten($element, $form_state);
    $value = [];
    if ($element['#max_choices'] != 1) {
      foreach ($items as $child) {
        if (!empty($child['#value'])) {

          // If the element is leaves only and select parents is on,
          // then automatically add all the parents of each selected value.
          if (!empty($element['#select_parents']) && !empty($element['#leaves_only'])) {
            foreach ($child['#parent_values'] as $parent_tid) {
              if (!in_array([
                $element['#value_key'] => $parent_tid,
              ], $value)) {
                array_push($value, [
                  $element['#value_key'] => $parent_tid,
                ]);
              }
            }
          }
          array_push($value, [
            $element['#value_key'] => $child['#value'],
          ]);
        }
      }
    }
    else {

      // If it's a tree of radio buttons, they all have the same value,
      // so we can just grab the value of the first one.
      if (count($items) > 0) {
        $child = reset($items);
        if (!empty($child['#value'])) {
          array_push($value, [
            $element['#value_key'] => $child['#value'],
          ]);
        }
      }
    }
    if ($element['#required'] && empty($value)) {
      $form_state
        ->setError($element, t('%name field is required.', [
        '%name' => $element['#title'],
      ]));
    }
    $form_state
      ->setValueForElement($element, $value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedTagsXssTrait::allowedTags	public	function	Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags	public	function	Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss	public	function	Filters an HTML string to prevent XSS vulnerabilities.
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
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.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
TermReferenceTree::CASCADING_SELECTION_BOTH		constant
TermReferenceTree::CASCADING_SELECTION_DESELECT		constant
TermReferenceTree::CASCADING_SELECTION_NONE		constant
TermReferenceTree::CASCADING_SELECTION_SELECT		constant
TermReferenceTree::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TermReferenceTree::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
TermReferenceTree::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
TermReferenceTree::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
TermReferenceTree::validateTermReferenceTreeElement	public static	function	Form element validation handler for term reference form widget.
WidgetBase::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::afterBuild	public static	function	After-build handler for field elements in a form.
WidgetBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	5
WidgetBase::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
WidgetBase::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues	2
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
WidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values.	1
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable	4
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct	public	function	Constructs a WidgetBase object. Overrides PluginBase::__construct	5

You are here

class TermReferenceTree in Taxonomy Term Reference Tree Widget 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation