You are here

Home » API reference » Super Term Reference Autocomplete Widget 8 » SuperTermReferenceAutocomplete.php

class SuperTermReferenceAutocomplete in Super Term Reference Autocomplete Widget 8

Provides an entity autocomplete form element.

The #default_value accepted by this element is either an entity object or an array of entity objects.

Plugin annotation

@FormElement("super_term_reference_autocomplete");

Hierarchy

Expanded class hierarchy of SuperTermReferenceAutocomplete

File

src/Element/SuperTermReferenceAutocomplete.php, line 16

Namespace

Drupal\straw\Element
View source 
class SuperTermReferenceAutocomplete extends EntityAutocomplete {

  /**
   * Gets the term label with its hierarchy.
   *
   * Converts an array of term objects into a string of term labels including
   * the full tree path to the term. This method is also responsible for
   * checking the 'view label' access on the passed-in terms.
   *
   * @param \Drupal\taxonomy\Entity\Term[] $terms
   *   An array of term objects.
   *
   * @return string
   *   A string of term labels separated by commas.
   */
  public static function getEntityLabels(array $terms) {
    $term_labels = [];

    /** @var \Drupal\taxonomy\TermStorage $term_storage */
    $term_storage = \Drupal::entityTypeManager()
      ->getStorage('taxonomy_term');
    foreach ($terms as $term) {

      // Use the special view label, since some entities allow the label to be
      // viewed, even if the entity is not allowed to be viewed.
      $label = t('- Restricted access -');
      if ($term
        ->access('view label')) {

        // For Straw widgets, we want to show the full tree path to the current
        // term rather than just the current term's label.
        $label = $term
          ->label();
        $current = $term;
        while ($parents = $term_storage
          ->loadParents($current
          ->id())) {
          $parent = reset($parents);
          $label = $parent
            ->label() . ' >> ' . $label;
          $current = $parent;
        }
      }

      // Take into account "autocreated" entities.
      if (!$term
        ->isNew()) {
        $label .= ' (' . $term
          ->id() . ')';
      }

      // Labels containing commas or quotes must be wrapped in quotes.
      $term_labels[] = Tags::encode($label);
    }
    return implode(', ', $term_labels);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
EntityAutocomplete::extractEntityIdFromAutocompleteInput public static function Extracts the entity ID from the autocompletion result.
EntityAutocomplete::getInfo public function Returns the element properties for this element. Overrides Textfield::getInfo
EntityAutocomplete::matchEntityByTitle protected static function Finds an entity from an autocomplete input without an explicit ID.
EntityAutocomplete::processEntityAutocomplete public static function Adds entity autocomplete functionality to a form element.
EntityAutocomplete::validateEntityAutocomplete public static function Form element validation handler for entity_autocomplete elements.
EntityAutocomplete::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides Textfield::valueCallback
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.
SuperTermReferenceAutocomplete::getEntityLabels public static function Gets the term label with its hierarchy. Overrides EntityAutocomplete::getEntityLabels
Textfield::preRenderTextfield public static function Prepares a #type 'textfield' render element for input.html.twig.