You are here

Home » API reference » Client-side Hierarchical Select 8.3 » CshsWidget.php

class CshsWidget in Client-side Hierarchical Select 8.3

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldWidget/CshsWidget.php \Drupal\cshs\Plugin\Field\FieldWidget\CshsWidget
  2. 8.2 src/Plugin/Field/FieldWidget/CshsWidget.php \Drupal\cshs\Plugin\Field\FieldWidget\CshsWidget

Provides "cshs" field widget.

Plugin annotation


@FieldWidget(
  id = "cshs",
  label = @Translation("Client-side hierarchical select"),
  field_types = {
    "entity_reference",
  },
)

Hierarchy

Expanded class hierarchy of CshsWidget

File

src/Plugin/Field/FieldWidget/CshsWidget.php, line 25

Namespace

Drupal\cshs\Plugin\Field\FieldWidget
View source 
class CshsWidget extends WidgetBase {
  use IsApplicable {
    isApplicable as helperIsApplicable;
  }
  use CshsOptionsFromHelper {
    defaultSettings as helperDefaultSettings;
    settingsSummary as helperSettingsSummary;
    settingsForm as helperSettingsForm;
    formElement as helperFormElement;
  }

  /**
   * The field widget settings across all bundles of the entity type.
   *
   * @var array[]|null
   */
  protected $perDisplaySettings;

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) : bool {
    if (static::helperIsApplicable($field_definition)) {

      /* @see \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection */
      if (!empty($field_definition
        ->getSettings()['handler_settings']['target_bundles'] ?? [])) {
        return TRUE;
      }
      \Drupal::messenger()
        ->addWarning(\t('The client-side hierarchical select widget cannot be used for the %field because it is not using the default entity reference selection handler or has no taxonomy vocabularies selected. If you are aimed to use the CSHS widget for the %label field, please configure it accordingly or ignore this warning as its purpose to let site builders know why the CSHS widget is not an option for this taxonomy reference field.', [
        '%label' => $field_definition
          ->getLabel(),
        // Some fields have no IDs and only names.
        '%field' => \str_replace('.', ' -> ', \method_exists($field_definition, 'id') ? $field_definition
          ->id() : $field_definition
          ->getName()),
      ]));
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() : array {

    /* @noinspection AdditionOperationOnArraysInspection */
    return static::helperDefaultSettings() + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function getSettings() : array {
    $this->settings = parent::getSettings();
    if (empty($this->settings['save_lineage'])) {

      // If the `save_lineage` is enabled for the entity type it
      // can no longer be disabled unless the storage is empty.
      foreach ($this
        ->getPerDisplaySettings() as $display_settings) {
        if (!empty($display_settings['save_lineage'])) {
          $this->settings['save_lineage'] = $display_settings['save_lineage'];
          break;
        }
      }
    }
    return $this->settings;
  }

  /**
   * {@inheritdoc}
   */
  public function getSetting($key) {
    return $this
      ->getSettings()[$key] ?? NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() : array {
    return $this
      ->helperSettingsSummary();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) : array {
    return $this
      ->helperSettingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) : array {
    $element['target_id'] = \array_merge($element, $this
      ->helperFormElement(), [
      '#label' => $this->fieldDefinition
        ->getLabel(),
    ]);
    if ($items
      ->isEmpty()) {
      return $element;
    }
    if ($this
      ->handlesMultipleValues()) {
      $element['target_id']['#default_value'] = \array_map(static function (array $item) : int {
        return $item['target_id'];
      }, $items
        ->getValue());
    }
    else {
      $element['target_id']['#default_value'] = $items
        ->get($delta)->target_id ?? NULL;
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) : array {

    // This is the case when `$this->handlesMultipleValues()` returns `TRUE`.
    if (!empty($values['target_id']) && \is_array($values['target_id'])) {
      $list = [];
      foreach ($values['target_id'] as $id) {
        $list[] = [
          'target_id' => $id,
        ];
      }
      return $list;
    }
    return parent::massageFormValues($values, $form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function getVocabulariesIds() : array {
    return $this->fieldDefinition
      ->getSettings()['handler_settings']['target_bundles'] ?? [];
  }

  /**
   * {@inheritdoc}
   */
  protected function handlesMultipleValues() : bool {
    return (bool) $this
      ->getSetting('save_lineage');
  }

  /**
   * Returns the per display widget settings for the entity type.
   *
   * @return array[]
   *   The per display widget settings.
   */
  protected function getPerDisplaySettings() : array {
    if ($this->perDisplaySettings === NULL) {
      $this->perDisplaySettings = [];
      $field_name = $this->fieldDefinition
        ->getName();

      // Load all form displays for the entity type the field is attached to.
      $form_displays = $this
        ->getStorage('entity_form_display')
        ->loadByProperties([
        'targetEntityType' => $this->fieldDefinition
          ->getTargetEntityTypeId(),
      ]);
      foreach ($form_displays as $form_display) {
        \assert($form_display instanceof EntityFormDisplay);
        if (($widget = $form_display
          ->getComponent($field_name)) && CshsElement::ID === ($widget['type'] ?? '')) {
          $this->perDisplaySettings[] = $widget['settings'] ?? [];
        }
      }
    }
    return $this->perDisplaySettings;
  }

}

Members

Namesort descending 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.
CshsOptionsFromHelper::defaultSettings public static function Defines the default settings for this plugin. Aliased as: helperDefaultSettings
CshsOptionsFromHelper::formElement public function Returns the form for a single widget. Aliased as: helperFormElement
CshsOptionsFromHelper::getOptions private function Returns the list of options for `cshs` element.
CshsOptionsFromHelper::getTranslatedLevelLabels private function Returns the translated labels with escaped markup.
CshsOptionsFromHelper::getTranslatedNoneLabel private function Returns the translated label for the "no selection" option.
CshsOptionsFromHelper::getTranslatedValue private function Returns the translated label.
CshsOptionsFromHelper::getVocabularies public function Returns the taxonomy vocabularies to work with.
CshsOptionsFromHelper::settingsForm public function Returns a form to configure settings. Aliased as: helperSettingsForm
CshsOptionsFromHelper::settingsSummary public function Returns a short summary for the settings. Aliased as: helperSettingsSummary
CshsOptionsFromHelper::validateSettingsForm public function Validates the settings form.
CshsWidget::$perDisplaySettings protected property The field widget settings across all bundles of the entity type.
CshsWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
CshsWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
CshsWidget::getPerDisplaySettings protected function Returns the per display widget settings for the entity type.
CshsWidget::getSetting public function Returns the value of a setting, or its default value if absent. Overrides CshsOptionsFromHelper::getSetting
CshsWidget::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides CshsOptionsFromHelper::getSettings
CshsWidget::getVocabulariesIds public function Returns the list of taxonomy vocabularies IDs to work with. Overrides CshsOptionsFromHelper::getVocabulariesIds
CshsWidget::handlesMultipleValues protected function Returns whether the widget handles multiple values. Overrides WidgetBase::handlesMultipleValues
CshsWidget::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
CshsWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
CshsWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
CshsWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
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
IsApplicable::isApplicable public static function Aliased as: helperIsApplicable
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::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.
TaxonomyStorages::$entityRepository protected property An instance of the "entity.repository" service.
TaxonomyStorages::$entityTypeManager protected property An instance of the "entity_type.manager" service.
TaxonomyStorages::$needsTranslatedContent private property The state of whether content translation should be used.
TaxonomyStorages::getStorage private function Returns the entity storage.
TaxonomyStorages::getTermStorage protected function Returns storage of the "taxonomy_term" entities. 1
TaxonomyStorages::getTranslationFromContext protected function Returns the entity translation to be used in the given context.
TaxonomyStorages::getVocabularyStorage protected function Returns storage of the "taxonomy_vocabulary" entities. 1
TaxonomyStorages::needsTranslatedContent protected function Returns the state of whether content translation needed.
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::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