SearchApiDataType.php in Search API 8

Namespace

Drupal\search_api\Annotation

File

src/Annotation/SearchApiDataType.php

<?php

namespace Drupal\search_api\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines a Search API data type annotation object.
 *
 * @see \Drupal\search_api\DataType\DataTypePluginManager
 * @see \Drupal\search_api\DataType\DataTypeInterface
 * @see \Drupal\search_api\DataType\DataTypePluginBase
 * @see plugin_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';

}

Classes

Name	Description
SearchApiDataType	Defines a Search API data type annotation object.