You are here

Home » API reference » Search API 8

Classes, traits, and interfaces in Search API 8

Primary tabs

Namesort descending Type Namespace Location Description Direct uses Use statements Strings
ContentEntityTaskManager class Drupal\search_api\Plugin\search_api\datasource src/Plugin/search_api/datasource/ContentEntityTaskManager.php Provides a service for managing pending tracking tasks for datasources. 2
ContentEntityTrackingManager class Drupal\search_api\Plugin\search_api\datasource src/Plugin/search_api/datasource/ContentEntityTrackingManager.php Provides hook implementations on behalf of the Content Entity datasource. 2
CustomDataTypesTest class Drupal\Tests\search_api\Kernel\System tests/src/Kernel/System/CustomDataTypesTest.php Tests custom data types integration.
Database class Drupal\search_api_db\Plugin\search_api\backend modules/search_api_db/src/Plugin/search_api/backend/Database.php Indexes and searches items using the database. 2
DatabaseCompatibilityHandlerInterface interface Drupal\search_api_db\DatabaseCompatibility modules/search_api_db/src/DatabaseCompatibility/DatabaseCompatibilityHandlerInterface.php Bundles methods for resolving DBMS-specific differences. 1 1
DatabaseTestsTrait trait Drupal\search_api_db\Tests modules/search_api_db/src/Tests/DatabaseTestsTrait.php Provides some common helper methods for database tests. 2
DatasourceInterface interface Drupal\search_api\Datasource src/Datasource/DatasourceInterface.php Describes a source for search items. 2 25
DatasourcePluginBase abstract class Drupal\search_api\Datasource src/Datasource/DatasourcePluginBase.php Defines a base class from which other datasources may extend. 3 3
DatasourcePluginManager class Drupal\search_api\Datasource src/Datasource/DatasourcePluginManager.php Manages datasource plugins. 1 2
DatasourceTaskTest class Drupal\Tests\search_api\Kernel\Datasource tests/src/Kernel/Datasource/DatasourceTaskTest.php Tests task integration of the content entity datasource.
DataTypeHelper class Drupal\search_api\Utility src/Utility/DataTypeHelper.php Provides helper methods for dealing with Search API data types. 2 2
DataTypeHelperInterface interface Drupal\search_api\Utility src/Utility/DataTypeHelperInterface.php Provides an interface for implementations of the data type helper service. 1 6
DataTypeInterface interface Drupal\search_api\DataType src/DataType/DataTypeInterface.php Defines an interface for data type plugins. 1 2
DataTypePluginBase abstract class Drupal\search_api\DataType src/DataType/DataTypePluginBase.php Defines a base class from which other data type classes may extend. 10 10
DataTypePluginManager class Drupal\search_api\DataType src/DataType/DataTypePluginManager.php Manages data type plugins. 4 2
DateDataType class Drupal\search_api\Plugin\search_api\data_type src/Plugin/search_api/data_type/DateDataType.php Provides a date data type. 1
DateDataTypeTest class Drupal\Tests\search_api\Unit tests/src/Unit/DateDataTypeTest.php Tests functionality of the "Date" data type plugin.
DecimalDataType class Drupal\search_api\Plugin\search_api\data_type src/Plugin/search_api/data_type/DecimalDataType.php Provides a decimal data type.
DefaultConfigEntityInstallationTest class Drupal\Tests\search_api\Kernel\ConfigEntity tests/src/Kernel/ConfigEntity/DefaultConfigEntityInstallationTest.php Tests that installing config entities from an extension works correctly.
Dependencies class Drupal\search_api\Utility src/Utility/Dependencies.php Provides an easy mechanism for building a dependency array. 1
DependencyRemovalTest class Drupal\Tests\search_api\Kernel\ConfigEntity tests/src/Kernel/ConfigEntity/DependencyRemovalTest.php Tests what happens when an index's or a server's dependencies are removed.
DeterminingServerFeaturesEvent final class Drupal\search_api\Event src/Event/DeterminingServerFeaturesEvent.php Wraps a determining server features event. 2
Direct class Drupal\search_api\Plugin\search_api\parse_mode src/Plugin/search_api/parse_mode/Direct.php Represents a parse mode that just passes the user input on as-is. 1
DisplayDeriverBase abstract class Drupal\search_api\Display src/Display/DisplayDeriverBase.php A base class for display derivers. 1 1
DisplayInterface interface Drupal\search_api\Display src/Display/DisplayInterface.php Defines an interface for display plugins. 1
DisplayPluginBase abstract class Drupal\search_api\Display src/Display/DisplayPluginBase.php Defines a base class from which other display classes may extend. 2 2
DisplayPluginManager class Drupal\search_api\Display src/Display/DisplayPluginManager.php Manages display plugins. 2
DisplayPluginManagerInterface interface Drupal\search_api\Display src/Display/DisplayPluginManagerInterface.php Provides an interface for the display plugin manager service. 1 1
EntityDatasourceInterface Deprecated interface Drupal\search_api\Plugin\search_api\datasource src/Plugin/search_api/datasource/EntityDatasourceInterface.php Describes an interface for entity datasources.
EntityFieldRenderer class Drupal\search_api\Plugin\views src/Plugin/views/EntityFieldRenderer.php Renders entity fields. 1
EntityProcessorProperty class Drupal\search_api\Processor src/Processor/EntityProcessorProperty.php Provides a definition for a processor property that contains an entity. 2
EntityStatus class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/EntityStatus.php Excludes unpublished nodes from node indexes. 1
EntityStatusTest class Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/EntityStatusTest.php Tests the "Entity status" processor.
EntityStringIdTest class Drupal\Tests\search_api\Kernel\Datasource tests/src/Kernel/Datasource/EntityStringIdTest.php Tests indexing entities that use string IDs.
EntityTestAction class Drupal\search_api_test_bulk_form\Plugin\Action tests/search_api_test_bulk_form/src/Plugin/Action/EntityTestAction.php Provides an action for the entity_test entity type.
EntityTestStringIdAction class Drupal\search_api_test_bulk_form\Plugin\Action tests/search_api_test_bulk_form/src/Plugin/Action/EntityTestStringIdAction.php Provides an action for the entity_test_string_id entity type.
EntityTranslationRenderer class Drupal\search_api\Plugin\views src/Plugin/views/EntityTranslationRenderer.php Renders entity translations in their row language.
EventListener class Drupal\search_api_test_events tests/search_api_test_events/src/EventListener.php Provides an event listener for testing purposes. 2
EventListener class Drupal\search_api_test_db tests/search_api_test_db/src/EventListener.php Listens to Database Search events for testing purposes. 2
EventsTest class Drupal\Tests\search_api\Functional tests/src/Functional/EventsTest.php Tests integration of events.
ExampleContentTrait trait Drupal\Tests\search_api\Functional tests/src/Functional/ExampleContentTrait.php Contains helpers to create data that can be used by tests. 4
ExcerptFieldTest class Drupal\Tests\search_api\Functional tests/src/Functional/ExcerptFieldTest.php Verifies that the "Search excerpt" field in entity displays works correctly.
FacetsQueryTypeMappingInterface interface Drupal\search_api src/FacetsQueryTypeMappingInterface.php Defines a method for mapping Search API data types to Facets query types.
Field class Drupal\search_api\Item src/Item/Field.php Represents a field on a search item that can be indexed. 16
FieldConfigurationForm class Drupal\search_api\Form src/Form/FieldConfigurationForm.php Defines a form for changing a field's configuration.
FieldIntegrationTest class Drupal\Tests\search_api\Functional tests/src/Functional/FieldIntegrationTest.php Tests field validation on index creation.
FieldInterface interface Drupal\search_api\Item src/Item/FieldInterface.php Represents a field on a search item that can be indexed. 1 19
FieldsHelper class Drupal\search_api\Utility src/Utility/FieldsHelper.php Provides helper methods for dealing with Search API fields and properties. 3 2
FieldsHelperInterface interface Drupal\search_api\Utility src/Utility/FieldsHelperInterface.php Provides an interface for implementations of the fields helper service. 1 6
FieldsHelperTest class Drupal\Tests\search_api\Unit tests/src/Unit/FieldsHelperTest.php Tests the fields helper utility class.

Pages

Other projects