Skip to content

Commit 1809b7a

Browse files
fabpotfabpot
committed
minor #47390 [CS] Remove @inheritdoc PHPDoc (lyrixx)
This PR was merged into the 6.2 branch. Discussion ---------- [CS] Remove `@inheritdoc` PHPDoc | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | --- It looks like this PHP Doc is useless. IDEs are able to inherit the doc (at least VS Code and PHP Storm). And tools like PHP Stan are able to too https://phpstan.org/r/74a2c008-ff2b-42c0-8edf-8da87c1a7b5f I could have open an RFC before doing the PR, but it was easy :) So let's discuss here Commits ------- 015d5015e3 [CS] Remove `@inheritdoc` PHPDoc
2 parents 3be9604 + 7dddf80 commit 1809b7a

File tree

109 files changed

+0
-1349
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+0
-1349
lines changed

‎AbstractExtension.php

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,6 @@ abstract class AbstractExtension implements FormExtensionInterface
4343
*/
4444
private bool $typeGuesserLoaded = false;
4545

46-
/**
47-
* {@inheritdoc}
48-
*/
4946
public function getType(string $name): FormTypeInterface
5047
{
5148
if (!isset($this->types)) {
@@ -59,9 +56,6 @@ public function getType(string $name): FormTypeInterface
5956
return $this->types[$name];
6057
}
6158

62-
/**
63-
* {@inheritdoc}
64-
*/
6559
public function hasType(string $name): bool
6660
{
6761
if (!isset($this->types)) {
@@ -71,9 +65,6 @@ public function hasType(string $name): bool
7165
return isset($this->types[$name]);
7266
}
7367

74-
/**
75-
* {@inheritdoc}
76-
*/
7768
public function getTypeExtensions(string $name): array
7869
{
7970
if (!isset($this->typeExtensions)) {
@@ -84,9 +75,6 @@ public function getTypeExtensions(string $name): array
8475
?? [];
8576
}
8677

87-
/**
88-
* {@inheritdoc}
89-
*/
9078
public function hasTypeExtensions(string $name): bool
9179
{
9280
if (!isset($this->typeExtensions)) {
@@ -96,9 +84,6 @@ public function hasTypeExtensions(string $name): bool
9684
return isset($this->typeExtensions[$name]) && \count($this->typeExtensions[$name]) > 0;
9785
}
9886

99-
/**
100-
* {@inheritdoc}
101-
*/
10287
public function getTypeGuesser(): ?FormTypeGuesserInterface
10388
{
10489
if (!$this->typeGuesserLoaded) {

‎AbstractRendererEngine.php

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,6 @@ public function __construct(array $defaultThemes = [])
6161
$this->defaultThemes = $defaultThemes;
6262
}
6363

64-
/**
65-
* {@inheritdoc}
66-
*/
6764
public function setTheme(FormView $view, mixed $themes, bool $useDefaultThemes = true)
6865
{
6966
$cacheKey = $view->vars[self::CACHE_KEY_VAR];
@@ -78,9 +75,6 @@ public function setTheme(FormView $view, mixed $themes, bool $useDefaultThemes =
7875
unset($this->resources[$cacheKey], $this->resourceHierarchyLevels[$cacheKey]);
7976
}
8077

81-
/**
82-
* {@inheritdoc}
83-
*/
8478
public function getResourceForBlockName(FormView $view, string $blockName): mixed
8579
{
8680
$cacheKey = $view->vars[self::CACHE_KEY_VAR];
@@ -92,9 +86,6 @@ public function getResourceForBlockName(FormView $view, string $blockName): mixe
9286
return $this->resources[$cacheKey][$blockName];
9387
}
9488

95-
/**
96-
* {@inheritdoc}
97-
*/
9889
public function getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, int $hierarchyLevel): mixed
9990
{
10091
$cacheKey = $view->vars[self::CACHE_KEY_VAR];
@@ -107,9 +98,6 @@ public function getResourceForBlockNameHierarchy(FormView $view, array $blockNam
10798
return $this->resources[$cacheKey][$blockName];
10899
}
109100

110-
/**
111-
* {@inheritdoc}
112-
*/
113101
public function getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, int $hierarchyLevel): int|false
114102
{
115103
$cacheKey = $view->vars[self::CACHE_KEY_VAR];

‎AbstractType.php

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,45 +20,27 @@
2020
*/
2121
abstract class AbstractType implements FormTypeInterface
2222
{
23-
/**
24-
* {@inheritdoc}
25-
*/
2623
public function buildForm(FormBuilderInterface $builder, array $options)
2724
{
2825
}
2926

30-
/**
31-
* {@inheritdoc}
32-
*/
3327
public function buildView(FormView $view, FormInterface $form, array $options)
3428
{
3529
}
3630

37-
/**
38-
* {@inheritdoc}
39-
*/
4031
public function finishView(FormView $view, FormInterface $form, array $options)
4132
{
4233
}
4334

44-
/**
45-
* {@inheritdoc}
46-
*/
4735
public function configureOptions(OptionsResolver $resolver)
4836
{
4937
}
5038

51-
/**
52-
* {@inheritdoc}
53-
*/
5439
public function getBlockPrefix()
5540
{
5641
return StringUtil::fqcnToBlockPrefix(static::class) ?: '';
5742
}
5843

59-
/**
60-
* {@inheritdoc}
61-
*/
6244
public function getParent()
6345
{
6446
return FormType::class;

‎AbstractTypeExtension.php

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,18 @@
1818
*/
1919
abstract class AbstractTypeExtension implements FormTypeExtensionInterface
2020
{
21-
/**
22-
* {@inheritdoc}
23-
*/
2421
public function buildForm(FormBuilderInterface $builder, array $options)
2522
{
2623
}
2724

28-
/**
29-
* {@inheritdoc}
30-
*/
3125
public function buildView(FormView $view, FormInterface $form, array $options)
3226
{
3327
}
3428

35-
/**
36-
* {@inheritdoc}
37-
*/
3829
public function finishView(FormView $view, FormInterface $form, array $options)
3930
{
4031
}
4132

42-
/**
43-
* {@inheritdoc}
44-
*/
4533
public function configureOptions(OptionsResolver $resolver)
4634
{
4735
}

‎Button.php

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,6 @@ public function offsetUnset(mixed $offset): void
8181
throw new BadMethodCallException('Buttons cannot have children.');
8282
}
8383

84-
/**
85-
* {@inheritdoc}
86-
*/
8784
public function setParent(FormInterface $parent = null): static
8885
{
8986
if ($this->submitted) {
@@ -95,9 +92,6 @@ public function setParent(FormInterface $parent = null): static
9592
return $this;
9693
}
9794

98-
/**
99-
* {@inheritdoc}
100-
*/
10195
public function getParent(): ?FormInterface
10296
{
10397
return $this->parent;
@@ -147,17 +141,11 @@ public function remove(string $name): static
147141
throw new BadMethodCallException('Buttons cannot have children.');
148142
}
149143

150-
/**
151-
* {@inheritdoc}
152-
*/
153144
public function all(): array
154145
{
155146
return [];
156147
}
157148

158-
/**
159-
* {@inheritdoc}
160-
*/
161149
public function getErrors(bool $deep = false, bool $flatten = true): FormErrorIterator
162150
{
163151
return new FormErrorIterator($this, []);
@@ -266,9 +254,6 @@ public function isRequired(): bool
266254
return false;
267255
}
268256

269-
/**
270-
* {@inheritdoc}
271-
*/
272257
public function isDisabled(): bool
273258
{
274259
if ($this->parent?->isDisabled()) {
@@ -340,25 +325,16 @@ public function submit(array|string|null $submittedData, bool $clearMissing = tr
340325
return $this;
341326
}
342327

343-
/**
344-
* {@inheritdoc}
345-
*/
346328
public function getRoot(): FormInterface
347329
{
348330
return $this->parent ? $this->parent->getRoot() : $this;
349331
}
350332

351-
/**
352-
* {@inheritdoc}
353-
*/
354333
public function isRoot(): bool
355334
{
356335
return null === $this->parent;
357336
}
358337

359-
/**
360-
* {@inheritdoc}
361-
*/
362338
public function createView(FormView $parent = null): FormView
363339
{
364340
if (null === $parent && $this->parent) {

‎ButtonBuilder.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -173,19 +173,13 @@ public function resetModelTransformers(): static
173173
throw new BadMethodCallException('Buttons do not support data transformers.');
174174
}
175175

176-
/**
177-
* {@inheritdoc}
178-
*/
179176
public function setAttribute(string $name, mixed $value): static
180177
{
181178
$this->attributes[$name] = $value;
182179

183180
return $this;
184181
}
185182

186-
/**
187-
* {@inheritdoc}
188-
*/
189183
public function setAttributes(array $attributes): static
190184
{
191185
$this->attributes = $attributes;
@@ -415,9 +409,6 @@ public function getEventDispatcher(): EventDispatcherInterface
415409
throw new BadMethodCallException('Buttons do not support event dispatching.');
416410
}
417411

418-
/**
419-
* {@inheritdoc}
420-
*/
421412
public function getName(): string
422413
{
423414
return $this->name;

‎CallbackTransformer.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,11 @@ public function __construct(callable $transform, callable $reverseTransform)
2222
$this->reverseTransform = $reverseTransform(...);
2323
}
2424

25-
/**
26-
* {@inheritdoc}
27-
*/
2825
public function transform(mixed $data): mixed
2926
{
3027
return ($this->transform)($data);
3128
}
3229

33-
/**
34-
* {@inheritdoc}
35-
*/
3630
public function reverseTransform(mixed $data): mixed
3731
{
3832
return ($this->reverseTransform)($data);

‎ChoiceList/ArrayChoiceList.php

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -90,41 +90,26 @@ public function __construct(iterable $choices, callable $value = null)
9090
$this->structuredValues = $structuredValues;
9191
}
9292

93-
/**
94-
* {@inheritdoc}
95-
*/
9693
public function getChoices(): array
9794
{
9895
return $this->choices;
9996
}
10097

101-
/**
102-
* {@inheritdoc}
103-
*/
10498
public function getValues(): array
10599
{
106100
return array_map('strval', array_keys($this->choices));
107101
}
108102

109-
/**
110-
* {@inheritdoc}
111-
*/
112103
public function getStructuredValues(): array
113104
{
114105
return $this->structuredValues;
115106
}
116107

117-
/**
118-
* {@inheritdoc}
119-
*/
120108
public function getOriginalKeys(): array
121109
{
122110
return $this->originalKeys;
123111
}
124112

125-
/**
126-
* {@inheritdoc}
127-
*/
128113
public function getChoicesForValues(array $values): array
129114
{
130115
$choices = [];
@@ -138,9 +123,6 @@ public function getChoicesForValues(array $values): array
138123
return $choices;
139124
}
140125

141-
/**
142-
* {@inheritdoc}
143-
*/
144126
public function getValuesForChoices(array $choices): array
145127
{
146128
$values = [];

‎ChoiceList/Factory/Cache/ChoiceLoader.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,16 @@
2626
*/
2727
final class ChoiceLoader extends AbstractStaticOption implements ChoiceLoaderInterface
2828
{
29-
/**
30-
* {@inheritdoc}
31-
*/
3229
public function loadChoiceList(callable $value = null): ChoiceListInterface
3330
{
3431
return $this->getOption()->loadChoiceList($value);
3532
}
3633

37-
/**
38-
* {@inheritdoc}
39-
*/
4034
public function loadChoicesForValues(array $values, callable $value = null): array
4135
{
4236
return $this->getOption()->loadChoicesForValues($values, $value);
4337
}
4438

45-
/**
46-
* {@inheritdoc}
47-
*/
4839
public function loadValuesForChoices(array $choices, callable $value = null): array
4940
{
5041
return $this->getOption()->loadValuesForChoices($choices, $value);

‎ChoiceList/Factory/CachingFactoryDecorator.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,6 @@ public function getDecoratedFactory(): ChoiceListFactoryInterface
7777
return $this->decoratedFactory;
7878
}
7979

80-
/**
81-
* {@inheritdoc}
82-
*/
8380
public function createListFromChoices(iterable $choices, mixed $value = null, mixed $filter = null): ChoiceListInterface
8481
{
8582
if ($choices instanceof \Traversable) {
@@ -113,9 +110,6 @@ public function createListFromChoices(iterable $choices, mixed $value = null, mi
113110
return $this->lists[$hash];
114111
}
115112

116-
/**
117-
* {@inheritdoc}
118-
*/
119113
public function createListFromLoader(ChoiceLoaderInterface $loader, mixed $value = null, mixed $filter = null): ChoiceListInterface
120114
{
121115
$cache = true;
@@ -151,9 +145,6 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, mixed $value
151145
return $this->lists[$hash];
152146
}
153147

154-
/**
155-
* {@inheritdoc}
156-
*/
157148
public function createView(ChoiceListInterface $list, mixed $preferredChoices = null, mixed $label = null, mixed $index = null, mixed $groupBy = null, mixed $attr = null, mixed $labelTranslationParameters = []): ChoiceListView
158149
{
159150
$cache = true;

0 commit comments

Comments
 (0)