From 2277edbcdd34062d073b4bfa98d4daa4f39b02ad Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Fri, 25 Oct 2024 19:02:00 +0100
Subject: [PATCH] Issue #3478200 by quietone, alexpott: Fix MissingParamType in
core/lib/Drupal/Component
---
core/lib/Drupal/Component/Gettext/PoStreamInterface.php | 2 +-
core/lib/Drupal/Component/Gettext/PoStreamReader.php | 4 ++--
core/lib/Drupal/Component/Gettext/PoWriterInterface.php | 2 +-
core/lib/Drupal/Component/Graph/Graph.php | 8 ++++----
.../Drupal/Component/PhpStorage/FileReadOnlyStorage.php | 2 +-
.../PhpStorage/MTimeProtectedFastFileStorage.php | 4 ++--
core/lib/Drupal/Component/Render/HtmlEscapedText.php | 2 +-
.../Component/Transliteration/PhpTransliteration.php | 6 +++---
core/lib/Drupal/Component/Utility/Color.php | 2 +-
core/lib/Drupal/Component/Utility/Crypt.php | 2 +-
core/lib/Drupal/Component/Utility/DeprecatedArray.php | 2 +-
core/lib/Drupal/Component/Utility/Environment.php | 2 +-
core/lib/Drupal/Component/Utility/Timer.php | 2 +-
core/phpcs.xml.dist | 5 ++++-
14 files changed, 24 insertions(+), 21 deletions(-)
diff --git a/core/lib/Drupal/Component/Gettext/PoStreamInterface.php b/core/lib/Drupal/Component/Gettext/PoStreamInterface.php
index 599929912947..0e2ac8b5a7c5 100644
--- a/core/lib/Drupal/Component/Gettext/PoStreamInterface.php
+++ b/core/lib/Drupal/Component/Gettext/PoStreamInterface.php
@@ -31,7 +31,7 @@ public function getURI();
/**
* Set the URI of the PO stream that is going to be read or written.
*
- * @param $uri
+ * @param string $uri
* URI string to set for this stream.
*/
public function setURI($uri);
diff --git a/core/lib/Drupal/Component/Gettext/PoStreamReader.php b/core/lib/Drupal/Component/Gettext/PoStreamReader.php
index 0644b25e8647..46a18498aee6 100644
--- a/core/lib/Drupal/Component/Gettext/PoStreamReader.php
+++ b/core/lib/Drupal/Component/Gettext/PoStreamReader.php
@@ -541,7 +541,7 @@ public function setItemFromArray($value) {
/**
* Parses a string in quotes.
*
- * @param $string
+ * @param string $string
* A string specified with enclosing quotes.
*
* @return bool|string
@@ -572,7 +572,7 @@ public function parseQuoted($string) {
/**
* Generates a short, one-string version of the passed comment array.
*
- * @param $comment
+ * @param string[] $comment
* An array of strings containing a comment.
*
* @return string
diff --git a/core/lib/Drupal/Component/Gettext/PoWriterInterface.php b/core/lib/Drupal/Component/Gettext/PoWriterInterface.php
index f81d567adfed..fac4ee821637 100644
--- a/core/lib/Drupal/Component/Gettext/PoWriterInterface.php
+++ b/core/lib/Drupal/Component/Gettext/PoWriterInterface.php
@@ -20,7 +20,7 @@ public function writeItem(PoItem $item);
*
* @param PoReaderInterface $reader
* Reader to read PoItems from.
- * @param $count
+ * @param int $count
* Amount of items to read from $reader to write. If -1, all items are
* read from $reader.
*/
diff --git a/core/lib/Drupal/Component/Graph/Graph.php b/core/lib/Drupal/Component/Graph/Graph.php
index 6fe9cf21b004..1242decf647a 100644
--- a/core/lib/Drupal/Component/Graph/Graph.php
+++ b/core/lib/Drupal/Component/Graph/Graph.php
@@ -15,7 +15,7 @@ class Graph {
/**
* Instantiates the depth first search object.
*
- * @param $graph
+ * @param array $graph
* A three dimensional associated array, with the first keys being the names
* of the vertices, these can be strings or numbers. The second key is
* 'edges' and the third one are again vertices, each such key representing
@@ -87,13 +87,13 @@ public function searchAndSort() {
/**
* Performs a depth-first search on a graph.
*
- * @param $state
+ * @param array $state
* An associative array. The key 'last_visit_order' stores a list of the
* vertices visited. The key components stores list of vertices belonging
* to the same the component.
- * @param $start
+ * @param string|int $start
* An arbitrary vertex where we started traversing the graph.
- * @param $component
+ * @param string|int|null $component
* The component of the last vertex.
*
* @see \Drupal\Component\Graph\Graph::searchAndSort()
diff --git a/core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php b/core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php
index ca74d602fba3..7c0e45dd19d9 100644
--- a/core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php
+++ b/core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php
@@ -17,7 +17,7 @@ class FileReadOnlyStorage implements PhpStorageInterface {
/**
* Constructs this FileStorage object.
*
- * @param $configuration
+ * @param string[] $configuration
* An associative array, containing at least two keys (the rest are ignored):
* - directory: The directory where the files should be stored.
* - bin: The storage bin. Multiple storage objects can be instantiated with
diff --git a/core/lib/Drupal/Component/PhpStorage/MTimeProtectedFastFileStorage.php b/core/lib/Drupal/Component/PhpStorage/MTimeProtectedFastFileStorage.php
index 1db14568a433..c304e7736cef 100644
--- a/core/lib/Drupal/Component/PhpStorage/MTimeProtectedFastFileStorage.php
+++ b/core/lib/Drupal/Component/PhpStorage/MTimeProtectedFastFileStorage.php
@@ -217,9 +217,9 @@ protected function getUncachedMTime($directory) {
/**
* A brute force tempnam implementation supporting streams.
*
- * @param $directory
+ * @param string $directory
* The directory where the temporary filename will be created.
- * @param $prefix
+ * @param string $prefix
* The prefix of the generated temporary filename.
*
* @return string
diff --git a/core/lib/Drupal/Component/Render/HtmlEscapedText.php b/core/lib/Drupal/Component/Render/HtmlEscapedText.php
index 6ca9538089e6..be27ba85a3ed 100644
--- a/core/lib/Drupal/Component/Render/HtmlEscapedText.php
+++ b/core/lib/Drupal/Component/Render/HtmlEscapedText.php
@@ -24,7 +24,7 @@ class HtmlEscapedText implements MarkupInterface, \Countable {
/**
* Constructs an HtmlEscapedText object.
*
- * @param $string
+ * @param string $string
* The string to escape. This value will be cast to a string.
*/
public function __construct($string) {
diff --git a/core/lib/Drupal/Component/Transliteration/PhpTransliteration.php b/core/lib/Drupal/Component/Transliteration/PhpTransliteration.php
index 3bce69b4c4b8..ab111e1872e5 100644
--- a/core/lib/Drupal/Component/Transliteration/PhpTransliteration.php
+++ b/core/lib/Drupal/Component/Transliteration/PhpTransliteration.php
@@ -246,7 +246,7 @@ protected function replace($code, $langcode, $unknown_character) {
/**
* Look up the generic replacement for a UTF-8 character code.
*
- * @param $code
+ * @param int $code
* The UTF-8 character code.
* @param string $unknown_character
* (optional) The character to substitute for characters without entries in
@@ -277,7 +277,7 @@ protected function lookupReplacement($code, $unknown_character = '?') {
* transliterations in this language. The character codes can be for any valid
* Unicode character, independent of the number of bytes.
*
- * @param $langcode
+ * @param string $langcode
* Code for the language to read.
*/
protected function readLanguageOverrides($langcode) {
@@ -304,7 +304,7 @@ protected function readLanguageOverrides($langcode) {
* transliterations of these characters into US-ASCII. Note that the maximum
* Unicode character that can be encoded in this way is 4 bytes.
*
- * @param $bank
+ * @param int $bank
* First two bytes of the Unicode character, or 0 for the ASCII range.
*/
protected function readGenericData($bank) {
diff --git a/core/lib/Drupal/Component/Utility/Color.php b/core/lib/Drupal/Component/Utility/Color.php
index 49d0aa256033..fa06da8f7c84 100644
--- a/core/lib/Drupal/Component/Utility/Color.php
+++ b/core/lib/Drupal/Component/Utility/Color.php
@@ -10,7 +10,7 @@ class Color {
/**
* Validates whether a hexadecimal color value is syntactically correct.
*
- * @param $hex
+ * @param string $hex
* The hexadecimal string to validate. May contain a leading '#'. May use
* the shorthand notation (e.g., '123' for '112233').
*
diff --git a/core/lib/Drupal/Component/Utility/Crypt.php b/core/lib/Drupal/Component/Utility/Crypt.php
index f76cd8b8ca3e..42fde05cd759 100644
--- a/core/lib/Drupal/Component/Utility/Crypt.php
+++ b/core/lib/Drupal/Component/Utility/Crypt.php
@@ -54,7 +54,7 @@ public static function hashBase64($data) {
/**
* Returns a URL-safe, base64 encoded string of highly randomized bytes.
*
- * @param $count
+ * @param int $count
* The number of random bytes to fetch and base64 encode.
*
* @return string
diff --git a/core/lib/Drupal/Component/Utility/DeprecatedArray.php b/core/lib/Drupal/Component/Utility/DeprecatedArray.php
index 6f93c7c68d08..6d7ef5d484c3 100644
--- a/core/lib/Drupal/Component/Utility/DeprecatedArray.php
+++ b/core/lib/Drupal/Component/Utility/DeprecatedArray.php
@@ -19,7 +19,7 @@ class DeprecatedArray extends \ArrayObject {
*
* @param array $values
* The array values.
- * @param $message
+ * @param string $message
* The deprecation message.
*/
public function __construct(array $values, $message) {
diff --git a/core/lib/Drupal/Component/Utility/Environment.php b/core/lib/Drupal/Component/Utility/Environment.php
index 6028183c6f45..5fd7441c79c1 100644
--- a/core/lib/Drupal/Component/Utility/Environment.php
+++ b/core/lib/Drupal/Component/Utility/Environment.php
@@ -14,7 +14,7 @@ class Environment {
* The memory required for the operation, expressed as a number of bytes with
* optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8bytes,
* 9mbytes).
- * @param $memory_limit
+ * @param string|null $memory_limit
* (optional) The memory limit for the operation, expressed as a number of
* bytes with optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G,
* 6GiB, 8bytes, 9mbytes). If no value is passed, the current PHP
diff --git a/core/lib/Drupal/Component/Utility/Timer.php b/core/lib/Drupal/Component/Utility/Timer.php
index b086bfbcd34b..19c83922e4cb 100644
--- a/core/lib/Drupal/Component/Utility/Timer.php
+++ b/core/lib/Drupal/Component/Utility/Timer.php
@@ -17,7 +17,7 @@ class Timer {
* If you start and stop the same timer multiple times, the measured intervals
* will be accumulated.
*
- * @param $name
+ * @param string $name
* The name of the timer.
*/
public static function start($name) {
diff --git a/core/phpcs.xml.dist b/core/phpcs.xml.dist
index 8aa3e883aea7..733c8d5084ea 100644
--- a/core/phpcs.xml.dist
+++ b/core/phpcs.xml.dist
@@ -66,14 +66,17 @@
<rule ref="Drupal.Commenting.DocCommentLongArraySyntax"/>
<rule ref="Drupal.Commenting.DocCommentStar"/>
<rule ref="Drupal.Commenting.FileComment"/>
+
<rule ref="Drupal.Commenting.FunctionComment">
<exclude name="Drupal.Commenting.FunctionComment.InvalidNoReturn"/>
<exclude name="Drupal.Commenting.FunctionComment.Missing"/>
- <exclude name="Drupal.Commenting.FunctionComment.MissingParamType"/>
<exclude name="Drupal.Commenting.FunctionComment.MissingReturnComment"/>
<exclude name="Drupal.Commenting.FunctionComment.ParamCommentFullStop"/>
<exclude name="Drupal.Commenting.FunctionComment.TypeHintMissing"/>
</rule>
+ <rule ref="Drupal.Commenting.FunctionComment.MissingParamType">
+ <include-pattern>core/lib/Component/*</include-pattern>
+ </rule>
<rule ref="Drupal.Commenting.GenderNeutralComment"/>
<rule ref="Drupal.Commenting.HookComment"/>
<rule ref="Drupal.Commenting.InlineComment">
--
GitLab