Classes, traits, and interfaces - 10.3.x - drupal

Introduction to classes

A lot of the PHP code in Drupal is object oriented (OO), making use of PHP classes, interfaces, and traits. See the Objected-oriented programming conventions for more information.

See also

Objected-oriented programming conventions

File

core/core.api.php, line 1518

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
SearchIndex class Drupal\search core/modules/search/src/SearchIndex.php Provides search index management functions. 2
SearchIndexException class Drupal\search\Exception core/modules/search/src/Exception/SearchIndexException.php Exception thrown for search index errors. 1
SearchIndexingInterface interface Drupal\search\Plugin core/modules/search/src/Plugin/SearchIndexingInterface.php Defines an optional interface for SearchPlugin objects using an index. 2 4
SearchIndexInterface interface Drupal\search core/modules/search/src/SearchIndexInterface.php Provides search index management functions. 1 6
SearchIndexTest class Drupal\Tests\search\Kernel core/modules/search/tests/src/Kernel/SearchIndexTest.php Tests the service "search.index".
SearchIntegrationTest class Drupal\Tests\views\Functional core/modules/views/tests/src/Functional/SearchIntegrationTest.php Tests search integration filters.
SearchInterface interface Drupal\search\Plugin core/modules/search/src/Plugin/SearchInterface.php Defines a common interface for all SearchPlugin objects. 2 1
SearchKeywordsConditionsTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchKeywordsConditionsTest.php Verify the search without keywords set and extra conditions.
SearchLanguageTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchLanguageTest.php Tests advanced search with different languages added.
SearchLocalTask class Drupal\search\Plugin\Derivative core/modules/search/src/Plugin/Derivative/SearchLocalTask.php Provides local tasks for each search page. 1 1
SearchMatchTest class Drupal\Tests\search\Kernel core/modules/search/tests/src/Kernel/SearchMatchTest.php Indexes content and queries it.
SearchMultilingualEntityTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchMultilingualEntityTest.php Tests entities with multilingual fields.
SearchMultilingualTest class Drupal\Tests\views\Functional core/modules/views/tests/src/Functional/SearchMultilingualTest.php Tests search integration filters with multilingual nodes.
SearchNodeDiacriticsTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchNodeDiacriticsTest.php Tests search functionality with diacritics.
SearchNodePunctuationTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchNodePunctuationTest.php Tests search functionality with punctuation and HTML entities.
SearchNodeUpdateAndDeletionTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchNodeUpdateAndDeletionTest.php Tests search index is updated properly when nodes are removed or updated.
SearchNumberMatchingTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchNumberMatchingTest.php Tests that numbers can be searched with more complex matching.
SearchNumbersTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchNumbersTest.php Tests that numbers can be searched.
SearchPage class Drupal\search\Entity core/modules/search/src/Entity/SearchPage.php Defines a configured search page. 1 12
SearchPage class Drupal\search\Plugin\migrate\source\d6 core/modules/search/src/Plugin/migrate/source/d6/SearchPage.php Drupal 6 node search rankings for core modules source from database.
SearchPage class Drupal\search\Plugin\migrate\source\d7 core/modules/search/src/Plugin/migrate/source/d7/SearchPage.php Drupal 7 search active core modules and rankings source from database.
SearchPageAccessControlHandler class Drupal\search core/modules/search/src/SearchPageAccessControlHandler.php Defines the access control handler for the search page entity type.
SearchPageAddForm class Drupal\search\Form core/modules/search/src/Form/SearchPageAddForm.php Provides a form for adding a search page.
SearchPageCacheTagsTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchPageCacheTagsTest.php Tests the search_page entity cache tags on the search results pages.
SearchPageEditForm class Drupal\search\Form core/modules/search/src/Form/SearchPageEditForm.php Provides a form for editing a search page.
SearchPageForm class Drupal\search\Form core/modules/search/src/Form/SearchPageForm.php Provides a search form for site wide search. 1
SearchPageFormBase abstract class Drupal\search\Form core/modules/search/src/Form/SearchPageFormBase.php Provides a base form for search pages. 2
SearchPageInterface interface Drupal\search core/modules/search/src/SearchPageInterface.php Provides an interface defining a search page entity. 1 4
SearchPageJsonAnonTest class Drupal\Tests\search\Functional\Rest core/modules/search/tests/src/Functional/Rest/SearchPageJsonAnonTest.php @group rest
SearchPageJsonBasicAuthTest class Drupal\Tests\search\Functional\Rest core/modules/search/tests/src/Functional/Rest/SearchPageJsonBasicAuthTest.php @group rest
SearchPageJsonCookieTest class Drupal\Tests\search\Functional\Rest core/modules/search/tests/src/Functional/Rest/SearchPageJsonCookieTest.php @group rest
SearchPageListBuilder class Drupal\search core/modules/search/src/SearchPageListBuilder.php Defines a class to build a listing of search page entities.
SearchPageOverrideTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchPageOverrideTest.php Tests if the result page can be overridden.
SearchPageRepository class Drupal\search core/modules/search/src/SearchPageRepository.php Provides a repository for Search Page config entities. 2 2
SearchPageRepositoryInterface interface Drupal\search core/modules/search/src/SearchPageRepositoryInterface.php Provides the interface for a repository Search Page entities. 1 6
SearchPageRepositoryTest class Drupal\Tests\search\Unit core/modules/search/tests/src/Unit/SearchPageRepositoryTest.php @coversDefaultClass \Drupal\search\SearchPageRepository[[api-linebreak]] @group search
SearchPageResourceTestBase abstract class Drupal\Tests\search\Functional\Rest core/modules/search/tests/src/Functional/Rest/SearchPageResourceTestBase.php Base class for Search page tests. 6
SearchPageRoutes class Drupal\search\Routing core/modules/search/src/Routing/SearchPageRoutes.php Provides dynamic routes for search.
SearchPageTest class Drupal\Tests\search\Kernel\Migrate\d6 core/modules/search/tests/src/Kernel/Migrate/d6/SearchPageTest.php Tests D6 search page source plugin.
SearchPageTest class Drupal\Tests\search\Kernel\Migrate\d7 core/modules/search/tests/src/Kernel/Migrate/d7/SearchPageTest.php Tests D7 search page source plugin.
SearchPageTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/SearchPageTest.php JSON:API integration test for the "SearchPage" config entity type.
SearchPageTextTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchPageTextTest.php Tests the search help text and search page text.
SearchPageValidationTest class Drupal\Tests\search\Kernel core/modules/search/tests/src/Kernel/SearchPageValidationTest.php Tests validation of search_page entities.
SearchPageXmlAnonTest class Drupal\Tests\search\Functional\Rest core/modules/search/tests/src/Functional/Rest/SearchPageXmlAnonTest.php @group rest
SearchPageXmlBasicAuthTest class Drupal\Tests\search\Functional\Rest core/modules/search/tests/src/Functional/Rest/SearchPageXmlBasicAuthTest.php @group rest
SearchPageXmlCookieTest class Drupal\Tests\search\Functional\Rest core/modules/search/tests/src/Functional/Rest/SearchPageXmlCookieTest.php @group rest
SearchPlugin class Drupal\search\Annotation core/modules/search/src/Annotation/SearchPlugin.php Defines a SearchPlugin type annotation object.
SearchPluginBase abstract class Drupal\search\Plugin core/modules/search/src/Plugin/SearchPluginBase.php Defines a base class for plugins wishing to support search. 3 2
SearchPluginCollection class Drupal\search\Plugin core/modules/search/src/Plugin/SearchPluginCollection.php Provides a container for lazily loading search plugins. 2
SearchPluginCollectionTest class Drupal\Tests\search\Unit core/modules/search/tests/src/Unit/SearchPluginCollectionTest.php @coversDefaultClass \Drupal\search\Plugin\SearchPluginCollection[[api-linebreak]] @group search

Other projects

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.