Classes, traits, and interfaces - 9.5.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 1523

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
SearchPageTextTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchPageTextTest.php Tests the search help text and search page text.
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
SearchPluginManager class Drupal\search core/modules/search/src/SearchPluginManager.php SearchExecute plugin manager. 2
SearchPreprocessLangcodeTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchPreprocessLangcodeTest.php Tests that the search preprocessing uses the correct language code.
SearchQuery class Drupal\search core/modules/search/src/SearchQuery.php Search query extender and helper functions. 2 4
SearchQuery class Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/SearchQuery.php CorefakeWithAllCustomClasses implementation of \Drupal\search\SearchQuery.
SearchQueryAlterTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchQueryAlterTest.php Tests that the node search query can be altered via the query alter hook.
SearchRankingTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchRankingTest.php Indexes content and tests ranking factors.
SearchRow class Drupal\search\Plugin\views\row core/modules/search/src/Plugin/views/row/SearchRow.php Row handler plugin for displaying search results.
SearchSetLocaleTest class Drupal\Tests\search\Functional core/modules/search/tests/src/Functional/SearchSetLocaleTest.php Tests that search works with numeric locale settings.
SearchTextProcessor class Drupal\search core/modules/search/src/SearchTextProcessor.php Processes search text for indexing. 2
SearchTextProcessorInterface interface Drupal\search core/modules/search/src/SearchTextProcessorInterface.php Processes search text for indexing. 1 3
SearchTextProcessorTest class Drupal\Tests\search\Kernel core/modules/search/tests/src/Kernel/SearchTextProcessorTest.php Test search text preprocessing functionality.
SearchTokenizerTest class Drupal\Tests\search\Kernel core/modules/search/tests/src/Kernel/SearchTokenizerTest.php Tests that CJK tokenizer works as intended.
Section class Drupal\layout_builder core/modules/layout_builder/src/Section.php Provides a domain object for layout sections. 26
SectionComponent class Drupal\layout_builder core/modules/layout_builder/src/SectionComponent.php Provides a value object for a section component. 16
SectionComponentBuildRenderArrayEvent class Drupal\layout_builder\Event core/modules/layout_builder/src/Event/SectionComponentBuildRenderArrayEvent.php Event fired when a section component's render array is being built. 4
SectionComponentTest class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/SectionComponentTest.php @coversDefaultClass \Drupal\layout_builder\SectionComponent[[api-linebreak]] @group layout_builder
SectionData class Drupal\layout_builder\Plugin\DataType core/modules/layout_builder/src/Plugin/DataType/SectionData.php Provides a data type wrapping \Drupal\layout_builder\Section.
SectionListInterface interface Drupal\layout_builder core/modules/layout_builder/src/SectionListInterface.php Defines the interface for an object that stores layout sections. 4 3
SectionListTestBase abstract class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/SectionListTestBase.php Provides a base class for testing implementations of a section list. 5
SectionListTrait trait Drupal\layout_builder core/modules/layout_builder/src/SectionListTrait.php Provides a trait for maintaining a list of sections. 5
SectionListTraitTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/SectionListTraitTest.php @coversDefaultClass \Drupal\layout_builder\SectionListTrait[[api-linebreak]]
SectionRenderTest class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/SectionRenderTest.php @coversDefaultClass \Drupal\layout_builder\Section[[api-linebreak]] @group layout_builder
SectionStorage class Drupal\layout_builder\Annotation core/modules/layout_builder/src/Annotation/SectionStorage.php Defines a Section Storage type annotation object. 1
SectionStorageBase abstract class Drupal\layout_builder\Plugin\SectionStorage core/modules/layout_builder/src/Plugin/SectionStorage/SectionStorageBase.php Provides a base class for Section Storage types. 3 1
SectionStorageDefinition class Drupal\layout_builder\SectionStorage core/modules/layout_builder/src/SectionStorage/SectionStorageDefinition.php Provides section storage type plugin definition. 8
SectionStorageInterface interface Drupal\layout_builder core/modules/layout_builder/src/SectionStorageInterface.php Defines an interface for Section Storage type plugins. 4 34
SectionStorageLocalTaskProviderInterface interface Drupal\layout_builder\Plugin\SectionStorage core/modules/layout_builder/src/Plugin/SectionStorage/SectionStorageLocalTaskProviderInterface.php Allows section storage plugins to provide local tasks. 2 2
SectionStorageManager class Drupal\layout_builder\SectionStorage core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php Provides the Section Storage type plugin manager. 1 2
SectionStorageManagerInterface interface Drupal\layout_builder\SectionStorage core/modules/layout_builder/src/SectionStorage/SectionStorageManagerInterface.php Provides the interface for a plugin manager of section storage types. 1 11
SectionStorageManagerTest class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/SectionStorageManagerTest.php @coversDefaultClass \Drupal\layout_builder\SectionStorage\SectionStorageManager[[api-linebreak]]
SectionStorageTestBase

in drupal:9.3.0 and is removed from drupal:10.0.0. Use \Drupal\Tests\layout_builder\Kernel\SectionListTestBase instead.

 abstract class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/SectionStorageTestBase.php Provides a base class for testing implementations of section storage.
SectionStorageTrait

in drupal:9.3.0 and is removed from drupal:10.0.0. Use \Drupal\layout_builder\SectionListTrait instead.

 trait Drupal\layout_builder\SectionStorage core/modules/layout_builder/src/SectionStorage/SectionStorageTrait.php Provides a trait for storing sections on an object.
SectionTest class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/SectionTest.php @coversDefaultClass \Drupal\layout_builder\Section[[api-linebreak]] @group layout_builder
Secure class Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Annotation core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Annotation/Secure.php
SecuredRedirectResponse abstract class Drupal\Component\HttpFoundation core/lib/Drupal/Component/HttpFoundation/SecuredRedirectResponse.php Provides a common base class for safe redirects. 2 3
SecuredRedirectResponseTest class Drupal\Tests\Component\HttpFoundation core/tests/Drupal/Tests/Component/HttpFoundation/SecuredRedirectResponseTest.php Test secure redirect base class.
SecuredRedirectStub class Drupal\Tests\Component\HttpFoundation core/tests/Drupal/Tests/Component/HttpFoundation/SecuredRedirectResponseTest.php
SecurityAdvisoriesFetcher final class Drupal\system\SecurityAdvisories core/modules/system/src/SecurityAdvisories/SecurityAdvisoriesFetcher.php Defines a service to get security advisories. 1 2
SecurityAdvisoriesFetcherTest class Drupal\Tests\system\Kernel\SecurityAdvisories core/modules/system/tests/src/Kernel/SecurityAdvisories/SecurityAdvisoriesFetcherTest.php @coversDefaultClass \Drupal\system\SecurityAdvisories\SecurityAdvisoriesFetcher[[api-linebreak]]
SecurityAdvisory final class Drupal\system\SecurityAdvisories core/modules/system/src/SecurityAdvisories/SecurityAdvisory.php Provides a security advisory value object. 1
SecurityAdvisoryTest class Drupal\Tests\system\Unit\SecurityAdvisories core/modules/system/tests/src/Unit/SecurityAdvisories/SecurityAdvisoryTest.php @coversDefaultClass \Drupal\system\SecurityAdvisories\SecurityAdvisory[[api-linebreak]]
SecurityAdvisoryTest class Drupal\Tests\system\Functional\SecurityAdvisories core/modules/system/tests/src/Functional/SecurityAdvisories/SecurityAdvisoryTest.php Tests of security advisories functionality.

Other projects

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