From 576bd7543d19002c76fe4488c57d972e69c45671 Mon Sep 17 00:00:00 2001 From: Alex Pott <alex.a.pott@googlemail.com> Date: Fri, 19 Nov 2021 09:49:33 +0000 Subject: [PATCH] Issue #3207567 by Spokje, quietone, guilhermevp, yogeshmpawar, daffie, alexpott: Fix Drupal.Commenting.FunctionComment.MissingParamComment --- .../Scaffold/Operations/OperationFactory.php | 1 + .../Annotation/AnnotationInterface.php | 2 + .../Bridge/ZfExtensionManagerSfContainer.php | 1 + core/lib/Drupal/Component/Gettext/PoItem.php | 8 ++ core/lib/Drupal/Component/Utility/Random.php | 1 + core/lib/Drupal/Core/Access/AccessManager.php | 1 + core/lib/Drupal/Core/Ajax/RemoveCommand.php | 1 + .../Cache/Context/IsFrontPathCacheContext.php | 1 + core/lib/Drupal/Core/Composer/Composer.php | 3 + .../Core/Config/ConfigInstallerInterface.php | 1 + .../Drupal/Core/Datetime/Element/Datelist.php | 2 + .../Drupal/Core/Datetime/Element/Datetime.php | 1 + .../Query/ConditionAggregateInterface.php | 14 +++ .../Core/Entity/Query/ConditionInterface.php | 9 ++ .../Drupal/Core/Entity/Query/Sql/Tables.php | 2 + .../AuthenticationSubscriber.php | 1 + .../ExceptionTestSiteSubscriber.php | 1 + .../FinishResponseSubscriber.php | 1 + core/lib/Drupal/Core/Form/FormSubmitter.php | 1 + .../lib/Drupal/Core/Locale/CountryManager.php | 1 + .../Drupal/Core/Lock/LockBackendInterface.php | 1 + .../lib/Drupal/Core/Menu/LocalTaskManager.php | 1 + .../Core/Render/Element/InlineTemplate.php | 1 + .../Enhancer/ParamConversionEnhancer.php | 1 + .../Drupal/Core/Routing/RoutePreloader.php | 1 + core/lib/Drupal/Core/Test/TestDiscovery.php | 1 + core/lib/Drupal/Core/Updater/Updater.php | 1 + .../Drupal/Core/Updater/UpdaterInterface.php | 1 + .../Validation/ConstraintValidatorFactory.php | 1 + core/modules/ban/src/Form/BanAdmin.php | 1 + .../src/EventSubscriber.php | 2 + .../Functional/ConfigTranslationUiTest.php | 2 + .../tests/src/Unit/ConfigNamesMapperTest.php | 1 + .../Kernel/FieldLayoutEntityDisplayTest.php | 3 + .../file/src/Upload/FileUploadResult.php | 3 + .../jsonapi/tests/src/Functional/UserTest.php | 2 + core/modules/locale/src/PluralFormula.php | 2 + .../src/Event/MigratePreRowSaveEvent.php | 1 + .../tests/src/Kernel/process/ExtractTest.php | 2 + .../Kernel/process/HandleMultiplesTest.php | 2 + .../NodeAdminRouteSubscriber.php | 1 + .../node/src/Plugin/views/argument/Nid.php | 1 + .../Kernel/Migrate/d7/MigrateNodeTypeTest.php | 5 + .../tests/src/Kernel/QuickEditTestBase.php | 1 + .../serialization/src/Encoder/XmlEncoder.php | 1 + ...ntityReferenceFieldItemNormalizerTrait.php | 1 + .../ContentEntityNormalizerTest.php | 4 + .../system/src/Form/ModulesListForm.php | 1 + .../src/Form/SystemMenuOffCanvasForm.php | 3 + .../system/src/PhpStorage/MockPhpStorage.php | 1 + .../system/src/SystemConfigSubscriber.php | 1 + .../src/Tests/Routing/MockAliasManager.php | 4 - .../src/EarlyRenderingTestController.php | 1 + .../FormTestMachineNameValidationForm.php | 1 + .../EventSubscriber/ThemeTestSubscriber.php | 1 + .../AssertPageCacheContextsAndTagsTrait.php | 1 + .../tests/src/Kernel/Common/UrlTest.php | 1 + .../Kernel/Extension/ModuleHandlerTest.php | 1 + .../modules/user/src/UserStorageInterface.php | 1 + .../src/Functional/UserPasswordResetTest.php | 1 + core/modules/views/src/Analyzer.php | 1 + .../views/argument_validator/Entity.php | 1 + .../views/display/DisplayRouterInterface.php | 1 + .../views/src/Plugin/views/filter/Combine.php | 1 + .../Plugin/views/filter/FilterPluginBase.php | 3 +- .../views/src/Tests/TestHelperPlugin.php | 1 + .../src/Plugin/views/join/JoinTest.php | 1 + .../src/Plugin/views/query/QueryTest.php | 1 + .../Handler/FieldRenderedEntityTest.php | 1 + .../tests/src/Kernel/ViewExecutableTest.php | 1 + core/modules/views_ui/src/ViewEditForm.php | 1 + .../src/Functional/ArgumentValidatorTest.php | 1 + .../FunctionalJavascript/ViewsListingTest.php | 1 + core/modules/workflows/src/State.php | 1 + core/phpcs.xml.dist | 1 - .../Template/ComposerProjectTemplatesTest.php | 2 + .../KernelTests/Core/Command/DbDumpTest.php | 1 + .../Core/Entity/EntityQueryAggregateTest.php | 2 + .../Core/Routing/ExceptionHandlingTest.php | 1 + .../Component/Datetime/DateTimePlusTest.php | 1 + .../StubPluginManagerBaseWithMapper.php | 1 + .../Component/Utility/ReflectionTest.php | 2 + .../Plugin/Scaffold/ScaffoldTestResult.php | 2 + .../Context/IsFrontPathCacheContextTest.php | 1 + .../Config/Entity/ConfigEntityStorageTest.php | 2 + .../Compiler/BackendCompilerPassTest.php | 3 + .../Tests/Core/Entity/EntityTypeTest.php | 1 + .../KeyValueEntityStorageTest.php | 2 + .../Routing/DefaultHtmlRouteProviderTest.php | 2 + .../RssResponseRelativeUrlFilterTest.php | 2 + .../Core/Extension/ExtensionDiscoveryTest.php | 3 + .../Core/Extension/ExtensionListTest.php | 1 + .../Drupal/Tests/Core/File/FileSystemTest.php | 3 + .../Core/Form/FormStateDecoratorBaseTest.php | 114 ++++++++---------- .../Tests/Core/Form/SubformStateTest.php | 4 + .../Tests/Core/Http/ClientFactoryTest.php | 3 + .../Core/Plugin/DefaultPluginManagerTest.php | 1 + .../TestDerivativeDiscoveryWithObject.php | 3 + .../Core/Render/RendererPlaceholdersTest.php | 1 + .../RecursiveContextualValidatorTest.php | 1 + core/tests/Drupal/Tests/Core/UrlTest.php | 5 + core/tests/Drupal/Tests/DocumentElement.php | 4 + core/tests/Drupal/Tests/UnitTestCase.php | 3 + 103 files changed, 236 insertions(+), 67 deletions(-) diff --git a/composer/Plugin/Scaffold/Operations/OperationFactory.php b/composer/Plugin/Scaffold/Operations/OperationFactory.php index b256e0e15fba..0f54a35c51c5 100644 --- a/composer/Plugin/Scaffold/Operations/OperationFactory.php +++ b/composer/Plugin/Scaffold/Operations/OperationFactory.php @@ -124,6 +124,7 @@ protected function createAppendOp(PackageInterface $package, OperationData $oper * * @param Drupal\Composer\Plugin\Scaffold\ScaffoldFilePath $file * Scaffold file to check. + * * @return bool * True if the file exists and has content. */ diff --git a/core/lib/Drupal/Component/Annotation/AnnotationInterface.php b/core/lib/Drupal/Component/Annotation/AnnotationInterface.php index 1168510d6550..eb44b398193e 100644 --- a/core/lib/Drupal/Component/Annotation/AnnotationInterface.php +++ b/core/lib/Drupal/Component/Annotation/AnnotationInterface.php @@ -23,6 +23,7 @@ public function getProvider(); * Sets the name of the provider of the annotated class. * * @param string $provider + * The provider of the annotated class. */ public function setProvider($provider); @@ -44,6 +45,7 @@ public function getClass(); * Sets the class of the annotated class. * * @param string $class + * The class of the annotated class. */ public function setClass($class); diff --git a/core/lib/Drupal/Component/Bridge/ZfExtensionManagerSfContainer.php b/core/lib/Drupal/Component/Bridge/ZfExtensionManagerSfContainer.php index 396e8439076e..2e9fdd310cf1 100644 --- a/core/lib/Drupal/Component/Bridge/ZfExtensionManagerSfContainer.php +++ b/core/lib/Drupal/Component/Bridge/ZfExtensionManagerSfContainer.php @@ -124,6 +124,7 @@ public function setContainer(ContainerInterface $container = NULL) { /** * @param $class + * The class to set as standalone. */ public function setStandalone($class) { if (!is_subclass_of($class, ReaderManagerInterface::class) && !is_subclass_of($class, WriterManagerInterface::class)) { diff --git a/core/lib/Drupal/Component/Gettext/PoItem.php b/core/lib/Drupal/Component/Gettext/PoItem.php index 5e7d6f6444da..3ef8a2acea81 100644 --- a/core/lib/Drupal/Component/Gettext/PoItem.php +++ b/core/lib/Drupal/Component/Gettext/PoItem.php @@ -77,6 +77,7 @@ public function getLangcode() { * Set the language code of the current language. * * @param string $langcode + * The language code of the current language. */ public function setLangcode($langcode) { $this->langcode = $langcode; @@ -95,6 +96,7 @@ public function getContext() { * Set the context this translation belongs to. * * @param string $context + * The context this translation belongs to. */ public function setContext($context) { $this->context = $context; @@ -115,6 +117,7 @@ public function getSource() { * plurals. * * @param string|array $source + * The source string or the array of strings if the translation has plurals. */ public function setSource($source) { $this->source = $source; @@ -135,6 +138,8 @@ public function getTranslation() { * plurals. * * @param string|array $translation + * The translation string or the array of strings if the translation has + * plurals. */ public function setTranslation($translation) { $this->translation = $translation; @@ -144,6 +149,7 @@ public function setTranslation($translation) { * Set if the translation has plural values. * * @param bool $plural + * TRUE, if the translation has plural values. FALSE otherwise. */ public function setPlural($plural) { $this->plural = $plural; @@ -171,6 +177,7 @@ public function getComment() { * Set the comment of this translation. * * @param string $comment + * The comment of this translation. */ public function setComment($comment) { $this->comment = $comment; @@ -180,6 +187,7 @@ public function setComment($comment) { * Create the PoItem from a structured array. * * @param array $values + * A structured array to create the PoItem from. */ public function setFromArray(array $values = []) { if (isset($values['context'])) { diff --git a/core/lib/Drupal/Component/Utility/Random.php b/core/lib/Drupal/Component/Utility/Random.php index 06fa8b0c9545..16190d8f6694 100644 --- a/core/lib/Drupal/Component/Utility/Random.php +++ b/core/lib/Drupal/Component/Utility/Random.php @@ -249,6 +249,7 @@ public function sentences($min_word_count, $capitalize = FALSE) { * Generate paragraphs separated by double new line. * * @param int $paragraph_count + * The number of paragraphs to create. Defaults to 12. * * @return string */ diff --git a/core/lib/Drupal/Core/Access/AccessManager.php b/core/lib/Drupal/Core/Access/AccessManager.php index 14b5c87d7c6b..7650fb672417 100644 --- a/core/lib/Drupal/Core/Access/AccessManager.php +++ b/core/lib/Drupal/Core/Access/AccessManager.php @@ -66,6 +66,7 @@ class AccessManager implements AccessManagerInterface { * @param \Drupal\Core\Session\AccountInterface $current_user * The current user. * @param CheckProviderInterface $check_provider + * The check access provider. */ public function __construct(RouteProviderInterface $route_provider, ParamConverterManagerInterface $paramconverter_manager, AccessArgumentsResolverFactoryInterface $arguments_resolver_factory, AccountInterface $current_user, CheckProviderInterface $check_provider) { $this->routeProvider = $route_provider; diff --git a/core/lib/Drupal/Core/Ajax/RemoveCommand.php b/core/lib/Drupal/Core/Ajax/RemoveCommand.php index d7f86ddd257f..47993c9f6e0b 100644 --- a/core/lib/Drupal/Core/Ajax/RemoveCommand.php +++ b/core/lib/Drupal/Core/Ajax/RemoveCommand.php @@ -29,6 +29,7 @@ class RemoveCommand implements CommandInterface { * Constructs a RemoveCommand object. * * @param string $selector + * The selector. */ public function __construct($selector) { $this->selector = $selector; diff --git a/core/lib/Drupal/Core/Cache/Context/IsFrontPathCacheContext.php b/core/lib/Drupal/Core/Cache/Context/IsFrontPathCacheContext.php index 141b13a63f10..6a0afab504d8 100644 --- a/core/lib/Drupal/Core/Cache/Context/IsFrontPathCacheContext.php +++ b/core/lib/Drupal/Core/Cache/Context/IsFrontPathCacheContext.php @@ -21,6 +21,7 @@ class IsFrontPathCacheContext implements CacheContextInterface { * Constructs an IsFrontPathCacheContext object. * * @param \Drupal\Core\Path\PathMatcherInterface $path_matcher + * The path matcher. */ public function __construct(PathMatcherInterface $path_matcher) { $this->pathMatcher = $path_matcher; diff --git a/core/lib/Drupal/Core/Composer/Composer.php b/core/lib/Drupal/Core/Composer/Composer.php index 3041dab3a777..0048296d8478 100644 --- a/core/lib/Drupal/Core/Composer/Composer.php +++ b/core/lib/Drupal/Core/Composer/Composer.php @@ -87,6 +87,7 @@ class Composer { * Add vendor classes to Composer's static classmap. * * @param \Composer\Script\Event $event + * The event. */ public static function preAutoloadDump(Event $event) { // Get the configured vendor directory. @@ -159,6 +160,7 @@ public static function preAutoloadDump(Event $event) { * Ensures that .htaccess and web.config files are present in Composer root. * * @param \Composer\Script\Event $event + * The event. */ public static function ensureHtaccess(Event $event) { @@ -295,6 +297,7 @@ protected static function deleteRecursive($path) { * Fires the drupal-phpunit-upgrade script event if necessary. * * @param \Composer\Script\Event $event + * The event. */ public static function upgradePHPUnit(Event $event) { $repository = $event->getComposer()->getRepositoryManager()->getLocalRepository(); diff --git a/core/lib/Drupal/Core/Config/ConfigInstallerInterface.php b/core/lib/Drupal/Core/Config/ConfigInstallerInterface.php index daa99bb4519c..0b383a76fa7d 100644 --- a/core/lib/Drupal/Core/Config/ConfigInstallerInterface.php +++ b/core/lib/Drupal/Core/Config/ConfigInstallerInterface.php @@ -70,6 +70,7 @@ public function installCollectionDefaultConfig($collection); * Sets the configuration storage that provides the default configuration. * * @param \Drupal\Core\Config\StorageInterface $storage + * The storage. * * @return $this */ diff --git a/core/lib/Drupal/Core/Datetime/Element/Datelist.php b/core/lib/Drupal/Core/Datetime/Element/Datelist.php index bbb1676d70e1..add7a73ae153 100644 --- a/core/lib/Drupal/Core/Datetime/Element/Datelist.php +++ b/core/lib/Drupal/Core/Datetime/Element/Datelist.php @@ -350,7 +350,9 @@ protected static function checkEmptyInputs($input, $parts) { * Rounds minutes and seconds to nearest requested value. * * @param $date + * The date. * @param $increment + * The value to round to. * * @return */ diff --git a/core/lib/Drupal/Core/Datetime/Element/Datetime.php b/core/lib/Drupal/Core/Datetime/Element/Datetime.php index e1d0aea4720a..11c5f2a69f60 100644 --- a/core/lib/Drupal/Core/Datetime/Element/Datetime.php +++ b/core/lib/Drupal/Core/Datetime/Element/Datetime.php @@ -387,6 +387,7 @@ public static function validateDatetime(&$element, FormStateInterface $form_stat * This is centralized for a consistent method of creating these examples. * * @param string $format + * The date format. * * @return string */ diff --git a/core/lib/Drupal/Core/Entity/Query/ConditionAggregateInterface.php b/core/lib/Drupal/Core/Entity/Query/ConditionAggregateInterface.php index 0c49c2811a3f..3cdf00c971fd 100644 --- a/core/lib/Drupal/Core/Entity/Query/ConditionAggregateInterface.php +++ b/core/lib/Drupal/Core/Entity/Query/ConditionAggregateInterface.php @@ -19,10 +19,16 @@ public function getConjunction(); * Adds a condition. * * @param string|ConditionAggregateInterface $field + * The field. * @param string $function + * (optional) The function. * @param mixed $value + * (optional) The value. * @param string $operator + * (optional) The operator. * @param string $langcode + * (optional) For which language the entity should be prepared, defaults to + * the current content language. * * @return $this * The called object. @@ -35,8 +41,12 @@ public function condition($field, $function = NULL, $value = NULL, $operator = N * Queries for the existence of a field. * * @param string $field + * The field to query for existence. * @param string $function + * The function. * @param string $langcode + * (optional) For which language the entity should be prepared, defaults to + * the current content language. * * @return \Drupal\Core\Entity\Query\ConditionInterface * @@ -48,8 +58,12 @@ public function exists($field, $function, $langcode = NULL); * Queries for the nonexistence of a field. * * @param string $field + * The field to query for nonexistence. * @param string $function + * The function. * @param string $langcode + * (optional) For which language the entity should be prepared, defaults to + * the current content language. * * @return \Drupal\Core\Entity\Query\ConditionInterface * diff --git a/core/lib/Drupal/Core/Entity/Query/ConditionInterface.php b/core/lib/Drupal/Core/Entity/Query/ConditionInterface.php index d0817fc79354..c2893e64fdd7 100644 --- a/core/lib/Drupal/Core/Entity/Query/ConditionInterface.php +++ b/core/lib/Drupal/Core/Entity/Query/ConditionInterface.php @@ -27,9 +27,14 @@ public function count(); * Adds a condition. * * @param string|\Drupal\Core\Entity\Query\ConditionInterface $field + * The field. * @param mixed $value + * (optional) The value. * @param string $operator + * (optional) The operator. * @param string $langcode + * (optional) For which language the entity should be prepared, defaults to + * the current content language. * * @return $this * @@ -41,7 +46,10 @@ public function condition($field, $value = NULL, $operator = NULL, $langcode = N * Queries for the existence of a field. * * @param string $field + * The field to query for existence. * @param string $langcode + * (optional) For which language the entity should be prepared, defaults to + * the current content language. * * @return $this * @@ -53,6 +61,7 @@ public function exists($field, $langcode = NULL); * Queries for the nonexistence of a field. * * @param string $field + * The field to query for nonexistence. * @param string $langcode * (optional) For which language the entity should be prepared, defaults to * the current content language. diff --git a/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php b/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php index 43b7be38a3ad..91b43bef9396 100644 --- a/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php +++ b/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php @@ -66,6 +66,7 @@ class Tables implements TablesInterface { /** * @param \Drupal\Core\Database\Query\SelectInterface $sql_query + * The SQL query. */ public function __construct(SelectInterface $sql_query) { $this->sqlQuery = $sql_query; @@ -454,6 +455,7 @@ protected function addJoin($type, $table, $join_condition, $langcode, $delta = N * @param string $table * The table name. * @param string $entity_type_id + * The entity type ID. * * @return array|false * An associative array of table field mapping for the given table, keyed by diff --git a/core/lib/Drupal/Core/EventSubscriber/AuthenticationSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/AuthenticationSubscriber.php index b592c1ad09ae..129cd692bf56 100644 --- a/core/lib/Drupal/Core/EventSubscriber/AuthenticationSubscriber.php +++ b/core/lib/Drupal/Core/EventSubscriber/AuthenticationSubscriber.php @@ -125,6 +125,7 @@ public function onExceptionSendChallenge(ExceptionEvent $event) { * Detect disallowed authentication methods on access denied exceptions. * * @param \Symfony\Component\HttpKernel\Event\ExceptionEvent $event + * The event. */ public function onExceptionAccessDenied(ExceptionEvent $event) { if (isset($this->filter) && $event->isMainRequest()) { diff --git a/core/lib/Drupal/Core/EventSubscriber/ExceptionTestSiteSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/ExceptionTestSiteSubscriber.php index 00ef848c0f51..2f9745c5c88f 100644 --- a/core/lib/Drupal/Core/EventSubscriber/ExceptionTestSiteSubscriber.php +++ b/core/lib/Drupal/Core/EventSubscriber/ExceptionTestSiteSubscriber.php @@ -32,6 +32,7 @@ protected function getHandledFormats() { * vestigial and can be removed. * * @param \Symfony\Component\HttpKernel\Event\ExceptionEvent $event + * The event. */ public function on500(ExceptionEvent $event) { $exception = $event->getThrowable(); diff --git a/core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php index d00270f793ad..9d70038a787f 100644 --- a/core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php +++ b/core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php @@ -213,6 +213,7 @@ public function onRespond(ResponseEvent $event) { * @see \Symfony\Component\HttpFoundation\ResponseHeaderBag::computeCacheControlValue() * * @param \Symfony\Component\HttpFoundation\Response $response + * The response object. * * @return bool * TRUE when Cache-Control header was set explicitly on the given response. diff --git a/core/lib/Drupal/Core/Form/FormSubmitter.php b/core/lib/Drupal/Core/Form/FormSubmitter.php index 94dadbb48274..b5638ce9578c 100644 --- a/core/lib/Drupal/Core/Form/FormSubmitter.php +++ b/core/lib/Drupal/Core/Form/FormSubmitter.php @@ -33,6 +33,7 @@ class FormSubmitter implements FormSubmitterInterface { * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack * The request stack. * @param \Drupal\Core\Routing\UrlGeneratorInterface $url_generator + * The URL generator. */ public function __construct(RequestStack $request_stack, UrlGeneratorInterface $url_generator) { $this->requestStack = $request_stack; diff --git a/core/lib/Drupal/Core/Locale/CountryManager.php b/core/lib/Drupal/Core/Locale/CountryManager.php index b5b01acfe0de..cc80581b0e68 100644 --- a/core/lib/Drupal/Core/Locale/CountryManager.php +++ b/core/lib/Drupal/Core/Locale/CountryManager.php @@ -25,6 +25,7 @@ class CountryManager implements CountryManagerInterface { * Constructor. * * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler + * The module handler. */ public function __construct(ModuleHandlerInterface $module_handler) { $this->moduleHandler = $module_handler; diff --git a/core/lib/Drupal/Core/Lock/LockBackendInterface.php b/core/lib/Drupal/Core/Lock/LockBackendInterface.php index dcc8ea4e7420..5f74cdda9c04 100644 --- a/core/lib/Drupal/Core/Lock/LockBackendInterface.php +++ b/core/lib/Drupal/Core/Lock/LockBackendInterface.php @@ -127,6 +127,7 @@ public function wait($name, $delay = 30); * Releases the given lock. * * @param string $name + * The lock name. */ public function release($name); diff --git a/core/lib/Drupal/Core/Menu/LocalTaskManager.php b/core/lib/Drupal/Core/Menu/LocalTaskManager.php index f0d42fb7be6e..6fb8bdfe935b 100644 --- a/core/lib/Drupal/Core/Menu/LocalTaskManager.php +++ b/core/lib/Drupal/Core/Menu/LocalTaskManager.php @@ -389,6 +389,7 @@ public function getLocalTasks($route_name, $level = 0) { * @param string $route_name * The route name of the local task to determine the active status. * @param array $route_parameters + * The parameter for the route. * * @return bool * Returns TRUE if the passed route_name and route_parameters is considered diff --git a/core/lib/Drupal/Core/Render/Element/InlineTemplate.php b/core/lib/Drupal/Core/Render/Element/InlineTemplate.php index ddef29673a92..d53a317e92cd 100644 --- a/core/lib/Drupal/Core/Render/Element/InlineTemplate.php +++ b/core/lib/Drupal/Core/Render/Element/InlineTemplate.php @@ -43,6 +43,7 @@ public function getInfo() { * Renders a twig string directly. * * @param array $element + * The element. * * @return array */ diff --git a/core/lib/Drupal/Core/Routing/Enhancer/ParamConversionEnhancer.php b/core/lib/Drupal/Core/Routing/Enhancer/ParamConversionEnhancer.php index 3d268e481697..445c4fe3f48c 100644 --- a/core/lib/Drupal/Core/Routing/Enhancer/ParamConversionEnhancer.php +++ b/core/lib/Drupal/Core/Routing/Enhancer/ParamConversionEnhancer.php @@ -73,6 +73,7 @@ protected function copyRawVariables(array $defaults) { * Catches failed parameter conversions and throw a 404 instead. * * @param \Symfony\Component\HttpKernel\Event\ExceptionEvent $event + * The event. */ public function onException(ExceptionEvent $event) { $exception = $event->getThrowable(); diff --git a/core/lib/Drupal/Core/Routing/RoutePreloader.php b/core/lib/Drupal/Core/Routing/RoutePreloader.php index 9a8fba810c03..f9bc874b69ea 100644 --- a/core/lib/Drupal/Core/Routing/RoutePreloader.php +++ b/core/lib/Drupal/Core/Routing/RoutePreloader.php @@ -55,6 +55,7 @@ class RoutePreloader implements EventSubscriberInterface { * @param \Drupal\Core\State\StateInterface $state * The state key value store. * @param \Drupal\Core\Cache\CacheBackendInterface $cache + * The cache backend. */ public function __construct(RouteProviderInterface $route_provider, StateInterface $state, CacheBackendInterface $cache) { $this->routeProvider = $route_provider; diff --git a/core/lib/Drupal/Core/Test/TestDiscovery.php b/core/lib/Drupal/Core/Test/TestDiscovery.php index 1b12a47c7c65..cf0ca32f2810 100644 --- a/core/lib/Drupal/Core/Test/TestDiscovery.php +++ b/core/lib/Drupal/Core/Test/TestDiscovery.php @@ -389,6 +389,7 @@ public static function getTestInfo($classname, $doc_comment = NULL) { * Parses the phpDoc summary line of a test class. * * @param string $doc_comment + * The documentation comment. * * @return string * The parsed phpDoc summary line. An empty string is returned if no summary diff --git a/core/lib/Drupal/Core/Updater/Updater.php b/core/lib/Drupal/Core/Updater/Updater.php index 46ea7ea8cd83..65c7409bbc62 100644 --- a/core/lib/Drupal/Core/Updater/Updater.php +++ b/core/lib/Drupal/Core/Updater/Updater.php @@ -155,6 +155,7 @@ protected static function getExtensionInfo($directory) { * provide their canonical name. * * @param string $directory + * The full directory path. * * @return string * The name of the project. diff --git a/core/lib/Drupal/Core/Updater/UpdaterInterface.php b/core/lib/Drupal/Core/Updater/UpdaterInterface.php index 09e3bec9072e..6e0bdaf32f9f 100644 --- a/core/lib/Drupal/Core/Updater/UpdaterInterface.php +++ b/core/lib/Drupal/Core/Updater/UpdaterInterface.php @@ -49,6 +49,7 @@ public static function getRootDirectoryRelativePath(); * Determines if the Updater can handle the project provided in $directory. * * @param string $directory + * The directory. * * @return bool * TRUE if the project is installed, FALSE if not. diff --git a/core/lib/Drupal/Core/Validation/ConstraintValidatorFactory.php b/core/lib/Drupal/Core/Validation/ConstraintValidatorFactory.php index 4e6bfe309132..218033e58046 100644 --- a/core/lib/Drupal/Core/Validation/ConstraintValidatorFactory.php +++ b/core/lib/Drupal/Core/Validation/ConstraintValidatorFactory.php @@ -19,6 +19,7 @@ class ConstraintValidatorFactory extends BaseConstraintValidatorFactory { * Constructs a new ConstraintValidatorFactory. * * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver + * The class resolver. */ public function __construct(ClassResolverInterface $class_resolver) { $this->classResolver = $class_resolver; diff --git a/core/modules/ban/src/Form/BanAdmin.php b/core/modules/ban/src/Form/BanAdmin.php index 9a55d02dbe27..a92954e9d200 100644 --- a/core/modules/ban/src/Form/BanAdmin.php +++ b/core/modules/ban/src/Form/BanAdmin.php @@ -24,6 +24,7 @@ class BanAdmin extends FormBase { * Constructs a new BanAdmin object. * * @param \Drupal\ban\BanIpManagerInterface $ip_manager + * The ban IP manager. */ public function __construct(BanIpManagerInterface $ip_manager) { $this->ipManager = $ip_manager; diff --git a/core/modules/config/tests/config_import_test/src/EventSubscriber.php b/core/modules/config/tests/config_import_test/src/EventSubscriber.php index 6b72b8ac992e..a0691c3f0edc 100644 --- a/core/modules/config/tests/config_import_test/src/EventSubscriber.php +++ b/core/modules/config/tests/config_import_test/src/EventSubscriber.php @@ -84,6 +84,7 @@ public function onConfigImporterMissingContentTwo(MissingContentEvent $event) { * Reacts to a config save and records information in state for testing. * * @param \Drupal\Core\Config\ConfigCrudEvent $event + * The event. */ public function onConfigSave(ConfigCrudEvent $event) { $config = $event->getConfig(); @@ -116,6 +117,7 @@ public function onConfigSave(ConfigCrudEvent $event) { * Reacts to a config delete and records information in state for testing. * * @param \Drupal\Core\Config\ConfigCrudEvent $event + * The event. */ public function onConfigDelete(ConfigCrudEvent $event) { $config = $event->getConfig(); diff --git a/core/modules/config_translation/tests/src/Functional/ConfigTranslationUiTest.php b/core/modules/config_translation/tests/src/Functional/ConfigTranslationUiTest.php index 025f933eb44f..50a74e205691 100644 --- a/core/modules/config_translation/tests/src/Functional/ConfigTranslationUiTest.php +++ b/core/modules/config_translation/tests/src/Functional/ConfigTranslationUiTest.php @@ -1147,7 +1147,9 @@ protected function getTranslation($config_name, $key, $langcode) { * Sets site name and slogan for default language, helps in tests. * * @param string $site_name + * The site name. * @param string $site_slogan + * The site slogan. */ protected function setSiteInformation($site_name, $site_slogan) { $edit = [ diff --git a/core/modules/config_translation/tests/src/Unit/ConfigNamesMapperTest.php b/core/modules/config_translation/tests/src/Unit/ConfigNamesMapperTest.php index 728063ad5756..ea273e39fd40 100644 --- a/core/modules/config_translation/tests/src/Unit/ConfigNamesMapperTest.php +++ b/core/modules/config_translation/tests/src/Unit/ConfigNamesMapperTest.php @@ -675,6 +675,7 @@ public function getInternalLangcode() { * Sets the list of configuration names. * * @param array $config_names + * The configuration names. */ public function setConfigNames(array $config_names) { $this->pluginDefinition['names'] = $config_names; diff --git a/core/modules/field_layout/tests/src/Kernel/FieldLayoutEntityDisplayTest.php b/core/modules/field_layout/tests/src/Kernel/FieldLayoutEntityDisplayTest.php index 1f94b9da38fa..0042c7b0585a 100644 --- a/core/modules/field_layout/tests/src/Kernel/FieldLayoutEntityDisplayTest.php +++ b/core/modules/field_layout/tests/src/Kernel/FieldLayoutEntityDisplayTest.php @@ -176,8 +176,11 @@ public function testPreSave() { * Asserts than an entity has the correct values. * * @param mixed $expected + * The expected values. * @param array $values + * The actual values. * @param string $message + * (optional) An error message. */ public static function assertEntityValues($expected, array $values, $message = '') { diff --git a/core/modules/file/src/Upload/FileUploadResult.php b/core/modules/file/src/Upload/FileUploadResult.php index 8481002cf602..8a00935da17e 100644 --- a/core/modules/file/src/Upload/FileUploadResult.php +++ b/core/modules/file/src/Upload/FileUploadResult.php @@ -51,6 +51,7 @@ public function setSecurityRename(): FileUploadResult { * Sets the sanitized filename. * * @param string $sanitizedFilename + * The sanitized filename. * * @return $this */ @@ -72,6 +73,7 @@ public function getOriginalFilename(): string { * Sets the original filename. * * @param string $originalFilename + * The original filename. * * @return $this */ @@ -84,6 +86,7 @@ public function setOriginalFilename(string $originalFilename): FileUploadResult * Sets the File entity. * * @param \Drupal\file\FileInterface $file + * A file entity. * * @return $this */ diff --git a/core/modules/jsonapi/tests/src/Functional/UserTest.php b/core/modules/jsonapi/tests/src/Functional/UserTest.php index 2184c3bcb4b8..21a2d99d0b58 100644 --- a/core/modules/jsonapi/tests/src/Functional/UserTest.php +++ b/core/modules/jsonapi/tests/src/Functional/UserTest.php @@ -803,7 +803,9 @@ protected function makeNormalizationInvalid(array $document, $entity_key) { /** * @param \Drupal\user\UserInterface $account + * The user account. * @param string $cancel_method + * The cancel method. */ private function sendDeleteRequestForUser(UserInterface $account, string $cancel_method) { $url = Url::fromRoute(sprintf('jsonapi.%s.individual', static::$resourceTypeName), ['entity' => $account->uuid()]); diff --git a/core/modules/locale/src/PluralFormula.php b/core/modules/locale/src/PluralFormula.php index 0913a69cdaf7..fc7fd88519fa 100644 --- a/core/modules/locale/src/PluralFormula.php +++ b/core/modules/locale/src/PluralFormula.php @@ -42,7 +42,9 @@ class PluralFormula implements PluralFormulaInterface { /** * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager + * The language manager. * @param \Drupal\Core\State\StateInterface $state + * The state. */ public function __construct(LanguageManagerInterface $language_manager, StateInterface $state) { $this->languageManager = $language_manager; diff --git a/core/modules/migrate/src/Event/MigratePreRowSaveEvent.php b/core/modules/migrate/src/Event/MigratePreRowSaveEvent.php index 98a1c0a53edf..397ceb5e372d 100644 --- a/core/modules/migrate/src/Event/MigratePreRowSaveEvent.php +++ b/core/modules/migrate/src/Event/MigratePreRowSaveEvent.php @@ -26,6 +26,7 @@ class MigratePreRowSaveEvent extends EventBase { * @param \Drupal\migrate\MigrateMessageInterface $message * The current migrate message service. * @param \Drupal\migrate\Row $row + * The current row. */ public function __construct(MigrationInterface $migration, MigrateMessageInterface $message, Row $row) { parent::__construct($migration, $message); diff --git a/core/modules/migrate/tests/src/Kernel/process/ExtractTest.php b/core/modules/migrate/tests/src/Kernel/process/ExtractTest.php index 8dc73f492449..c85f8aab1a57 100644 --- a/core/modules/migrate/tests/src/Kernel/process/ExtractTest.php +++ b/core/modules/migrate/tests/src/Kernel/process/ExtractTest.php @@ -57,7 +57,9 @@ public function getDefinition() { * @dataProvider multipleValueProviderSource * * @param array $source_data + * The source data. * @param array $expected_data + * The expected results. */ public function testMultipleValueExplode(array $source_data, array $expected_data) { $definition = $this->getDefinition(); diff --git a/core/modules/migrate/tests/src/Kernel/process/HandleMultiplesTest.php b/core/modules/migrate/tests/src/Kernel/process/HandleMultiplesTest.php index caae69de613c..1319a7bf8a77 100644 --- a/core/modules/migrate/tests/src/Kernel/process/HandleMultiplesTest.php +++ b/core/modules/migrate/tests/src/Kernel/process/HandleMultiplesTest.php @@ -85,7 +85,9 @@ public function getDefinition() { * @dataProvider scalarAndMultipleValuesProviderSource * * @param array $source_data + * The source data. * @param array $expected_data + * The expected results. */ public function testScalarAndMultipleValues(array $source_data, array $expected_data) { $definition = $this->getDefinition(); diff --git a/core/modules/node/src/EventSubscriber/NodeAdminRouteSubscriber.php b/core/modules/node/src/EventSubscriber/NodeAdminRouteSubscriber.php index 722c70549d09..a726ae8a649e 100644 --- a/core/modules/node/src/EventSubscriber/NodeAdminRouteSubscriber.php +++ b/core/modules/node/src/EventSubscriber/NodeAdminRouteSubscriber.php @@ -58,6 +58,7 @@ protected function alterRoutes(RouteCollection $collection) { * Rebuilds the router when node.settings:use_admin_theme is changed. * * @param \Drupal\Core\Config\ConfigCrudEvent $event + * The event object. */ public function onConfigSave(ConfigCrudEvent $event) { if ($event->getConfig()->getName() === 'node.settings' && $event->isChanged('use_admin_theme')) { diff --git a/core/modules/node/src/Plugin/views/argument/Nid.php b/core/modules/node/src/Plugin/views/argument/Nid.php index 382b66643ed9..4a8c1e2b18c1 100644 --- a/core/modules/node/src/Plugin/views/argument/Nid.php +++ b/core/modules/node/src/Plugin/views/argument/Nid.php @@ -30,6 +30,7 @@ class Nid extends NumericArgument { * @param mixed $plugin_definition * The plugin implementation definition. * @param \Drupal\node\NodeStorageInterface $node_storage + * The node storage handler. */ public function __construct(array $configuration, $plugin_id, $plugin_definition, NodeStorageInterface $node_storage) { parent::__construct($configuration, $plugin_id, $plugin_definition); diff --git a/core/modules/node/tests/src/Kernel/Migrate/d7/MigrateNodeTypeTest.php b/core/modules/node/tests/src/Kernel/Migrate/d7/MigrateNodeTypeTest.php index b1080a9de36b..94a579c8703b 100644 --- a/core/modules/node/tests/src/Kernel/Migrate/d7/MigrateNodeTypeTest.php +++ b/core/modules/node/tests/src/Kernel/Migrate/d7/MigrateNodeTypeTest.php @@ -42,10 +42,15 @@ protected function setUp(): void { * @param string $help * The expected help text. * @param bool $display_submitted + * If submission information is displayed. * @param bool $new_revision + * If this is a new revision. * @param array $expected_available_menus + * The expected menus. * @param string $expected_parent + * The expected menu parents. * @param string|null $body_label + * (optional) The label for the body field. */ protected function assertEntity($id, $label, $description, $help, $display_submitted, $new_revision, $expected_available_menus, $expected_parent, $body_label = NULL) { /** @var \Drupal\node\NodeTypeInterface $entity */ diff --git a/core/modules/quickedit/tests/src/Kernel/QuickEditTestBase.php b/core/modules/quickedit/tests/src/Kernel/QuickEditTestBase.php index abcf71d7fcbc..b92af125ac4d 100644 --- a/core/modules/quickedit/tests/src/Kernel/QuickEditTestBase.php +++ b/core/modules/quickedit/tests/src/Kernel/QuickEditTestBase.php @@ -65,6 +65,7 @@ protected function setUp() { * @param string $label * The field's label (used everywhere: widget label, formatter label). * @param array $field_settings + * The field's settings. * @param string $widget_type * The widget type. * @param array $widget_settings diff --git a/core/modules/serialization/src/Encoder/XmlEncoder.php b/core/modules/serialization/src/Encoder/XmlEncoder.php index f80955b54c03..bdcb184d3e8c 100644 --- a/core/modules/serialization/src/Encoder/XmlEncoder.php +++ b/core/modules/serialization/src/Encoder/XmlEncoder.php @@ -55,6 +55,7 @@ public function getBaseEncoder() { * Sets the base encoder instance. * * @param \Symfony\Component\Serializer\Encoder\XmlEncoder $encoder + * The XML encoder. */ public function setBaseEncoder($encoder) { $this->baseEncoder = $encoder; diff --git a/core/modules/serialization/src/Normalizer/EntityReferenceFieldItemNormalizerTrait.php b/core/modules/serialization/src/Normalizer/EntityReferenceFieldItemNormalizerTrait.php index 1acfd70a7a44..6f4ec68d4470 100644 --- a/core/modules/serialization/src/Normalizer/EntityReferenceFieldItemNormalizerTrait.php +++ b/core/modules/serialization/src/Normalizer/EntityReferenceFieldItemNormalizerTrait.php @@ -20,6 +20,7 @@ protected function normalizeRootReferenceValue(&$values, EntityReferenceItem $fi * Determines if a field item references a taxonomy term. * * @param \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $field_item + * The entity reference item. * * @return bool */ diff --git a/core/modules/serialization/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php b/core/modules/serialization/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php index 5f20476b74aa..888499c4fd8a 100644 --- a/core/modules/serialization/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php +++ b/core/modules/serialization/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php @@ -122,6 +122,7 @@ public function testNormalizeWithAccountContext() { * Creates a mock content entity. * * @param $definitions + * The properties the will be returned. * * @return \PHPUnit\Framework\MockObject\MockObject */ @@ -145,8 +146,11 @@ public function createMockForContentEntity($definitions) { * Creates a mock field list item. * * @param bool $access + * The value that access() will return. * @param bool $internal + * The value that isInternal() will return. * @param \Drupal\Core\Session\AccountInterface $user_context + * The user context used for the access check. * * @return \Drupal\Core\Field\FieldItemListInterface|\PHPUnit\Framework\MockObject\MockObject */ diff --git a/core/modules/system/src/Form/ModulesListForm.php b/core/modules/system/src/Form/ModulesListForm.php index ec50babddce8..d38749400b56 100644 --- a/core/modules/system/src/Form/ModulesListForm.php +++ b/core/modules/system/src/Form/ModulesListForm.php @@ -238,6 +238,7 @@ public function buildForm(array $form, FormStateInterface $form_state) { * @param \Drupal\Core\Extension\Extension $module * The module for which to build the form row. * @param $distribution + * The distribution. * * @return array * The form row for the given module. diff --git a/core/modules/system/src/Form/SystemMenuOffCanvasForm.php b/core/modules/system/src/Form/SystemMenuOffCanvasForm.php index a561a5bd9a5a..8a500853ae62 100644 --- a/core/modules/system/src/Form/SystemMenuOffCanvasForm.php +++ b/core/modules/system/src/Form/SystemMenuOffCanvasForm.php @@ -61,8 +61,11 @@ class SystemMenuOffCanvasForm extends PluginFormBase implements ContainerInjecti * SystemMenuOffCanvasForm constructor. * * @param \Drupal\Core\Entity\EntityStorageInterface $menu_storage + * The menu storage handler. * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager + * The entity type manager. * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation + * The string translation handler. * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory * The config factory. */ diff --git a/core/modules/system/src/PhpStorage/MockPhpStorage.php b/core/modules/system/src/PhpStorage/MockPhpStorage.php index cb3c42f8a42a..349191334c0f 100644 --- a/core/modules/system/src/PhpStorage/MockPhpStorage.php +++ b/core/modules/system/src/PhpStorage/MockPhpStorage.php @@ -18,6 +18,7 @@ class MockPhpStorage { * Constructs a MockPhpStorage object. * * @param array $configuration + * The storage configuration. */ public function __construct(array $configuration) { $this->configuration = $configuration; diff --git a/core/modules/system/src/SystemConfigSubscriber.php b/core/modules/system/src/SystemConfigSubscriber.php index 0ab0d15fc610..76830b70a6e2 100644 --- a/core/modules/system/src/SystemConfigSubscriber.php +++ b/core/modules/system/src/SystemConfigSubscriber.php @@ -36,6 +36,7 @@ public function __construct(RouteBuilderInterface $router_builder) { * Rebuilds the router when the default or admin theme is changed. * * @param \Drupal\Core\Config\ConfigCrudEvent $event + * The configuration event. */ public function onConfigSave(ConfigCrudEvent $event) { $saved_config = $event->getConfig(); diff --git a/core/modules/system/src/Tests/Routing/MockAliasManager.php b/core/modules/system/src/Tests/Routing/MockAliasManager.php index b52b0b44c768..5299281d44f9 100644 --- a/core/modules/system/src/Tests/Routing/MockAliasManager.php +++ b/core/modules/system/src/Tests/Routing/MockAliasManager.php @@ -71,10 +71,6 @@ public function getPathByAlias($alias, $langcode = NULL) { /** * {@inheritdoc} - * @param $path - * @param null $langcode - * - * @return */ public function getAliasByPath($path, $langcode = NULL) { if ($path[0] !== '/') { diff --git a/core/modules/system/tests/modules/early_rendering_controller_test/src/EarlyRenderingTestController.php b/core/modules/system/tests/modules/early_rendering_controller_test/src/EarlyRenderingTestController.php index a6aeb389e679..00f3ef9848ec 100644 --- a/core/modules/system/tests/modules/early_rendering_controller_test/src/EarlyRenderingTestController.php +++ b/core/modules/system/tests/modules/early_rendering_controller_test/src/EarlyRenderingTestController.php @@ -32,6 +32,7 @@ class EarlyRenderingTestController extends ControllerBase { * Constructs an EarlyRenderingTestController. * * @param \Drupal\Core\Render\RendererInterface $renderer + * The renderer. */ public function __construct(RendererInterface $renderer) { $this->renderer = $renderer; 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 470683ce9b75..22cbb7cf456f 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 @@ -121,6 +121,7 @@ public function buildAjaxSnackConfigureForm(array $form, FormStateInterface $for * Loading stub for machine name. * * @param $machine_name + * The machine name. * * @return bool */ diff --git a/core/modules/system/tests/modules/theme_test/src/EventSubscriber/ThemeTestSubscriber.php b/core/modules/system/tests/modules/theme_test/src/EventSubscriber/ThemeTestSubscriber.php index 2cc0d369761a..337ab4c3b151 100644 --- a/core/modules/system/tests/modules/theme_test/src/EventSubscriber/ThemeTestSubscriber.php +++ b/core/modules/system/tests/modules/theme_test/src/EventSubscriber/ThemeTestSubscriber.php @@ -40,6 +40,7 @@ class ThemeTestSubscriber implements EventSubscriberInterface { * Constructs a new ThemeTestSubscriber. * * @param \Drupal\Core\Routing\RouteMatchInterface $current_route_match + * The route match handler. * @param \Drupal\Core\Render\RendererInterface $renderer * The renderer. */ diff --git a/core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php b/core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php index dc375371a8e8..fefd3a462b5e 100644 --- a/core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php +++ b/core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php @@ -149,6 +149,7 @@ protected function assertCacheContexts(array $expected_contexts, $message = NULL * Asserts the max age header. * * @param int $max_age + * The maximum age of the cache. */ protected function assertCacheMaxAge($max_age) { $this->assertSession()->responseHeaderContains('Cache-Control', 'max-age:' . $max_age); diff --git a/core/modules/system/tests/src/Kernel/Common/UrlTest.php b/core/modules/system/tests/src/Kernel/Common/UrlTest.php index 447d056e3a01..76c5ffc45cd3 100644 --- a/core/modules/system/tests/src/Kernel/Common/UrlTest.php +++ b/core/modules/system/tests/src/Kernel/Common/UrlTest.php @@ -166,6 +166,7 @@ public function testLinkRenderArrayText() { * Checks for class existence in link. * * @param $attribute + * Attribute to be checked. * @param $link * URL to search. * @param $class diff --git a/core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php b/core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php index 8ba2ac6072b5..ff33361d4f45 100644 --- a/core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php +++ b/core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php @@ -59,6 +59,7 @@ public function testModuleList() { * @param array $expected_values * The expected values, sorted by weight and module name. * @param $condition + * The condition being tested, such as 'After adding a module'. */ protected function assertModuleList(array $expected_values, $condition) { $expected_values = array_values(array_unique($expected_values)); diff --git a/core/modules/user/src/UserStorageInterface.php b/core/modules/user/src/UserStorageInterface.php index 4cfd26b1a815..07121687af8f 100644 --- a/core/modules/user/src/UserStorageInterface.php +++ b/core/modules/user/src/UserStorageInterface.php @@ -14,6 +14,7 @@ interface UserStorageInterface extends ContentEntityStorageInterface { * Update the last login timestamp of the user. * * @param \Drupal\user\UserInterface $account + * The user account. */ public function updateLastLoginTimestamp(UserInterface $account); diff --git a/core/modules/user/tests/src/Functional/UserPasswordResetTest.php b/core/modules/user/tests/src/Functional/UserPasswordResetTest.php index 31c0db9ed3d2..775f2806c1d3 100644 --- a/core/modules/user/tests/src/Functional/UserPasswordResetTest.php +++ b/core/modules/user/tests/src/Functional/UserPasswordResetTest.php @@ -498,6 +498,7 @@ public function assertValidPasswordReset($name) { * Helper function to make assertions about an invalid password reset. * * @param string $name + * The user name. */ public function assertNoValidPasswordReset($name) { // This message is the same as the valid reset for privacy reasons. diff --git a/core/modules/views/src/Analyzer.php b/core/modules/views/src/Analyzer.php index 360a08f1bbdc..42ae3ccb6300 100644 --- a/core/modules/views/src/Analyzer.php +++ b/core/modules/views/src/Analyzer.php @@ -107,6 +107,7 @@ public function formatMessages(array $messages) { * for items that are definitely broken are much more useful. * * @param string $message + * The message. * @param string $type * The type of message. This should be "ok", "warning" or "error". Other * values can be used but how they are treated by the output routine diff --git a/core/modules/views/src/Plugin/views/argument_validator/Entity.php b/core/modules/views/src/Plugin/views/argument_validator/Entity.php index d41de8482786..ba0bb219623d 100644 --- a/core/modules/views/src/Plugin/views/argument_validator/Entity.php +++ b/core/modules/views/src/Plugin/views/argument_validator/Entity.php @@ -209,6 +209,7 @@ public function validateArgument($argument) { * Validates an individual entity against class access settings. * * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity. * * @return bool * True if validated. diff --git a/core/modules/views/src/Plugin/views/display/DisplayRouterInterface.php b/core/modules/views/src/Plugin/views/display/DisplayRouterInterface.php index e78198d84aaf..189d2424cb85 100644 --- a/core/modules/views/src/Plugin/views/display/DisplayRouterInterface.php +++ b/core/modules/views/src/Plugin/views/display/DisplayRouterInterface.php @@ -27,6 +27,7 @@ public function collectRoutes(RouteCollection $collection); * the method can specify to break the search. * * @param \Symfony\Component\Routing\RouteCollection $collection + * The route collection. * * @return array * Returns a list of "$view_id.$display_id" elements which got overridden. diff --git a/core/modules/views/src/Plugin/views/filter/Combine.php b/core/modules/views/src/Plugin/views/filter/Combine.php index 400be23aba1b..36dab819e57f 100644 --- a/core/modules/views/src/Plugin/views/filter/Combine.php +++ b/core/modules/views/src/Plugin/views/filter/Combine.php @@ -150,6 +150,7 @@ protected function opContains($expression) { * expressions. * * @param string $expression + * The expression to add to the query. */ protected function opContainsWord($expression) { $placeholder = $this->placeholder(); diff --git a/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php b/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php index 4207ef9ea68a..3e5370beebde 100644 --- a/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php +++ b/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php @@ -748,8 +748,9 @@ protected function buildGroupValidate($form, FormStateInterface $form_state) { * @param string $identifier * The identifier to check. * @param \Drupal\Core\Form\FormStateInterface $form_state + * (optional) The current state of the form. * @param array $form_group - * The form element to set any errors on. + * (optional) The form element to set any errors on. * * @return string */ diff --git a/core/modules/views/src/Tests/TestHelperPlugin.php b/core/modules/views/src/Tests/TestHelperPlugin.php index 86560630fcce..51d20bd68c50 100644 --- a/core/modules/views/src/Tests/TestHelperPlugin.php +++ b/core/modules/views/src/Tests/TestHelperPlugin.php @@ -31,6 +31,7 @@ public function testSetOptionDefaults(&$storage, $options, $level = 0) { * Allows to set the defined options. * * @param array $options + * The options to set. * * @return $this */ 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 ed96decd57de..025a7748f35d 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 @@ -30,6 +30,7 @@ public function getJoinValue() { * Sets the joinValue property. * * @param int $join_value + * The value of the join. */ public function setJoinValue($join_value) { $this->joinValue = $join_value; diff --git a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/query/QueryTest.php b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/query/QueryTest.php index 2d475c97b127..cf1e5dc18d66 100644 --- a/core/modules/views/tests/modules/views_test_data/src/Plugin/views/query/QueryTest.php +++ b/core/modules/views/tests/modules/views_test_data/src/Plugin/views/query/QueryTest.php @@ -82,6 +82,7 @@ public function ensureTable($table, $relationship = NULL, JoinPluginBase $join = * Implements Drupal\views\Plugin\views\query\QueryPluginBase::build(). * * @param \Drupal\views\ViewExecutable $view + * The view executable. */ public function build(ViewExecutable $view) { $this->view = $view; diff --git a/core/modules/views/tests/src/Kernel/Handler/FieldRenderedEntityTest.php b/core/modules/views/tests/src/Kernel/Handler/FieldRenderedEntityTest.php index 46897992b1f4..241c65cec516 100644 --- a/core/modules/views/tests/src/Kernel/Handler/FieldRenderedEntityTest.php +++ b/core/modules/views/tests/src/Kernel/Handler/FieldRenderedEntityTest.php @@ -167,6 +167,7 @@ protected function assertCacheabilityMetadata($build) { * Ensures that the config dependencies are calculated the right way. * * @param \Drupal\views\Entity\View $storage + * The view storage. */ protected function assertConfigDependencies(View $storage) { $storage->calculateDependencies(); diff --git a/core/modules/views/tests/src/Kernel/ViewExecutableTest.php b/core/modules/views/tests/src/Kernel/ViewExecutableTest.php index 3b1eac8136ee..92e4b51d2590 100644 --- a/core/modules/views/tests/src/Kernel/ViewExecutableTest.php +++ b/core/modules/views/tests/src/Kernel/ViewExecutableTest.php @@ -361,6 +361,7 @@ public function testDestroy() { * Asserts that expected view properties have been unset by destroy(). * * @param \Drupal\views\ViewExecutable $view + * The view executable. */ protected function assertViewDestroy(ViewExecutable $view) { $reflection = new \ReflectionClass($view); diff --git a/core/modules/views_ui/src/ViewEditForm.php b/core/modules/views_ui/src/ViewEditForm.php index c5cd2381dc3c..c22ca7d82c6d 100644 --- a/core/modules/views_ui/src/ViewEditForm.php +++ b/core/modules/views_ui/src/ViewEditForm.php @@ -394,6 +394,7 @@ public function getDisplayTab($view) { * @param \Drupal\views_ui\ViewUI $view * The ViewUI entity. * @param array $display + * The display. * * @return array * A renderable page build array. diff --git a/core/modules/views_ui/tests/src/Functional/ArgumentValidatorTest.php b/core/modules/views_ui/tests/src/Functional/ArgumentValidatorTest.php index af0e5bf6bb50..f2f7a1e454f2 100644 --- a/core/modules/views_ui/tests/src/Functional/ArgumentValidatorTest.php +++ b/core/modules/views_ui/tests/src/Functional/ArgumentValidatorTest.php @@ -49,6 +49,7 @@ public function testSpecifyValidation() { * both with and without specify_validation turned on. * * @param bool $specify_validation + * The form validation. */ protected function saveArgumentHandlerWithValidationOptions($specify_validation) { $options = [ diff --git a/core/modules/views_ui/tests/src/FunctionalJavascript/ViewsListingTest.php b/core/modules/views_ui/tests/src/FunctionalJavascript/ViewsListingTest.php index 1a4cde7ed6e6..641d2fc4abd7 100644 --- a/core/modules/views_ui/tests/src/FunctionalJavascript/ViewsListingTest.php +++ b/core/modules/views_ui/tests/src/FunctionalJavascript/ViewsListingTest.php @@ -133,6 +133,7 @@ public function testFilterViewsListing() { * Removes any non-visible elements from the passed array. * * @param array $elements + * The elements. * * @return array */ diff --git a/core/modules/workflows/src/State.php b/core/modules/workflows/src/State.php index 57f830e92250..e4e65579bf23 100644 --- a/core/modules/workflows/src/State.php +++ b/core/modules/workflows/src/State.php @@ -103,6 +103,7 @@ public function getTransitions() { * Helper method to convert a State value object to a label. * * @param \Drupal\workflows\StateInterface $state + * The state. * * @return string * The label of the state. diff --git a/core/phpcs.xml.dist b/core/phpcs.xml.dist index 5db0cfbabd86..de9eefb69260 100644 --- a/core/phpcs.xml.dist +++ b/core/phpcs.xml.dist @@ -68,7 +68,6 @@ <rule ref="Drupal.Commenting.FunctionComment"> <exclude name="Drupal.Commenting.FunctionComment.InvalidNoReturn"/> <exclude name="Drupal.Commenting.FunctionComment.Missing"/> - <exclude name="Drupal.Commenting.FunctionComment.MissingParamComment"/> <exclude name="Drupal.Commenting.FunctionComment.MissingParamType"/> <exclude name="Drupal.Commenting.FunctionComment.MissingReturnComment"/> <exclude name="Drupal.Commenting.FunctionComment.MissingReturnType"/> diff --git a/core/tests/Drupal/BuildTests/Composer/Template/ComposerProjectTemplatesTest.php b/core/tests/Drupal/BuildTests/Composer/Template/ComposerProjectTemplatesTest.php index 53a5c2308c3c..04c5ff9bc007 100644 --- a/core/tests/Drupal/BuildTests/Composer/Template/ComposerProjectTemplatesTest.php +++ b/core/tests/Drupal/BuildTests/Composer/Template/ComposerProjectTemplatesTest.php @@ -256,7 +256,9 @@ public function testTemplateCreateProject($project, $package_dir, $docroot_dir) * Assert that the VERSION constant in Drupal.php is the expected value. * * @param string $expectedVersion + * The expected version. * @param string $dir + * The path to the site root. */ protected function assertDrupalVersion($expectedVersion, $dir) { $drupal_php_path = $dir . '/core/lib/Drupal.php'; diff --git a/core/tests/Drupal/KernelTests/Core/Command/DbDumpTest.php b/core/tests/Drupal/KernelTests/Core/Command/DbDumpTest.php index b66e3452931d..3b19ba554259 100644 --- a/core/tests/Drupal/KernelTests/Core/Command/DbDumpTest.php +++ b/core/tests/Drupal/KernelTests/Core/Command/DbDumpTest.php @@ -220,6 +220,7 @@ public function testScriptLoad() { * Helper function to get a simplified schema for a given table. * * @param string $table + * The table name. * * @return array * Array keyed by field name, with the values being the field type. diff --git a/core/tests/Drupal/KernelTests/Core/Entity/EntityQueryAggregateTest.php b/core/tests/Drupal/KernelTests/Core/Entity/EntityQueryAggregateTest.php index 796f6ca1391e..9a50a78fe6aa 100644 --- a/core/tests/Drupal/KernelTests/Core/Entity/EntityQueryAggregateTest.php +++ b/core/tests/Drupal/KernelTests/Core/Entity/EntityQueryAggregateTest.php @@ -624,6 +624,8 @@ public function testRepeatedExecution() { * @param array $expected * An array of the expected results. * @param bool $sorted + * (optiOnal) Whether the array keys of the expected are sorted, defaults to + * FALSE. */ protected function assertResults($expected, $sorted = FALSE) { $found = TRUE; diff --git a/core/tests/Drupal/KernelTests/Core/Routing/ExceptionHandlingTest.php b/core/tests/Drupal/KernelTests/Core/Routing/ExceptionHandlingTest.php index d8b1c4163527..a0bd58876670 100644 --- a/core/tests/Drupal/KernelTests/Core/Routing/ExceptionHandlingTest.php +++ b/core/tests/Drupal/KernelTests/Core/Routing/ExceptionHandlingTest.php @@ -128,6 +128,7 @@ public function testExceptionResponseGeneratedForOriginalRequest() { * Sets the given path to use as the 404 page and triggers a 404. * * @param string $path + * The path to test. * * @return \Drupal\Core\Render\HtmlResponse * diff --git a/core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php b/core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php index 5918bafece67..a2c80f893497 100644 --- a/core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php +++ b/core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php @@ -231,6 +231,7 @@ public function assertDateTimestamp($date, $input, $initial, $transform) { * @param string $timezone * Timezone argument for DateTimePlus. * @param string $format + * PHP date() type format for parsing the input. * @param string $format_date * Format argument for DateTimePlus::format(). * @param string $expected diff --git a/core/tests/Drupal/Tests/Component/Plugin/StubPluginManagerBaseWithMapper.php b/core/tests/Drupal/Tests/Component/Plugin/StubPluginManagerBaseWithMapper.php index d3f3f94b0781..025c684ae745 100644 --- a/core/tests/Drupal/Tests/Component/Plugin/StubPluginManagerBaseWithMapper.php +++ b/core/tests/Drupal/Tests/Component/Plugin/StubPluginManagerBaseWithMapper.php @@ -14,6 +14,7 @@ final class StubPluginManagerBaseWithMapper extends PluginManagerBase { * Constructs a new instance. * * @param \Drupal\Component\Plugin\Mapper\MapperInterface $mapper + * The plugin mapper interface. */ public function __construct(MapperInterface $mapper) { $this->mapper = $mapper; diff --git a/core/tests/Drupal/Tests/Component/Utility/ReflectionTest.php b/core/tests/Drupal/Tests/Component/Utility/ReflectionTest.php index 7deb10328ed3..0a52a305f8e1 100644 --- a/core/tests/Drupal/Tests/Component/Utility/ReflectionTest.php +++ b/core/tests/Drupal/Tests/Component/Utility/ReflectionTest.php @@ -13,7 +13,9 @@ class ReflectionTest extends TestCase { /** * @param string|null $expected + * The expected value of the parameter. * @param \ReflectionParameter $parameter + * The reflection parameter. * * @covers ::getParameterClassName * @dataProvider providerGetParameterClassName diff --git a/core/tests/Drupal/Tests/Composer/Plugin/Scaffold/ScaffoldTestResult.php b/core/tests/Drupal/Tests/Composer/Plugin/Scaffold/ScaffoldTestResult.php index c68322a2d73d..a82bcf4fbe36 100644 --- a/core/tests/Drupal/Tests/Composer/Plugin/Scaffold/ScaffoldTestResult.php +++ b/core/tests/Drupal/Tests/Composer/Plugin/Scaffold/ScaffoldTestResult.php @@ -14,7 +14,9 @@ class ScaffoldTestResult { * Holds the location of the scaffold fixture and the stdout from the test. * * @param string $docroot + * The location of the scaffold fixture. * @param string $scaffoldOutput + * The stdout from the test. */ public function __construct($docroot, $scaffoldOutput) { $this->docroot = $docroot; diff --git a/core/tests/Drupal/Tests/Core/Cache/Context/IsFrontPathCacheContextTest.php b/core/tests/Drupal/Tests/Core/Cache/Context/IsFrontPathCacheContextTest.php index 5ccb18566f3b..84fe9b1b33d5 100644 --- a/core/tests/Drupal/Tests/Core/Cache/Context/IsFrontPathCacheContextTest.php +++ b/core/tests/Drupal/Tests/Core/Cache/Context/IsFrontPathCacheContextTest.php @@ -32,6 +32,7 @@ public function testGetContextNotFront() { * Creates a PathMatcherInterface prophecy. * * @param bool $is_front + * Whether the page is the front page. * * @return \Prophecy\Prophecy\ObjectProphecy */ diff --git a/core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityStorageTest.php b/core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityStorageTest.php index 8f6c3aa359ea..8f237c60e785 100644 --- a/core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityStorageTest.php +++ b/core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityStorageTest.php @@ -247,6 +247,7 @@ public function testCreateWithExplicitLanguage() { * @covers ::doSave * * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity to test. * * @return \Drupal\Core\Entity\EntityInterface * @@ -299,6 +300,7 @@ public function testSaveInsert(EntityInterface $entity) { * @covers ::doSave * * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity to test. * * @return \Drupal\Core\Entity\EntityInterface * diff --git a/core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php b/core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php index bfc7dee4ab2e..fa9a371d001b 100644 --- a/core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php +++ b/core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php @@ -116,6 +116,7 @@ public function providerTestProcess() { * bag so the setParameter() call effects the parent container as well. * * @param $service + * The service definition. * * @return \Symfony\Component\DependencyInjection\ContainerBuilder */ @@ -135,6 +136,7 @@ protected function getSqliteContainer($service) { * bag so the setParameter() call effects the parent container as well. * * @param $service + * The service definition. * * @return \Symfony\Component\DependencyInjection\ContainerBuilder */ @@ -152,6 +154,7 @@ protected function getMysqlContainer($service) { * bag so the setParameter() call effects the parent container as well. * * @param $service + * The service definition. * * @return \Symfony\Component\DependencyInjection\ContainerBuilder */ diff --git a/core/tests/Drupal/Tests/Core/Entity/EntityTypeTest.php b/core/tests/Drupal/Tests/Core/Entity/EntityTypeTest.php index e85c4391de3b..a05fe7cac13a 100644 --- a/core/tests/Drupal/Tests/Core/Entity/EntityTypeTest.php +++ b/core/tests/Drupal/Tests/Core/Entity/EntityTypeTest.php @@ -483,6 +483,7 @@ public function testConstraintMethods() { * Asserts there on no public properties on the object instance. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type + * The entity type. */ protected function assertNoPublicProperties(EntityTypeInterface $entity_type) { $reflection = new \ReflectionObject($entity_type); diff --git a/core/tests/Drupal/Tests/Core/Entity/KeyValueStore/KeyValueEntityStorageTest.php b/core/tests/Drupal/Tests/Core/Entity/KeyValueStore/KeyValueEntityStorageTest.php index 3131893fcc19..62c9d27935a5 100644 --- a/core/tests/Drupal/Tests/Core/Entity/KeyValueStore/KeyValueEntityStorageTest.php +++ b/core/tests/Drupal/Tests/Core/Entity/KeyValueStore/KeyValueEntityStorageTest.php @@ -222,6 +222,7 @@ public function testCreate() { * @covers ::doSave * * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity. * * @return \Drupal\Core\Entity\EntityInterface * @@ -265,6 +266,7 @@ public function testSaveInsert(EntityInterface $entity) { * @covers ::doSave * * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity. * * @return \Drupal\Core\Entity\EntityInterface * diff --git a/core/tests/Drupal/Tests/Core/Entity/Routing/DefaultHtmlRouteProviderTest.php b/core/tests/Drupal/Tests/Core/Entity/Routing/DefaultHtmlRouteProviderTest.php index e15d795bc396..3ec83076c03e 100644 --- a/core/tests/Drupal/Tests/Core/Entity/Routing/DefaultHtmlRouteProviderTest.php +++ b/core/tests/Drupal/Tests/Core/Entity/Routing/DefaultHtmlRouteProviderTest.php @@ -335,6 +335,8 @@ public function testGetEntityTypeIdKeyTypeNotFieldable() { /** * @param \Prophecy\Prophecy\ObjectProphecy $base_entity_type + * (optional) The prophesize base entity type. + * * @return \Prophecy\Prophecy\ObjectProphecy */ protected function getEntityType(ObjectProphecy $base_entity_type = NULL) { diff --git a/core/tests/Drupal/Tests/Core/EventSubscriber/RssResponseRelativeUrlFilterTest.php b/core/tests/Drupal/Tests/Core/EventSubscriber/RssResponseRelativeUrlFilterTest.php index 89b609609732..92d85f05310b 100644 --- a/core/tests/Drupal/Tests/Core/EventSubscriber/RssResponseRelativeUrlFilterTest.php +++ b/core/tests/Drupal/Tests/Core/EventSubscriber/RssResponseRelativeUrlFilterTest.php @@ -108,7 +108,9 @@ public function providerTestOnResponse() { * @dataProvider providerTestOnResponse * * @param string $content + * The content for the request. * @param string $expected_content + * The expected content from the response. */ public function testOnResponse($content, $expected_content) { $event = new ResponseEvent( diff --git a/core/tests/Drupal/Tests/Core/Extension/ExtensionDiscoveryTest.php b/core/tests/Drupal/Tests/Core/Extension/ExtensionDiscoveryTest.php index f40c2ac48d08..7d6eaf054107 100644 --- a/core/tests/Drupal/Tests/Core/Extension/ExtensionDiscoveryTest.php +++ b/core/tests/Drupal/Tests/Core/Extension/ExtensionDiscoveryTest.php @@ -102,6 +102,7 @@ public function testExtensionDiscoveryCache() { * Adds example files to the filesystem structure. * * @param array $filesystem_structure + * An associative array where each key represents a directory. * * @return string[][] * Format: $[$type][$name] = $yml_file @@ -174,9 +175,11 @@ protected function populateFilesystemStructure(array &$filesystem_structure) { /** * @param array $filesystem_structure + * An associative array where each key represents a directory. * @param string[] $pieces * Fragments of the file path. * @param string $content + * The contents of the file. */ protected function addFileToFilesystemStructure(array &$filesystem_structure, array $pieces, $content) { $piece = array_shift($pieces); diff --git a/core/tests/Drupal/Tests/Core/Extension/ExtensionListTest.php b/core/tests/Drupal/Tests/Core/Extension/ExtensionListTest.php index 929ad62b1df7..a1ebab060ce1 100644 --- a/core/tests/Drupal/Tests/Core/Extension/ExtensionListTest.php +++ b/core/tests/Drupal/Tests/Core/Extension/ExtensionListTest.php @@ -333,6 +333,7 @@ class TestExtension extends ExtensionList { /** * @param \Drupal\Core\Extension\ExtensionDiscovery $extension_discovery + * The extension discovery class. */ public function setExtensionDiscovery(ExtensionDiscovery $extension_discovery) { $this->extensionDiscovery = $extension_discovery; diff --git a/core/tests/Drupal/Tests/Core/File/FileSystemTest.php b/core/tests/Drupal/Tests/Core/File/FileSystemTest.php index 1b5a49543ab3..465c60adb4f7 100644 --- a/core/tests/Drupal/Tests/Core/File/FileSystemTest.php +++ b/core/tests/Drupal/Tests/Core/File/FileSystemTest.php @@ -133,8 +133,11 @@ public function providerTestBasename() { * Asserts that the file permissions of a given URI matches. * * @param int $expected_mode + * The expected file mode. * @param string $uri + * The URI to test. * @param string $message + * An optional error message. */ protected function assertFilePermissions($expected_mode, $uri, $message = '') { // Mask out all but the last three octets. diff --git a/core/tests/Drupal/Tests/Core/Form/FormStateDecoratorBaseTest.php b/core/tests/Drupal/Tests/Core/Form/FormStateDecoratorBaseTest.php index 63dff16a8d42..f8d2db7677f1 100644 --- a/core/tests/Drupal/Tests/Core/Form/FormStateDecoratorBaseTest.php +++ b/core/tests/Drupal/Tests/Core/Form/FormStateDecoratorBaseTest.php @@ -71,8 +71,6 @@ public function testSetFormState() { * @covers ::setAlwaysProcess * * @dataProvider providerSingleBooleanArgument - * - * @param bool $always_process */ public function testSetAlwaysProcess($always_process) { $this->decoratedFormState->setAlwaysProcess($always_process) @@ -85,8 +83,6 @@ public function testSetAlwaysProcess($always_process) { * @covers ::getAlwaysProcess * * @dataProvider providerSingleBooleanArgument - * - * @param bool $always_process */ public function testGetAlwaysProcess($always_process) { $this->decoratedFormState->getAlwaysProcess() @@ -129,8 +125,6 @@ public function testGetButtons() { * @covers ::setCached * * @dataProvider providerSingleBooleanArgument - * - * @param bool $cache */ public function testSetCached($cache) { $this->decoratedFormState->setCached($cache) @@ -143,8 +137,6 @@ public function testSetCached($cache) { * @covers ::isCached * * @dataProvider providerSingleBooleanArgument - * - * @param bool $cache */ public function testIsCached($cache) { $this->decoratedFormState->isCached() @@ -157,8 +149,6 @@ public function testIsCached($cache) { * @covers ::setCached * * @dataProvider providerSingleBooleanArgument - * - * @param bool $cache */ public function testSetCachedWithLogicException($cache) { $this->decoratedFormState->setCached($cache) @@ -193,6 +183,8 @@ public function testSetExecuted() { * @dataProvider providerSingleBooleanArgument * * @param bool $executed + * Any valid value for \Drupal\Core\Form\FormStateInterface::isExecuted()'s + * return value. */ public function testIsExecuted($executed) { $this->decoratedFormState->isExecuted() @@ -240,8 +232,6 @@ public function testGetGroups() { * @covers ::setHasFileElement * * @dataProvider providerSingleBooleanArgument - * - * @param bool $has_file_element */ public function testSetHasFileElement($has_file_element) { $this->decoratedFormState->setHasFileElement($has_file_element) @@ -254,8 +244,6 @@ public function testSetHasFileElement($has_file_element) { * @covers ::hasFileElement * * @dataProvider providerSingleBooleanArgument - * - * @param bool $has_file_element */ public function testHasFileElement($has_file_element) { $this->decoratedFormState->hasFileElement() @@ -269,11 +257,6 @@ public function testHasFileElement($has_file_element) { * @covers ::setLimitValidationErrors * * @dataProvider providerLimitValidationErrors - * - * @param array[]|null $limit_validation_errors - * Any valid value for - * \Drupal\Core\Form\FormStateInterface::setLimitValidationErrors()'s - * $limit_validation_errors argument; */ public function testSetLimitValidationErrors($limit_validation_errors) { $this->decoratedFormState->setLimitValidationErrors($limit_validation_errors) @@ -286,11 +269,6 @@ public function testSetLimitValidationErrors($limit_validation_errors) { * @covers ::getLimitValidationErrors * * @dataProvider providerLimitValidationErrors - * - * @param array[]|null $limit_validation_errors - * Any valid value for - * \Drupal\Core\Form\FormStateInterface::getLimitValidationErrors()'s - * return value; */ public function testGetLimitValidationErrors($limit_validation_errors) { $this->decoratedFormState->getLimitValidationErrors() @@ -318,8 +296,6 @@ public function providerLimitValidationErrors() { * @covers ::setMethod * * @dataProvider providerSingleBooleanArgument - * - * @param bool $method */ public function testSetMethod($method) { $this->decoratedFormState->setMethod($method) @@ -332,10 +308,6 @@ public function testSetMethod($method) { * @covers ::isMethodType * * @dataProvider providerIsMethodType - * - * @param bool $expected_return_value - * @param string $method_type - * Either "GET" or "POST". */ public function testIsMethodType($expected_return_value, $method_type) { $this->decoratedFormState->isMethodType($method_type) @@ -361,8 +333,6 @@ public function providerIsMethodType() { * @covers ::setRequestMethod * * @dataProvider providerSetRequestMethod - * - * @param bool $method */ public function testSetRequestMethod($method) { $this->decoratedFormState->setRequestMethod($method) @@ -385,8 +355,6 @@ public function providerSetRequestMethod() { * @covers ::setValidationEnforced * * @dataProvider providerSingleBooleanArgument - * - * @param bool $must_validate */ public function testSetValidationEnforced($must_validate) { $this->decoratedFormState->setValidationEnforced($must_validate) @@ -399,8 +367,6 @@ public function testSetValidationEnforced($must_validate) { * @covers ::isValidationEnforced * * @dataProvider providerSingleBooleanArgument - * - * @param bool $must_validate */ public function testIsValidationEnforced($must_validate) { $this->decoratedFormState->isValidationEnforced() @@ -414,8 +380,6 @@ public function testIsValidationEnforced($must_validate) { * @covers ::disableRedirect * * @dataProvider providerSingleBooleanArgument - * - * @param bool $no_redirect */ public function testDisableRedirect($no_redirect) { $this->decoratedFormState->disableRedirect($no_redirect) @@ -428,8 +392,6 @@ public function testDisableRedirect($no_redirect) { * @covers ::isRedirectDisabled * * @dataProvider providerSingleBooleanArgument - * - * @param bool $no_redirect */ public function testIsRedirectDisabled($no_redirect) { $this->decoratedFormState->isRedirectDisabled() @@ -443,8 +405,6 @@ public function testIsRedirectDisabled($no_redirect) { * @covers ::setProcessInput * * @dataProvider providerSingleBooleanArgument - * - * @param bool $process_input */ public function testSetProcessInput($process_input) { $this->decoratedFormState->setProcessInput($process_input) @@ -457,8 +417,6 @@ public function testSetProcessInput($process_input) { * @covers ::isProcessingInput * * @dataProvider providerSingleBooleanArgument - * - * @param bool $process_input */ public function testIsProcessingInput($process_input) { $this->decoratedFormState->isProcessingInput() @@ -472,8 +430,6 @@ public function testIsProcessingInput($process_input) { * @covers ::setProgrammed * * @dataProvider providerSingleBooleanArgument - * - * @param bool $programmed */ public function testSetProgrammed($programmed) { $this->decoratedFormState->setProgrammed($programmed) @@ -486,8 +442,6 @@ public function testSetProgrammed($programmed) { * @covers ::isProgrammed * * @dataProvider providerSingleBooleanArgument - * - * @param bool $programmed */ public function testIsProgrammed($programmed) { $this->decoratedFormState->isProgrammed() @@ -501,8 +455,6 @@ public function testIsProgrammed($programmed) { * @covers ::setProgrammedBypassAccessCheck * * @dataProvider providerSingleBooleanArgument - * - * @param bool $programmed_bypass_access_check */ public function testSetProgrammedBypassAccessCheck($programmed_bypass_access_check) { $this->decoratedFormState->setProgrammedBypassAccessCheck($programmed_bypass_access_check) @@ -515,8 +467,6 @@ public function testSetProgrammedBypassAccessCheck($programmed_bypass_access_che * @covers ::isBypassingProgrammedAccessChecks * * @dataProvider providerSingleBooleanArgument - * - * @param bool $programmed_bypass_access_check */ public function testIsBypassingProgrammedAccessChecks($programmed_bypass_access_check) { $this->decoratedFormState->isBypassingProgrammedAccessChecks() @@ -646,6 +596,9 @@ public function testSetSubmitted() { * @dataProvider providerSingleBooleanArgument * * @param bool $submitted + * Any valid value for + * \Drupal\Core\Form\FormStateInterface::isSubmitted()'s return + * value. */ public function testIsSubmitted($submitted) { $this->decoratedFormState->isSubmitted() @@ -689,7 +642,13 @@ public function testGetTemporary() { * @dataProvider providerSetTemporaryValue * * @param string $key + * Any valid value for + * \Drupal\Core\Form\FormStateInterface::setTemporaryValue()'s $key + * argument. * @param mixed $value + * Any valid value for + * \Drupal\Core\Form\FormStateInterface::setTemporaryValue()'s $value + * argument. */ public function testSetTemporaryValue($key, $value) { $this->decoratedFormState->setTemporaryValue($key, $value) @@ -714,7 +673,13 @@ public function providerSetTemporaryValue() { * @dataProvider providerGetTemporaryValue * * @param string $key + * Any valid value for + * \Drupal\Core\Form\FormStateInterface::getTemporaryValue()'s $key + * argument. * @param mixed $value + * (optional) Any valid value for + * \Drupal\Core\Form\FormStateInterface::getTemporaryValue()'s return + * value. */ public function testGetTemporaryValue($key, $value = NULL) { // Use PHPUnit for mocking, because Prophecy cannot mock methods that return @@ -746,7 +711,13 @@ public function providerGetTemporaryValue() { * @dataProvider providerHasTemporaryValue * * @param bool $exists + * Any valid value for + * \Drupal\Core\Form\FormStateInterface::hasTemporaryValue()'s return + * value. * @param string $key + * Any valid value for + * \Drupal\Core\Form\FormStateInterface::hasTemporaryValue()'s $key + * argument. */ public function testHasTemporaryValue($exists, $key) { $this->decoratedFormState->hasTemporaryValue($key) @@ -835,6 +806,9 @@ public function testGetValidateHandlers() { * @dataProvider providerSingleBooleanArgument * * @param bool $complete + * Any valid value for + * \Drupal\Core\Form\FormStateInterface::setValidationComplete()'s $complete + * argument. */ public function testSetValidationComplete($complete) { $this->decoratedFormState->setValidationComplete($complete) @@ -849,6 +823,9 @@ public function testSetValidationComplete($complete) { * @dataProvider providerSingleBooleanArgument * * @param bool $complete + * Any valid value for + * \Drupal\Core\Form\FormStateInterface::isValidationComplete()'s return + * value. */ public function testIsValidationComplete($complete) { $this->decoratedFormState->isValidationComplete() @@ -864,9 +841,17 @@ public function testIsValidationComplete($complete) { * @dataProvider providerLoadInclude * * @param string|false $expected + * Any valid value for \Drupal\Core\Form\FormStateInterface::loadInclude()'s + * return value. * @param string $module + * Any valid value for \Drupal\Core\Form\FormStateInterface::loadInclude()'s + * $module argument. * @param string $type + * Any valid value for \Drupal\Core\Form\FormStateInterface::loadInclude()'s + * $type argument. * @param string|null $name + * Any valid value for \Drupal\Core\Form\FormStateInterface::loadInclude()'s + * $name argument. */ public function testLoadInclude($expected, $module, $type, $name) { $this->decoratedFormState->loadInclude($module, $type, $name) @@ -947,7 +932,11 @@ public function testGetCompleteForm() { * @dataProvider providerSet * * @param string $key + * Any valid value for \Drupal\Core\Form\FormStateInterface::set()'s $key + * argument. * @param mixed $value + * Any valid value for \Drupal\Core\Form\FormStateInterface::set()'s $value + * argument. */ public function testSet($key, $value) { $this->decoratedFormState->set($key, $value) @@ -972,7 +961,11 @@ public function providerSet() { * @dataProvider providerGet * * @param string $key + * Any valid value for \Drupal\Core\Form\FormStateInterface::get()'s $key + * argument. * @param mixed $value + * (optional) Any valid value for + * \Drupal\Core\Form\FormStateInterface::get()'s return value. */ public function testGet($key, $value = NULL) { @@ -1005,7 +998,11 @@ public function providerGet() { * @dataProvider providerHas * * @param bool $exists + * Any valid value for \Drupal\Core\Form\FormStateInterface::has()'s return + * value. * @param string $key + * Any valid value for \Drupal\Core\Form\FormStateInterface::has()'s $key + * argument. */ public function testHas($exists, $key) { $this->decoratedFormState->has($key) @@ -1285,6 +1282,8 @@ public function testSetRedirectUrl() { * @dataProvider providerGetRedirect * * @param bool $expected + * Any valid value for \Drupal\Core\Form\FormStateInterface::getRedirect()'s + * return value. */ public function testGetRedirect($expected) { $this->decoratedFormState->getRedirect() @@ -1380,6 +1379,8 @@ public function testGetErrors() { * @dataProvider providerSingleBooleanArgument * * @param bool $rebuild + * Any valid value for \Drupal\Core\Form\FormStateInterface::setRebuild()'s + * $rebuild argument. */ public function testSetRebuild($rebuild) { $this->decoratedFormState->setRebuild($rebuild) @@ -1392,8 +1393,6 @@ public function testSetRebuild($rebuild) { * @covers ::isRebuilding * * @dataProvider providerSingleBooleanArgument - * - * @param bool $rebuild */ public function testIsRebuilding($rebuild) { $this->decoratedFormState->isRebuilding() @@ -1407,8 +1406,6 @@ public function testIsRebuilding($rebuild) { * @covers ::setInvalidToken * * @dataProvider providerSingleBooleanArgument - * - * @param bool $expected */ public function testSetInvalidToken($expected) { $this->decoratedFormState->setInvalidToken($expected) @@ -1421,8 +1418,6 @@ public function testSetInvalidToken($expected) { * @covers ::hasInvalidToken * * @dataProvider providerSingleBooleanArgument - * - * @param bool $expected */ public function testHasInvalidToken($expected) { $this->decoratedFormState->hasInvalidToken() @@ -1436,9 +1431,6 @@ public function testHasInvalidToken($expected) { * @covers ::prepareCallback * * @dataProvider providerPrepareCallback - * - * @param string|callable $unprepared_callback - * @param callable $prepared_callback */ public function testPrepareCallback($unprepared_callback, callable $prepared_callback) { $this->decoratedFormState->prepareCallback(Argument::is($unprepared_callback)) diff --git a/core/tests/Drupal/Tests/Core/Form/SubformStateTest.php b/core/tests/Drupal/Tests/Core/Form/SubformStateTest.php index 7bb7d86d808d..6d5318402d92 100644 --- a/core/tests/Drupal/Tests/Core/Form/SubformStateTest.php +++ b/core/tests/Drupal/Tests/Core/Form/SubformStateTest.php @@ -61,7 +61,9 @@ class SubformStateTest extends UnitTestCase { * @dataProvider providerGetValues * * @param string[] $parents + * The parents. * @param string $expected + * The expected state values. */ public function testGetValues(array $parents, $expected) { $parent_form_state = new FormState(); @@ -98,7 +100,9 @@ public function providerGetValues() { * @dataProvider providerGetValuesBroken * * @param string[] $parents + * The parents. * @param string $expected + * The expected state values. */ public function testGetValuesBroken(array $parents, $expected) { $this->expectException(\UnexpectedValueException::class); diff --git a/core/tests/Drupal/Tests/Core/Http/ClientFactoryTest.php b/core/tests/Drupal/Tests/Core/Http/ClientFactoryTest.php index 3203ba27632c..4e98232d9426 100644 --- a/core/tests/Drupal/Tests/Core/Http/ClientFactoryTest.php +++ b/core/tests/Drupal/Tests/Core/Http/ClientFactoryTest.php @@ -34,8 +34,11 @@ protected function setUp(): void { * @dataProvider providerTestCreateFromOptions * * @param array $settings_config + * The settings configuration. * @param array $parameter_config + * The parameter configuration. * @param array $expected_config_keys + * The expected config keys. */ public function testCreateFromOptions($settings_config, $parameter_config, $expected_config_keys) { if ($settings_config) { diff --git a/core/tests/Drupal/Tests/Core/Plugin/DefaultPluginManagerTest.php b/core/tests/Drupal/Tests/Core/Plugin/DefaultPluginManagerTest.php index 6504157720b4..33881211195f 100644 --- a/core/tests/Drupal/Tests/Core/Plugin/DefaultPluginManagerTest.php +++ b/core/tests/Drupal/Tests/Core/Plugin/DefaultPluginManagerTest.php @@ -509,6 +509,7 @@ class ObjectDefinition extends PluginDefinition { * ObjectDefinition constructor. * * @param array $definition + * An associative array defining the plugin. */ public function __construct(array $definition) { // This class does not exist but plugin definitions must provide a class. diff --git a/core/tests/Drupal/Tests/Core/Plugin/Discovery/TestDerivativeDiscoveryWithObject.php b/core/tests/Drupal/Tests/Core/Plugin/Discovery/TestDerivativeDiscoveryWithObject.php index 1bb64cc5cc24..f05142de62de 100644 --- a/core/tests/Drupal/Tests/Core/Plugin/Discovery/TestDerivativeDiscoveryWithObject.php +++ b/core/tests/Drupal/Tests/Core/Plugin/Discovery/TestDerivativeDiscoveryWithObject.php @@ -12,7 +12,9 @@ class TestDerivativeDiscoveryWithObject implements DeriverInterface { /** * {@inheritdoc} * @param string $derivative_id + * The ID for the derivative. * @param array $base_plugin_definition + * An associative array defining the base plugin. * * @return array */ @@ -24,6 +26,7 @@ public function getDerivativeDefinition($derivative_id, $base_plugin_definition) /** * {@inheritdoc} * @param array $base_plugin_definition + * An associative array defining the base plugin. * * @return array */ diff --git a/core/tests/Drupal/Tests/Core/Render/RendererPlaceholdersTest.php b/core/tests/Drupal/Tests/Core/Render/RendererPlaceholdersTest.php index d13b41614008..a6626959fa5e 100644 --- a/core/tests/Drupal/Tests/Core/Render/RendererPlaceholdersTest.php +++ b/core/tests/Drupal/Tests/Core/Render/RendererPlaceholdersTest.php @@ -548,6 +548,7 @@ protected function generatePlaceholderElement() { /** * @param false|array $cid_parts + * The cid parts. * @param string[] $bubbled_cache_contexts * Additional cache contexts that were bubbled when the placeholder was * rendered. diff --git a/core/tests/Drupal/Tests/Core/TypedData/RecursiveContextualValidatorTest.php b/core/tests/Drupal/Tests/Core/TypedData/RecursiveContextualValidatorTest.php index 7153be5a57e0..53aea79e045e 100644 --- a/core/tests/Drupal/Tests/Core/TypedData/RecursiveContextualValidatorTest.php +++ b/core/tests/Drupal/Tests/Core/TypedData/RecursiveContextualValidatorTest.php @@ -189,6 +189,7 @@ public function testPropertiesValidateWithMultipleLevels() { * @param array $tree * An array of value, constraints and properties. * @param string $name + * The name to use for the object. * * @return \Drupal\Core\TypedData\TypedDataInterface|\PHPUnit\Framework\MockObject\MockObject */ diff --git a/core/tests/Drupal/Tests/Core/UrlTest.php b/core/tests/Drupal/Tests/Core/UrlTest.php index fcdabf14c953..45fbd0f33ede 100644 --- a/core/tests/Drupal/Tests/Core/UrlTest.php +++ b/core/tests/Drupal/Tests/Core/UrlTest.php @@ -491,6 +491,7 @@ public function testMergeOptions() { * Tests the access() method for routed URLs. * * @param bool $access + * The access value. * * @covers ::access * @covers ::accessManager @@ -522,6 +523,7 @@ public function testAccessUnrouted() { * Tests the renderAccess() method. * * @param bool $access + * The access value. * * @covers ::renderAccess * @dataProvider accessProvider @@ -832,7 +834,9 @@ public function testFromRouteUriWithMissingRouteName() { * Creates a mock access manager for the access tests. * * @param bool $access + * The access value. * @param \Drupal\Core\Session\AccountInterface|null $account + * The account to test. * * @return \Drupal\Core\Access\AccessManagerInterface|\PHPUnit\Framework\MockObject\MockObject */ @@ -863,6 +867,7 @@ class TestUrl extends Url { * Sets the access manager. * * @param \Drupal\Core\Access\AccessManagerInterface $access_manager + * The access manager. */ public function setAccessManager(AccessManagerInterface $access_manager) { $this->accessManager = $access_manager; diff --git a/core/tests/Drupal/Tests/DocumentElement.php b/core/tests/Drupal/Tests/DocumentElement.php index 27c4283a24d5..d7b1617f254f 100644 --- a/core/tests/Drupal/Tests/DocumentElement.php +++ b/core/tests/Drupal/Tests/DocumentElement.php @@ -1,5 +1,9 @@ <?php +// phpcs:ignoreFile Portions of this file are a direct copy of +// \Behat\Mink\Element\DocumentElement which uses a different code style than +// Drupal. + namespace Drupal\Tests; use Behat\Mink\Driver\BrowserKitDriver; diff --git a/core/tests/Drupal/Tests/UnitTestCase.php b/core/tests/Drupal/Tests/UnitTestCase.php index b06ae8dd2b06..fed556fe3d1e 100644 --- a/core/tests/Drupal/Tests/UnitTestCase.php +++ b/core/tests/Drupal/Tests/UnitTestCase.php @@ -101,8 +101,11 @@ protected function getRandomGenerator() { * Asserts if two arrays are equal by sorting them first. * * @param array $expected + * An expected results array. * @param array $actual + * The actual array value. * @param string $message + * An optional error message. * * @deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use * ::assertEquals, ::assertEqualsCanonicalizing, or ::assertSame instead. -- GitLab