class SearchApiDataType in Search API 8

Defines a Search API data type annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\search_api\Annotation\SearchApiDataType

See also

\Drupal\search_api\DataType\DataTypePluginManager

\Drupal\search_api\DataType\DataTypeInterface

\Drupal\search_api\DataType\DataTypePluginBase

Plugin API

10 classes are annotated with SearchApiDataType

AlteringValueTestDataType in tests/search_api_test/src/Plugin/search_api/data_type/AlteringValueTestDataType.php

Provides a dummy data type for testing purposes.

BooleanDataType in src/Plugin/search_api/data_type/BooleanDataType.php

Provides a boolean data type.

DateDataType in src/Plugin/search_api/data_type/DateDataType.php

Provides a date data type.

DecimalDataType in src/Plugin/search_api/data_type/DecimalDataType.php

Provides a decimal data type.

IntegerDataType in src/Plugin/search_api/data_type/IntegerDataType.php

Provides an integer data type.

... See full list

File

src/Annotation/SearchApiDataType.php, line 17

Namespace

Drupal\search_api\Annotation

class SearchApiDataType extends Plugin {

  /**
   * The data type plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the data type plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The description of the data type.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * Whether this is one of the default data types provided by the Search API.
   *
   * @var bool
   */
  public $default = FALSE;

  /**
   * The ID of the fallback data type for this data type.
   *
   * Needs to be one of the default data types defined in the Search API itself.
   *
   * @var string
   */
  public $fallback_type = 'string';

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
SearchApiDataType::$default	public	property	Whether this is one of the default data types provided by the Search API.
SearchApiDataType::$description	public	property	The description of the data type.
SearchApiDataType::$fallback_type	public	property	The ID of the fallback data type for this data type.
SearchApiDataType::$id	public	property	The data type plugin ID.
SearchApiDataType::$label	public	property	The human-readable name of the data type plugin.