Skip to content

Commit 6614e0a

Browse files
engcom-Charlieengcom-Charlie
committed
Merge remote-tracking branch '39153/bad-phpdoc-ManagerInterface' into febcomprs
2 parents 9e7230b + 1e7b0ed commit 6614e0a

File tree

2 files changed

+28
-110
lines changed

2 files changed

+28
-110
lines changed

‎lib/internal/Magento/Framework/Message/Manager.php

Lines changed: 13 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?php
22
/**
3-
* Copyright © Magento, Inc. All rights reserved.
4-
* See COPYING.txt for license details.
3+
* Copyright 2017 Adobe
4+
* All Rights Reserved.
55
*/
66
namespace Magento\Framework\Message;
77

@@ -21,7 +21,7 @@ class Manager implements ManagerInterface
2121
/**
2222
* Default message group
2323
*/
24-
const DEFAULT_GROUP = 'default';
24+
public const DEFAULT_GROUP = 'default';
2525

2626
/**
2727
* @var Session
@@ -88,7 +88,7 @@ public function __construct(
8888
$this->logger = $logger;
8989
$this->defaultGroup = $defaultGroup;
9090
$this->exceptionMessageFactory = $exceptionMessageFactory ?: ObjectManager::getInstance()
91-
->get(ExceptionMessageLookupFactory::class);
91+
->get(ExceptionMessageLookupFactory::class); // phpcs:ignore
9292
}
9393

9494
/**
@@ -112,10 +112,6 @@ protected function prepareGroup($group)
112112

113113
/**
114114
* @inheritdoc
115-
*
116-
* @param bool $clear
117-
* @param string|null $group
118-
* @return Collection
119115
*/
120116
public function getMessages($clear = false, $group = null)
121117
{
@@ -135,10 +131,6 @@ public function getMessages($clear = false, $group = null)
135131

136132
/**
137133
* @inheritdoc
138-
*
139-
* @param MessageInterface $message
140-
* @param string|null $group
141-
* @return $this
142134
*/
143135
public function addMessage(MessageInterface $message, $group = null)
144136
{
@@ -150,10 +142,6 @@ public function addMessage(MessageInterface $message, $group = null)
150142

151143
/**
152144
* @inheritdoc
153-
*
154-
* @param MessageInterface[] $messages
155-
* @param string|null $group
156-
* @return $this
157145
*/
158146
public function addMessages(array $messages, $group = null)
159147
{
@@ -167,10 +155,6 @@ public function addMessages(array $messages, $group = null)
167155

168156
/**
169157
* @inheritdoc
170-
*
171-
* @param string $message
172-
* @param string|null $group
173-
* @return $this
174158
*/
175159
public function addError($message, $group = null)
176160
{
@@ -180,10 +164,6 @@ public function addError($message, $group = null)
180164

181165
/**
182166
* @inheritdoc
183-
*
184-
* @param string $message
185-
* @param string|null $group
186-
* @return $this
187167
*/
188168
public function addWarning($message, $group = null)
189169
{
@@ -193,10 +173,6 @@ public function addWarning($message, $group = null)
193173

194174
/**
195175
* @inheritdoc
196-
*
197-
* @param string $message
198-
* @param string|null $group
199-
* @return $this
200176
*/
201177
public function addNotice($message, $group = null)
202178
{
@@ -206,10 +182,6 @@ public function addNotice($message, $group = null)
206182

207183
/**
208184
* @inheritdoc
209-
*
210-
* @param string $message
211-
* @param string|null $group
212-
* @return $this
213185
*/
214186
public function addSuccess($message, $group = null)
215187
{
@@ -219,10 +191,6 @@ public function addSuccess($message, $group = null)
219191

220192
/**
221193
* @inheritdoc
222-
*
223-
* @param MessageInterface[] $messages
224-
* @param string|null $group
225-
* @return $this
226194
*/
227195
public function addUniqueMessages(array $messages, $group = null)
228196
{
@@ -239,11 +207,6 @@ public function addUniqueMessages(array $messages, $group = null)
239207

240208
/**
241209
* @inheritdoc
242-
*
243-
* @param \Exception $exception
244-
* @param string $alternativeText
245-
* @param string $group
246-
* @return $this
247210
*/
248211
public function addException(\Exception $exception, $alternativeText = null, $group = null)
249212
{
@@ -282,11 +245,6 @@ public function hasMessages()
282245

283246
/**
284247
* @inheritdoc
285-
*
286-
* @param \Exception $exception
287-
* @param string $alternativeText
288-
* @param string $group
289-
* @return $this
290248
*/
291249
public function addExceptionMessage(\Exception $exception, $alternativeText = null, $group = null)
292250
{
@@ -314,11 +272,7 @@ public function addExceptionMessage(\Exception $exception, $alternativeText = nu
314272
}
315273

316274
/**
317-
* Adds new error message
318-
*
319-
* @param string $message
320-
* @param string|null $group
321-
* @return ManagerInterface
275+
* @inheritdoc
322276
*/
323277
public function addErrorMessage($message, $group = null)
324278
{
@@ -331,11 +285,7 @@ public function addErrorMessage($message, $group = null)
331285
}
332286

333287
/**
334-
* Adds new warning message
335-
*
336-
* @param string $message
337-
* @param string|null $group
338-
* @return ManagerInterface
288+
* @inheritdoc
339289
*/
340290
public function addWarningMessage($message, $group = null)
341291
{
@@ -348,11 +298,7 @@ public function addWarningMessage($message, $group = null)
348298
}
349299

350300
/**
351-
* Adds new notice message
352-
*
353-
* @param string $message
354-
* @param string|null $group
355-
* @return ManagerInterface
301+
* @inheritdoc
356302
*/
357303
public function addNoticeMessage($message, $group = null)
358304
{
@@ -365,11 +311,7 @@ public function addNoticeMessage($message, $group = null)
365311
}
366312

367313
/**
368-
* Adds new success message
369-
*
370-
* @param string $message
371-
* @param string|null $group
372-
* @return ManagerInterface
314+
* @inheritdoc
373315
*/
374316
public function addSuccessMessage($message, $group = null)
375317
{
@@ -382,13 +324,7 @@ public function addSuccessMessage($message, $group = null)
382324
}
383325

384326
/**
385-
* Adds new complex error message
386-
*
387-
* @param string $identifier
388-
* @param array $data
389-
* @param string|null $group
390-
* @return ManagerInterface
391-
* @throws \InvalidArgumentException
327+
* @inheritdoc
392328
*/
393329
public function addComplexErrorMessage($identifier, array $data = [], $group = null)
394330
{
@@ -403,13 +339,7 @@ public function addComplexErrorMessage($identifier, array $data = [], $group = n
403339
}
404340

405341
/**
406-
* Adds new complex warning message
407-
*
408-
* @param string $identifier
409-
* @param array $data
410-
* @param string|null $group
411-
* @return ManagerInterface
412-
* @throws \InvalidArgumentException
342+
* @inheritdoc
413343
*/
414344
public function addComplexWarningMessage($identifier, array $data = [], $group = null)
415345
{
@@ -424,13 +354,7 @@ public function addComplexWarningMessage($identifier, array $data = [], $group =
424354
}
425355

426356
/**
427-
* Adds new complex notice message
428-
*
429-
* @param string $identifier
430-
* @param array $data
431-
* @param string|null $group
432-
* @return ManagerInterface
433-
* @throws \InvalidArgumentException
357+
* @inheritdoc
434358
*/
435359
public function addComplexNoticeMessage($identifier, array $data = [], $group = null)
436360
{
@@ -445,13 +369,7 @@ public function addComplexNoticeMessage($identifier, array $data = [], $group =
445369
}
446370

447371
/**
448-
* Adds new complex success message
449-
*
450-
* @param string $identifier
451-
* @param array $data
452-
* @param string|null $group
453-
* @return ManagerInterface
454-
* @throws \InvalidArgumentException
372+
* @inheritdoc
455373
*/
456374
public function addComplexSuccessMessage($identifier, array $data = [], $group = null)
457375
{
@@ -466,12 +384,7 @@ public function addComplexSuccessMessage($identifier, array $data = [], $group =
466384
}
467385

468386
/**
469-
* Creates identified message
470-
*
471-
* @param string $type
472-
* @param string|null $identifier
473-
* @return MessageInterface
474-
* @throws \InvalidArgumentException
387+
* @inheritdoc
475388
*/
476389
public function createMessage($type, $identifier = null)
477390
{

‎lib/internal/Magento/Framework/Message/ManagerInterface.php

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?php
22
/**
3-
* Copyright © Magento, Inc. All rights reserved.
4-
* See COPYING.txt for license details.
3+
* Copyright 2017 Adobe
4+
* All Rights Reserved.
55
*/
66
namespace Magento\Framework\Message;
77

@@ -50,7 +50,7 @@ public function addMessages(array $messages, $group = null);
5050
/**
5151
* Adds new error message
5252
*
53-
* @param string $message
53+
* @param string|\Stringable $message
5454
* @param string|null $group
5555
* @return ManagerInterface
5656
* @deprecated 100.1.0
@@ -61,7 +61,7 @@ public function addError($message, $group = null);
6161
/**
6262
* Adds new warning message
6363
*
64-
* @param string $message
64+
* @param string|\Stringable $message
6565
* @param string|null $group
6666
* @return ManagerInterface
6767
* @deprecated 100.1.0
@@ -72,7 +72,7 @@ public function addWarning($message, $group = null);
7272
/**
7373
* Adds new notice message
7474
*
75-
* @param string $message
75+
* @param string|\Stringable $message
7676
* @param string|null $group
7777
* @return ManagerInterface
7878
* @deprecated 100.1.0
@@ -83,7 +83,7 @@ public function addNotice($message, $group = null);
8383
/**
8484
* Adds new success message
8585
*
86-
* @param string $message
86+
* @param string|\Stringable $message
8787
* @param string|null $group
8888
* @return ManagerInterface
8989
* @deprecated 100.1.0
@@ -94,7 +94,7 @@ public function addSuccess($message, $group = null);
9494
/**
9595
* Adds new error message
9696
*
97-
* @param string $message
97+
* @param string|\Stringable $message
9898
* @param string|null $group
9999
* @return ManagerInterface
100100
*/
@@ -103,7 +103,7 @@ public function addErrorMessage($message, $group = null);
103103
/**
104104
* Adds new warning message
105105
*
106-
* @param string $message
106+
* @param string|\Stringable $message
107107
* @param string|null $group
108108
* @return ManagerInterface
109109
*/
@@ -112,7 +112,7 @@ public function addWarningMessage($message, $group = null);
112112
/**
113113
* Adds new notice message
114114
*
115-
* @param string $message
115+
* @param string|\Stringable $message
116116
* @param string|null $group
117117
* @return ManagerInterface
118118
*/
@@ -121,7 +121,7 @@ public function addNoticeMessage($message, $group = null);
121121
/**
122122
* Adds new success message
123123
*
124-
* @param string $message
124+
* @param string|\Stringable $message
125125
* @param string|null $group
126126
* @return ManagerInterface
127127
*/
@@ -134,6 +134,7 @@ public function addSuccessMessage($message, $group = null);
134134
* @param array $data
135135
* @param string|null $group
136136
* @return ManagerInterface
137+
* @throws \InvalidArgumentException
137138
*/
138139
public function addComplexErrorMessage($identifier, array $data = [], $group = null);
139140

@@ -144,6 +145,7 @@ public function addComplexErrorMessage($identifier, array $data = [], $group = n
144145
* @param array $data
145146
* @param string|null $group
146147
* @return ManagerInterface
148+
* @throws \InvalidArgumentException
147149
*/
148150
public function addComplexWarningMessage($identifier, array $data = [], $group = null);
149151

@@ -154,6 +156,7 @@ public function addComplexWarningMessage($identifier, array $data = [], $group =
154156
* @param array $data
155157
* @param string|null $group
156158
* @return ManagerInterface
159+
* @throws \InvalidArgumentException
157160
*/
158161
public function addComplexNoticeMessage($identifier, array $data = [], $group = null);
159162

@@ -164,6 +167,7 @@ public function addComplexNoticeMessage($identifier, array $data = [], $group =
164167
* @param array $data
165168
* @param string|null $group
166169
* @return ManagerInterface
170+
* @throws \InvalidArgumentException
167171
*/
168172
public function addComplexSuccessMessage($identifier, array $data = [], $group = null);
169173

@@ -195,6 +199,7 @@ public function addException(\Exception $exception, $alternativeText = null, $gr
195199
* @param string|null $alternativeText
196200
* @param string|null $group
197201
* @return ManagerInterface
202+
* @throws \InvalidArgumentException
198203
*/
199204
public function addExceptionMessage(\Exception $exception, $alternativeText = null, $group = null);
200205

0 commit comments

Comments
 (0)