abstract class DataTypePluginBase in Search API 8

Defines a base class from which other data type classes may extend.

Plugins extending this class need to define a plugin definition array through annotation. These definition arrays may be altered through hook_search_api_data_type_info_alter(). The definition includes the following keys:

id: The unique, system-wide identifier of the data type class.
label: The human-readable name of the data type class, translated.
description: A human-readable description for the data type class, translated.
fallback_type: (optional) The fallback data type for this data type. Needs to be one of the default data types defined in the Search API itself. Defaults to "string".

A complete plugin definition should be written as in this example:


@SearchApiDataType(
  id = "my_data_type",
  label = @Translation("My data type"),
  description = @Translation("Some information about my data type"),
  fallback_type = "string"
)

Search API comes with a couple of default data types. These have an extra "default" property in the annotation. It is not allowed for custom data type plugins to set this property.

View source

abstract class DataTypePluginBase extends HideablePluginBase implements DataTypeInterface {

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

  /**
   * {@inheritdoc}
   */
  public function getValue($value) {
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function getFallbackType() {
    return $this->pluginDefinition['fallback_type'] ?? 'string';
  }

  /**
   * {@inheritdoc}
   */
  public function isDefault() {
    return !empty($this->pluginDefinition['default']);
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    $plugin_definition = $this
      ->getPluginDefinition();
    return $plugin_definition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $plugin_definition = $this
      ->getPluginDefinition();
    return $plugin_definition['description'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DataTypePluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DataTypePluginBase::getDescription	public	function	Returns the description of the data type. Overrides DataTypeInterface::getDescription
DataTypePluginBase::getFallbackType	public	function	Returns the fallback default data type for this data type. Overrides DataTypeInterface::getFallbackType	1
DataTypePluginBase::getValue	public	function	Converts a field value to match the data type (if needed). Overrides DataTypeInterface::getValue	7
DataTypePluginBase::isDefault	public	function	Determines whether this data type is a default data type. Overrides DataTypeInterface::isDefault
DataTypePluginBase::label	public	function	Returns the label of the data type. Overrides DataTypeInterface::label
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
HideablePluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface::isHidden	1
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
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.

You are here

abstract class DataTypePluginBase in Search API 8

Hierarchy

See also

File

Namespace

Members

API Navigation