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

Primary tabs

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 1523

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
Schema class Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Schema.php CorefakeWithAllCustomClasses implementation of \Drupal\Core\Database\Schema.
Schema

in drupal:9.4.0 and is removed from drupal:11.0.0. The SQLite database driver has been moved to the sqlite module.

class Drupal\Core\Database\Driver\sqlite core/lib/Drupal/Core/Database/Driver/sqlite/Schema.php SQLite implementation of \Drupal\Core\Database\Schema. 1
Schema

in drupal:9.4.0 and is removed from drupal:11.0.0. The MySQL database driver has been moved to the mysql module.

class Drupal\Core\Database\Driver\mysql core/lib/Drupal/Core/Database/Driver/mysql/Schema.php MySQL implementation of \Drupal\Core\Database\Schema. 1
Schema

in drupal:9.4.0 and is removed from drupal:11.0.0. The PostgreSQL database driver has been moved to the pgsql module.

class Drupal\Core\Database\Driver\pgsql core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php PostgreSQL implementation of \Drupal\Core\Database\Schema. 1
Schema abstract class Drupal\Core\Database core/lib/Drupal/Core/Database/Schema.php Provides a base implementation for Database Schema. 4 5
Schema class Drupal\driver_test\Driver\Database\DrivertestMysql core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Schema.php MySQL test implementation of \Drupal\Core\Database\Schema.
Schema class Drupal\driver_test\Driver\Database\DrivertestMysqlDeprecatedVersion core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Schema.php MySQL test implementation of \Drupal\Core\Database\Schema.
Schema class Drupal\driver_test\Driver\Database\DrivertestPgsql core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Schema.php PostgreSQL implementation of \Drupal\Core\Database\Schema.
Schema class Drupal\pgsql\Driver\Database\pgsql core/modules/pgsql/src/Driver/Database/pgsql/Schema.php PostgreSQL implementation of \Drupal\Core\Database\Schema. 2 3
Schema class Drupal\sqlite\Driver\Database\sqlite core/modules/sqlite/src/Driver/Database/sqlite/Schema.php SQLite implementation of \Drupal\Core\Database\Schema. 1 1
Schema class Drupal\mysql\Driver\Database\mysql core/modules/mysql/src/Driver/Database/mysql/Schema.php MySQL implementation of \Drupal\Core\Database\Schema. 3 3
SchemaCheckTestTrait trait Drupal\Tests core/tests/Drupal/Tests/SchemaCheckTestTrait.php Provides a class for checking configuration schema. 42
SchemaCheckTrait trait Drupal\Core\Config\Schema core/lib/Drupal/Core/Config/Schema/SchemaCheckTrait.php Provides a trait for checking configuration schema. 5
SchemaCheckTraitTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/SchemaCheckTraitTest.php Tests the functionality of SchemaCheckTrait.
SchemaConfigListenerTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/SchemaConfigListenerTest.php Tests the functionality of ConfigSchemaChecker in KernelTestBase tests.
SchemaConfigListenerTest class Drupal\FunctionalTests\Core\Config core/tests/Drupal/FunctionalTests/Core/Config/SchemaConfigListenerTest.php Tests the functionality of ConfigSchemaChecker in KernelTestBase tests.
SchemaConfigListenerTestTrait trait Drupal\Tests\Traits\Core\Config core/tests/Drupal/Tests/Traits/Core/Config/SchemaConfigListenerTestTrait.php Adds a test for the configuration schema checker use in tests. 2
SchemaConfigListenerWebTest class Drupal\Tests\config\Functional core/modules/config/tests/src/Functional/SchemaConfigListenerWebTest.php Tests the functionality of ConfigSchemaChecker in BrowserTestBase tests.
SchemaDeprecationTest class Drupal\KernelTests\Core\Extension core/tests/Drupal/KernelTests/Core/Extension/SchemaDeprecationTest.php Tests deprecated schema.inc functions.
SchemaException class Drupal\Core\Database core/lib/Drupal/Core/Database/SchemaException.php Base exception for Schema-related errors. 2 4
SchemaIncompleteException class Drupal\Core\Config\Schema core/lib/Drupal/Core/Config/Schema/SchemaIncompleteException.php An exception thrown when a config schema is incomplete. 8
SchemaInspector class Drupal\TestTools\Extension core/tests/Drupal/TestTools/Extension/SchemaInspector.php Provides methods to access modules' schema. 2
SchemaIntrospectionTestTrait trait Drupal\Tests\Core\Database core/tests/Drupal/Tests/Core/Database/SchemaIntrospectionTestTrait.php Provides methods for testing database schema characteristics. 2
SchemaListenerController class Drupal\config_test core/modules/config/tests/config_test/src/SchemaListenerController.php Controller for testing \Drupal\Core\Config\Development\ConfigSchemaChecker.
SchemaObjectDoesNotExistException class Drupal\Core\Database core/lib/Drupal/Core/Database/SchemaObjectDoesNotExistException.php Exception thrown if an object being modified doesn't exist yet. 4
SchemaObjectExistsException class Drupal\Core\Database core/lib/Drupal/Core/Database/SchemaObjectExistsException.php Exception thrown if an object being created already exists. 6
SchemaOrgDataConverter class Drupal\rdf core/modules/rdf/src/SchemaOrgDataConverter.php
SchemaTest class Drupal\Tests\mysql\Kernel\mysql core/modules/mysql/tests/src/Kernel/mysql/SchemaTest.php Tests schema API for the MySQL driver.
SchemaTest class Drupal\KernelTests\Core\Database core/tests/Drupal/KernelTests/Core/Database/SchemaTest.php Tests table creation and modification via the schema API.
SchemaTest class Drupal\Tests\pgsql\Unit core/modules/pgsql/tests/src/Unit/SchemaTest.php @coversDefaultClass \Drupal\pgsql\Driver\Database\pgsql\Schema[[api-linebreak]] @group Database
SchemaTest class Drupal\Tests\pgsql\Kernel\pgsql core/modules/pgsql/tests/src/Kernel/pgsql/SchemaTest.php Tests schema API for the PostgreSQL driver.
SchemaVersionUpdateTest class Drupal\Tests\system\Functional\Update core/modules/system/tests/src/Functional/Update/SchemaVersionUpdateTest.php Tests that updates clean-up non-integer schema version.
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\views\Ajax core/modules/views/src/Ajax/ScrollTopCommand.php Provides an AJAX command for scrolling to the top of an element. 1
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.
Search class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Search.php Provides an HTML5 input element with type of "search".
SearchableHelpInterface interface Drupal\help_topics core/modules/help_topics/src/SearchableHelpInterface.php Provides an interface for a HelpSection plugin that also supports search. 2 3
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
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 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.

Other projects


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