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
StyleTableTest class Drupal\Tests\views\Functional\Plugin core/modules/views/tests/src/Functional/Plugin/StyleTableTest.php Tests the table style views plugin.
StyleTableTest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/StyleTableTest.php Tests the UI of views when using the table style.
StyleTableUnitTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/StyleTableUnitTest.php Tests the table style plugin.
StyleTemplateTest class Drupal\views_test_data\Plugin\views\style core/modules/views/tests/modules/views_test_data/src/Plugin/views/style/StyleTemplateTest.php Provides a general test style template plugin.
StyleTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/StyleTest.php Tests general style functionality.
StyleTest class Drupal\views_test_data\Plugin\views\style core/modules/views/tests/modules/views_test_data/src/Plugin/views/style/StyleTest.php Provides a general test style plugin. 1
StyleTest class Drupal\Tests\ckeditor5\FunctionalJavascript core/modules/ckeditor5/tests/src/FunctionalJavascript/StyleTest.php @coversDefaultClass \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Style[[api-linebreak]] @group ckeditor5 @internal
StyleTestBase abstract class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/StyleTestBase.php Tests some general style plugin related functionality. 2
StyleUITest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/StyleUITest.php Tests the UI of style plugins.
StyleUnformattedTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/StyleUnformattedTest.php Tests unformatted style functionality.
SubDirAttribute final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Attribute\SubDir core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Attribute/SubDir/SubDirAttribute.php #[\Attribute]
SubformState class Drupal\Core\Form core/lib/Drupal/Core/Form/SubformState.php Stores information about the state of a subform. 18
SubformStateInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/SubformStateInterface.php Stores information about the state of a subform. 1 5
SubformStateTest class Drupal\Tests\Core\Form core/tests/Drupal/Tests/Core/Form/SubformStateTest.php @coversDefaultClass \Drupal\Core\Form\SubformState[[api-linebreak]]
Submit class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Submit.php Provides a form submit button. 1
SubProcess class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/SubProcess.php Runs an array of arrays through its own process pipeline. 2
SubProcessTest class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/SubProcessTest.php Tests the sub_process process plugin.
SubProcessWithSkipTest class Drupal\Tests\migrate\Kernel\process core/modules/migrate/tests/src/Kernel/process/SubProcessWithSkipTest.php Tests process pipelines when a sub_process skips a row or process.
Subquery class Drupal\views\Plugin\views\join core/modules/views/src/Plugin/views/join/Subquery.php Join handler for relationships that join with a subquery as the left field.
Substr class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/Substr.php Returns a substring of the input value. 1
SubstrTest class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/SubstrTest.php Tests the substr plugin.
SummaryLengthTest class Drupal\Tests\node\Kernel core/modules/node/tests/src/Kernel/SummaryLengthTest.php Tests summary length.
SupernovaGenerator class Drupal\help_test core/modules/help/tests/modules/help_test/src/SupernovaGenerator.php Implements a URL generator which always thrown an exception. 1
SuperUserAccessInstallTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/SuperUserAccessInstallTest.php Tests superuser access and the installer.
SuperUserAccessPolicy final class Drupal\Core\Session core/lib/Drupal/Core/Session/SuperUserAccessPolicy.php Grants user 1 an all access pass. 1 2
SuperUserAccessPolicyPass class Drupal\Core\DependencyInjection\Compiler core/lib/Drupal/Core/DependencyInjection/Compiler/SuperUserAccessPolicyPass.php Removes the super user access policy when toggled off. 1
SuperUserAccessPolicyTest class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/SuperUserAccessPolicyTest.php @coversDefaultClass \Drupal\Core\Session\SuperUserAccessPolicy[[api-linebreak]] @group Session
SuperUserPermissionsTest class Drupal\KernelTests\Core\Session core/tests/Drupal/KernelTests/Core/Session/SuperUserPermissionsTest.php Test case for getting all permissions as a super user.
SupportsTemporaryTablesInterface interface Drupal\Core\Database core/lib/Drupal/Core/Database/SupportsTemporaryTablesInterface.php Adds support for temporary tables. 3 3
SuspendQueueException class Drupal\Core\Queue core/lib/Drupal/Core/Queue/SuspendQueueException.php Exception class to throw to indicate that a cron queue should be skipped. 4
SvgIconBuilder class Drupal\Core\Layout\Icon core/lib/Drupal/Core/Layout/Icon/SvgIconBuilder.php Builds SVG layout icons. 1 2
SwitchShortcutSet class Drupal\shortcut\Form core/modules/shortcut/src/Form/SwitchShortcutSet.php Builds the shortcut set switch form. 1
SwitchToLiveForm class Drupal\workspaces\Form core/modules/workspaces/src/Form/SwitchToLiveForm.php Provides a form that switches to the live version of the site. 1
SymfonyInheritedEvent class Drupal\Tests\Component\EventDispatcher core/tests/Drupal/Tests/Component/EventDispatcher/ContainerAwareEventDispatcherTest.php
SymfonyMailer class Drupal\Core\Mail\Plugin\Mail core/lib/Drupal/Core/Mail/Plugin/Mail/SymfonyMailer.php Defines an experimental mail backend, based on the Symfony mailer component. 1
SymfonyMailerTest class Drupal\Tests\Core\Mail\Plugin\Mail core/tests/Drupal/Tests/Core/Mail/Plugin/Mail/SymfonyMailerTest.php @coversDefaultClass \Drupal\Core\Mail\Plugin\Mail\SymfonyMailer[[api-linebreak]] @group Mail
SynchronizableEntityTrait trait Drupal\Core\Entity core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php Provides a trait for accessing synchronization information. 1
SynchronizableInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/SynchronizableInterface.php Defines methods for an entity that supports synchronization. 2 3
SynchronizeCsrfTokenSeedTrait trait Drupal\Tests\ckeditor5\Traits core/modules/ckeditor5/tests/src/Traits/SynchronizeCsrfTokenSeedTrait.php Synchronizes the child site's CSRF token seed back to the test runner. 2
SyndicateBlock class Drupal\node\Plugin\Block core/modules/node/src/Plugin/Block/SyndicateBlock.php Provides a 'Syndicate' block that links to the site's RSS feed.
SyntaxTest class Drupal\Tests\pgsql\Kernel\pgsql core/modules/pgsql/tests/src/Kernel/pgsql/SyntaxTest.php Tests PostgreSQL syntax interpretation.
SyntaxTest class Drupal\Tests\sqlite\Kernel\sqlite core/modules/sqlite/tests/src/Kernel/sqlite/SyntaxTest.php Tests SQLite syntax interpretation.
SyntaxTest class Drupal\Tests\mysql\Kernel\mysql core/modules/mysql/tests/src/Kernel/mysql/SyntaxTest.php Tests MySql syntax interpretation.
SysLog class Drupal\syslog\Logger core/modules/syslog/src/Logger/SysLog.php Redirects logging messages to syslog. 1 1 2
SyslogTest class Drupal\Tests\syslog\Kernel core/modules/syslog/tests/src/Kernel/SyslogTest.php Test syslog logger functionality.
SyslogTest class Drupal\Tests\syslog\Functional core/modules/syslog/tests/src/Functional/SyslogTest.php Tests syslog settings.
SysLogTest class Drupal\syslog_test\Logger core/modules/syslog/tests/modules/syslog_test/src/Logger/SysLogTest.php Redirects logging messages to error_log. 2
SystemAdminMenuBlockAccessCheck class Drupal\system\Access core/modules/system/src/Access/SystemAdminMenuBlockAccessCheck.php Access check for routes implementing _access_admin_menu_block_page. 3
SystemAuthorizeTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/SystemAuthorizeTest.php Tests the authorize.php script and related API.
SystemBrandingBlock class Drupal\system\Plugin\Block core/modules/system/src/Plugin/Block/SystemBrandingBlock.php Provides a block to display 'Site branding' elements.

Other projects

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