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
NullStorageExpirable		class	Drupal\Core\KeyValueStore	core/lib/Drupal/Core/KeyValueStore/NullStorageExpirable.php	Defines a null key/value store implementation.
NullStorageTest		class	Drupal\Tests\Core\Config	core/tests/Drupal/Tests/Core/Config/NullStorageTest.php	Tests the NullStorage.
NullTestImageEffect		class	Drupal\image_module_test\Plugin\ImageEffect	core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/NullTestImageEffect.php	Performs no operation on an image resource.
Number		class	Drupal\Component\Utility	core/lib/Drupal/Component/Utility/Number.php	Provides helper methods for manipulating numbers.		3
Number		class	Drupal\Core\Render\Element	core/lib/Drupal/Core/Render/Element/Number.php	Provides a form element for numeric input, with special numeric validation.	1	1
NumberField		class	Drupal\field\Plugin\migrate\field\d7	core/modules/field/src/Plugin/migrate/field/d7/NumberField.php	MigrateField plugin for Drupal 7 number fields.
NumberFieldTest		class	Drupal\Tests\field\FunctionalJavascript\Number	core/modules/field/tests/src/FunctionalJavascript/Number/NumberFieldTest.php	Tests the numeric field widget.
NumberFieldTest		class	Drupal\Tests\field\Functional\Number	core/modules/field/tests/src/Functional/Number/NumberFieldTest.php	Tests the creation of numeric fields.
NumberItemTest		class	Drupal\Tests\field\Kernel\Number	core/modules/field/tests/src/Kernel/Number/NumberItemTest.php	Tests the new entity API for the number field type.
NumberListField		class	Drupal\options\Plugin\views\argument	core/modules/options/src/Plugin/views/argument/NumberListField.php	Argument handler for list field to show human readable name in the summary.
NumberTest		class	Drupal\Tests\Component\Utility	core/tests/Drupal/Tests/Component/Utility/NumberTest.php	Tests number manipulation utilities.
NumberWidget		class	Drupal\Core\Field\Plugin\Field\FieldWidget	core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/NumberWidget.php	Plugin implementation of the 'number' widget.
NumericArgument		class	Drupal\views\Plugin\views\argument	core/modules/views/src/Plugin/views/argument/NumericArgument.php	Basic argument handler for arguments that are numeric.	4	3
NumericArgumentTitleTest		class	Drupal\Tests\views\Unit\Plugin\argument	core/modules/views/tests/src/Unit/Plugin/argument/NumericArgumentTitleTest.php	Tests the title() method of NumericArgument.
NumericArgumentValidator		class	Drupal\views\Plugin\views\argument_validator	core/modules/views/src/Plugin/views/argument_validator/NumericArgumentValidator.php	Validate whether an argument is numeric or not.
NumericField		class	Drupal\views\Plugin\views\field	core/modules/views/src/Plugin/views/field/NumericField.php	Render a field as a numeric value.	1	2
NumericFilter		class	Drupal\views\Plugin\views\filter	core/modules/views/src/Plugin/views/filter/NumericFilter.php	Simple filter to handle greater than/less than filters.	2	2
NumericFilterTest		class	Drupal\Tests\views\Unit\Plugin\views\filter	core/modules/views/tests/src/Unit/Plugin/views/filter/NumericFilterTest.php	Tests Drupal\views\Plugin\views\filter\NumericFilter.
NumericFormatPluralTest		class	Drupal\Tests\views\Functional\Plugin	core/modules/views/tests/src/Functional/Plugin/NumericFormatPluralTest.php	Tests the creation of numeric fields.
NumericFormatterBase		abstract class	Drupal\Core\Field\Plugin\Field\FieldFormatter	core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/NumericFormatterBase.php	Parent plugin for decimal and integer formatters.	2
NumericItemBase		abstract class	Drupal\Core\Field\Plugin\Field\FieldType	core/lib/Drupal/Core/Field/Plugin/Field/FieldType/NumericItemBase.php	Base class for numeric configurable field types.	3	1
NumericUnformattedFormatter		class	Drupal\Core\Field\Plugin\Field\FieldFormatter	core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/NumericUnformattedFormatter.php	Plugin implementation of the 'number_unformatted' formatter.	1	1
NyanCatThemeEngine		class	Drupal\nyan_cat	core/modules/system/tests/modules/nyan_cat/src/NyanCatThemeEngine.php	NYAN NYAN NYAN!			2
ObjectAwareSerializationInterface		interface	Drupal\Component\Serialization	core/lib/Drupal/Component/Serialization/ObjectAwareSerializationInterface.php	Ensures that a serializer is usable for serializing PHP objects.	1	2
ObjectDefinition		class	Drupal\Tests\Core\Plugin	core/tests/Drupal/Tests/Core/Plugin/DefaultPluginManagerTest.php	Stub class for plugin definition.
ObjectDefinition		class	Drupal\Tests\Component\Annotation\Plugin\Discovery	core/tests/Drupal/Tests/Component/Annotation/Plugin/Discovery/AnnotationBridgeDecoratorTest.php
ObjectDefinition		class	Drupal\Tests\Component\Plugin\Discovery	core/tests/Drupal/Tests/Component/Plugin/Discovery/AttributeBridgeDecoratorTest.php
ObjectSerialization		class	Drupal\Core\Test	core/lib/Drupal/Core/Test/ObjectSerialization.php	Object to test that security issues around serialization.
ObjectWithPluginCollectionInterface		interface	Drupal\Core\Plugin	core/lib/Drupal/Core/Plugin/ObjectWithPluginCollectionInterface.php	Provides an interface for an object using a plugin collection.	1	1
ObjWithString		class	Drupal\Tests\migrate\Unit\process	core/modules/migrate/tests/src/Unit/process/LogTest.php	Test class with a __toString() method.
ObsoleteExtensionException		class	Drupal\Core\Extension\Exception	core/lib/Drupal/Core/Extension/Exception/ObsoleteExtensionException.php	Exception thrown when the extension is obsolete on install.		2
OEmbed		class	Drupal\media\Plugin\media\Source	core/modules/media/src/Plugin/media/Source/OEmbed.php	Provides a media source plugin for oEmbed resources.		1
OEmbedDeriver		class	Drupal\media\Plugin\media\Source	core/modules/media/src/Plugin/media/Source/OEmbedDeriver.php	Derives media source plugin definitions for supported oEmbed providers.
OEmbedFieldWidgetTest		class	Drupal\Tests\media\Functional\FieldWidget	core/modules/media/tests/src/Functional/FieldWidget/OEmbedFieldWidgetTest.php	Tests OEmbed Field Widget.
OEmbedForm		class	Drupal\media_library\Form	core/modules/media_library/src/Form/OEmbedForm.php	Creates a form to create media entities from oEmbed URLs.		2
OEmbedFormatter		class	Drupal\media\Plugin\Field\FieldFormatter	core/modules/media/src/Plugin/Field/FieldFormatter/OEmbedFormatter.php	Plugin implementation of the 'oembed' formatter.		1
OEmbedFormatterTest		class	Drupal\Tests\media\Functional\FieldFormatter	core/modules/media/tests/src/Functional/FieldFormatter/OEmbedFormatterTest.php	Tests OEmbed Formatter.
OEmbedIframeController		class	Drupal\media\Controller	core/modules/media/src/Controller/OEmbedIframeController.php	Controller which renders an oEmbed resource in a bare page (without blocks).		1
OEmbedIframeControllerTest		class	Drupal\Tests\media\Kernel	core/modules/media/tests/src/Kernel/OEmbedIframeControllerTest.php	Tests Drupal\media\Controller\OEmbedIframeController.
OEmbedInterface		interface	Drupal\media\Plugin\media\Source	core/modules/media/src/Plugin/media/Source/OEmbedInterface.php	Defines additional functionality for source plugins that use oEmbed.	1	5
OEmbedMediaSource		class	Drupal\media\Attribute	core/modules/media/src/Attribute/OEmbedMediaSource.php	Defines a OEmbedMediaSource attribute.		1
OEmbedResourceConstraint		class	Drupal\media\Plugin\Validation\Constraint	core/modules/media/src/Plugin/Validation/Constraint/OEmbedResourceConstraint.php	Checks if a value represents a valid oEmbed resource URL.		1
OEmbedResourceConstraintValidator		class	Drupal\media\Plugin\Validation\Constraint	core/modules/media/src/Plugin/Validation/Constraint/OEmbedResourceConstraintValidator.php	Validates oEmbed resource URLs.		1
OEmbedResourceConstraintValidatorTest		class	Drupal\Tests\media\Kernel	core/modules/media/tests/src/Kernel/OEmbedResourceConstraintValidatorTest.php	Tests Drupal\media\Plugin\Validation\Constraint\OEmbedResourceConstraintValidator.
OEmbedSourceTest		class	Drupal\Tests\media\Kernel	core/modules/media/tests/src/Kernel/OEmbedSourceTest.php	Tests Drupal\media\Plugin\media\Source\OEmbed.
OEmbedTestTrait		trait	Drupal\Tests\media\Traits	core/modules/media/tests/src/Traits/OEmbedTestTrait.php	Contains helper functions for testing oEmbed functionality in isolation.		6
OEmbedWidget		class	Drupal\media\Plugin\Field\FieldWidget	core/modules/media/src/Plugin/Field/FieldWidget/OEmbedWidget.php	Plugin implementation of the 'oembed_textfield' widget.		1
OffCanvasDialogTest		class	Drupal\Tests\system\Functional\Ajax	core/modules/system/tests/src/Functional/Ajax/OffCanvasDialogTest.php	Performs tests on opening and manipulating dialogs via AJAX commands.
OffCanvasRenderer		class	Drupal\Core\Render\MainContent	core/lib/Drupal/Core/Render/MainContent/OffCanvasRenderer.php	Default main content renderer for off-canvas dialog requests.			3
OffCanvasTest		class	Drupal\Tests\system\FunctionalJavascript	core/modules/system/tests/src/FunctionalJavascript/OffCanvasTest.php	Tests the off-canvas dialog functionality.

Other projects

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