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
AddHierarchy class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/AddHierarchy.php Adds all ancestors' IDs to a hierarchical field.
AddHierarchyTest class Drupal\Tests\search_api\Kernel\Processor tests/src/Kernel/Processor/AddHierarchyTest.php Tests the "Hierarchy" processor.
AddServerFormTest class Drupal\Tests\search_api\Functional tests/src/Functional/AddServerFormTest.php Tests the "Add server" form.
AddURL class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/AddURL.php Adds the item's URL to the indexed data. 1
AddURLKernelTest class Drupal\Tests\search_api\Kernel\Processor tests/src/Kernel/Processor/AddURLKernelTest.php Tests the "Add URL" processor at a higher level.
AddURLProperty class Drupal\search_api\Plugin\search_api\processor\Property src/Plugin/search_api/processor/Property/AddURLProperty.php Defines an "Item URL" property. 2
AddURLTest class Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/AddURLTest.php Tests the "URL field" processor.
AggregatedFieldProperty class Drupal\search_api\Plugin\search_api\processor\Property src/Plugin/search_api/processor/Property/AggregatedFieldProperty.php Defines an "aggregated field" property. 2
AggregatedFields class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/AggregatedFields.php Adds customized aggregations of existing fields to the index. 1
AggregatedFieldsTest class Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/AggregatedFieldsTest.php Tests the "Aggregated fields" processor.
AjaxTest class Drupal\Tests\search_api\FunctionalJavascript tests/src/FunctionalJavascript/AjaxTest.php Tests AJAX functionality in the Search API module.
AllTermsArgumentTest class Drupal\Tests\search_api\Unit\Views tests/src/Unit/Views/AllTermsArgumentTest.php Tests whether the SearchApiAllTerms argument plugin works correctly.
AlteringValueTestDataType class Drupal\search_api_test\Plugin\search_api\data_type tests/search_api_test/src/Plugin/search_api/data_type/AlteringValueTestDataType.php Provides a dummy data type for testing purposes.
AutocompleteTest class Drupal\Tests\search_api_db\Kernel modules/search_api_db/tests/src/Kernel/AutocompleteTest.php Tests autocomplete functionality of the Database backend.
BackendInterface interface Drupal\search_api\Backend src/Backend/BackendInterface.php Defines an interface for search backend plugins. 1 2
BackendPluginBase abstract class Drupal\search_api\Backend src/Backend/BackendPluginBase.php Defines a base class for backend plugins. 3 3
BackendPluginBaseTest class Drupal\Tests\search_api\Unit tests/src/Unit/BackendPluginBaseTest.php Tests methods provided by the backend plugin base class.
BackendPluginManager class Drupal\search_api\Backend src/Backend/BackendPluginManager.php Manages search backend plugins. 1 2
BackendSpecificInterface interface Drupal\search_api\Backend src/Backend/BackendSpecificInterface.php Defines methods common to search servers and backend plugins. 2 1
BackendTest class Drupal\Tests\search_api_db\Kernel modules/search_api_db/tests/src/Kernel/BackendTest.php Tests index and search capabilities using the Database search backend.
BackendTestBase abstract class Drupal\Tests\search_api\Kernel tests/src/Kernel/BackendTestBase.php Provides a base class for backend tests. 1 1
Basic class Drupal\search_api\Plugin\search_api\tracker src/Plugin/search_api/tracker/Basic.php Provides a tracker implementation which uses a FIFO-like processing order. 1 2
BasicTrackerTest class Drupal\Tests\search_api\Kernel tests/src/Kernel/BasicTrackerTest.php Tests the "default" tracker plugin.
BooleanDataType class Drupal\search_api\Plugin\search_api\data_type src/Plugin/search_api/data_type/BooleanDataType.php Provides a boolean data type.
BundlelessEntityTest class Drupal\Tests\search_api\Kernel\Datasource tests/src/Kernel/Datasource/BundlelessEntityTest.php Tests indexing entities that use string IDs.
CacheabilityTest class Drupal\Tests\search_api\Functional tests/src/Functional/CacheabilityTest.php Tests the cacheability metadata of Search API.
CaseSensitiveDatabase class Drupal\search_api_db\DatabaseCompatibility modules/search_api_db/src/DatabaseCompatibility/CaseSensitiveDatabase.php Represents a database whose tables are, by default, case-sensitive. 3
Cc class Drupal\search_api\Plugin\search_api\processor\Resources src/Plugin/search_api/processor/Resources/Cc.php Represents characters of the Unicode category "Cc" ("Other, Control").
Cf class Drupal\search_api\Plugin\search_api\processor\Resources src/Plugin/search_api/processor/Resources/Cf.php Represents characters of the Unicode category "Cf" ("Other, Format").
CliTest class Drupal\Tests\search_api\Kernel\System tests/src/Kernel/System/CliTest.php Tests Search API functionality when executed in the CLI.
Co class Drupal\search_api\Plugin\search_api\processor\Resources src/Plugin/search_api/processor/Resources/Co.php Represents characters of the Unicode category "Co" ("Other, Private Use").
CommandHelper class Drupal\search_api\Utility src/Utility/CommandHelper.php Provides functionality to be used by CLI tools. 3
CommandHelperTest class Drupal\Tests\search_api\Kernel\System tests/src/Kernel/System/CommandHelperTest.php Tests Search API functionality that gets executed by console utilities.
Condition class Drupal\search_api\Query src/Query/Condition.php Represents a single (field operator value) condition in a search query. 6
ConditionGroup class Drupal\search_api\Query src/Query/ConditionGroup.php Provides a standard implementation for a Search API query condition group. 2
ConditionGroupInterface interface Drupal\search_api\Query src/Query/ConditionGroupInterface.php Represents a condition group on a search query. 1 4
ConditionInterface interface Drupal\search_api\Query src/Query/ConditionInterface.php Represents a single (field operator value) condition in a search query. 1 1
ConditionSetInterface interface Drupal\search_api\Query src/Query/ConditionSetInterface.php Defines a common interface for objects which can hold conditions. 2
ConfigOverrideIntegrationTest class Drupal\Tests\search_api\Functional tests/src/Functional/ConfigOverrideIntegrationTest.php Contains integration tests for config entities with overrides.
ConfigOverrideKernelTest class Drupal\Tests\search_api\Kernel\ConfigEntity tests/src/Kernel/ConfigEntity/ConfigOverrideKernelTest.php Contains tests for config entities with overrides.
ConfigurablePluginBase abstract class Drupal\search_api\Plugin src/Plugin/ConfigurablePluginBase.php Provides a base class for all configurable Search API plugins. 2 1
ConfigurablePluginInterface interface Drupal\search_api\Plugin src/Plugin/ConfigurablePluginInterface.php Describes a configurable Search API plugin. 3 1
ConfigurablePropertyBase abstract class Drupal\search_api\Processor src/Processor/ConfigurablePropertyBase.php Provides a base class for configurable processor-defined properties. 3 3
ConfigurablePropertyInterface interface Drupal\search_api\Processor src/Processor/ConfigurablePropertyInterface.php Represents a processor-defined property with additional configuration. 1 9
ConsoleException class Drupal\search_api src/ConsoleException.php Represents an exception that occurred in the console code of Search API. 3
ContentAccess class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/ContentAccess.php Adds content access checks for nodes and comments.
ContentAccessTest class Drupal\Tests\search_api\Kernel\Processor tests/src/Kernel/Processor/ContentAccessTest.php Tests the "Content access" processor.
ContentEntity class Drupal\search_api\Plugin\search_api\datasource src/Plugin/search_api/datasource/ContentEntity.php Represents a datasource which exposes the content entities.
ContentEntityDatasourceTest class Drupal\Tests\search_api\Kernel\Datasource tests/src/Kernel/Datasource/ContentEntityDatasourceTest.php Tests correct functionality of the content entity datasource.
ContentEntityDeriver class Drupal\search_api\Plugin\search_api\datasource src/Plugin/search_api/datasource/ContentEntityDeriver.php Derives a datasource plugin definition for every content entity type.

Pages

Other projects