diff options
110 files changed, 157 insertions, 19 deletions
diff --git a/core/modules/big_pipe/tests/modules/big_pipe_regression_test/src/BigPipeRegressionTestController.php b/core/modules/big_pipe/tests/modules/big_pipe_regression_test/src/BigPipeRegressionTestController.php index fe5a0e00ce4..2d894da837e 100644 --- a/core/modules/big_pipe/tests/modules/big_pipe_regression_test/src/BigPipeRegressionTestController.php +++ b/core/modules/big_pipe/tests/modules/big_pipe_regression_test/src/BigPipeRegressionTestController.php @@ -87,6 +87,7 @@ class BigPipeRegressionTestController implements TrustedCallbackInterface { * #lazy_builder callback; builds <time> markup with current time. * * @return array + * Render array with a <time> markup with current time and cache settings. */ public static function currentTime() { return [ diff --git a/core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php b/core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php index 451523e0941..48471501c40 100644 --- a/core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php +++ b/core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php @@ -32,6 +32,7 @@ class BigPipePlaceholderTestCases { * Optional. Necessary to get the embedded AJAX/HTML responses. * * @return \Drupal\big_pipe_test\BigPipePlaceholderTestCase[] + * An array of placeholder test cases. */ public static function cases(?ContainerInterface $container = NULL, ?AccountInterface $user = NULL) { // Define the two types of cacheability that we expect to see. These will be diff --git a/core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipeTestController.php b/core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipeTestController.php index 207d60a9e75..c625f7d2d23 100644 --- a/core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipeTestController.php +++ b/core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipeTestController.php @@ -19,6 +19,7 @@ class BigPipeTestController implements TrustedCallbackInterface { * Returns all BigPipe placeholder test case render arrays. * * @return array + * Render array containing various Big Pipe placeholder test cases. */ public function test() { $has_session = \Drupal::service('session_configuration')->hasSession(\Drupal::requestStack()->getMainRequest()); @@ -63,6 +64,7 @@ class BigPipeTestController implements TrustedCallbackInterface { /** * @return array + * List of all BigPipe placeholder test cases. */ public static function nope() { return ['#markup' => '<p>Nope.</p>']; @@ -74,6 +76,7 @@ class BigPipeTestController implements TrustedCallbackInterface { * @see \Drupal\Tests\big_pipe\Functional\BigPipeTest::testBigPipeMultiOccurrencePlaceholders() * * @return array + * Render array with multiple placeholders using a lazy builder. */ public function multiOccurrence() { return [ @@ -96,6 +99,9 @@ class BigPipeTestController implements TrustedCallbackInterface { * A page with placeholder preview. * * @return array[] + * A render array with two containers: + * - 'user_container': Loads the user’s display name via a lazy builder. + * - 'user_links_container': Loads user links with a placeholder preview. */ public function placeholderPreview() { return [ @@ -129,6 +135,8 @@ class BigPipeTestController implements TrustedCallbackInterface { * Note: does not actually use current time, that would complicate testing. * * @return array + * A render array containing a <time> element with a predefined date + * and disabled caching for dynamic rendering. */ public static function currentTime() { return [ @@ -141,6 +149,8 @@ class BigPipeTestController implements TrustedCallbackInterface { * #lazy_builder callback; suspends its own execution then returns markup. * * @return array + * A render array with a pig-themed message wrapped in a <span>, + * and caching disabled to ensure dynamic rendering. */ public static function piggy(): array { // Immediately call Fiber::suspend(), so that other placeholders are @@ -159,6 +169,8 @@ class BigPipeTestController implements TrustedCallbackInterface { * #lazy_builder callback; says "hello" or "hi". * * @return array + * A render array with a marquee message using BigPipeMarkup, + * with caching disabled and a custom cache tag. */ public static function helloOrHi() { return [ @@ -185,6 +197,7 @@ class BigPipeTestController implements TrustedCallbackInterface { * @see \Drupal\big_pipe_test\EventSubscriber\BigPipeTestSubscriber::onRespondTriggerException() * * @return array + * A render array with plain text for testing BigPipe error handling. */ public static function responseException() { return ['#plain_text' => BigPipeTestSubscriber::CONTENT_TRIGGER_EXCEPTION]; diff --git a/core/modules/big_pipe/tests/src/Functional/BigPipeTest.php b/core/modules/big_pipe/tests/src/Functional/BigPipeTest.php index 1fac58c8115..e6e2784fc11 100644 --- a/core/modules/big_pipe/tests/src/Functional/BigPipeTest.php +++ b/core/modules/big_pipe/tests/src/Functional/BigPipeTest.php @@ -461,6 +461,7 @@ class BigPipeTest extends BrowserTestBase { /** * @return \Drupal\big_pipe_test\BigPipePlaceholderTestCase[] + * An array of test cases. */ protected function getTestCases($has_session = TRUE) { return BigPipePlaceholderTestCases::cases($this->container, $this->rootUser); diff --git a/core/modules/big_pipe/tests/src/Unit/Render/FiberPlaceholderTest.php b/core/modules/big_pipe/tests/src/Unit/Render/FiberPlaceholderTest.php index 33e3afe0177..b64095ecbdc 100644 --- a/core/modules/big_pipe/tests/src/Unit/Render/FiberPlaceholderTest.php +++ b/core/modules/big_pipe/tests/src/Unit/Render/FiberPlaceholderTest.php @@ -121,6 +121,7 @@ class TurtleLazyBuilder implements TrustedCallbackInterface { * Suspends its own execution twice to simulate long operation. * * @return array + * The lazy builder callback. */ public static function turtle(): array { if (\Fiber::getCurrent() !== NULL) { diff --git a/core/modules/block/tests/src/FunctionalJavascript/BlockFilterTest.php b/core/modules/block/tests/src/FunctionalJavascript/BlockFilterTest.php index 8914669d72c..3502e65a195 100644 --- a/core/modules/block/tests/src/FunctionalJavascript/BlockFilterTest.php +++ b/core/modules/block/tests/src/FunctionalJavascript/BlockFilterTest.php @@ -89,6 +89,7 @@ class BlockFilterTest extends WebDriverTestBase { * An array of node elements. * * @return \Behat\Mink\Element\NodeElement[] + * An array of visible elements. */ protected function filterVisibleElements(array $elements): array { $elements = array_filter($elements, function (NodeElement $element) { diff --git a/core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php b/core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php index 79802e1e376..5a8f88d7101 100644 --- a/core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php +++ b/core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php @@ -60,6 +60,8 @@ class CategoryAutocompleteTest extends UnitTestCase { * Data provider for testAutocompleteSuggestions(). * * @return array + * An array of test cases, each containing an input string and + * expected autocomplete suggestions. */ public static function providerTestAutocompleteSuggestions() { $test_parameters = []; diff --git a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestBase.php b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestBase.php index 9d86c0ee392..427a74a7054 100644 --- a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestBase.php +++ b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestBase.php @@ -51,6 +51,7 @@ abstract class ImageTestBase extends CKEditor5TestBase { * Provides the relevant image attributes. * * @return string[] + * An associative array with the image source, width, and height. */ protected function imageAttributes() { return [ @@ -67,6 +68,7 @@ abstract class ImageTestBase extends CKEditor5TestBase { * Reverse attributes when printing them. * * @return string + * A space-separated string of image attributes. */ protected function imageAttributesAsString($reverse = FALSE) { $string = []; diff --git a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestProviderTrait.php b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestProviderTrait.php index 91ff49e9186..9e7571bc790 100644 --- a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestProviderTrait.php +++ b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestProviderTrait.php @@ -243,6 +243,7 @@ trait ImageTestProviderTrait { * Data provider for ::testWidth(). * * @return string[][] + * An array of test cases, each with a width value. */ public static function providerWidth(): array { return [ diff --git a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestTestBase.php b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestTestBase.php index c60b8d4e8f9..070ae0e90ca 100644 --- a/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestTestBase.php +++ b/core/modules/ckeditor5/tests/src/FunctionalJavascript/ImageTestTestBase.php @@ -113,6 +113,7 @@ class ImageTestTestBase extends ImageTestBase { * Provides the relevant image attributes. * * @return string[] + * Default image attributes for tests. */ protected function imageAttributes(): array { return [ diff --git a/core/modules/ckeditor5/tests/src/FunctionalJavascript/LanguageTest.php b/core/modules/ckeditor5/tests/src/FunctionalJavascript/LanguageTest.php index c46c5588ac3..47ed0b6569b 100644 --- a/core/modules/ckeditor5/tests/src/FunctionalJavascript/LanguageTest.php +++ b/core/modules/ckeditor5/tests/src/FunctionalJavascript/LanguageTest.php @@ -81,6 +81,8 @@ JS; * Data provider for ensuring CKEditor 5 UI translations are loaded. * * @return string[][] + * An array of language code, CKEditor 5 plugin name, and expected + * translation. */ public static function provider(): array { return [ diff --git a/core/modules/ckeditor5/tests/src/Kernel/LanguageTest.php b/core/modules/ckeditor5/tests/src/Kernel/LanguageTest.php index 711354bd5b2..227496d6419 100644 --- a/core/modules/ckeditor5/tests/src/Kernel/LanguageTest.php +++ b/core/modules/ckeditor5/tests/src/Kernel/LanguageTest.php @@ -99,6 +99,7 @@ class LanguageTest extends KernelTestBase { * Provides a list of language code pairs. * * @return string[][] + * An array of language code pairs. */ public static function provider(): array { $random_langcode = Random::machineName(); diff --git a/core/modules/ckeditor5/tests/src/Unit/SmartDefaultSettingsTest.php b/core/modules/ckeditor5/tests/src/Unit/SmartDefaultSettingsTest.php index c694c2870b4..aeb866eaffd 100644 --- a/core/modules/ckeditor5/tests/src/Unit/SmartDefaultSettingsTest.php +++ b/core/modules/ckeditor5/tests/src/Unit/SmartDefaultSettingsTest.php @@ -38,6 +38,7 @@ class SmartDefaultSettingsTest extends UnitTestCase { * Data provider for testing computeSurplusScore(). * * @return \Generator + * Yields the data for testSurplusScore(). */ public static function providerSurplusScore(): \Generator { $needed = new HTMLRestrictions(['code' => FALSE]); @@ -103,6 +104,7 @@ class SmartDefaultSettingsTest extends UnitTestCase { * Data provider for testing getCandidates() and ::selectCandidate(). * * @return \Generator + * Yields the data for testCandidates(). */ public static function providerCandidates(): \Generator { $generate_definition = function (string $label_and_id, array $overrides): CKEditor5PluginDefinition { diff --git a/core/modules/comment/tests/src/Kernel/Migrate/d7/CommentEntityTranslationCheckRequirementsTest.php b/core/modules/comment/tests/src/Kernel/Migrate/d7/CommentEntityTranslationCheckRequirementsTest.php index 47dc5969acd..26f84a0f1e3 100644 --- a/core/modules/comment/tests/src/Kernel/Migrate/d7/CommentEntityTranslationCheckRequirementsTest.php +++ b/core/modules/comment/tests/src/Kernel/Migrate/d7/CommentEntityTranslationCheckRequirementsTest.php @@ -47,6 +47,7 @@ class CommentEntityTranslationCheckRequirementsTest extends MigrateDrupal7TestBa * Provides data for testCheckRequirements. * * @return string[][] + * An array of module machine names. */ public static function providerTestCheckRequirements() { return [ diff --git a/core/modules/config/tests/src/FunctionalJavascript/ConfigExportTest.php b/core/modules/config/tests/src/FunctionalJavascript/ConfigExportTest.php index 4323a4b2ae3..2489d31ae95 100644 --- a/core/modules/config/tests/src/FunctionalJavascript/ConfigExportTest.php +++ b/core/modules/config/tests/src/FunctionalJavascript/ConfigExportTest.php @@ -64,6 +64,7 @@ class ConfigExportTest extends WebDriverTestBase { * Title of the block. * * @return \Drupal\block_content\Entity\BlockContent + * The created block content entity. * * @throws \Drupal\Core\Entity\EntityStorageException */ diff --git a/core/modules/content_translation/tests/src/Kernel/ContentTranslationFieldSyncRevisionTest.php b/core/modules/content_translation/tests/src/Kernel/ContentTranslationFieldSyncRevisionTest.php index 2e9ed9e2661..52418c28089 100644 --- a/core/modules/content_translation/tests/src/Kernel/ContentTranslationFieldSyncRevisionTest.php +++ b/core/modules/content_translation/tests/src/Kernel/ContentTranslationFieldSyncRevisionTest.php @@ -480,6 +480,7 @@ class ContentTranslationFieldSyncRevisionTest extends EntityKernelTestBase { /** * @return \Drupal\Core\Entity\ContentEntityInterface + * The saved entity. */ protected function saveNewEntity() { /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */ diff --git a/core/modules/datetime/tests/src/Functional/DateTestBase.php b/core/modules/datetime/tests/src/Functional/DateTestBase.php index 6b128598a94..b7399930273 100644 --- a/core/modules/datetime/tests/src/Functional/DateTestBase.php +++ b/core/modules/datetime/tests/src/Functional/DateTestBase.php @@ -82,6 +82,7 @@ abstract class DateTestBase extends BrowserTestBase { * Returns the type of field to be tested. * * @return string + * The field type to be tested. */ abstract protected function getTestFieldType(); diff --git a/core/modules/filter/tests/src/Kernel/Plugin/migrate/process/FilterSettingsTest.php b/core/modules/filter/tests/src/Kernel/Plugin/migrate/process/FilterSettingsTest.php index 75d2845c477..c44651dd6e3 100644 --- a/core/modules/filter/tests/src/Kernel/Plugin/migrate/process/FilterSettingsTest.php +++ b/core/modules/filter/tests/src/Kernel/Plugin/migrate/process/FilterSettingsTest.php @@ -43,6 +43,7 @@ class FilterSettingsTest extends MigrateTestCase { * The test data provider. * * @return array + * An array of test data. */ public static function dataProvider() { return [ diff --git a/core/modules/image/tests/src/Functional/ImageFieldValidateTest.php b/core/modules/image/tests/src/Functional/ImageFieldValidateTest.php index afe46956874..8b15f60acad 100644 --- a/core/modules/image/tests/src/Functional/ImageFieldValidateTest.php +++ b/core/modules/image/tests/src/Functional/ImageFieldValidateTest.php @@ -272,6 +272,7 @@ class ImageFieldValidateTest extends ImageFieldTestBase { * The maximum width and height setting. * * @return array + * List of field settings. */ protected function getFieldSettings($min_resolution, $max_resolution): array { return [ diff --git a/core/modules/jsonapi/tests/modules/jsonapi_test_meta_events/src/EventSubscriber/MetaEventSubscriber.php b/core/modules/jsonapi/tests/modules/jsonapi_test_meta_events/src/EventSubscriber/MetaEventSubscriber.php index a28716f0340..3315e025fcd 100644 --- a/core/modules/jsonapi/tests/modules/jsonapi_test_meta_events/src/EventSubscriber/MetaEventSubscriber.php +++ b/core/modules/jsonapi/tests/modules/jsonapi_test_meta_events/src/EventSubscriber/MetaEventSubscriber.php @@ -29,8 +29,6 @@ class MetaEventSubscriber implements EventSubscriberInterface { /** * @param \Drupal\jsonapi\Events\CollectResourceObjectMetaEvent $event * Event to be processed. - * - * @return void */ public function addResourceObjectMeta(CollectResourceObjectMetaEvent $event): void { $config = \Drupal::state()->get('jsonapi_test_meta_events.object_meta', [ @@ -72,8 +70,6 @@ class MetaEventSubscriber implements EventSubscriberInterface { /** * @param \Drupal\jsonapi\Events\CollectRelationshipMetaEvent $event * Event to be processed. - * - * @return void */ public function addRelationshipMeta(CollectRelationshipMetaEvent $event): void { $config = \Drupal::state()->get('jsonapi_test_meta_events.relationship_meta', [ @@ -138,6 +134,8 @@ class MetaEventSubscriber implements EventSubscriberInterface { /** * @return string + * The value 'yes' if the current user has an admin role, 'no' otherwise. + * * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ diff --git a/core/modules/jsonapi/tests/src/Kernel/Normalizer/LinkCollectionNormalizerTest.php b/core/modules/jsonapi/tests/src/Kernel/Normalizer/LinkCollectionNormalizerTest.php index a4cdb4f5444..2d15edb3480 100644 --- a/core/modules/jsonapi/tests/src/Kernel/Normalizer/LinkCollectionNormalizerTest.php +++ b/core/modules/jsonapi/tests/src/Kernel/Normalizer/LinkCollectionNormalizerTest.php @@ -169,6 +169,7 @@ class LinkCollectionNormalizerTest extends KernelTestBase { * Provides test cases for testing link access checking. * * @return array[] + * An array of test cases for testLinkAccess(). */ public static function linkAccessTestData() { return [ diff --git a/core/modules/language/tests/src/Functional/LanguageNegotiationInfoTest.php b/core/modules/language/tests/src/Functional/LanguageNegotiationInfoTest.php index 14e55ed1b5a..a1a760a48bb 100644 --- a/core/modules/language/tests/src/Functional/LanguageNegotiationInfoTest.php +++ b/core/modules/language/tests/src/Functional/LanguageNegotiationInfoTest.php @@ -45,6 +45,7 @@ class LanguageNegotiationInfoTest extends BrowserTestBase { * Returns the configurable language manager. * * @return \Drupal\language\ConfigurableLanguageManager + * The language manager. */ protected function languageManager() { return $this->container->get('language_manager'); diff --git a/core/modules/language/tests/src/Unit/Plugin/LanguageNegotiation/LanguageNegotiationTestBase.php b/core/modules/language/tests/src/Unit/Plugin/LanguageNegotiation/LanguageNegotiationTestBase.php index e35731c47b9..07d825127e4 100644 --- a/core/modules/language/tests/src/Unit/Plugin/LanguageNegotiation/LanguageNegotiationTestBase.php +++ b/core/modules/language/tests/src/Unit/Plugin/LanguageNegotiation/LanguageNegotiationTestBase.php @@ -26,6 +26,7 @@ abstract class LanguageNegotiationTestBase extends UnitTestCase { * Creates a @LanguageNegotiation plugin using the factory ::create method. * * @return \Drupal\language\LanguageNegotiationMethodInterface + * The created language negotiation plugin. */ protected function createLanguageNegotiationPlugin(array $configuration = [], $plugin_definition = NULL) { $class = $this->getPluginClass(); diff --git a/core/modules/media/tests/src/Functional/FieldFormatter/OEmbedFormatterTest.php b/core/modules/media/tests/src/Functional/FieldFormatter/OEmbedFormatterTest.php index 88c2cbf8e01..80d0a653d16 100644 --- a/core/modules/media/tests/src/Functional/FieldFormatter/OEmbedFormatterTest.php +++ b/core/modules/media/tests/src/Functional/FieldFormatter/OEmbedFormatterTest.php @@ -58,6 +58,7 @@ class OEmbedFormatterTest extends MediaFunctionalTestBase { * @see ::testRender() * * @return array + * An array of test data. */ public static function providerRender() { return [ diff --git a/core/modules/media/tests/src/Functional/ResourceFetcherTest.php b/core/modules/media/tests/src/Functional/ResourceFetcherTest.php index ec327a73ac7..8542b3a2a4d 100644 --- a/core/modules/media/tests/src/Functional/ResourceFetcherTest.php +++ b/core/modules/media/tests/src/Functional/ResourceFetcherTest.php @@ -38,6 +38,7 @@ class ResourceFetcherTest extends MediaFunctionalTestBase { * Data provider for testFetchResource(). * * @return array + * An array of test data. */ public static function providerFetchResource() { return [ diff --git a/core/modules/media/tests/src/Functional/UrlResolverTest.php b/core/modules/media/tests/src/Functional/UrlResolverTest.php index bbd12372a3f..e6629104f46 100644 --- a/core/modules/media/tests/src/Functional/UrlResolverTest.php +++ b/core/modules/media/tests/src/Functional/UrlResolverTest.php @@ -39,6 +39,7 @@ class UrlResolverTest extends MediaFunctionalTestBase { * @see ::testEndpointMatching() * * @return array + * An array of test data. */ public static function providerEndpointMatching() { return [ @@ -103,6 +104,7 @@ class UrlResolverTest extends MediaFunctionalTestBase { * @see ::testUrlDiscovery() * * @return array + * An array of test data. */ public static function providerUrlDiscovery() { return [ diff --git a/core/modules/media/tests/src/Kernel/MediaThumbnailFormatterTest.php b/core/modules/media/tests/src/Kernel/MediaThumbnailFormatterTest.php index e7f6ee635b5..124d3f490cf 100644 --- a/core/modules/media/tests/src/Kernel/MediaThumbnailFormatterTest.php +++ b/core/modules/media/tests/src/Kernel/MediaThumbnailFormatterTest.php @@ -91,6 +91,7 @@ class MediaThumbnailFormatterTest extends MediaKernelTestBase { * Data provider for testSettingsSummary(). * * @return array[] + * An array of test data. */ public static function providerTestSettingsSummary(): array { return [ diff --git a/core/modules/media/tests/src/Kernel/OEmbedIframeControllerTest.php b/core/modules/media/tests/src/Kernel/OEmbedIframeControllerTest.php index 05005000471..76b2523c568 100644 --- a/core/modules/media/tests/src/Kernel/OEmbedIframeControllerTest.php +++ b/core/modules/media/tests/src/Kernel/OEmbedIframeControllerTest.php @@ -28,6 +28,7 @@ class OEmbedIframeControllerTest extends MediaKernelTestBase { * Data provider for testBadHashParameter(). * * @return array + * An array of test cases.OffCanvasDialogTest.php */ public static function providerBadHashParameter() { return [ diff --git a/core/modules/media/tests/src/Kernel/ProviderRepositoryTest.php b/core/modules/media/tests/src/Kernel/ProviderRepositoryTest.php index c8ed11cdf44..1fff55829bf 100644 --- a/core/modules/media/tests/src/Kernel/ProviderRepositoryTest.php +++ b/core/modules/media/tests/src/Kernel/ProviderRepositoryTest.php @@ -43,6 +43,7 @@ class ProviderRepositoryTest extends MediaKernelTestBase { * @see ::testEmptyProviderList() * * @return array + * An array of test cases. */ public static function providerEmptyProviderList() { return [ @@ -77,6 +78,7 @@ class ProviderRepositoryTest extends MediaKernelTestBase { * @see ::testEmptyProviderList() * * @return array + * An array of test cases. */ public static function providerNonExistingProviderDatabase() { return [ diff --git a/core/modules/media/tests/src/Traits/OEmbedTestTrait.php b/core/modules/media/tests/src/Traits/OEmbedTestTrait.php index 273b2513301..b57de135045 100644 --- a/core/modules/media/tests/src/Traits/OEmbedTestTrait.php +++ b/core/modules/media/tests/src/Traits/OEmbedTestTrait.php @@ -17,6 +17,7 @@ trait OEmbedTestTrait { * Returns the relative path to the oEmbed fixtures directory. * * @return string + * The relative path to the oEmbed fixtures directory. */ protected function getFixturesDirectory(): string { return \Drupal::service('extension.list.module')->getPath('media') . '/tests/fixtures/oembed'; @@ -26,6 +27,7 @@ trait OEmbedTestTrait { * Returns the absolute URL of the oEmbed fixtures directory. * * @return string + * The absolute URL of the oEmbed fixtures directory. */ protected function getFixturesUrl(): string { return $this->baseUrl . '/' . $this->getFixturesDirectory(); diff --git a/core/modules/media/tests/src/Unit/IFrameUrlHelperTest.php b/core/modules/media/tests/src/Unit/IFrameUrlHelperTest.php index cd384efb2b4..389fb37c23d 100644 --- a/core/modules/media/tests/src/Unit/IFrameUrlHelperTest.php +++ b/core/modules/media/tests/src/Unit/IFrameUrlHelperTest.php @@ -22,6 +22,7 @@ class IFrameUrlHelperTest extends UnitTestCase { * @see ::testIsSecure() * * @return array + * An array of test data. */ public static function providerIsSecure() { return [ diff --git a/core/modules/migrate/tests/src/Kernel/HighWaterTest.php b/core/modules/migrate/tests/src/Kernel/HighWaterTest.php index 28b4f633bfc..402275698be 100644 --- a/core/modules/migrate/tests/src/Kernel/HighWaterTest.php +++ b/core/modules/migrate/tests/src/Kernel/HighWaterTest.php @@ -295,6 +295,7 @@ class HighWaterTest extends MigrateTestBase { * Title of the node. * * @return bool + * TRUE if node exists, FALSE otherwise. */ protected function nodeExists($title): bool { $query = \Drupal::entityQuery('node')->accessCheck(FALSE); diff --git a/core/modules/migrate/tests/src/Kernel/MigrateSourceTestBase.php b/core/modules/migrate/tests/src/Kernel/MigrateSourceTestBase.php index 7d2a59e5297..1999e3ad86f 100644 --- a/core/modules/migrate/tests/src/Kernel/MigrateSourceTestBase.php +++ b/core/modules/migrate/tests/src/Kernel/MigrateSourceTestBase.php @@ -82,6 +82,7 @@ abstract class MigrateSourceTestBase extends KernelTestBase { * Determines the plugin to be tested by reading the class @covers annotation. * * @return string + * The fully qualified class name of the plugin to be tested. */ protected function getPluginClass() { $covers = $this->getTestClassCovers(); diff --git a/core/modules/migrate/tests/src/Kernel/TrackChangesTest.php b/core/modules/migrate/tests/src/Kernel/TrackChangesTest.php index 03f8d74f20c..fae23fd46b4 100644 --- a/core/modules/migrate/tests/src/Kernel/TrackChangesTest.php +++ b/core/modules/migrate/tests/src/Kernel/TrackChangesTest.php @@ -225,6 +225,7 @@ class TrackChangesTest extends MigrateTestBase { * Value to evaluate. * * @return bool + * TRUE if term exists, FALSE otherwise. */ protected function termExists($property, $value): bool { $property = $property === 'description' ? 'description__value' : $property; diff --git a/core/modules/migrate/tests/src/Kernel/process/ExtractTest.php b/core/modules/migrate/tests/src/Kernel/process/ExtractTest.php index 6651337f1bf..641b4e5bfa8 100644 --- a/core/modules/migrate/tests/src/Kernel/process/ExtractTest.php +++ b/core/modules/migrate/tests/src/Kernel/process/ExtractTest.php @@ -24,6 +24,7 @@ class ExtractTest extends KernelTestBase { * Returns test migration definition. * * @return array + * The test migration definition. */ public function getDefinition() { return [ diff --git a/core/modules/migrate/tests/src/Kernel/process/HandleMultiplesTest.php b/core/modules/migrate/tests/src/Kernel/process/HandleMultiplesTest.php index c17719d6e1e..35bda35ba7a 100644 --- a/core/modules/migrate/tests/src/Kernel/process/HandleMultiplesTest.php +++ b/core/modules/migrate/tests/src/Kernel/process/HandleMultiplesTest.php @@ -24,6 +24,7 @@ class HandleMultiplesTest extends KernelTestBase { * Provides the test migration definition. * * @return array + * The test migration definition. */ public function getDefinition() { return [ @@ -137,6 +138,7 @@ class HandleMultiplesTest extends KernelTestBase { * Provides the source data with scalar and multiple values. * * @return array + * An array of test cases. */ public static function scalarAndMultipleValuesProviderSource() { return [ diff --git a/core/modules/migrate/tests/src/Kernel/process/SubProcessWithSkipTest.php b/core/modules/migrate/tests/src/Kernel/process/SubProcessWithSkipTest.php index 7d94b673e5e..f3a59aaf36f 100644 --- a/core/modules/migrate/tests/src/Kernel/process/SubProcessWithSkipTest.php +++ b/core/modules/migrate/tests/src/Kernel/process/SubProcessWithSkipTest.php @@ -24,6 +24,7 @@ class SubProcessWithSkipTest extends KernelTestBase { * Provides the test migration definition. * * @return array + * The test migration definition. */ public function getDefinition() { return [ @@ -110,6 +111,7 @@ class SubProcessWithSkipTest extends KernelTestBase { * Data provider for testNotFoundSubProcess(). * * @return array + * The data for the testNotFoundSubProcess() test. */ public static function providerTestSubProcessSkip(): array { return [ diff --git a/core/modules/migrate/tests/src/Unit/process/DefaultValueTest.php b/core/modules/migrate/tests/src/Unit/process/DefaultValueTest.php index 1f09bca8429..c6dfbeb776d 100644 --- a/core/modules/migrate/tests/src/Unit/process/DefaultValueTest.php +++ b/core/modules/migrate/tests/src/Unit/process/DefaultValueTest.php @@ -31,6 +31,7 @@ class DefaultValueTest extends MigrateProcessTestCase { * Provides data for the successful lookup test. * * @return array + * An array of test cases. */ public static function defaultValueDataProvider() { return [ diff --git a/core/modules/migrate/tests/src/Unit/process/GetTest.php b/core/modules/migrate/tests/src/Unit/process/GetTest.php index fd3374e2ccf..b457f850d36 100644 --- a/core/modules/migrate/tests/src/Unit/process/GetTest.php +++ b/core/modules/migrate/tests/src/Unit/process/GetTest.php @@ -96,6 +96,7 @@ class GetTest extends MigrateProcessTestCase { * Provides data for the successful lookup test. * * @return array + * An array of data for the test. */ public static function integerValuesDataProvider() { return [ diff --git a/core/modules/migrate_drupal/tests/src/Traits/CreateTestContentEntitiesTrait.php b/core/modules/migrate_drupal/tests/src/Traits/CreateTestContentEntitiesTrait.php index c43e7019194..51f3d7fbccf 100644 --- a/core/modules/migrate_drupal/tests/src/Traits/CreateTestContentEntitiesTrait.php +++ b/core/modules/migrate_drupal/tests/src/Traits/CreateTestContentEntitiesTrait.php @@ -13,6 +13,7 @@ trait CreateTestContentEntitiesTrait { * Gets required modules. * * @return array + * An array of required modules. */ protected function getRequiredModules(): array { return [ diff --git a/core/modules/mysql/tests/src/Unit/ConnectionTest.php b/core/modules/mysql/tests/src/Unit/ConnectionTest.php index 80104ab2b97..8865c764e19 100644 --- a/core/modules/mysql/tests/src/Unit/ConnectionTest.php +++ b/core/modules/mysql/tests/src/Unit/ConnectionTest.php @@ -44,6 +44,7 @@ class ConnectionTest extends UnitTestCase { * Creates a Connection object for testing. * * @return \Drupal\mysql\Driver\Database\mysql\Connection + * A Connection object. */ private function createConnection(): Connection { $this->pdoStatement @@ -98,6 +99,7 @@ class ConnectionTest extends UnitTestCase { * Provides test data. * * @return array + * An array of test data. */ public static function providerVersionAndIsMariaDb(): array { return [ diff --git a/core/modules/mysql/tests/src/Unit/InstallTasksTest.php b/core/modules/mysql/tests/src/Unit/InstallTasksTest.php index 759271d4717..a50a6f010c7 100644 --- a/core/modules/mysql/tests/src/Unit/InstallTasksTest.php +++ b/core/modules/mysql/tests/src/Unit/InstallTasksTest.php @@ -36,6 +36,7 @@ class InstallTasksTest extends UnitTestCase { * Creates a Tasks object for testing. * * @return \Drupal\mysql\Driver\Database\mysql\Install\Tasks + * A Tasks object. */ private function createTasks(): Tasks { /** @var \Drupal\mysql\Driver\Database\mysql\Connection $connection */ @@ -73,6 +74,7 @@ class InstallTasksTest extends UnitTestCase { * Creates a Tasks object for testing, without connection. * * @return \Drupal\mysql\Driver\Database\mysql\Install\Tasks + * A Tasks object. */ private function createTasksNoConnection(): Tasks { return new class() extends Tasks { @@ -116,6 +118,7 @@ class InstallTasksTest extends UnitTestCase { * Provides test data. * * @return array + * An array of test data. */ public static function providerNameAndMinimumVersion(): array { return [ diff --git a/core/modules/node/tests/src/Functional/NodeDisplayConfigurableTest.php b/core/modules/node/tests/src/Functional/NodeDisplayConfigurableTest.php index 1d2602c18aa..48b893c866a 100644 --- a/core/modules/node/tests/src/Functional/NodeDisplayConfigurableTest.php +++ b/core/modules/node/tests/src/Functional/NodeDisplayConfigurableTest.php @@ -153,6 +153,7 @@ class NodeDisplayConfigurableTest extends NodeTestBase { * Data provider for ::testDisplayConfigurable(). * * @return array + * An array of test cases. */ public static function provideThemes() { return [ diff --git a/core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorTestBase.php b/core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorTestBase.php index 6515796de8e..d9b91b1a760 100644 --- a/core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorTestBase.php +++ b/core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorTestBase.php @@ -98,6 +98,7 @@ class ComposerPluginsValidatorTestBase extends PackageManagerKernelTestBase { * Generates simple test cases. * * @return \Generator + * The test cases. */ public static function providerSimpleValidCases(): \Generator { yield 'no composer plugins' => [ @@ -181,6 +182,7 @@ class ComposerPluginsValidatorTestBase extends PackageManagerKernelTestBase { * Generates simple invalid test cases. * * @return \Generator + * The test cases. */ public static function providerSimpleInvalidCases(): \Generator { yield 'one UNsupported composer plugin — pretty package name' => [ @@ -280,6 +282,7 @@ class ComposerPluginsValidatorTestBase extends PackageManagerKernelTestBase { * Generates complex invalid test cases based on the simple test cases. * * @return \Generator + * The test cases. */ public static function providerComplexInvalidCases(): \Generator { $valid_cases = iterator_to_array(static::providerSimpleValidCases()); diff --git a/core/modules/path_alias/tests/src/Unit/PathProcessor/AliasPathProcessorTest.php b/core/modules/path_alias/tests/src/Unit/PathProcessor/AliasPathProcessorTest.php index b3a0ea3971c..b49b6bbebc1 100644 --- a/core/modules/path_alias/tests/src/Unit/PathProcessor/AliasPathProcessorTest.php +++ b/core/modules/path_alias/tests/src/Unit/PathProcessor/AliasPathProcessorTest.php @@ -82,6 +82,7 @@ class AliasPathProcessorTest extends UnitTestCase { /** * @return array + * The data provider for testProcessOutbound. */ public static function providerTestProcessOutbound() { return [ diff --git a/core/modules/rest/tests/modules/rest_test/src/Plugin/rest/resource/NoSerializationClassTestResource.php b/core/modules/rest/tests/modules/rest_test/src/Plugin/rest/resource/NoSerializationClassTestResource.php index 728dd209ddb..6ca42077130 100644 --- a/core/modules/rest/tests/modules/rest_test/src/Plugin/rest/resource/NoSerializationClassTestResource.php +++ b/core/modules/rest/tests/modules/rest_test/src/Plugin/rest/resource/NoSerializationClassTestResource.php @@ -27,6 +27,7 @@ class NoSerializationClassTestResource extends ResourceBase { * An array with the payload. * * @return \Drupal\rest\ResourceResponse + * The HTTP response object. */ public function post(array $data) { return new ResourceResponse($data); diff --git a/core/modules/rest/tests/src/Functional/EntityResource/EntityResourceTestBase.php b/core/modules/rest/tests/src/Functional/EntityResource/EntityResourceTestBase.php index e2e0770648c..365f7b2f06a 100644 --- a/core/modules/rest/tests/src/Functional/EntityResource/EntityResourceTestBase.php +++ b/core/modules/rest/tests/src/Functional/EntityResource/EntityResourceTestBase.php @@ -272,6 +272,7 @@ abstract class EntityResourceTestBase extends ResourceTestBase { * @see ::createEntity() * * @return array + * An array structure as returned by ::getExpectedNormalizedEntity(). */ abstract protected function getExpectedNormalizedEntity(); @@ -281,6 +282,7 @@ abstract class EntityResourceTestBase extends ResourceTestBase { * @see ::testPost * * @return array + * An array structure as returned by ::getNormalizedPostEntity(). */ abstract protected function getNormalizedPostEntity(); @@ -293,6 +295,7 @@ abstract class EntityResourceTestBase extends ResourceTestBase { * @see ::testPatch * * @return array + * An array structure as returned by ::getNormalizedPostEntity(). */ protected function getNormalizedPatchEntity() { return $this->getNormalizedPostEntity(); @@ -377,6 +380,7 @@ abstract class EntityResourceTestBase extends ResourceTestBase { * @see ::testGet * * @return string[] + * The expected cache tags. */ protected function getExpectedCacheTags() { $expected_cache_tags = [ @@ -395,6 +399,7 @@ abstract class EntityResourceTestBase extends ResourceTestBase { * @see ::testGet * * @return string[] + * The expected cache contexts. */ protected function getExpectedCacheContexts() { return [ diff --git a/core/modules/rest/tests/src/Functional/FileUploadResourceTestBase.php b/core/modules/rest/tests/src/Functional/FileUploadResourceTestBase.php index ea5003dd8ee..e4c1db6435d 100644 --- a/core/modules/rest/tests/src/Functional/FileUploadResourceTestBase.php +++ b/core/modules/rest/tests/src/Functional/FileUploadResourceTestBase.php @@ -229,6 +229,7 @@ abstract class FileUploadResourceTestBase extends ResourceTestBase { * Returns the normalized POST entity referencing the uploaded file. * * @return array + * The normalized POST entity. * * @see ::testPostFileUpload() * @see \Drupal\Tests\rest\Functional\EntityResource\EntityTest\EntityTestResourceTestBase::getNormalizedPostEntity() @@ -766,6 +767,7 @@ abstract class FileUploadResourceTestBase extends ResourceTestBase { * the header value to FALSE. * * @return \Psr\Http\Message\ResponseInterface + * The response object. * * @see \GuzzleHttp\ClientInterface::request() */ diff --git a/core/modules/rest/tests/src/Unit/EventSubscriber/ResourceResponseSubscriberTest.php b/core/modules/rest/tests/src/Unit/EventSubscriber/ResourceResponseSubscriberTest.php index fd0dce49060..5b1c0c400b5 100644 --- a/core/modules/rest/tests/src/Unit/EventSubscriber/ResourceResponseSubscriberTest.php +++ b/core/modules/rest/tests/src/Unit/EventSubscriber/ResourceResponseSubscriberTest.php @@ -380,6 +380,7 @@ class ResourceResponseSubscriberTest extends UnitTestCase { /** * @return \Drupal\rest\EventSubscriber\ResourceResponseSubscriber + * A functioning ResourceResponseSubscriber. */ protected function getFunctioningResourceResponseSubscriber(RouteMatchInterface $route_match) { // Create a dummy of the renderer service. diff --git a/core/modules/serialization/tests/src/Traits/JsonSchemaTestTrait.php b/core/modules/serialization/tests/src/Traits/JsonSchemaTestTrait.php index 2a08c3214cc..a7852e7bec1 100644 --- a/core/modules/serialization/tests/src/Traits/JsonSchemaTestTrait.php +++ b/core/modules/serialization/tests/src/Traits/JsonSchemaTestTrait.php @@ -36,6 +36,7 @@ trait JsonSchemaTestTrait { * Method to make prophecy public for use in data provider closures. * * @return \Prophecy\Prophecy\ObjectProphecy<object> + * A new prophecy object. */ public function doProphesize(?string $classOrInterface = NULL): ObjectProphecy { return $this->prophesize($classOrInterface); diff --git a/core/modules/serialization/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php b/core/modules/serialization/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php index 3e8da705c83..55d4c4e4296 100644 --- a/core/modules/serialization/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php +++ b/core/modules/serialization/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php @@ -126,6 +126,7 @@ class ContentEntityNormalizerTest extends UnitTestCase { * The properties the will be returned. * * @return \PHPUnit\Framework\MockObject\MockObject + * The mock content entity. */ public function createMockForContentEntity($definitions) { $content_entity_mock = $this->getMockBuilder(ContentEntityBaseMockableClass::class) @@ -154,6 +155,7 @@ class ContentEntityNormalizerTest extends UnitTestCase { * The user context used for the access check. * * @return \Drupal\Core\Field\FieldItemListInterface|\PHPUnit\Framework\MockObject\MockObject + * The mock field list item. */ protected function createMockFieldListItem($access, $internal, ?AccountInterface $user_context = NULL) { $data_definition = $this->prophesize(DataDefinitionInterface::class); diff --git a/core/modules/serialization/tests/src/Unit/Normalizer/DateTimeIso8601NormalizerTest.php b/core/modules/serialization/tests/src/Unit/Normalizer/DateTimeIso8601NormalizerTest.php index 0cf16102e6b..4a805e19d6b 100644 --- a/core/modules/serialization/tests/src/Unit/Normalizer/DateTimeIso8601NormalizerTest.php +++ b/core/modules/serialization/tests/src/Unit/Normalizer/DateTimeIso8601NormalizerTest.php @@ -155,6 +155,7 @@ class DateTimeIso8601NormalizerTest extends UnitTestCase { * Data provider for testNormalize. * * @return array + * The data provider array. */ public static function providerTestNormalize() { return [ @@ -199,6 +200,7 @@ class DateTimeIso8601NormalizerTest extends UnitTestCase { * Data provider for testDenormalizeValidFormats. * * @return array + * An array of test cases. */ public static function providerTestDenormalizeValidFormats() { $data = []; diff --git a/core/modules/serialization/tests/src/Unit/Normalizer/DateTimeNormalizerTest.php b/core/modules/serialization/tests/src/Unit/Normalizer/DateTimeNormalizerTest.php index 39e96006c06..2737f367bfe 100644 --- a/core/modules/serialization/tests/src/Unit/Normalizer/DateTimeNormalizerTest.php +++ b/core/modules/serialization/tests/src/Unit/Normalizer/DateTimeNormalizerTest.php @@ -123,6 +123,7 @@ class DateTimeNormalizerTest extends UnitTestCase { * Data provider for testDenormalizeValidFormats. * * @return array + * An array of test data. */ public static function providerTestDenormalizeValidFormats() { $data = []; @@ -154,6 +155,7 @@ class DateTimeNormalizerTest extends UnitTestCase { * Data provider for testDenormalizeUserFormats. * * @return array + * An array of test data. */ public static function providerTestDenormalizeUserFormats() { $data = []; diff --git a/core/modules/serialization/tests/src/Unit/Normalizer/TimestampItemNormalizerTest.php b/core/modules/serialization/tests/src/Unit/Normalizer/TimestampItemNormalizerTest.php index c0cd1374ff6..15837fa81b8 100644 --- a/core/modules/serialization/tests/src/Unit/Normalizer/TimestampItemNormalizerTest.php +++ b/core/modules/serialization/tests/src/Unit/Normalizer/TimestampItemNormalizerTest.php @@ -173,6 +173,7 @@ class TimestampItemNormalizerTest extends UnitTestCase { * Creates a TimestampItem prophecy. * * @return \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Field\Plugin\Field\FieldType\TimestampItem> + * The TimestampItem prophecy. */ protected function createTimestampItemProphecy(): ObjectProphecy { $timestamp_item = $this->prophesize(TimestampItem::class); diff --git a/core/modules/serialization/tests/src/Unit/Normalizer/TimestampNormalizerTest.php b/core/modules/serialization/tests/src/Unit/Normalizer/TimestampNormalizerTest.php index c200bbde64f..e0e4c991c47 100644 --- a/core/modules/serialization/tests/src/Unit/Normalizer/TimestampNormalizerTest.php +++ b/core/modules/serialization/tests/src/Unit/Normalizer/TimestampNormalizerTest.php @@ -103,6 +103,7 @@ class TimestampNormalizerTest extends UnitTestCase { * Data provider for testDenormalizeValidFormats. * * @return array + * An array of test data. */ public static function providerTestDenormalizeValidFormats() { $expected_stamp = 1478422920; diff --git a/core/modules/system/src/Tests/Routing/MockAliasManager.php b/core/modules/system/src/Tests/Routing/MockAliasManager.php index a9b88bfbc5c..86bcd201c46 100644 --- a/core/modules/system/src/Tests/Routing/MockAliasManager.php +++ b/core/modules/system/src/Tests/Routing/MockAliasManager.php @@ -80,6 +80,7 @@ class MockAliasManager implements AliasManagerInterface { * The language code. * * @return string + * The value of the alias. */ public function getAliasByPath($path, $langcode = NULL) { if ($path[0] !== '/') { diff --git a/core/modules/system/tests/modules/content_negotiation_test/src/Controller/TestController.php b/core/modules/system/tests/modules/content_negotiation_test/src/Controller/TestController.php index dc06b5c3c7d..58df87602bf 100644 --- a/core/modules/system/tests/modules/content_negotiation_test/src/Controller/TestController.php +++ b/core/modules/system/tests/modules/content_negotiation_test/src/Controller/TestController.php @@ -17,6 +17,7 @@ class TestController { * Returns a json response. * * @return \Symfony\Component\HttpFoundation\JsonResponse + * The Json response value. */ public function simple() { return new JsonResponse(['some' => 'data']); @@ -26,6 +27,7 @@ class TestController { * Returns a simple render array. * * @return array + * A render array with only '#markup'. */ public function html() { return [ diff --git a/core/modules/system/tests/modules/database_test/src/Controller/DatabaseTestController.php b/core/modules/system/tests/modules/database_test/src/Controller/DatabaseTestController.php index 6634b9d2740..71e23ba35bb 100644 --- a/core/modules/system/tests/modules/database_test/src/Controller/DatabaseTestController.php +++ b/core/modules/system/tests/modules/database_test/src/Controller/DatabaseTestController.php @@ -52,6 +52,7 @@ class DatabaseTestController extends ControllerBase { * test HTTP call. * * @return \Symfony\Component\HttpFoundation\JsonResponse + * A JSON response containing the names of the test entries. */ public function pagerQueryEven($limit) { $query = $this->connection->select('test', 't'); @@ -78,6 +79,7 @@ class DatabaseTestController extends ControllerBase { * test HTTP call. * * @return \Symfony\Component\HttpFoundation\JsonResponse + * A JSON response containing the names of the test entries. */ public function pagerQueryOdd($limit) { $query = $this->connection->select('test_task', 't'); @@ -104,6 +106,7 @@ class DatabaseTestController extends ControllerBase { * test HTTP call. * * @return \Symfony\Component\HttpFoundation\JsonResponse + * A JSON response containing the test tasks. */ public function testTablesort() { $header = [ @@ -136,6 +139,7 @@ class DatabaseTestController extends ControllerBase { * test HTTP call. * * @return \Symfony\Component\HttpFoundation\JsonResponse + * A JSON response containing the test tasks. */ public function testTablesortFirst() { $header = [ diff --git a/core/modules/system/tests/modules/entity_test/src/Entity/EntityTest.php b/core/modules/system/tests/modules/entity_test/src/Entity/EntityTest.php index 9c7298121a0..39f70e5c8c8 100644 --- a/core/modules/system/tests/modules/entity_test/src/Entity/EntityTest.php +++ b/core/modules/system/tests/modules/entity_test/src/Entity/EntityTest.php @@ -166,6 +166,7 @@ class EntityTest extends ContentEntityBase implements EntityOwnerInterface { * Returns the name. * * @return string + * The name of the entity. */ public function getName() { return $this->get('name')->value; diff --git a/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameForm.php b/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameForm.php index 6b5415cdb5c..d072732e52a 100644 --- a/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameForm.php +++ b/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameForm.php @@ -87,6 +87,7 @@ class FormTestMachineNameForm extends FormBase { * The machine name. * * @return bool + * TRUE if the machine name is a duplicate, FALSE otherwise. */ public function load($machine_name) { return str_contains($machine_name, 'duplicate'); diff --git a/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameValidationForm.php b/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameValidationForm.php index 48e72015230..5e14dc5e3d3 100644 --- a/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameValidationForm.php +++ b/core/modules/system/tests/modules/form_test/src/Form/FormTestMachineNameValidationForm.php @@ -126,6 +126,7 @@ class FormTestMachineNameValidationForm extends FormBase { * The machine name. * * @return bool + * TRUE if the machine name is a duplicate, FALSE otherwise. */ public function load($machine_name) { if (str_contains($machine_name, 'duplicate')) { diff --git a/core/modules/system/tests/modules/many_assets_test/src/Controller/ManyAssetsTestController.php b/core/modules/system/tests/modules/many_assets_test/src/Controller/ManyAssetsTestController.php index 13307fd999a..770b6fcd443 100644 --- a/core/modules/system/tests/modules/many_assets_test/src/Controller/ManyAssetsTestController.php +++ b/core/modules/system/tests/modules/many_assets_test/src/Controller/ManyAssetsTestController.php @@ -15,6 +15,7 @@ class ManyAssetsTestController extends ControllerBase { * The render array of the assets testing page. * * @return array + * A render array with a message and attached asset libraries. */ public function build() { return [ diff --git a/core/modules/system/tests/modules/menu_test/src/Access/AccessCheck.php b/core/modules/system/tests/modules/menu_test/src/Access/AccessCheck.php index 29ac7a74164..9c7ff92de2c 100644 --- a/core/modules/system/tests/modules/menu_test/src/Access/AccessCheck.php +++ b/core/modules/system/tests/modules/menu_test/src/Access/AccessCheck.php @@ -56,6 +56,7 @@ class AccessCheck implements AccessInterface, ContainerInjectionInterface { /** * @return \Drupal\Core\Access\AccessResultForbidden + * The forbidden access result. */ public function menuLocalAction7() { return AccessResult::forbidden()->addCacheTags(['menu_local_action7'])->addCacheContexts(['url.query_args:menu_local_action7']); @@ -63,6 +64,7 @@ class AccessCheck implements AccessInterface, ContainerInjectionInterface { /** * @return \Drupal\Core\Access\AccessResultAllowed + * The allowed access result. */ public function menuLocalAction8() { return AccessResult::allowed()->addCacheTags(['menu_local_action8'])->addCacheContexts(['url.query_args:menu_local_action8']); diff --git a/core/modules/system/tests/modules/menu_test/src/Controller/MenuTestController.php b/core/modules/system/tests/modules/menu_test/src/Controller/MenuTestController.php index 24b29753e84..8a21cb2fb49 100644 --- a/core/modules/system/tests/modules/menu_test/src/Controller/MenuTestController.php +++ b/core/modules/system/tests/modules/menu_test/src/Controller/MenuTestController.php @@ -118,6 +118,7 @@ class MenuTestController extends ControllerBase { * A title callback for XSS breadcrumb check. * * @return string + * A string that can be used for comparison. */ public function breadcrumbTitleCallback() { return '<script>alert(123);</script>'; diff --git a/core/modules/system/tests/modules/path_encoded_test/src/Controller/PathEncodedTestController.php b/core/modules/system/tests/modules/path_encoded_test/src/Controller/PathEncodedTestController.php index bdbef9f35dd..46b010981da 100644 --- a/core/modules/system/tests/modules/path_encoded_test/src/Controller/PathEncodedTestController.php +++ b/core/modules/system/tests/modules/path_encoded_test/src/Controller/PathEncodedTestController.php @@ -15,6 +15,7 @@ class PathEncodedTestController { * Returns an HTML simple response. * * @return \Symfony\Component\HttpFoundation\Response + * A simple HTML response. */ public function simple() { return new Response('<html><body>PathEncodedTestController works</body></html>'); diff --git a/core/modules/system/tests/modules/performance_test/src/Cache/CacheBackendDecorator.php b/core/modules/system/tests/modules/performance_test/src/Cache/CacheBackendDecorator.php index 361a6f2eba1..120cd312e82 100644 --- a/core/modules/system/tests/modules/performance_test/src/Cache/CacheBackendDecorator.php +++ b/core/modules/system/tests/modules/performance_test/src/Cache/CacheBackendDecorator.php @@ -27,8 +27,6 @@ class CacheBackendDecorator implements CacheBackendInterface, CacheTagsInvalidat * The stop microtime. * @param string $operation * The type of operation being logged. - * - * @return void */ protected function logCacheOperation(string|array $cids, float $start, float $stop, string $operation): void { $this->performanceDataCollector->addCacheOperation([ diff --git a/core/modules/system/tests/modules/performance_test/src/Cache/CacheTagsChecksumDecorator.php b/core/modules/system/tests/modules/performance_test/src/Cache/CacheTagsChecksumDecorator.php index dd4675f4b62..23be1b43a16 100644 --- a/core/modules/system/tests/modules/performance_test/src/Cache/CacheTagsChecksumDecorator.php +++ b/core/modules/system/tests/modules/performance_test/src/Cache/CacheTagsChecksumDecorator.php @@ -90,8 +90,6 @@ class CacheTagsChecksumDecorator implements CacheTagsChecksumInterface, CacheTag * The stop microtime. * @param \Drupal\performance_test\Cache\CacheTagOperation $operation * The type of operation being logged. - * - * @return void */ protected function logCacheTagOperation(array $tags, float $start, float $stop, CacheTagOperation $operation): void { $this->performanceDataCollector->addCacheTagOperation([ diff --git a/core/modules/system/tests/modules/plugin_test/src/Plugin/MockBlockManager.php b/core/modules/system/tests/modules/plugin_test/src/Plugin/MockBlockManager.php index c6c078b6215..15784dc6a85 100644 --- a/core/modules/system/tests/modules/plugin_test/src/Plugin/MockBlockManager.php +++ b/core/modules/system/tests/modules/plugin_test/src/Plugin/MockBlockManager.php @@ -140,6 +140,7 @@ class MockBlockManager extends PluginManagerBase { * Whether the context definition is required. * * @return \Drupal\Core\Plugin\Context\ContextDefinition + * The context definition object. */ protected function createContextDefinition($data_type, $label, $required = TRUE) { // We cast the label to string for testing purposes only, as it may be diff --git a/core/modules/system/tests/modules/render_array_non_html_subscriber_test/src/RenderArrayNonHtmlSubscriberTestController.php b/core/modules/system/tests/modules/render_array_non_html_subscriber_test/src/RenderArrayNonHtmlSubscriberTestController.php index 41f2c794266..244c8284034 100644 --- a/core/modules/system/tests/modules/render_array_non_html_subscriber_test/src/RenderArrayNonHtmlSubscriberTestController.php +++ b/core/modules/system/tests/modules/render_array_non_html_subscriber_test/src/RenderArrayNonHtmlSubscriberTestController.php @@ -14,6 +14,7 @@ class RenderArrayNonHtmlSubscriberTestController extends ControllerBase { /** * @return string + * The value of raw string. */ public function rawString() { return new Response((string) $this->t('Raw controller response.')); @@ -21,6 +22,7 @@ class RenderArrayNonHtmlSubscriberTestController extends ControllerBase { /** * @return array + * The value of render array. */ public function renderArray() { return [ diff --git a/core/modules/system/tests/modules/render_placeholder_message_test/src/RenderPlaceholderMessageTestController.php b/core/modules/system/tests/modules/render_placeholder_message_test/src/RenderPlaceholderMessageTestController.php index 4c42ae171ee..82cf68ddd3c 100644 --- a/core/modules/system/tests/modules/render_placeholder_message_test/src/RenderPlaceholderMessageTestController.php +++ b/core/modules/system/tests/modules/render_placeholder_message_test/src/RenderPlaceholderMessageTestController.php @@ -35,6 +35,7 @@ class RenderPlaceholderMessageTestController implements TrustedCallbackInterface /** * @return array + * A renderable array with the messages placeholder rendered first. */ public function messagesPlaceholderFirst() { return $this->build([ @@ -48,6 +49,7 @@ class RenderPlaceholderMessageTestController implements TrustedCallbackInterface /** * @return array + * A renderable array with the messages placeholder rendered in the middle. */ public function messagesPlaceholderMiddle() { return $this->build([ @@ -61,6 +63,7 @@ class RenderPlaceholderMessageTestController implements TrustedCallbackInterface /** * @return array + * A renderable array with the messages placeholder rendered last. */ public function messagesPlaceholderLast() { return $this->build([ @@ -74,6 +77,7 @@ class RenderPlaceholderMessageTestController implements TrustedCallbackInterface /** * @return array + * A renderable array containing only messages. */ public function queuedMessages() { return ['#type' => 'status_messages']; @@ -81,6 +85,7 @@ class RenderPlaceholderMessageTestController implements TrustedCallbackInterface /** * @return array + * A renderable array containing only placeholders. */ protected function build(array $placeholder_order) { $build = []; diff --git a/core/modules/system/tests/modules/system_test/src/Controller/PageCacheAcceptHeaderController.php b/core/modules/system/tests/modules/system_test/src/Controller/PageCacheAcceptHeaderController.php index 9a83cb3615d..e6e700c9dd9 100644 --- a/core/modules/system/tests/modules/system_test/src/Controller/PageCacheAcceptHeaderController.php +++ b/core/modules/system/tests/modules/system_test/src/Controller/PageCacheAcceptHeaderController.php @@ -22,6 +22,7 @@ class PageCacheAcceptHeaderController { * The current request object. * * @return mixed + * The processed response object. */ public function content(Request $request) { if ($request->getRequestFormat() === 'json' && $request->query->get('_wrapper_format') === 'drupal_ajax') { diff --git a/core/modules/system/tests/modules/system_test/src/Controller/SystemTestController.php b/core/modules/system/tests/modules/system_test/src/Controller/SystemTestController.php index b2f5f26d72d..566968fe2d0 100644 --- a/core/modules/system/tests/modules/system_test/src/Controller/SystemTestController.php +++ b/core/modules/system/tests/modules/system_test/src/Controller/SystemTestController.php @@ -357,6 +357,7 @@ class SystemTestController extends ControllerBase implements TrustedCallbackInte * Any string for the {foo} slug. * * @return string + * The value of title. */ public function configureTitle($foo) { return 'Bar.' . $foo; diff --git a/core/modules/system/tests/src/Functional/Ajax/OffCanvasDialogTest.php b/core/modules/system/tests/src/Functional/Ajax/OffCanvasDialogTest.php index 6c84e168cda..51ee8e9184b 100644 --- a/core/modules/system/tests/src/Functional/Ajax/OffCanvasDialogTest.php +++ b/core/modules/system/tests/src/Functional/Ajax/OffCanvasDialogTest.php @@ -74,6 +74,7 @@ class OffCanvasDialogTest extends BrowserTestBase { * The data provider for potential dialog positions. * * @return array + * An array of dialog positions. */ public static function dialogPosition() { return [ diff --git a/core/modules/system/tests/src/Functional/System/AdminTest.php b/core/modules/system/tests/src/Functional/System/AdminTest.php index 021e7bdcea2..ee9935b6fea 100644 --- a/core/modules/system/tests/src/Functional/System/AdminTest.php +++ b/core/modules/system/tests/src/Functional/System/AdminTest.php @@ -132,6 +132,7 @@ class AdminTest extends BrowserTestBase { * Returns all top level menu links. * * @return \Drupal\Core\Menu\MenuLinkTreeElement[] + * The top level menu links. */ protected function getTopLevelMenuLinks() { $menu_tree = \Drupal::menuTree(); diff --git a/core/modules/system/tests/src/FunctionalJavascript/Form/DevelopmentSettingsFormTest.php b/core/modules/system/tests/src/FunctionalJavascript/Form/DevelopmentSettingsFormTest.php index 49943d8023b..30f50b7bd0a 100644 --- a/core/modules/system/tests/src/FunctionalJavascript/Form/DevelopmentSettingsFormTest.php +++ b/core/modules/system/tests/src/FunctionalJavascript/Form/DevelopmentSettingsFormTest.php @@ -86,6 +86,7 @@ class DevelopmentSettingsFormTest extends WebDriverTestBase { * Test data for Twig development mode. * * @return array[] + * An array of test data. */ public static function twigDevelopmentData(): array { return [ diff --git a/core/modules/system/tests/src/FunctionalJavascript/ModuleUninstallFilterTest.php b/core/modules/system/tests/src/FunctionalJavascript/ModuleUninstallFilterTest.php index e89ac08ec83..2652b322578 100644 --- a/core/modules/system/tests/src/FunctionalJavascript/ModuleUninstallFilterTest.php +++ b/core/modules/system/tests/src/FunctionalJavascript/ModuleUninstallFilterTest.php @@ -89,6 +89,7 @@ class ModuleUninstallFilterTest extends WebDriverTestBase { * An array of node elements. * * @return \Behat\Mink\Element\NodeElement[] + * An array of node elements that are visible. */ protected function filterVisibleElements($elements) { $elements = array_filter($elements, function ($element) { diff --git a/core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php b/core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php index f09aaef10eb..188e1bac918 100644 --- a/core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php +++ b/core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php @@ -94,6 +94,7 @@ abstract class OffCanvasTestBase extends WebDriverTestBase { * Gets the off-canvas dialog element. * * @return \Behat\Mink\Element\NodeElement|null + * The off-canvas dialog element. */ protected function getOffCanvasDialog() { $off_canvas_dialog = $this->getSession()->getPage()->find('css', '.ui-dialog[aria-describedby="drupal-off-canvas"]'); diff --git a/core/modules/system/tests/src/Kernel/Block/SystemMenuBlockTest.php b/core/modules/system/tests/src/Kernel/Block/SystemMenuBlockTest.php index 2cb413a7e42..48f7df788a1 100644 --- a/core/modules/system/tests/src/Kernel/Block/SystemMenuBlockTest.php +++ b/core/modules/system/tests/src/Kernel/Block/SystemMenuBlockTest.php @@ -313,6 +313,7 @@ class SystemMenuBlockTest extends KernelTestBase { /** * @return array + * An array of test cases for the config expanded option. */ public static function configExpandedTestCases() { return [ diff --git a/core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelectionReferenceableTest.php b/core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelectionReferenceableTest.php index c81bb7c0dd6..8c9d95e0ca6 100644 --- a/core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelectionReferenceableTest.php +++ b/core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelectionReferenceableTest.php @@ -143,6 +143,7 @@ class EntityReferenceSelectionReferenceableTest extends KernelTestBase { * Provides test cases for ::testReferenceablesWithNoLabelKey() test. * * @return array[] + * An array of test cases. */ public static function providerTestCases() { return [ diff --git a/core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php b/core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php index 3d16ce748fd..aa0af090c19 100644 --- a/core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php +++ b/core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php @@ -365,6 +365,7 @@ class ModuleHandlerTest extends KernelTestBase { * Returns the ModuleHandler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface + * The module handler service. */ protected function moduleHandler() { return $this->container->get('module_handler'); @@ -374,6 +375,7 @@ class ModuleHandlerTest extends KernelTestBase { * Returns the ModuleInstaller. * * @return \Drupal\Core\Extension\ModuleInstallerInterface + * The module installer service. */ protected function moduleInstaller() { return $this->container->get('module_installer'); diff --git a/core/modules/system/tests/src/Kernel/Installer/InstallTranslationFilePatternTest.php b/core/modules/system/tests/src/Kernel/Installer/InstallTranslationFilePatternTest.php index 619f7744ec1..46f9e1409d7 100644 --- a/core/modules/system/tests/src/Kernel/Installer/InstallTranslationFilePatternTest.php +++ b/core/modules/system/tests/src/Kernel/Installer/InstallTranslationFilePatternTest.php @@ -49,6 +49,7 @@ class InstallTranslationFilePatternTest extends KernelTestBase { /** * @return array + * Array of valid translation files. */ public static function providerValidTranslationFiles() { return [ @@ -68,6 +69,7 @@ class InstallTranslationFilePatternTest extends KernelTestBase { /** * @return array + * Array of invalid translation files. */ public static function providerInvalidTranslationFiles() { return [ diff --git a/core/modules/update/tests/src/Functional/UpdateSemverTestBaselineTrait.php b/core/modules/update/tests/src/Functional/UpdateSemverTestBaselineTrait.php index 852332bd4fd..db0b33ae997 100644 --- a/core/modules/update/tests/src/Functional/UpdateSemverTestBaselineTrait.php +++ b/core/modules/update/tests/src/Functional/UpdateSemverTestBaselineTrait.php @@ -109,8 +109,6 @@ trait UpdateSemverTestBaselineTrait { * * @param string $full_version * The recommended version. - * - * @return void */ protected function assertNoExtraVersion(string $full_version): void { $this->assertUpdateTableTextNotContains('Up to date'); diff --git a/core/modules/user/tests/modules/user_hooks_test/src/Hook/UserHooksTest.php b/core/modules/user/tests/modules/user_hooks_test/src/Hook/UserHooksTest.php index ed10dcf6037..27aa8988395 100644 --- a/core/modules/user/tests/modules/user_hooks_test/src/Hook/UserHooksTest.php +++ b/core/modules/user/tests/modules/user_hooks_test/src/Hook/UserHooksTest.php @@ -20,8 +20,6 @@ class UserHooksTest { * The username that is displayed for a user. * @param \Drupal\Core\Session\AccountInterface $account * The object on which the operation is being performed. - * - * @return void */ #[Hook('user_format_name_alter')] public function userFormatNameAlter(&$name, AccountInterface $account): void { diff --git a/core/modules/user/tests/src/Functional/UserPasswordResetTest.php b/core/modules/user/tests/src/Functional/UserPasswordResetTest.php index 0eeee42d2c9..9c61e956348 100644 --- a/core/modules/user/tests/src/Functional/UserPasswordResetTest.php +++ b/core/modules/user/tests/src/Functional/UserPasswordResetTest.php @@ -286,6 +286,7 @@ class UserPasswordResetTest extends BrowserTestBase { * Provides scenarios for testUserPasswordResetPreferredLanguage(). * * @return array + * An array of scenarios. */ protected function languagePrefixTestProvider() { return [ diff --git a/core/modules/user/tests/src/Kernel/UserConfigValidationTest.php b/core/modules/user/tests/src/Kernel/UserConfigValidationTest.php index 991f1324130..4e739f7ee07 100644 --- a/core/modules/user/tests/src/Kernel/UserConfigValidationTest.php +++ b/core/modules/user/tests/src/Kernel/UserConfigValidationTest.php @@ -30,6 +30,7 @@ class UserConfigValidationTest extends KernelTestBase { * Data provider for testUserSettings(). * * @return array + * An array of test cases for testUserSettings(). */ public static function providerTestUserSettings(): array { return [ diff --git a/core/modules/user/tests/src/Kernel/UserMailNotifyTest.php b/core/modules/user/tests/src/Kernel/UserMailNotifyTest.php index e341751ccbd..f9616dfa530 100644 --- a/core/modules/user/tests/src/Kernel/UserMailNotifyTest.php +++ b/core/modules/user/tests/src/Kernel/UserMailNotifyTest.php @@ -31,6 +31,7 @@ class UserMailNotifyTest extends EntityKernelTestBase { * Data provider for user mail testing. * * @return array + * An array of operations and the mail keys they should send. */ public static function userMailsProvider() { return [ diff --git a/core/modules/user/tests/src/Unit/Form/EntityPermissionsFormTest.php b/core/modules/user/tests/src/Unit/Form/EntityPermissionsFormTest.php index aba42464d88..bffb235006e 100644 --- a/core/modules/user/tests/src/Unit/Form/EntityPermissionsFormTest.php +++ b/core/modules/user/tests/src/Unit/Form/EntityPermissionsFormTest.php @@ -101,6 +101,7 @@ class EntityPermissionsFormTest extends UnitTestCase { * Provides data for the testPermissionsByProvider method. * * @return array + * An array of test data. */ public static function providerTestPermissionsByProvider() { return [ diff --git a/core/modules/user/tests/src/Unit/PermissionAccessCheckTest.php b/core/modules/user/tests/src/Unit/PermissionAccessCheckTest.php index 3660e00fe1d..e1e80dba56c 100644 --- a/core/modules/user/tests/src/Unit/PermissionAccessCheckTest.php +++ b/core/modules/user/tests/src/Unit/PermissionAccessCheckTest.php @@ -52,6 +52,7 @@ class PermissionAccessCheckTest extends UnitTestCase { * Provides data for the testAccess method. * * @return array + * An array of test data. */ public static function providerTestAccess() { return [ diff --git a/core/modules/user/tests/src/Unit/UserAuthTest.php b/core/modules/user/tests/src/Unit/UserAuthTest.php index b007a570fd8..b4a101dbf72 100644 --- a/core/modules/user/tests/src/Unit/UserAuthTest.php +++ b/core/modules/user/tests/src/Unit/UserAuthTest.php @@ -107,6 +107,7 @@ class UserAuthTest extends UnitTestCase { * Data provider for testAuthenticateWithMissingCredentials(). * * @return array + * An array of test data. */ public static function providerTestAuthenticateWithMissingCredentials() { return [ diff --git a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/field/FieldTest.php b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/field/FieldTest.php index db5cc0e9e8a..b8d6a6d80ac 100644 --- a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/field/FieldTest.php +++ b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/field/FieldTest.php @@ -36,6 +36,7 @@ class FieldTest extends FieldPluginBase { * Returns the testValue property. * * @return string + * The value of the test. */ public function getTestValue() { return $this->testValue; diff --git a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php index 93bddef6664..d35daecd195 100644 --- a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php +++ b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php @@ -18,6 +18,7 @@ class FilterTest extends FilterPluginBase { * Overrides Drupal\views\Plugin\views\row\RowPluginBase::defineOptions(). * * @return array + * An array of options. */ protected function defineOptions() { $options = parent::defineOptions(); diff --git a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/join/JoinTest.php b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/join/JoinTest.php index 38352a5e45d..6e359aefedf 100644 --- a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/join/JoinTest.php +++ b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/join/JoinTest.php @@ -23,6 +23,7 @@ class JoinTest extends JoinPluginBase { * Returns the joinValue property. * * @return int + * The value of the join. */ public function getJoinValue() { return $this->joinValue; diff --git a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/row/RowTest.php b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/row/RowTest.php index 280b79fe00b..e951533bcd5 100644 --- a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/row/RowTest.php +++ b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/row/RowTest.php @@ -68,6 +68,7 @@ class RowTest extends RowPluginBase { * Returns the output property. * * @return string + * The string to output by this plugin. */ public function getOutput() { return $this->output; diff --git a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/style/StyleTest.php b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/style/StyleTest.php index 48d398c9b59..42f53feae9a 100644 --- a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/style/StyleTest.php +++ b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/style/StyleTest.php @@ -84,6 +84,7 @@ class StyleTest extends StylePluginBase { * Returns the output property. * * @return string + * The output of the plugin. */ public function getOutput() { return $this->output; diff --git a/core/modules/views/tests/src/Kernel/Handler/ArgumentSummaryTest.php b/core/modules/views/tests/src/Kernel/Handler/ArgumentSummaryTest.php index 9cbdfb9ccc4..03488125064 100644 --- a/core/modules/views/tests/src/Kernel/Handler/ArgumentSummaryTest.php +++ b/core/modules/views/tests/src/Kernel/Handler/ArgumentSummaryTest.php @@ -102,7 +102,8 @@ class ArgumentSummaryTest extends ViewsKernelTestBase { /** * Creates a term in the tag vocabulary. * - * @return \Drupal\taxonomy\TermInterface $term + * @return \Drupal\taxonomy\TermInterface + * The created term. */ protected function createTag(): TermInterface { $tag = Term::create([ diff --git a/core/modules/views/tests/src/Kernel/Handler/FilterBooleanOperatorTest.php b/core/modules/views/tests/src/Kernel/Handler/FilterBooleanOperatorTest.php index 73c5e09d8ef..4dda6b5d550 100644 --- a/core/modules/views/tests/src/Kernel/Handler/FilterBooleanOperatorTest.php +++ b/core/modules/views/tests/src/Kernel/Handler/FilterBooleanOperatorTest.php @@ -247,6 +247,7 @@ class FilterBooleanOperatorTest extends ViewsKernelTestBase { * Provides grouped exposed filter configuration. * * @return array + * An array of grouped exposed filter configuration. */ protected function getGroupedExposedFilters(): array { $filters = [ diff --git a/core/modules/views/tests/src/Kernel/Handler/FilterStringTest.php b/core/modules/views/tests/src/Kernel/Handler/FilterStringTest.php index 31a2b64e619..c05b04ad18c 100644 --- a/core/modules/views/tests/src/Kernel/Handler/FilterStringTest.php +++ b/core/modules/views/tests/src/Kernel/Handler/FilterStringTest.php @@ -79,6 +79,7 @@ class FilterStringTest extends ViewsKernelTestBase { * Build and return a Page view of the views_test_data table. * * @return \Drupal\views\ViewExecutable + * The page view object. */ protected function getBasicPageView() { $view = Views::getView('test_view'); diff --git a/core/modules/views/tests/src/Unit/Plugin/area/EntityTest.php b/core/modules/views/tests/src/Unit/Plugin/area/EntityTest.php index 189b3f5da96..680047792ca 100644 --- a/core/modules/views/tests/src/Unit/Plugin/area/EntityTest.php +++ b/core/modules/views/tests/src/Unit/Plugin/area/EntityTest.php @@ -142,6 +142,7 @@ class EntityTest extends UnitTestCase { * Data provider for testing different types of tokens. * * @return array + * An array of test data. */ public static function providerTestTokens() { return [ diff --git a/core/modules/views/tests/src/Unit/Plugin/area/ResultTest.php b/core/modules/views/tests/src/Unit/Plugin/area/ResultTest.php index c42eb70b709..2dcc16334c1 100644 --- a/core/modules/views/tests/src/Unit/Plugin/area/ResultTest.php +++ b/core/modules/views/tests/src/Unit/Plugin/area/ResultTest.php @@ -93,6 +93,7 @@ class ResultTest extends UnitTestCase { * Data provider for testResultArea. * * @return array + * An array of test cases. */ public static function providerTestResultArea() { return [ diff --git a/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php b/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php index a038aa7835a..128a5cefb7c 100644 --- a/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php +++ b/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php @@ -667,6 +667,7 @@ class FieldTest extends UnitTestCase { * Returns a mocked base field storage object. * * @return \Drupal\Core\Field\FieldStorageDefinitionInterface|\PHPUnit\Framework\MockObject\MockObject + * The mocked field storage object. */ protected function getBaseFieldStorage() { $title_storage = $this->createMock('Drupal\Core\Field\FieldStorageDefinitionInterface'); @@ -686,6 +687,7 @@ class FieldTest extends UnitTestCase { * Returns a mocked configurable field storage object. * * @return \Drupal\field\FieldStorageConfigInterface|\PHPUnit\Framework\MockObject\MockObject + * The mocked field storage object. */ protected function getConfigFieldStorage() { $title_storage = $this->createMock('Drupal\field\FieldStorageConfigInterface'); @@ -705,6 +707,7 @@ class FieldTest extends UnitTestCase { * Provides sort orders for clickSort() test methods. * * @return array + * An array of sort orders. */ public static function providerSortOrders() { return [ diff --git a/core/modules/views/tests/src/Unit/Plugin/filter/InOperatorTest.php b/core/modules/views/tests/src/Unit/Plugin/filter/InOperatorTest.php index dd0fea7dd87..1f46a6461d7 100644 --- a/core/modules/views/tests/src/Unit/Plugin/filter/InOperatorTest.php +++ b/core/modules/views/tests/src/Unit/Plugin/filter/InOperatorTest.php @@ -33,6 +33,7 @@ class InOperatorTest extends UnitTestCase { /** * @return array + * The options for the filter. */ public static function validate_options_callback() { return ['Yes', 'No']; diff --git a/core/modules/views/tests/src/Unit/Plugin/query/SqlTest.php b/core/modules/views/tests/src/Unit/Plugin/query/SqlTest.php index 031ac4e6365..bcc6ede7dc2 100644 --- a/core/modules/views/tests/src/Unit/Plugin/query/SqlTest.php +++ b/core/modules/views/tests/src/Unit/Plugin/query/SqlTest.php @@ -151,6 +151,7 @@ class SqlTest extends UnitTestCase { * Test entities keyed by entity type and revision ID. * * @return \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Entity\EntityTypeManagerInterface> + * The mocked entity type manager. */ protected function setupEntityTypes($entities_by_type = [], $entity_revisions_by_type = []): ObjectProphecy { $entity_type_manager = $this->prophesize(EntityTypeManagerInterface::class); diff --git a/core/modules/views/tests/src/Unit/PluginBaseTest.php b/core/modules/views/tests/src/Unit/PluginBaseTest.php index b557ba40f0e..e596fc14fff 100644 --- a/core/modules/views/tests/src/Unit/PluginBaseTest.php +++ b/core/modules/views/tests/src/Unit/PluginBaseTest.php @@ -73,6 +73,7 @@ class PluginBaseTest extends UnitTestCase { * Data provider for testUnpackOptions(). * * @return array + * An array of test data. */ public static function providerTestUnpackOptions() { $test_parameters = []; @@ -221,6 +222,7 @@ class PluginBaseTest extends UnitTestCase { * Data provider for testSetOptionDefault(). * * @return array + * An array of test data. */ public static function providerTestSetOptionDefault() { $test_parameters = []; diff --git a/core/modules/views/tests/src/Unit/ViewsDataHelperTest.php b/core/modules/views/tests/src/Unit/ViewsDataHelperTest.php index 510a1ba953b..4b3026460d6 100644 --- a/core/modules/views/tests/src/Unit/ViewsDataHelperTest.php +++ b/core/modules/views/tests/src/Unit/ViewsDataHelperTest.php @@ -18,6 +18,7 @@ class ViewsDataHelperTest extends UnitTestCase { * Returns the views data definition. * * @return array + * The views data definition. */ protected function viewsData() { $data = ViewTestData::viewsData(); diff --git a/core/modules/views/tests/src/Unit/ViewsDataTest.php b/core/modules/views/tests/src/Unit/ViewsDataTest.php index 4018cd97960..d8889190189 100644 --- a/core/modules/views/tests/src/Unit/ViewsDataTest.php +++ b/core/modules/views/tests/src/Unit/ViewsDataTest.php @@ -116,6 +116,7 @@ class ViewsDataTest extends UnitTestCase { * Returns the views data definition with the provider key. * * @return array + * The views data definition. * * @see static::viewsData() */ diff --git a/core/modules/views/tests/src/Unit/ViewsTest.php b/core/modules/views/tests/src/Unit/ViewsTest.php index 784b5a89e8d..5c055b69fb7 100644 --- a/core/modules/views/tests/src/Unit/ViewsTest.php +++ b/core/modules/views/tests/src/Unit/ViewsTest.php @@ -211,6 +211,7 @@ class ViewsTest extends UnitTestCase { * Data provider for testGetApplicableViews. * * @return array + * An array of test data. */ public static function providerTestGetApplicableViews() { return [ diff --git a/core/modules/views_ui/tests/src/FunctionalJavascript/ViewsListingTest.php b/core/modules/views_ui/tests/src/FunctionalJavascript/ViewsListingTest.php index 418712b023d..b6f442e6265 100644 --- a/core/modules/views_ui/tests/src/FunctionalJavascript/ViewsListingTest.php +++ b/core/modules/views_ui/tests/src/FunctionalJavascript/ViewsListingTest.php @@ -138,6 +138,7 @@ class ViewsListingTest extends WebDriverTestBase { * The elements. * * @return array + * The filtered array. */ protected function filterVisibleElements($elements): array { $elements = array_filter($elements, function ($element) { diff --git a/core/modules/workflows/tests/src/Kernel/WorkflowAccessControlHandlerTest.php b/core/modules/workflows/tests/src/Kernel/WorkflowAccessControlHandlerTest.php index f24e427b2ef..e46fbcf417b 100644 --- a/core/modules/workflows/tests/src/Kernel/WorkflowAccessControlHandlerTest.php +++ b/core/modules/workflows/tests/src/Kernel/WorkflowAccessControlHandlerTest.php @@ -121,6 +121,7 @@ class WorkflowAccessControlHandlerTest extends KernelTestBase { * Data provider for ::testCheckAccess. * * @return array + * An array of test data. */ public static function checkAccessProvider() { $container = new ContainerBuilder(); diff --git a/core/modules/workspaces/tests/src/Unit/ActiveWorkspaceCheckTest.php b/core/modules/workspaces/tests/src/Unit/ActiveWorkspaceCheckTest.php index c87da448fa0..bf2358311de 100644 --- a/core/modules/workspaces/tests/src/Unit/ActiveWorkspaceCheckTest.php +++ b/core/modules/workspaces/tests/src/Unit/ActiveWorkspaceCheckTest.php @@ -45,6 +45,7 @@ class ActiveWorkspaceCheckTest extends UnitTestCase { * Provides data for the testAccess method. * * @return array + * An array of test data. */ public static function providerTestAccess() { return [ diff --git a/core/phpcs.xml.dist b/core/phpcs.xml.dist index 5b862e191b7..3e120eadc66 100644 --- a/core/phpcs.xml.dist +++ b/core/phpcs.xml.dist @@ -87,12 +87,7 @@ <include-pattern>core/lib/Drupal/Core/*</include-pattern> <include-pattern>core/lib/Drupal/Component/*</include-pattern> <include-pattern>core/tests/*</include-pattern> - </rule> - <rule ref="Drupal.Commenting.FunctionComment.MissingReturnComment"> - <exclude-pattern>core/lib/Drupal/Core/*</exclude-pattern> - <exclude-pattern>core/lib/Drupal/Component/*</exclude-pattern> - <exclude-pattern>core/tests/*</exclude-pattern> - <exclude-pattern>core/*/tests/*</exclude-pattern> + <include-pattern>core/*/tests/*</include-pattern> </rule> <rule ref="Drupal.Commenting.GenderNeutralComment"/> <rule ref="Drupal.Commenting.HookComment"/> |