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
ProcessorPropertyInterface interface Drupal\search_api\Processor src/Processor/ProcessorPropertyInterface.php Provides an interface for processor-defined properties. 3 5
ProcessorTestBase abstract class Drupal\Tests\search_api\Kernel\Processor tests/src/Kernel/Processor/ProcessorTestBase.php Provides a base class for Drupal unit tests for processors. 9
ProcessorTestTrait trait Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/ProcessorTestTrait.php Provides common methods for processor testing unit tests.
Ps class Drupal\search_api\Plugin\search_api\processor\Resources src/Plugin/search_api/processor/Resources/Ps.php Represents characters of the Unicode category "Ps" ("Punctuation, Open").
Query class Drupal\search_api\Query src/Query/Query.php Provides a standard implementation for a Search API query. 6
QueryHelper class Drupal\search_api\Utility src/Utility/QueryHelper.php Provides methods for creating search queries and statically caching results. 2
QueryHelperInterface interface Drupal\search_api\Utility src/Utility/QueryHelperInterface.php Provides an interface for query helper services. 1 3
QueryInterface interface Drupal\search_api\Query src/Query/QueryInterface.php Represents a search query on a Search API index. 1 33
QueryPreExecuteEvent final class Drupal\search_api_db\Event modules/search_api_db/src/Event/QueryPreExecuteEvent.php Wraps a query pre-execute event. 2
QueryPreExecuteEvent final class Drupal\search_api\Event src/Event/QueryPreExecuteEvent.php Wraps a query pre-execute event. 2
QueryTest class Drupal\Tests\search_api\Kernel\System tests/src/Kernel/System/QueryTest.php Tests query functionality.
ReferencedEntitiesReindexingTest class Drupal\Tests\search_api\Kernel\Datasource tests/src/Kernel/Datasource/ReferencedEntitiesReindexingTest.php Tests that changes in related entities are correctly tracked.
ReindexScheduledEvent final class Drupal\search_api\Event src/Event/ReindexScheduledEvent.php Wraps a reindex scheduled event. 3
RenderedItem class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/RenderedItem.php Adds an additional field containing the rendered item.
RenderedItemProperty class Drupal\search_api\Plugin\search_api\processor\Property src/Plugin/search_api/processor/Property/RenderedItemProperty.php Defines a "rendered item" property. 1
RenderedItemTest class Drupal\Tests\search_api\Kernel\Processor tests/src/Kernel/Processor/RenderedItemTest.php Tests the "Rendered item" processor.
ResultRow class Drupal\search_api\Plugin\views src/Plugin/views/ResultRow.php A class representing a result row of a Search API-based view. 3
ResultSet class Drupal\search_api\Query src/Query/ResultSet.php Represents the result set of a search query. 1
ResultSetInterface interface Drupal\search_api\Query src/Query/ResultSetInterface.php Represents the result set of a search query. 1 17
ResultsTrait trait Drupal\Tests\search_api\Kernel tests/src/Kernel/ResultsTrait.php Defines a trait for testing results. 3
ReverseEntityReferences class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/ReverseEntityReferences.php Allows indexing of reverse entity references.
ReverseEntityReferencesTest class Drupal\Tests\search_api\Kernel\Processor tests/src/Kernel/Processor/ReverseEntityReferencesTest.php Tests the "Reverse entity references" processor.
RoleAccess class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/RoleAccess.php Adds access checks based on user roles.
RoleAccessTest class Drupal\Tests\search_api\Kernel\Processor tests/src/Kernel/Processor/RoleAccessTest.php Tests the "Role-based access" processor.
RoleFilter class Drupal\search_api\Plugin\search_api\processor src/Plugin/search_api/processor/RoleFilter.php Filters out users based on their role. 1
RoleFilterTest class Drupal\Tests\search_api\Unit\Processor tests/src/Unit/Processor/RoleFilterTest.php Tests the "Role filter" processor.
RowsOfMultiValueFields class Drupal\search_api\Contrib src/Contrib/RowsOfMultiValueFields.php Outputs multi-valued data as comma-separated values. 1
Sc class Drupal\search_api\Plugin\search_api\processor\Resources src/Plugin/search_api/processor/Resources/Sc.php Represents characters of the Unicode category "Sc" ("Symbol, Currency").
SearchApiAllTerms class Drupal\search_api\Plugin\views\argument src/Plugin/views/argument/SearchApiAllTerms.php Defines a contextual filter searching through all indexed taxonomy fields. 2
SearchApiBackend class Drupal\search_api\Annotation src/Annotation/SearchApiBackend.php Defines a Search API backend annotation object. 1
SearchApiBoolean class Drupal\search_api\Plugin\views\filter src/Plugin/views/filter/SearchApiBoolean.php Defines a filter for filtering on boolean values.
SearchApiBoolean class Drupal\search_api\Plugin\views\field src/Plugin/views/field/SearchApiBoolean.php Handles the display of boolean fields in Search API Views.
SearchApiBrowserTestBase abstract class Drupal\Tests\search_api\Functional tests/src/Functional/SearchApiBrowserTestBase.php Provides the base class for web tests for Search API. 11
SearchApiBulkForm class Drupal\search_api\Plugin\views\field src/Plugin/views/field/SearchApiBulkForm.php Defines an actions-based bulk operation form element.
SearchApiBulkFormTest class Drupal\Tests\search_api\Functional tests/src/Functional/SearchApiBulkFormTest.php Tests the Search API bulk form Views field plugin.
SearchApiCachePluginTrait trait Drupal\search_api\Plugin\views\cache src/Plugin/views/cache/SearchApiCachePluginTrait.php Provides a trait to use in Views cache plugins for Search API queries.
SearchApiCommands class Drupal\search_api\Commands src/Commands/SearchApiCommands.php Defines Drush commands for the Search API. 2
SearchApiConfigEntityStorage class Drupal\search_api\Entity src/Entity/SearchApiConfigEntityStorage.php Provides a special storage for Search API config entities.
SearchApiConverter class Drupal\search_api\ProxyClass\ParamConverter src/ProxyClass/ParamConverter/SearchApiConverter.php Provides a proxy class for \Drupal\search_api\ParamConverter\SearchApiConverter.
SearchApiConverter class Drupal\search_api\ParamConverter src/ParamConverter/SearchApiConverter.php Converts search indexes from path parameters to a temporary copy. 2
SearchApiDataRow class Drupal\search_api\Plugin\views\row src/Plugin/views/row/SearchApiDataRow.php Displays entities as raw data.
SearchApiDatasource class Drupal\search_api\Plugin\views\filter src/Plugin/views/filter/SearchApiDatasource.php Provides filtering on the datasource.
SearchApiDatasource class Drupal\search_api\Annotation src/Annotation/SearchApiDatasource.php Defines a Search API datasource annotation object.
SearchApiDataType class Drupal\search_api\Annotation src/Annotation/SearchApiDataType.php Defines a Search API data type annotation object.
SearchApiDate class Drupal\search_api\Plugin\views\filter src/Plugin/views/filter/SearchApiDate.php Defines a filter for filtering on dates.
SearchApiDate class Drupal\search_api\Plugin\views\argument src/Plugin/views/argument/SearchApiDate.php Defines a contextual filter for conditions on date fields.
SearchApiDate class Drupal\search_api\Plugin\views\field src/Plugin/views/field/SearchApiDate.php Handles the display of date fields in Search API Views.
SearchApiDbEvents class Drupal\search_api_db\Event modules/search_api_db/src/Event/SearchApiDbEvents.php Defines events for the Database Search module. 2
SearchApiDbUpdate8102Test class Drupal\search_api_db\Tests\Update modules/search_api_db/src/Tests/Update/SearchApiDbUpdate8102Test.php Tests whether search_api_db_update_8102() works correctly.
SearchApiDisplay class Drupal\search_api\Annotation src/Annotation/SearchApiDisplay.php Defines a Search API display annotation object.

Pages

Other projects