class StringDataType in Search API 8
Provides a string data type.
Plugin annotation
@SearchApiDataType(
id = "string",
label = @Translation("String"),
description = @Translation("String fields are used for short, keyword-like character strings where you only want to find complete field values, not 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\StringDataType
- 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 StringDataType
File
- src/
Plugin/ search_api/ data_type/ StringDataType.php, line 17
Namespace
Drupal\search_api\Plugin\search_api\data_typeView source
class StringDataType extends DataTypePluginBase {
/**
* {@inheritdoc}
*/
public function getValue($value) {
return (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 |
StringDataType:: |
public | function |
Converts a field value to match the data type (if needed). Overrides DataTypePluginBase:: |
|
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. |