From a997dea2dd1d4f12a906d218e9d218265bd0c135 Mon Sep 17 00:00:00 2001
From: xjm <xjm@65776.no-reply.drupal.org>
Date: Mon, 19 Dec 2022 17:16:19 -0600
Subject: [PATCH] Issue #3327853 by Spokje, bbrala, longwave: Don't allow
{@inheritDoc} annotation in PHPDocBlocks
(cherry picked from commit 36a8edd987c0971972fb559fbf65e82a0839604a)
---
.../Core/Entity/EntityAutocompleteMatcher.php | 2 +-
.../src/Plugin/CKEditor5Plugin/Media.php | 2 +-
.../Plugin/CKEditor5Plugin/MediaLibrary.php | 2 +-
.../src/Plugin/views/filter/DblogTypes.php | 2 +-
.../DummyExternalReadOnlyWrapper.php | 38 +++++++++----------
.../LinkCollectionNormalizerTest.php | 4 +-
core/modules/migrate/src/Plugin/Migration.php | 2 +-
.../src/Driver/Database/pgsql/Connection.php | 2 +-
.../src/Controller/JSInteractionTestForm.php | 2 +-
.../Kernel/Controller/UserControllerTest.php | 2 +-
.../src/ViewsConfigEntityTestViewsData.php | 2 +-
.../WorkspaceRequestSubscriber.php | 2 +-
core/phpcs.xml.dist | 16 ++++++++
13 files changed, 47 insertions(+), 31 deletions(-)
diff --git a/core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php b/core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php
index ba0dbf84f663..ab18ba090d7a 100644
--- a/core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php
+++ b/core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php
@@ -29,7 +29,7 @@ public function __construct(SelectionPluginManagerInterface $selection_manager)
}
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
public function getMatches($target_type, $selection_handler, $selection_settings, $string = '') {
$matches = [];
diff --git a/core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Media.php b/core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Media.php
index 2beb219ac776..c6b9f345a98a 100644
--- a/core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Media.php
+++ b/core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Media.php
@@ -55,7 +55,7 @@ public function __construct(array $configuration, string $plugin_id, CKEditor5Pl
}
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static(
diff --git a/core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/MediaLibrary.php b/core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/MediaLibrary.php
index 47cf82319978..4196cd1b7b04 100644
--- a/core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/MediaLibrary.php
+++ b/core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/MediaLibrary.php
@@ -48,7 +48,7 @@ public function __construct(array $configuration, string $plugin_id, CKEditor5Pl
}
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static(
diff --git a/core/modules/dblog/src/Plugin/views/filter/DblogTypes.php b/core/modules/dblog/src/Plugin/views/filter/DblogTypes.php
index b6dd27f602ef..ed8f5471669c 100644
--- a/core/modules/dblog/src/Plugin/views/filter/DblogTypes.php
+++ b/core/modules/dblog/src/Plugin/views/filter/DblogTypes.php
@@ -23,7 +23,7 @@ public function getValueOptions() {
}
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
protected function valueForm(&$form, FormStateInterface $form_state) {
parent::valueForm($form, $form_state);
diff --git a/core/modules/file/tests/file_test/src/StreamWrapper/DummyExternalReadOnlyWrapper.php b/core/modules/file/tests/file_test/src/StreamWrapper/DummyExternalReadOnlyWrapper.php
index 1727b7950ab6..347de4a3bef4 100644
--- a/core/modules/file/tests/file_test/src/StreamWrapper/DummyExternalReadOnlyWrapper.php
+++ b/core/modules/file/tests/file_test/src/StreamWrapper/DummyExternalReadOnlyWrapper.php
@@ -13,28 +13,28 @@
class DummyExternalReadOnlyWrapper extends ReadOnlyStream {
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public static function getType() {
return StreamWrapperInterface::READ_VISIBLE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function getName() {
return t('Dummy external stream wrapper (readonly)');
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function getDescription() {
return t('Dummy external read-only stream wrapper for testing.');
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function getExternalUrl() {
[, $target] = explode('://', $this->uri, 2);
@@ -42,105 +42,105 @@ public function getExternalUrl() {
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function realpath() {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function dirname($uri = NULL) {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function dir_closedir() {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function dir_opendir($path, $options) {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function dir_readdir() {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function dir_rewinddir() {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function stream_cast($cast_as) {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function stream_close() {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function stream_eof() {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function stream_read($count) {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function stream_seek($offset, $whence = SEEK_SET) {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function stream_set_option($option, $arg1, $arg2) {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function stream_stat() {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function stream_tell() {
return FALSE;
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function url_stat($path, $flags) {
return FALSE;
diff --git a/core/modules/jsonapi/tests/src/Kernel/Normalizer/LinkCollectionNormalizerTest.php b/core/modules/jsonapi/tests/src/Kernel/Normalizer/LinkCollectionNormalizerTest.php
index 4282b62947f9..9a8d96d31e3c 100644
--- a/core/modules/jsonapi/tests/src/Kernel/Normalizer/LinkCollectionNormalizerTest.php
+++ b/core/modules/jsonapi/tests/src/Kernel/Normalizer/LinkCollectionNormalizerTest.php
@@ -46,7 +46,7 @@ class LinkCollectionNormalizerTest extends KernelTestBase {
protected $testUsers;
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
protected static $modules = [
'jsonapi',
@@ -56,7 +56,7 @@ class LinkCollectionNormalizerTest extends KernelTestBase {
];
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
diff --git a/core/modules/migrate/src/Plugin/Migration.php b/core/modules/migrate/src/Plugin/Migration.php
index 8e3b3eac0a0a..0b4350fcfdff 100644
--- a/core/modules/migrate/src/Plugin/Migration.php
+++ b/core/modules/migrate/src/Plugin/Migration.php
@@ -496,7 +496,7 @@ public function getIdMap() {
}
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
public function getRequirements(): array {
return $this->requirements;
diff --git a/core/modules/pgsql/src/Driver/Database/pgsql/Connection.php b/core/modules/pgsql/src/Driver/Database/pgsql/Connection.php
index 590a36551aae..d5452dab2390 100644
--- a/core/modules/pgsql/src/Driver/Database/pgsql/Connection.php
+++ b/core/modules/pgsql/src/Driver/Database/pgsql/Connection.php
@@ -364,7 +364,7 @@ public function rollbackSavepoint($savepoint_name = 'mimic_implicit_commit') {
}
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
public function hasJson(): bool {
try {
diff --git a/core/modules/system/tests/modules/js_interaction_test/src/Controller/JSInteractionTestForm.php b/core/modules/system/tests/modules/js_interaction_test/src/Controller/JSInteractionTestForm.php
index 1439ec16b4ed..026b341d42fd 100644
--- a/core/modules/system/tests/modules/js_interaction_test/src/Controller/JSInteractionTestForm.php
+++ b/core/modules/system/tests/modules/js_interaction_test/src/Controller/JSInteractionTestForm.php
@@ -12,7 +12,7 @@
class JSInteractionTestForm extends FormBase {
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function getFormId() {
return __CLASS__;
diff --git a/core/modules/user/tests/src/Kernel/Controller/UserControllerTest.php b/core/modules/user/tests/src/Kernel/Controller/UserControllerTest.php
index 942a9f5b9a8c..c2d0f21041e1 100644
--- a/core/modules/user/tests/src/Kernel/Controller/UserControllerTest.php
+++ b/core/modules/user/tests/src/Kernel/Controller/UserControllerTest.php
@@ -40,7 +40,7 @@ class UserControllerTest extends KernelTestBase {
];
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
protected function setUp(): void {
diff --git a/core/modules/views/tests/modules/views_config_entity_test/src/ViewsConfigEntityTestViewsData.php b/core/modules/views/tests/modules/views_config_entity_test/src/ViewsConfigEntityTestViewsData.php
index 97138f1c404a..4e19ebc46437 100644
--- a/core/modules/views/tests/modules/views_config_entity_test/src/ViewsConfigEntityTestViewsData.php
+++ b/core/modules/views/tests/modules/views_config_entity_test/src/ViewsConfigEntityTestViewsData.php
@@ -18,7 +18,7 @@ public function getViewsData() {
}
/**
- * @inheritDoc
+ * {@inheritdoc}
*/
public function getViewsTableForEntityType(EntityTypeInterface $entity_type) {
return 'views_config_entity_test';
diff --git a/core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php b/core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php
index 2852f3036587..7d9592fb08b6 100644
--- a/core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php
+++ b/core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php
@@ -93,7 +93,7 @@ public function onKernelRequest(RequestEvent $event) {
}
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
public static function getSubscribedEvents(): array {
// Use a priority of 190 in order to run after the generic core subscriber.
diff --git a/core/phpcs.xml.dist b/core/phpcs.xml.dist
index 9836486b3eaa..27853d5a33d3 100644
--- a/core/phpcs.xml.dist
+++ b/core/phpcs.xml.dist
@@ -251,6 +251,22 @@
<rule ref="PSR2.Namespaces.NamespaceDeclaration"/>
<rule ref="PSR2.Namespaces.UseDeclaration"/>
+ <!-- SlevomatCodingStandard sniffs -->
+ <rule ref="SlevomatCodingStandard.Commenting.ForbiddenAnnotations">
+ <properties>
+ <property name="forbiddenAnnotations" type="array">
+ <element value="@inheritDoc"/>
+ </property>
+ </properties>
+ </rule>
+ <rule ref="SlevomatCodingStandard.Commenting.ForbiddenComments">
+ <properties>
+ <property name="forbiddenCommentPatterns" type="array">
+ <element value="/@inheritDoc/"/>
+ </property>
+ </properties>
+ </rule>
+
<!-- Squiz sniffs -->
<rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
<rule ref="Squiz.Arrays.ArrayDeclaration">
--
GitLab