Skip to content

Commit b1ba36e

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 b7303b6 + 8fba54b commit b1ba36e

34 files changed

+0
-475
lines changed

‎BinaryFileResponse.php

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,6 @@ public function setContentDisposition(string $disposition, string $filename = ''
177177
return $this;
178178
}
179179

180-
/**
181-
* {@inheritdoc}
182-
*/
183180
public function prepare(Request $request): static
184181
{
185182
if (!$this->headers->has('Content-Type')) {
@@ -283,9 +280,6 @@ private function hasValidIfRangeHeader(?string $header): bool
283280
return $lastModified->format('D, d M Y H:i:s').' GMT' === $header;
284281
}
285282

286-
/**
287-
* {@inheritdoc}
288-
*/
289283
public function sendContent(): static
290284
{
291285
if (!$this->isSuccessful()) {
@@ -328,8 +322,6 @@ public function sendContent(): static
328322
}
329323

330324
/**
331-
* {@inheritdoc}
332-
*
333325
* @throws \LogicException when the content is not null
334326
*/
335327
public function setContent(?string $content): static
@@ -341,9 +333,6 @@ public function setContent(?string $content): static
341333
return $this;
342334
}
343335

344-
/**
345-
* {@inheritdoc}
346-
*/
347336
public function getContent(): string|false
348337
{
349338
return false;

‎FileBag.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,12 @@ public function __construct(array $parameters = [])
3131
$this->replace($parameters);
3232
}
3333

34-
/**
35-
* {@inheritdoc}
36-
*/
3734
public function replace(array $files = [])
3835
{
3936
$this->parameters = [];
4037
$this->add($files);
4138
}
4239

43-
/**
44-
* {@inheritdoc}
45-
*/
4640
public function set(string $key, mixed $value)
4741
{
4842
if (!\is_array($value) && !$value instanceof UploadedFile) {
@@ -52,9 +46,6 @@ public function set(string $key, mixed $value)
5246
parent::set($key, $this->convertFileInformation($value));
5347
}
5448

55-
/**
56-
* {@inheritdoc}
57-
*/
5849
public function add(array $files = [])
5950
{
6051
foreach ($files as $key => $file) {

‎InputBag.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,6 @@ public function set(string $key, mixed $value)
7373
$this->parameters[$key] = $value;
7474
}
7575

76-
/**
77-
* {@inheritdoc}
78-
*/
7976
public function filter(string $key, mixed $default = null, int $filter = \FILTER_DEFAULT, mixed $options = []): mixed
8077
{
8178
$value = $this->has($key) ? $this->all()[$key] : $default;

‎RequestMatcher.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,6 @@ public function matchAttribute(string $key, string $regexp)
139139
$this->attributes[$key] = $regexp;
140140
}
141141

142-
/**
143-
* {@inheritdoc}
144-
*/
145142
public function matches(Request $request): bool
146143
{
147144
if ($this->schemes && !\in_array($request->getScheme(), $this->schemes, true)) {

‎ResponseHeaderBag.php

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,6 @@ public function allPreserveCaseWithoutCookies()
6565
return $headers;
6666
}
6767

68-
/**
69-
* {@inheritdoc}
70-
*/
7168
public function replace(array $headers = [])
7269
{
7370
$this->headerNames = [];
@@ -83,9 +80,6 @@ public function replace(array $headers = [])
8380
}
8481
}
8582

86-
/**
87-
* {@inheritdoc}
88-
*/
8983
public function all(string $key = null): array
9084
{
9185
$headers = parent::all();
@@ -103,9 +97,6 @@ public function all(string $key = null): array
10397
return $headers;
10498
}
10599

106-
/**
107-
* {@inheritdoc}
108-
*/
109100
public function set(string $key, string|array|null $values, bool $replace = true)
110101
{
111102
$uniqueKey = strtr($key, self::UPPER, self::LOWER);
@@ -134,9 +125,6 @@ public function set(string $key, string|array|null $values, bool $replace = true
134125
}
135126
}
136127

137-
/**
138-
* {@inheritdoc}
139-
*/
140128
public function remove(string $key)
141129
{
142130
$uniqueKey = strtr($key, self::UPPER, self::LOWER);
@@ -159,17 +147,11 @@ public function remove(string $key)
159147
}
160148
}
161149

162-
/**
163-
* {@inheritdoc}
164-
*/
165150
public function hasCacheControlDirective(string $key): bool
166151
{
167152
return \array_key_exists($key, $this->computedCacheControl);
168153
}
169154

170-
/**
171-
* {@inheritdoc}
172-
*/
173155
public function getCacheControlDirective(string $key): bool|string|null
174156
{
175157
return $this->computedCacheControl[$key] ?? null;

‎Session/Attribute/AttributeBag.php

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ public function __construct(string $storageKey = '_sf2_attributes')
3131
$this->storageKey = $storageKey;
3232
}
3333

34-
/**
35-
* {@inheritdoc}
36-
*/
3734
public function getName(): string
3835
{
3936
return $this->name;
@@ -44,57 +41,36 @@ public function setName(string $name)
4441
$this->name = $name;
4542
}
4643

47-
/**
48-
* {@inheritdoc}
49-
*/
5044
public function initialize(array &$attributes)
5145
{
5246
$this->attributes = &$attributes;
5347
}
5448

55-
/**
56-
* {@inheritdoc}
57-
*/
5849
public function getStorageKey(): string
5950
{
6051
return $this->storageKey;
6152
}
6253

63-
/**
64-
* {@inheritdoc}
65-
*/
6654
public function has(string $name): bool
6755
{
6856
return \array_key_exists($name, $this->attributes);
6957
}
7058

71-
/**
72-
* {@inheritdoc}
73-
*/
7459
public function get(string $name, mixed $default = null): mixed
7560
{
7661
return \array_key_exists($name, $this->attributes) ? $this->attributes[$name] : $default;
7762
}
7863

79-
/**
80-
* {@inheritdoc}
81-
*/
8264
public function set(string $name, mixed $value)
8365
{
8466
$this->attributes[$name] = $value;
8567
}
8668

87-
/**
88-
* {@inheritdoc}
89-
*/
9069
public function all(): array
9170
{
9271
return $this->attributes;
9372
}
9473

95-
/**
96-
* {@inheritdoc}
97-
*/
9874
public function replace(array $attributes)
9975
{
10076
$this->attributes = [];
@@ -103,9 +79,6 @@ public function replace(array $attributes)
10379
}
10480
}
10581

106-
/**
107-
* {@inheritdoc}
108-
*/
10982
public function remove(string $name): mixed
11083
{
11184
$retval = null;
@@ -117,9 +90,6 @@ public function remove(string $name): mixed
11790
return $retval;
11891
}
11992

120-
/**
121-
* {@inheritdoc}
122-
*/
12393
public function clear(): mixed
12494
{
12595
$return = $this->attributes;

‎Session/Flash/AutoExpireFlashBag.php

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ public function __construct(string $storageKey = '_symfony_flashes')
3030
$this->storageKey = $storageKey;
3131
}
3232

33-
/**
34-
* {@inheritdoc}
35-
*/
3633
public function getName(): string
3734
{
3835
return $this->name;
@@ -43,9 +40,6 @@ public function setName(string $name)
4340
$this->name = $name;
4441
}
4542

46-
/**
47-
* {@inheritdoc}
48-
*/
4943
public function initialize(array &$flashes)
5044
{
5145
$this->flashes = &$flashes;
@@ -57,33 +51,21 @@ public function initialize(array &$flashes)
5751
$this->flashes['new'] = [];
5852
}
5953

60-
/**
61-
* {@inheritdoc}
62-
*/
6354
public function add(string $type, mixed $message)
6455
{
6556
$this->flashes['new'][$type][] = $message;
6657
}
6758

68-
/**
69-
* {@inheritdoc}
70-
*/
7159
public function peek(string $type, array $default = []): array
7260
{
7361
return $this->has($type) ? $this->flashes['display'][$type] : $default;
7462
}
7563

76-
/**
77-
* {@inheritdoc}
78-
*/
7964
public function peekAll(): array
8065
{
8166
return \array_key_exists('display', $this->flashes) ? $this->flashes['display'] : [];
8267
}
8368

84-
/**
85-
* {@inheritdoc}
86-
*/
8769
public function get(string $type, array $default = []): array
8870
{
8971
$return = $default;
@@ -100,9 +82,6 @@ public function get(string $type, array $default = []): array
10082
return $return;
10183
}
10284

103-
/**
104-
* {@inheritdoc}
105-
*/
10685
public function all(): array
10786
{
10887
$return = $this->flashes['display'];
@@ -111,49 +90,31 @@ public function all(): array
11190
return $return;
11291
}
11392

114-
/**
115-
* {@inheritdoc}
116-
*/
11793
public function setAll(array $messages)
11894
{
11995
$this->flashes['new'] = $messages;
12096
}
12197

122-
/**
123-
* {@inheritdoc}
124-
*/
12598
public function set(string $type, string|array $messages)
12699
{
127100
$this->flashes['new'][$type] = (array) $messages;
128101
}
129102

130-
/**
131-
* {@inheritdoc}
132-
*/
133103
public function has(string $type): bool
134104
{
135105
return \array_key_exists($type, $this->flashes['display']) && $this->flashes['display'][$type];
136106
}
137107

138-
/**
139-
* {@inheritdoc}
140-
*/
141108
public function keys(): array
142109
{
143110
return array_keys($this->flashes['display']);
144111
}
145112

146-
/**
147-
* {@inheritdoc}
148-
*/
149113
public function getStorageKey(): string
150114
{
151115
return $this->storageKey;
152116
}
153117

154-
/**
155-
* {@inheritdoc}
156-
*/
157118
public function clear(): mixed
158119
{
159120
return $this->all();

0 commit comments

Comments
 (0)