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
LinkGenerationTestHooks class Drupal\link_generation_test\Hook core/modules/system/tests/modules/link_generation_test/src/Hook/LinkGenerationTestHooks.php Hook implementations for link_generation_test.
LinkGenerator class Drupal\Core\Utility core/lib/Drupal/Core/Utility/LinkGenerator.php Provides a class which generates a link with route names and parameters. 3 2
LinkGeneratorInterface interface Drupal\Core\Utility core/lib/Drupal/Core/Utility/LinkGeneratorInterface.php Defines an interface for generating links from route names and parameters. 1 5
LinkGeneratorTest class Drupal\Tests\Core\Utility core/tests/Drupal/Tests/Core/Utility/LinkGeneratorTest.php Tests Drupal\Core\Utility\LinkGenerator.
LinkHooks class Drupal\link\Hook core/modules/link/src/Hook/LinkHooks.php Hook implementations for link.
LinkInputValuesTraits trait Drupal\Tests\link\Traits core/modules/link/tests/src/Traits/LinkInputValuesTraits.php Provides test values for the Link field. 2
LinkItem class Drupal\link\Plugin\Field\FieldType core/modules/link/src/Plugin/Field/FieldType/LinkItem.php Plugin implementation of the 'link' field type. 1
LinkItemInterface interface Drupal\link core/modules/link/src/LinkItemInterface.php Defines an interface for the link field item. 1 27
LinkItemSerializationTest class Drupal\Tests\link\Kernel core/modules/link/tests/src/Kernel/LinkItemSerializationTest.php Tests link field serialization.
LinkItemTest class Drupal\Tests\link\Kernel core/modules/link/tests/src/Kernel/LinkItemTest.php Tests the new entity API for the link field type.
LinkItemUrlValidationTest class Drupal\Tests\link\Kernel core/modules/link/tests/src/Kernel/LinkItemUrlValidationTest.php Tests link field validation.
LinkNotExistingInternalConstraint class Drupal\link\Plugin\Validation\Constraint core/modules/link/src/Plugin/Validation/Constraint/LinkNotExistingInternalConstraint.php Defines a protocol validation constraint for links to broken internal URLs. 1
LinkNotExistingInternalConstraintValidator class Drupal\link\Plugin\Validation\Constraint core/modules/link/src/Plugin/Validation/Constraint/LinkNotExistingInternalConstraintValidator.php Validates the LinkNotExistingInternal constraint. 1
LinkNotExistingInternalConstraintValidatorTest class Drupal\Tests\link\Unit\Plugin\Validation\Constraint core/modules/link/tests/src/Unit/Plugin/Validation/Constraint/LinkNotExistingInternalConstraintValidatorTest.php Tests Drupal\link\Plugin\Validation\Constraint\LinkNotExistingInternalConstraintValidator.
LinkOptions class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/LinkOptions.php Converts links options.
LinkOptions

in drupal:11.4.0 and is removed from drupal:13.0.0. Use \Drupal\migrate\Plugin\migrate\process\LinkOptions instead.

Examples:

 class Drupal\menu_link_content\Plugin\migrate\process core/modules/menu_link_content/src/Plugin/migrate/process/LinkOptions.php Converts links options.
LinkRelationsTest class Drupal\KernelTests\Core\Http core/tests/Drupal/KernelTests/Core/Http/LinkRelationsTest.php Tests link relationships in Drupal.
LinkRelationType class Drupal\Core\Http core/lib/Drupal/Core/Http/LinkRelationType.php Defines a single link relationship type. 1
LinkRelationTypeInterface interface Drupal\Core\Http core/lib/Drupal/Core/Http/LinkRelationTypeInterface.php Defines a single link relation type. 1
LinkRelationTypeManager class Drupal\Core\Http core/lib/Drupal/Core/Http/LinkRelationTypeManager.php Provides a default plugin manager for link relation types. 2
LinkReply class Drupal\comment\Plugin\views\field core/modules/comment/src/Plugin/views/field/LinkReply.php Field handler to present a link to reply to a comment. 1
LinkReplyTest class Drupal\Tests\comment\Unit\Plugin\views\field core/modules/comment/tests/src/Unit/Plugin/views/field/LinkReplyTest.php Tests Drupal\comment\Plugin\views\field\LinkReply.
Links abstract class Drupal\views\Plugin\views\field core/modules/views/src/Plugin/views/field/Links.php An abstract handler which provides a collection of links. 1
LinkSeparateFormatter class Drupal\link\Plugin\Field\FieldFormatter core/modules/link/src/Plugin/Field/FieldFormatter/LinkSeparateFormatter.php Plugin implementation of the 'link_separate' formatter.
LinkSeparateFormatterDisplayTest class Drupal\Tests\link\Kernel core/modules/link/tests/src/Kernel/LinkSeparateFormatterDisplayTest.php Tests the 'link_separate' field formatter.
LinksetController final class Drupal\system\Controller core/modules/system/src/Controller/LinksetController.php Linkset controller.
LinksetControllerMultiLingualTest final class Drupal\Tests\system\Functional\Menu core/modules/system/tests/src/Functional/Menu/LinksetControllerMultiLingualTest.php Tests the behavior of the linkset controller in multilingual setup.
LinksetControllerTest final class Drupal\Tests\system\Functional\Menu core/modules/system/tests/src/Functional/Menu/LinksetControllerTest.php Tests the behavior of the linkset controller.
LinksetControllerTestBase abstract class Drupal\Tests\system\Functional\Menu core/modules/system/tests/src/Functional/Menu/LinksetControllerTestBase.php A base class for implementing LinksetController tests. 2
LinkTest class Drupal\Tests\jsonapi\Unit\JsonApiResource core/modules/jsonapi/tests/src/Unit/JsonApiResource/LinkTest.php Tests Drupal\jsonapi\JsonApiResource\Link.
LinkTestBaseFieldHooks class Drupal\link_test_base_field\Hook core/modules/link/tests/modules/link_test_base_field/src/Hook/LinkTestBaseFieldHooks.php Hook implementations for link_test_base_field.
LinkThemeHooks class Drupal\link\Hook core/modules/link/src/Hook/LinkThemeHooks.php Theme hooks for link. 1
LinkTitleRequiredConstraint class Drupal\link\Plugin\Validation\Constraint core/modules/link/src/Plugin/Validation/Constraint/LinkTitleRequiredConstraint.php Validation constraint for link title subfields if a URL was entered. 1
LinkTitleRequiredConstraintValidator class Drupal\link\Plugin\Validation\Constraint core/modules/link/src/Plugin/Validation/Constraint/LinkTitleRequiredConstraintValidator.php Constraint validator for link title subfields if a URL was entered. 1
LinkTitleRequiredConstraintValidatorTest class Drupal\Tests\link\Unit\Plugin\Validation\Constraint core/modules/link/tests/src/Unit/Plugin/Validation/Constraint/LinkTitleRequiredConstraintValidatorTest.php Tests LinkTitleRequiredConstraintValidator::validate().
LinkTypeConstraint class Drupal\link\Plugin\Validation\Constraint core/modules/link/src/Plugin/Validation/Constraint/LinkTypeConstraint.php Validation constraint for links receiving data allowed by its settings. 1
LinkTypeConstraintValidator class Drupal\link\Plugin\Validation\Constraint core/modules/link/src/Plugin/Validation/Constraint/LinkTypeConstraintValidator.php Constraint validator for links receiving data allowed by its settings. 1
LinkTypeConstraintValidatorTest class Drupal\Tests\link\Unit\Plugin\Validation\Constraint core/modules/link/tests/src/Unit/Plugin/Validation/Constraint/LinkTypeConstraintValidatorTest.php Tests LinkTypeConstraintValidator.
LinkUri class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/LinkUri.php Generates an internal URI from the source value. 1
LinkUri

in drupal:11.4.0 and is removed from drupal:13.0.0. Use \Drupal\migrate\Plugin\migrate\process\LinkUri instead.

Converts the source path value to an 'entity:', 'internal:' or 'base:' URI.

Available configuration keys:

  • source: A source path to be converted into an URI.
  • validate_route: (optional) Whether the plugin should validate that the URI derived from the source link path has a valid Drupal route.

    • TRUE: Throw a MigrateException if the resulting URI is not routed. This value is the default.
    • FALSE: Return the URI for the unrouted path.

Examples:

 class Drupal\menu_link_content\Plugin\migrate\process core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php Generates an internal URI from the source value. 1
LinkUriTest class Drupal\Tests\menu_link_content\Kernel\Plugin\migrate\process core/modules/menu_link_content/tests/src/Kernel/Plugin/migrate/process/LinkUriTest.php Tests \Drupal\menu_link_content\Plugin\migrate\process\LinkUri.
LinkUriTest class Drupal\Tests\migrate\Kernel\process core/modules/migrate/tests/src/Kernel/process/LinkUriTest.php Tests \Drupal\migrate\Plugin\migrate\process\LinkUri.
LinkViewsTokensTest class Drupal\Tests\link\Functional\Views core/modules/link/tests/src/Functional/Views/LinkViewsTokensTest.php Tests the views integration for link tokens.
LinkWidget class Drupal\link\Plugin\Field\FieldWidget core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php Plugin implementation of the 'link' widget.
ListCacheBinsPass class Drupal\Core\Cache core/lib/Drupal/Core/Cache/ListCacheBinsPass.php Adds cache_bins parameter to the container. 1
ListDataDefinition class Drupal\Core\TypedData core/lib/Drupal/Core/TypedData/ListDataDefinition.php A typed data definition class for defining lists. 3 7
ListDataDefinitionInterface interface Drupal\Core\TypedData core/lib/Drupal/Core/TypedData/ListDataDefinitionInterface.php Interface for data definitions of lists. 2 4
ListElement class Drupal\config_translation\FormElement core/modules/config_translation/src/FormElement/ListElement.php Defines the list element for the configuration translation interface.
ListField class Drupal\options\Plugin\views\filter core/modules/options/src/Plugin/views/filter/ListField.php Filter handler which uses list-fields as options.
ListField class Drupal\options\Plugin\migrate\field\d7 core/modules/options/src/Plugin/migrate/field/d7/ListField.php Migrate field plugin for Drupal 7 list fields.

Other projects

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