class TextDataType in Search API 8
Provides a full text data type.
This data type uses objects of type \Drupal\search_api\Plugin\search_api\data_type\value\TextValueInterface for its values.
The same is expected of all data types that specify this type as their fallback.
Plugin annotation
@SearchApiDataType(
id = "text",
label = @Translation("Fulltext"),
description = @Translation("Fulltext fields are analyzed fields which are made available for fulltext search. This data type should be used for any fields (usually with free text input by users) which you want to search for individual words."),
default = "true"
)
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\DataType\DataTypePluginBase implements DataTypeInterface
- class \Drupal\search_api\Plugin\search_api\data_type\TextDataType
- class \Drupal\search_api\DataType\DataTypePluginBase implements DataTypeInterface
- class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of TextDataType
See also
\Drupal\search_api\Plugin\search_api\data_type\value\TextValueInterface
File
- src/
Plugin/ search_api/ data_type/ TextDataType.php, line 27
Namespace
Drupal\search_api\Plugin\search_api\data_typeView source
class TextDataType extends DataTypePluginBase {
/**
* {@inheritdoc}
*/
public function getValue($value) {
return new TextValue((string) $value);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DataTypePluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
DataTypePluginBase:: |
public | function |
Returns the description of the data type. Overrides DataTypeInterface:: |
|
DataTypePluginBase:: |
public | function |
Returns the fallback default data type for this data type. Overrides DataTypeInterface:: |
1 |
DataTypePluginBase:: |
public | function |
Determines whether this data type is a default data type. Overrides DataTypeInterface:: |
|
DataTypePluginBase:: |
public | function |
Returns the label of the data type. Overrides DataTypeInterface:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
HideablePluginBase:: |
public | function |
Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface:: |
1 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TextDataType:: |
public | function |
Converts a field value to match the data type (if needed). Overrides DataTypePluginBase:: |