class Transliteration in Search API 8

Makes searches insensitive to accents and other non-ASCII characters.

Plugin annotation


@SearchApiProcessor(
  id = "transliteration",
  label = @Translation("Transliteration"),
  description = @Translation("Makes searches insensitive to accents and other non-ASCII characters."),
  stages = {
    "pre_index_save" = 0,
    "preprocess_index" = -20,
    "preprocess_query" = -20
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
    class \Drupal\search_api\Plugin\ConfigurablePluginBase implements ConfigurablePluginInterface uses PluginDependencyTrait
    class \Drupal\search_api\Plugin\IndexPluginBase implements IndexPluginInterface
    class \Drupal\search_api\Processor\ProcessorPluginBase implements ProcessorInterface
    class \Drupal\search_api\Processor\FieldsProcessorPluginBase implements PluginFormInterface, TrustedCallbackInterface uses PluginFormTrait
    class \Drupal\search_api\Plugin\search_api\processor\Transliteration

Expanded class hierarchy of Transliteration

1 file declares its use of Transliteration

TransliterationTest.php in tests/src/Unit/Processor/TransliterationTest.php

File

src/Plugin/search_api/processor/Transliteration.php, line 24

Namespace

Drupal\search_api\Plugin\search_api\processor

View source

class Transliteration extends FieldsProcessorPluginBase {

  /**
   * The transliteration service to use.
   *
   * @var \Drupal\Component\Transliteration\TransliterationInterface
   */
  protected $transliterator;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface|null
   */
  protected $languageManager;

  /**
   * The language to use for transliterating.
   *
   * @var string
   */
  protected $langcode;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var static $processor */
    $processor = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $processor
      ->setTransliterator($container
      ->get('transliteration'));
    $processor
      ->setLanguageManager($container
      ->get('language_manager'));
    $langcode = $processor
      ->getLanguageManager()
      ->getDefaultLanguage()
      ->getId();
    $processor
      ->setLangcode($langcode);
    return $processor;
  }

  /**
   * Retrieves the transliterator.
   *
   * @return \Drupal\Component\Transliteration\TransliterationInterface
   *   The transliterator.
   */
  public function getTransliterator() {
    return $this->transliterator ?: \Drupal::service('transliteration');
  }

  /**
   * Sets the transliterator.
   *
   * @param \Drupal\Component\Transliteration\TransliterationInterface $transliterator
   *   The new transliterator.
   *
   * @return $this
   */
  public function setTransliterator(TransliterationInterface $transliterator) {
    $this->transliterator = $transliterator;
    return $this;
  }

  /**
   * Retrieves the language manager.
   *
   * @return \Drupal\Core\Language\LanguageManagerInterface
   *   The language manager.
   */
  public function getLanguageManager() {
    return $this->languageManager ?: \Drupal::languageManager();
  }

  /**
   * Sets the language manager.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The new language manager.
   *
   * @return $this
   */
  public function setLanguageManager(LanguageManagerInterface $language_manager) {
    $this->languageManager = $language_manager;
    return $this;
  }

  /**
   * Retrieves the langcode.
   *
   * @return string
   *   The langcode.
   */
  public function getLangcode() {
    return $this->langcode ?: $this
      ->getLanguageManager()
      ->getDefaultLanguage()
      ->getId();
  }

  /**
   * Sets the langcode.
   *
   * @param string $langcode
   *   The new langcode.
   *
   * @return $this
   */
  public function setLangcode($langcode) {
    $this->langcode = $langcode;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  protected function process(&$value) {
    $value = $this
      ->getTransliterator()
      ->transliterate($value, $this
      ->getLangcode());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
ConfigurablePluginBase::calculatePluginDependencies Deprecated	protected	function	Calculates and adds dependencies of a specific plugin instance.
ConfigurablePluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurablePluginBase::getDescription	public	function	Returns the plugin's description. Overrides ConfigurablePluginInterface::getDescription
ConfigurablePluginBase::getPluginDependencies Deprecated	protected	function	Calculates and returns dependencies of a specific plugin instance.
ConfigurablePluginBase::label	public	function	Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface::label
ConfigurablePluginBase::moduleHandler Deprecated	protected	function	Wraps the module handler.
ConfigurablePluginBase::onDependencyRemoval	public	function	Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface::onDependencyRemoval	5
ConfigurablePluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	3
ConfigurablePluginBase::themeHandler Deprecated	protected	function	Wraps the theme handler.
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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
FieldsProcessorPluginBase::$dataTypeHelper	protected	property	The data type helper.	1
FieldsProcessorPluginBase::$elementInfoManager	protected	property	The element info manager.
FieldsProcessorPluginBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	5
FieldsProcessorPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurablePluginBase::defaultConfiguration	5
FieldsProcessorPluginBase::getDataTypeHelper	public	function	Retrieves the data type helper.	1
FieldsProcessorPluginBase::getElementInfoManager	public	function	Retrieves the element info manager.
FieldsProcessorPluginBase::preIndexSave	public	function	Preprocesses the search index entity before it is saved. Overrides ProcessorPluginBase::preIndexSave
FieldsProcessorPluginBase::preprocessIndexItems	public	function	Preprocesses search items for indexing. Overrides ProcessorPluginBase::preprocessIndexItems	1
FieldsProcessorPluginBase::preprocessSearchQuery	public	function	Preprocesses a search query. Overrides ProcessorPluginBase::preprocessSearchQuery	2
FieldsProcessorPluginBase::preRenderFieldsCheckboxes	public static	function	Preprocesses the "fields" checkboxes before rendering.
FieldsProcessorPluginBase::processConditions	protected	function	Preprocesses the query conditions.
FieldsProcessorPluginBase::processConditionValue	protected	function	Processes a single condition value.	1
FieldsProcessorPluginBase::processField	protected	function	Processes a single field's value.	3
FieldsProcessorPluginBase::processFieldValue	protected	function	Processes a single text element in a field.	3
FieldsProcessorPluginBase::processKey	protected	function	Processes a single search keyword.	1
FieldsProcessorPluginBase::processKeys	protected	function	Preprocesses the search keywords.
FieldsProcessorPluginBase::setDataTypeHelper	public	function	Sets the data type helper.	1
FieldsProcessorPluginBase::setElementInfoManager	public	function	Sets the element info manager.
FieldsProcessorPluginBase::shouldProcess	protected	function	Determines whether a single value (not an array) should be processed.	1
FieldsProcessorPluginBase::testField	protected	function	Tests whether a certain field should be processed.	1
FieldsProcessorPluginBase::testType	protected	function	Determines whether a field of a certain type should be preprocessed.	4
FieldsProcessorPluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
FieldsProcessorPluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormTrait::validateConfigurationForm	4
IndexPluginBase::$index	protected	property	The index this processor is configured for.
IndexPluginBase::getIndex	public	function	Retrieves the index this plugin is configured for. Overrides IndexPluginInterface::getIndex
IndexPluginBase::setIndex	public	function	Sets the index this plugin is configured for. Overrides IndexPluginInterface::setIndex
IndexPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ConfigurablePluginBase::__construct	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.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler. Aliased as: traitModuleHandler	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler. Aliased as: traitThemeHandler	1
PluginFormTrait::submitConfigurationForm	public	function	Form submission handler.	7
ProcessorInterface::STAGE_ADD_PROPERTIES		constant	Processing stage: add properties.
ProcessorInterface::STAGE_ALTER_ITEMS		constant	Processing stage: alter indexed items.
ProcessorInterface::STAGE_POSTPROCESS_QUERY		constant	Processing stage: postprocess query.
ProcessorInterface::STAGE_PREPROCESS_INDEX		constant	Processing stage: preprocess index.
ProcessorInterface::STAGE_PREPROCESS_QUERY		constant	Processing stage: preprocess query.
ProcessorInterface::STAGE_PRE_INDEX_SAVE		constant	Processing stage: preprocess index.
ProcessorPluginBase::$fieldsHelper	protected	property	The fields helper.	1
ProcessorPluginBase::addFieldValues	public	function	Adds the values of properties defined by this processor to the item. Overrides ProcessorInterface::addFieldValues	8
ProcessorPluginBase::alterIndexedItems	public	function	Alter the items to be indexed. Overrides ProcessorInterface::alterIndexedItems	3
ProcessorPluginBase::ensureField	protected	function	Ensures that a field with certain properties is indexed on the index.
ProcessorPluginBase::findField	protected	function	Finds a certain field in the index.
ProcessorPluginBase::getFieldsHelper	public	function	Retrieves the fields helper.	1
ProcessorPluginBase::getPropertyDefinitions	public	function	Retrieves the properties this processor defines for the given datasource. Overrides ProcessorInterface::getPropertyDefinitions	8
ProcessorPluginBase::getWeight	public	function	Returns the weight for a specific processing stage. Overrides ProcessorInterface::getWeight
ProcessorPluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginBase::isHidden
ProcessorPluginBase::isLocked	public	function	Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::postprocessSearchResults	public	function	Postprocess search results before they are returned by the query. Overrides ProcessorInterface::postprocessSearchResults	2
ProcessorPluginBase::requiresReindexing	public	function	Determines whether re-indexing is required after a settings change. Overrides ProcessorInterface::requiresReindexing
ProcessorPluginBase::setFieldsHelper	public	function	Sets the fields helper.	1
ProcessorPluginBase::setWeight	public	function	Sets the weight for a specific processing stage. Overrides ProcessorInterface::setWeight
ProcessorPluginBase::supportsIndex	public static	function	Checks whether this processor is applicable for a certain index. Overrides ProcessorInterface::supportsIndex	8
ProcessorPluginBase::supportsStage	public	function	Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage	2
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.
Transliteration::$langcode	protected	property	The language to use for transliterating.
Transliteration::$languageManager	protected	property	The language manager.
Transliteration::$transliterator	protected	property	The transliteration service to use.
Transliteration::create	public static	function	Creates an instance of the plugin. Overrides FieldsProcessorPluginBase::create
Transliteration::getLangcode	public	function	Retrieves the langcode.
Transliteration::getLanguageManager	public	function	Retrieves the language manager.
Transliteration::getTransliterator	public	function	Retrieves the transliterator.
Transliteration::process	protected	function	Processes a single string value. Overrides FieldsProcessorPluginBase::process
Transliteration::setLangcode	public	function	Sets the langcode.
Transliteration::setLanguageManager	public	function	Sets the language manager.
Transliteration::setTransliterator	public	function	Sets the transliterator.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class Transliteration in Search API 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation