You are here

Home » API reference » Entity Reference Tree Widget 2.x » EntityReferenceTreeWidget.php

class EntityReferenceTreeWidget in Entity Reference Tree Widget 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldWidget/EntityReferenceTreeWidget.php \Drupal\entity_reference_tree\Plugin\Field\FieldWidget\EntityReferenceTreeWidget

A entity reference tree widget.

Plugin annotation


@FieldWidget(
  id = "entity_reference_tree",
  label = @Translation("Entity reference tree widget"),
  field_types = {
    "entity_reference",
  },
  multiple_values = TRUE
)

Hierarchy

Expanded class hierarchy of EntityReferenceTreeWidget

File

src/Plugin/Field/FieldWidget/EntityReferenceTreeWidget.php, line 22

Namespace

Drupal\entity_reference_tree\Plugin\Field\FieldWidget
View source 
class EntityReferenceTreeWidget extends EntityReferenceAutocompleteWidget {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $arr_element = parent::formElement($items, $delta, $element, $form, $form_state);
    $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
    $form['#attached']['library'][] = 'entity_reference_tree/widget';
    $arr_target = empty($arr_element['target_id']['#selection_settings']['target_bundles']) ? [] : $arr_element['target_id']['#selection_settings']['target_bundles'];
    $str_target_type = $arr_element['target_id']['#target_type'];

    // Target bundle of the entity tree.
    if (empty($arr_target)) {
      $str_target = '*';
    }
    else {
      $str_target = implode(',', $arr_target);
    }

    //The id of the autocomplete text field.

    //To ensure unqiueness when being used within Paragraph entities

    //add the ids of any parent elements as a prefix to the the

    //edit id.
    $parents = $element['#field_parents'];
    $id_prefix = '';
    if (!empty($parents)) {

      //Empty check necessary because implode will return the

      //separator when given an empty array.
      $id_prefix = str_replace('_', '-', implode('-', array_merge($parents))) . '-';
    }

    //Including the delta in the id to follow the Entity Reference module's convention.
    $edit_id = 'edit-' . $id_prefix . str_replace('_', '-', $items
      ->getName()) . '-' . $delta . '-target-id';
    $arr_element['target_id']['#id'] = $edit_id;
    $arr_element['target_id']['#tags'] = TRUE;
    $arr_element['target_id']['#default_value'] = $items
      ->referencedEntities();
    $label = $this
      ->getSetting('label');
    if (!$label) {
      $label = $this
        ->t('@label tree', [
        '@label' => ucfirst(str_replace('_', ' ', $str_target_type)),
      ]);
    }
    else {
      $label = $this
        ->t('@label', [
        '@label' => $label,
      ]);
    }
    $dialog_title = $this
      ->getSetting('dialog_title');
    if (empty($dialog_title)) {
      $dialog_title = $label;
    }
    else {
      $dialog_title = $this
        ->t('@title', [
        '@title' => $dialog_title,
      ]);
    }
    $arr_element['dialog_link'] = [
      '#type' => 'link',
      '#title' => $label,
      '#url' => Url::fromRoute('entity_reference_tree.widget_form', [
        'field_edit_id' => $edit_id,
        'bundle' => $str_target,
        'entity_type' => $str_target_type,
        'theme' => $this
          ->getSetting('theme'),
        'dots' => $this
          ->getSetting('dots'),
        'dialog_title' => $dialog_title,
        'limit' => $this->fieldDefinition
          ->getFieldStorageDefinition()
          ->getCardinality(),
      ]),
      '#attributes' => [
        'class' => [
          'use-ajax',
          'button',
        ],
      ],
    ];
    return $arr_element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    return $values['target_id'];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      // JsTree theme
      'theme' => 'default',
      // Using dot line.
      'dots' => 0,
      // Button label.
      'label' => '',
      // Dialog title.
      'dialog_title' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = [];

    // JsTRee theme.
    $element['theme'] = [
      '#type' => 'radios',
      '#title' => t('JsTree theme'),
      '#default_value' => $this
        ->getSetting('theme'),
      '#required' => TRUE,
      '#options' => array(
        'default' => $this
          ->t('Default'),
        'default-dark' => $this
          ->t('Default Dark'),
      ),
    ];

    // Tree dot.
    $element['dots'] = [
      '#type' => 'radios',
      '#title' => t('Dot line'),
      '#default_value' => $this
        ->getSetting('dots'),
      '#options' => array(
        0 => $this
          ->t('No'),
        1 => $this
          ->t('Yes'),
      ),
    ];

    // Button label.
    $element['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Button label'),
      '#default_value' => $this
        ->getSetting('label'),
    ];
    $element['dialog_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Dialog title'),
      '#default_value' => $this
        ->getSetting('dialog_title'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];

    // JsTree theme.
    $summary[] = t('JsTree theme: @theme', array(
      '@theme' => $this
        ->getSetting('theme'),
    ));

    // Button label.
    if ($label = $this
      ->getSetting('label')) {
      $summary[] = t('Button label: @label', [
        '@label' => $label,
      ]);
    }

    // Dialog title.
    if ($label = $this
      ->getSetting('dialog_title')) {
      $summary[] = t('Dialog title: @title', [
        '@title' => $label,
      ]);
    }
    return $summary;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityReferenceAutocompleteWidget::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetBase::errorElement
EntityReferenceAutocompleteWidget::getAutocreateBundle protected function Returns the name of the bundle which will be used for autocreated entities.
EntityReferenceAutocompleteWidget::getMatchOperatorOptions protected function Returns the options for the match operator.
EntityReferenceAutocompleteWidget::getSelectionHandlerSetting protected function Returns the value of a setting for the entity reference selection handler.
EntityReferenceTreeWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides EntityReferenceAutocompleteWidget::defaultSettings
EntityReferenceTreeWidget::formElement public function Returns the form for a single field widget. Overrides EntityReferenceAutocompleteWidget::formElement
EntityReferenceTreeWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides EntityReferenceAutocompleteWidget::massageFormValues
EntityReferenceTreeWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides EntityReferenceAutocompleteWidget::settingsForm
EntityReferenceTreeWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides EntityReferenceAutocompleteWidget::settingsSummary
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.
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. 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.
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::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::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