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
FieldsProcessorPluginBase abstract class Drupal\search_api\Processor src/Processor/FieldsProcessorPluginBase.php Provides a base class for processors that work on individual fields. 8 8
FieldsProcessorPluginBaseTest class Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/FieldsProcessorPluginBaseTest.php Tests the base class for fields-based processors.
FieldValuesExtractionTest class Drupal\Tests\search_api\Kernel\System tests/src/Kernel/System/FieldValuesExtractionTest.php Tests extraction of field values, as used during indexing.
FooDataDefinition class Drupal\search_api_test_bulk_form\TypedData tests/search_api_test_bulk_form/src/TypedData/FooDataDefinition.php Provides a typed data definition class for describing 'foo'. 1
GatheringPluginInfoEvent final class Drupal\search_api\Event src/Event/GatheringPluginInfoEvent.php Wraps a gathering of plugin information event. 2
GenericDatabase class Drupal\search_api_db\DatabaseCompatibility modules/search_api_db/src/DatabaseCompatibility/GenericDatabase.php Represents any database for which no specifics are known. 2 2 2
HideablePluginBase class Drupal\search_api\Plugin src/Plugin/HideablePluginBase.php Provides a base class for plugins that can be hidden. 4 3
HideablePluginInterface interface Drupal\search_api\Plugin src/Plugin/HideablePluginInterface.php Defines an interface for plugins that can be hidden. 5 3
Highlight class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/Highlight.php Adds a highlighted excerpt to results and highlights returned fields. 1
HighlightTest class Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/HighlightTest.php Tests the "Highlight" processor.
HooksTest class Drupal\Tests\search_api\Functional tests/src/Functional/HooksTest.php Tests integration of hooks.
Html class Drupal\search_api\Plugin\DataType src/Plugin/DataType/Html.php Defines a data type for fulltext fields containing valid HTML.
HtmlFilter class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/HtmlFilter.php Strips HTML tags from fulltext fields and decodes HTML entities. 1
HtmlFilterTest class Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/HtmlFilterTest.php Tests the "HTML filter" processor.
IgnoreCase class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/IgnoreCase.php Makes searches case-insensitive on selected fields. 1
IgnoreCaseTest class Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/IgnoreCaseTest.php Tests the "Ignore case" processor.
IgnoreCharacters class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/IgnoreCharacters.php Configure types of characters which should be ignored for searches. 1
IgnoreCharacterTest class Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/IgnoreCharacterTest.php Tests the "Ignore characters" processor.
Index class Drupal\search_api\Entity src/Entity/Index.php Defines the search index configuration entity. 53
IndexAddFieldsForm class Drupal\search_api\Form src/Form/IndexAddFieldsForm.php Provides a form for adding fields to a search index.
IndexBatchHelper class Drupal\search_api src/IndexBatchHelper.php Provides helper methods for indexing items using Drupal's Batch API. 2
IndexBreakLockForm class Drupal\search_api\Form src/Form/IndexBreakLockForm.php Builds the form to break the lock of an edited search index.
IndexChangesTest class Drupal\Tests\search_api\Kernel\Index tests/src/Kernel/Index/IndexChangesTest.php Tests correct reactions to changes for the index.
IndexClearConfirmForm class Drupal\search_api\Form src/Form/IndexClearConfirmForm.php Defines a confirm form for clearing an index.
IndexController class Drupal\search_api\Controller src/Controller/IndexController.php Provides route responses for search indexes.
IndexDeleteConfirmForm class Drupal\search_api\Form src/Form/IndexDeleteConfirmForm.php Defines a confirm form for deleting an index.
IndexDisableConfirmForm class Drupal\search_api\Form src/Form/IndexDisableConfirmForm.php Defines a confirm form for disabling an index.
IndexFieldsForm class Drupal\search_api\Form src/Form/IndexFieldsForm.php Provides a form for configuring the fields of a search index.
IndexForm class Drupal\search_api\Form src/Form/IndexForm.php Provides a form for the Index entity.
IndexImportTest class Drupal\Tests\search_api\Kernel\Index tests/src/Kernel/Index/IndexImportTest.php Tests whether importing of index configuration works correctly.
IndexingItemsEvent final class Drupal\search_api\Event src/Event/IndexingItemsEvent.php Wraps an indexing items event. 3
IndexInterface interface Drupal\search_api src/IndexInterface.php Defines the interface for index entities. 2 78
IndexListBuilder class Drupal\search_api src/IndexListBuilder.php Builds a listing of search index entities. 1
IndexLoadItemsTest class Drupal\Tests\search_api\Kernel\Index tests/src/Kernel/Index/IndexLoadItemsTest.php Tests whether loading items works correctly.
IndexPluginBase abstract class Drupal\search_api\Plugin src/Plugin/IndexPluginBase.php Provides a base class for plugins linked to a search index. 3 3
IndexPluginInterface interface Drupal\search_api\Plugin src/Plugin/IndexPluginInterface.php Represents a plugin that is linked to an index. 4 3
IndexProcessorsForm class Drupal\search_api\Form src/Form/IndexProcessorsForm.php Provides a form for configuring the processors of a search index.
IndexRebuildTrackerConfirmForm class Drupal\search_api\Form src/Form/IndexRebuildTrackerConfirmForm.php Defines a confirm form for clearing an index.
IndexReindexConfirmForm class Drupal\search_api\Form src/Form/IndexReindexConfirmForm.php Defines a confirm form for reindexing an index.
IndexStatusForm class Drupal\search_api\Form src/Form/IndexStatusForm.php Provides a form for indexing, clearing, etc., an index.
IndexStorageTest class Drupal\Tests\search_api\Kernel\Index tests/src/Kernel/Index/IndexStorageTest.php Tests whether the storage of search indexes works correctly.
IndexTaskManager class Drupal\search_api\Task src/Task/IndexTaskManager.php Provides a service for managing pending index tasks. 1 2
IndexTaskManagerInterface interface Drupal\search_api\Task src/Task/IndexTaskManagerInterface.php Defines the interface for the index task manager. 1 1
InstallingTrait trait Drupal\search_api\Entity src/Entity/InstallingTrait.php Provides a helper method for checking a saved config entity's source.
IntegerDataType class Drupal\search_api\Plugin\search_api\data_type src/Plugin/search_api/data_type/IntegerDataType.php Provides an integer data type.
IntegrationTest class Drupal\Tests\search_api_db\FunctionalJavascript modules/search_api_db/tests/src/FunctionalJavascript/IntegrationTest.php Tests that using the DB backend via the UI works as expected.
IntegrationTest class Drupal\Tests\search_api\Functional tests/src/Functional/IntegrationTest.php Tests the overall functionality of the Search API framework and admin UI.
IntegrationTest class Drupal\Tests\search_api_db_defaults\Functional modules/search_api_db/search_api_db_defaults/tests/src/Functional/IntegrationTest.php Tests the correct installation of the default configs.
Item class Drupal\search_api\Item src/Item/Item.php Provides a default implementation for a search item. 4
ItemFieldTest class Drupal\Tests\search_api\Unit tests/src/Unit/ItemFieldTest.php Tests functionality of the field class.

Pages

Other projects