class DateDataType in Search API 8

Provides a date data type.

Plugin annotation

@SearchApiDataType(
  id = "date",
  label = @Translation("Date"),
  description = @Translation("Represents points in time."),
  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\DateDataType

1 file declares its use of DateDataType

DateDataTypeTest.php in tests/src/Unit/DateDataTypeTest.php

File

src/Plugin/search_api/data_type/DateDataType.php, line 19

Namespace

Drupal\search_api\Plugin\search_api\data_type

class DateDataType extends DataTypePluginBase {

  /**
   * {@inheritdoc}
   */
  public function getValue($value) {
    if ((string) $value === '') {
      return NULL;
    }
    if (is_numeric($value)) {
      return (int) $value;
    }
    $timezone = new \DateTimeZone(DateTimeItemInterface::STORAGE_TIMEZONE);
    $date = new DateTimePlus($value, $timezone);

    // Add in time component if this is a date-only field.
    if (strpos($value, ':') === FALSE) {
      $date
        ->setDefaultDateTime();
    }
    return $date
      ->getTimestamp();
  }

}

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::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
DateDataType::getValue	public	function	Converts a field value to match the data type (if needed). Overrides DataTypePluginBase::getValue
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.