Classes, traits, and interfaces - main - 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 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
SchemaTest class Drupal\Tests\mysqli\Kernel\mysqli core/modules/mysqli/tests/src/Kernel/mysqli/SchemaTest.php Tests schema API for the MySQL driver.
SchemaTest class Drupal\Tests\pgsql\Unit core/modules/pgsql/tests/src/Unit/SchemaTest.php Tests Drupal\pgsql\Driver\Database\pgsql\Schema.
SchemaTest class Drupal\Tests\pgsql\Kernel\pgsql core/modules/pgsql/tests/src/Kernel/pgsql/SchemaTest.php Tests schema API for the PostgreSQL driver.
SchematicNormalizerFallbackTrait trait Drupal\serialization\Normalizer core/modules/serialization/src/Normalizer/SchematicNormalizerFallbackTrait.php Trait for generating helpful schema-generation fallback messages. 1
SchematicNormalizerHelperTrait trait Drupal\serialization\Normalizer core/modules/serialization/src/Normalizer/SchematicNormalizerHelperTrait.php Methods for normalizing JSON schema.
SchematicNormalizerTrait trait Drupal\serialization\Normalizer core/modules/serialization/src/Normalizer/SchematicNormalizerTrait.php Trait for normalizers which can also provide JSON Schema. 5
SchemaUniquePrefixedKeysIndexTest class Drupal\Tests\pgsql\Kernel\pgsql core/modules/pgsql/tests/src/Kernel/pgsql/SchemaUniquePrefixedKeysIndexTest.php Tests adding UNIQUE keys to tables.
SchemaUniquePrefixedKeysIndexTest class Drupal\Tests\sqlite\Kernel\sqlite core/modules/sqlite/tests/src/Kernel/sqlite/SchemaUniquePrefixedKeysIndexTest.php Tests adding UNIQUE keys to tables.
SchemaUniquePrefixedKeysIndexTest class Drupal\Tests\mysql\Kernel\mysql core/modules/mysql/tests/src/Kernel/mysql/SchemaUniquePrefixedKeysIndexTest.php Tests adding UNIQUE keys to tables.
SchemaUniquePrefixedKeysIndexTestBase abstract class Drupal\KernelTests\Core\Database core/tests/Drupal/KernelTests/Core/Database/SchemaUniquePrefixedKeysIndexTestBase.php Tests adding UNIQUE keys to tables. 3 3
Score class Drupal\search\Plugin\views\sort core/modules/search/src/Plugin/views/sort/Score.php Sort handler for sorting by search score.
Score class Drupal\search\Plugin\views\field core/modules/search/src/Plugin/views/field/Score.php Field handler for search score.
ScrollTopCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/ScrollTopCommand.php Provides an AJAX command for scrolling to the top of an element. 1
Search class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Search.php Provides an HTML5 input element with type of "search".
Search class Drupal\search\Attribute core/modules/search/src/Attribute/Search.php Defines a Search type attribute for plugin discovery. 6
Search class Drupal\search\Plugin\views\filter core/modules/search/src/Plugin/views/filter/Search.php Filter handler for search keywords.
Search class Drupal\search\Plugin\views\argument core/modules/search/src/Plugin/views/argument/Search.php Argument handler for search keywords.
SearchableHelpInterface interface Drupal\help core/modules/help/src/SearchableHelpInterface.php Provides an interface for a HelpSection plugin that also supports search. 2 4
SearchAdminThemeTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchAdminThemeTest.php Verify the search results using administration theme for specific plugins.
SearchAdvancedSearchFormTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchAdvancedSearchFormTest.php Indexes content and tests the advanced search form.
SearchBlock class Drupal\search\Plugin\Block core/modules/search/src/Plugin/Block/SearchBlock.php Provides a 'Search form' block.
SearchBlockForm class Drupal\search\Form core/modules/search/src/Form/SearchBlockForm.php Builds the search form for the search block. 1
SearchBlockPageIdUpdatePathTest class Drupal\Tests\search\Functional\Update core/modules/search/tests/src/Functional/Update/SearchBlockPageIdUpdatePathTest.php Tests update path for the search block's `page_id` setting from '' to NULL.
SearchBlockTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchBlockTest.php Tests if the search form block is available.
SearchCommentCountToggleTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchCommentCountToggleTest.php Tests that comment count display toggles properly on comment status of node.
SearchCommentTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchCommentTest.php Tests integration searching comments.
SearchConfigSettingsFormTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchConfigSettingsFormTest.php Verify the search config settings form.
SearchConfigurationRankings

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

 class Drupal\search\Plugin\migrate\process core/modules/search/src/Plugin/migrate/process/SearchConfigurationRankings.php Generate configuration rankings.
SearchController class Drupal\search\Controller core/modules/search/src/Controller/SearchController.php Route controller for search.
SearchDateIntervalTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchDateIntervalTest.php Tests searching with date filters that exclude some translations.
SearchDateQueryAlterHooks class Drupal\search_date_query_alter\Hook core/modules/search/tests/modules/search_date_query_alter/src/Hook/SearchDateQueryAlterHooks.php Hook implementations for search_date_query_alter.
SearchEmbeddedForm class Drupal\search_embedded_form\Form core/modules/search/tests/modules/search_embedded_form/src/Form/SearchEmbeddedForm.php Form controller for search_embedded_form form. 1
SearchEmbeddedFormThemeHooks class Drupal\search_embedded_form\Hook core/modules/search/tests/modules/search_embedded_form/src/Hook/SearchEmbeddedFormThemeHooks.php Theme hook implementations for search_embedded_form module.
SearchEmbedFormTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchEmbedFormTest.php Verifies that a form embedded in search results works.
SearchEntityOperationsCacheabilityTest class Drupal\Tests\search\Kernel core/modules/search/tests/src/Kernel/SearchEntityOperationsCacheabilityTest.php Tests cacheability added by entity operations.
SearchExactTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchExactTest.php Tests that searching for a phrase gets the correct page count.
SearchExcerptTest class Drupal\Tests\search\Kernel core/modules/search/tests/src/Kernel/SearchExcerptTest.php Tests the search_excerpt() function.
SearchExtraTypeSearch class Drupal\search_extra_type\Plugin\Search core/modules/search/tests/modules/search_extra_type/src/Plugin/Search/SearchExtraTypeSearch.php Executes a dummy keyword search.
SearchHelpHooks class Drupal\search_help\Hook core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php Hook implementations for help.
SearchHelpSearch class Drupal\search_help\Plugin\Search core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Handles searching for help using the Search module index. 1
SearchHooks class Drupal\search\Hook core/modules/search/src/Hook/SearchHooks.php Hook implementations for search.
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. 3 6
SearchIndexInterface interface Drupal\search core/modules/search/src/SearchIndexInterface.php Provides search index management functions. 1 8
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 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.
SearchLangcodeTestHooks class Drupal\search_langcode_test\Hook core/modules/search/tests/modules/search_langcode_test/src/Hook/SearchLangcodeTestHooks.php Hook implementations for search_langcode_test.

Other projects

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