You are here

Home » API reference » Glossify 8 » TaxonomyTooltip.php

class TaxonomyTooltip in Glossify 8

Filter to find and process found taxonomy terms in the fields value.

Plugin annotation


@Filter(
  id = "glossify_taxonomy",
  title = @Translation("Tooltips with taxonomy"),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_HTML_RESTRICTOR,
  settings = {
    "glossify_taxonomy_case_sensitivity" = TRUE,
    "glossify_taxonomy_first_only" = TRUE,
    "glossify_taxonomy_type" = "tooltips",
    "glossify_taxonomy_vocabs" = NULL,
    "glossify_taxonomy_urlpattern" = "/taxonomy/term/[id]",
  },
  weight = -10
)

Hierarchy

Expanded class hierarchy of TaxonomyTooltip

File

modules/glossify_taxonomy/src/Plugin/Filter/TaxonomyTooltip.php, line 27

Namespace

Drupal\glossify_taxonomy\Plugin\Filter
View source 
class TaxonomyTooltip extends GlossifyBase {

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $vocab_options = [];
    $vocabularies = Vocabulary::loadMultiple();
    foreach ($vocabularies as $vocab) {
      $vocab_options[$vocab
        ->id()] = $vocab
        ->get('name');
    }
    $form['glossify_taxonomy_case_sensitivity'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Case sensitive'),
      '#description' => $this
        ->t('Whether or not the match is case sensitive.'),
      '#default_value' => $this->settings['glossify_taxonomy_case_sensitivity'],
    ];
    $form['glossify_taxonomy_first_only'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('First match only'),
      '#description' => $this
        ->t('Match and link only the first occurance per field.'),
      '#default_value' => $this->settings['glossify_taxonomy_first_only'],
    ];
    $form['glossify_taxonomy_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Type'),
      '#required' => TRUE,
      '#options' => [
        'tooltips' => $this
          ->t('Tooltips'),
        'links' => $this
          ->t('Links'),
        'tooltips_links' => $this
          ->t('Tooltips and links'),
      ],
      '#description' => $this
        ->t('How to show matches in content. Description as HTML5 tooltip (abbr element), link to description or both.'),
      '#default_value' => $this->settings['glossify_taxonomy_type'],
    ];
    $form['glossify_taxonomy_vocabs'] = [
      '#type' => 'checkboxes',
      '#multiple' => TRUE,
      '#element_validate' => [
        [
          get_class($this),
          'validateTaxonomyVocabs',
        ],
      ],
      '#title' => $this
        ->t('Taxonomy vocabularies'),
      '#description' => $this
        ->t('Select the taxonomy vocabularies you want to use term names from to link their term page.'),
      '#options' => $vocab_options,
      '#default_value' => explode(';', $this->settings['glossify_taxonomy_vocabs']),
    ];
    $form['glossify_taxonomy_urlpattern'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('URL pattern'),
      '#description' => $this
        ->t('Url pattern, used for linking matched words. Accepts "[id]" as token. Example: "/taxonomy/term/[id]"'),
      '#default_value' => $this->settings['glossify_taxonomy_urlpattern'],
    ];
    return $form;
  }

  /**
   * Validation callback for glossify_taxonomy_vocabs.
   *
   * Make the field required if the filter is enabled.
   *
   * @param array $element
   *   The element being processed.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   */
  public static function validateTaxonomyVocabs(&$element, FormStateInterface $form_state, &$complete_form) {
    $values = $form_state
      ->getValues();

    // Make taxonomy_vocabs required if the filter is enabled.
    if (!empty($values['filters']['glossify_taxonomy']['status'])) {
      $field_values = array_filter($values['filters']['glossify_taxonomy']['settings']['glossify_taxonomy_vocabs']);
      if (empty($field_values)) {
        $element['#required'] = TRUE;
        $form_state
          ->setError($element, t('%field is required.', [
          '%field' => $element['#title'],
        ]));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {

    // Get vocabularies.
    $vocabs = explode(';', $this->settings['glossify_taxonomy_vocabs']);

    // Let other modules override $vocabs.
    \Drupal::moduleHandler()
      ->alter('glossify_taxonomy_vocabs', $vocabs);
    if (count($vocabs)) {
      $terms = [];

      // Get taxonomyterm data.
      $query = \Drupal::database()
        ->select('taxonomy_term_field_data', 'tfd');
      $query
        ->addfield('tfd', 'tid', 'id');
      $query
        ->addfield('tfd', 'name');
      $query
        ->addfield('tfd', 'name', 'name_norm');
      $query
        ->addField('tfd', 'description__value', 'tip');
      $query
        ->condition('tfd.vid', $vocabs, 'IN');
      $query
        ->condition('tfd.langcode', $langcode);
      $query
        ->orderBy('name_norm', 'DESC');
      $results = $query
        ->execute()
        ->fetchAllAssoc('name_norm');

      // Build terms array.
      foreach ($results as $result) {

        // Make name_norm lowercase, it seems not possible in PDO query?
        if (!$this->settings['glossify_taxonomy_case_sensitivity']) {
          $result->name_norm = strtolower($result->name_norm);
        }
        $terms[$result->name_norm] = $result;
      }

      // Process text.
      if (count($terms) > 0) {
        $text = $this
          ->parseTooltipMatch($text, $terms, $this->settings['glossify_taxonomy_case_sensitivity'], $this->settings['glossify_taxonomy_first_only'], $this->settings['glossify_taxonomy_type'], $this->settings['glossify_taxonomy_urlpattern']);
      }
    }
    return new FilterProcessResult($text);
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    if (isset($configuration['status'])) {
      $this->status = (bool) $configuration['status'];
    }
    if (isset($configuration['weight'])) {
      $this->weight = (int) $configuration['weight'];
    }
    if (isset($configuration['settings'])) {

      // Workaround for not accepting arrays in config schema.
      if (is_array($configuration['settings']['glossify_taxonomy_vocabs'])) {
        $glossify_taxonomy_vocabs = array_filter($configuration['settings']['glossify_taxonomy_vocabs']);
        $configuration['settings']['glossify_taxonomy_vocabs'] = implode(';', $glossify_taxonomy_vocabs);
      }
      $this->settings = (array) $configuration['settings'];
    }
    return $this;
  }

}

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
FilterBase::$provider public property The name of the provider that owns this filter.
FilterBase::$settings public property An associative array containing the configured settings of this filter.
FilterBase::$status public property A Boolean indicating whether this filter is enabled.
FilterBase::$weight public property The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
FilterBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription public function Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions public function Returns HTML allowed by this filter's configuration. Overrides FilterInterface::getHTMLRestrictions 4
FilterBase::getLabel public function Returns the administrative label for this filter plugin. Overrides FilterInterface::getLabel
FilterBase::getType public function Returns the processing type of this filter plugin. Overrides FilterInterface::getType
FilterBase::prepare public function Prepares the text for processing. Overrides FilterInterface::prepare
FilterBase::tips public function Generates a filter's tip. Overrides FilterInterface::tips 9
FilterBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 4
FilterInterface::TYPE_HTML_RESTRICTOR constant HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE constant Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE constant Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE constant Reversible transformation filters.
GlossifyBase::currentPath protected function Get current path. 1
GlossifyBase::parseTooltipMatch protected function Convert terms in text to links.
GlossifyBase::renderLink protected function Render link for found match. 1
GlossifyBase::renderTip protected function Render tip for found match. 1
GlossifyBase::sanitizeTip private function Cleanup and truncate tip text.
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.
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.
TaxonomyTooltip::process public function Performs the filter processing. Overrides FilterInterface::process
TaxonomyTooltip::setConfiguration public function Sets the configuration for this plugin instance. Overrides FilterBase::setConfiguration
TaxonomyTooltip::settingsForm public function Generates a filter's settings form. Overrides FilterBase::settingsForm
TaxonomyTooltip::validateTaxonomyVocabs public static function Validation callback for glossify_taxonomy_vocabs.