Completed
Pull Request — master (#6210)
by Jordi Sala
03:12
created
src/Admin/AbstractAdmin.php 1 patch
Doc Comments   +7 added lines patch added patch discarded remove patch
@@ -1236,6 +1236,9 @@  discard block
 block discarded – undo
1236 1236
         return $this->baseControllerName;
1237 1237
     }
1238 1238
 
1239
+    /**
1240
+     * @param string $label
1241
+     */
1239 1242
     public function setLabel(?string $label): void
1240 1243
     {
1241 1244
         $this->label = $label;
@@ -1877,6 +1880,9 @@  discard block
 block discarded – undo
1877 1880
         return $this->managerType;
1878 1881
     }
1879 1882
 
1883
+    /**
1884
+     * @param string $type
1885
+     */
1880 1886
     public function setManagerType(?string $type): void
1881 1887
     {
1882 1888
         $this->managerType = $type;
@@ -2311,6 +2317,7 @@  discard block
 block discarded – undo
2311 2317
 
2312 2318
     /**
2313 2319
      * {@inheritdoc}
2320
+     * @param boolean $isShown
2314 2321
      */
2315 2322
     final public function showMosaicButton($isShown): void
2316 2323
     {
Please login to merge, or discard this patch.
src/Admin/FieldDescriptionInterface.php 1 patch
Doc Comments   +16 added lines patch added patch discarded remove patch
@@ -26,6 +26,7 @@  discard block
 block discarded – undo
26 26
 {
27 27
     /**
28 28
      * set the field name.
29
+     * @return void
29 30
      */
30 31
     public function setFieldName(?string $fieldName): void;
31 32
 
@@ -38,6 +39,7 @@  discard block
 block discarded – undo
38 39
 
39 40
     /**
40 41
      * Set the name.
42
+     * @return void
41 43
      */
42 44
     public function setName(?string $name): void;
43 45
 
@@ -61,6 +63,7 @@  discard block
 block discarded – undo
61 63
      * Define an option, an option is has a name and a value.
62 64
      *
63 65
      * @param mixed $value
66
+     * @return void
64 67
      */
65 68
     public function setOption(string $name, $value): void;
66 69
 
@@ -72,6 +75,7 @@  discard block
 block discarded – undo
72 75
      * Then the value are copied across to the related property value.
73 76
      *
74 77
      * @param array<string, mixed> $options
78
+     * @return void
75 79
      */
76 80
     public function setOptions(array $options): void;
77 81
 
@@ -84,6 +88,8 @@  discard block
 block discarded – undo
84 88
 
85 89
     /**
86 90
      * Sets the template used to render the field.
91
+     * @param string $template
92
+     * @return void
87 93
      */
88 94
     public function setTemplate(?string $template): void;
89 95
 
@@ -97,16 +103,19 @@  discard block
 block discarded – undo
97 103
     /**
98 104
      * Sets the field type. The type is a mandatory field as it's used to select the correct template
99 105
      * or the logic associated to the current FieldDescription object.
106
+     * @return void
100 107
      */
101 108
     public function setType(?string $type): void;
102 109
 
103 110
     /**
104 111
      * Returns the type.
112
+     * @return string
105 113
      */
106 114
     public function getType(): ?string;
107 115
 
108 116
     /**
109 117
      * set the parent Admin (only used in nested admin).
118
+     * @return void
110 119
      */
111 120
     public function setParent(AdminInterface $parent);
112 121
 
@@ -129,6 +138,7 @@  discard block
 block discarded – undo
129 138
 
130 139
     /**
131 140
      * Returns the related Target object model.
141
+     * @return string
132 142
      */
133 143
     public function getTargetModel(): ?string;
134 144
 
@@ -160,6 +170,7 @@  discard block
 block discarded – undo
160 170
      * set the association admin instance (only used if the field is linked to an Admin).
161 171
      *
162 172
      * @param AdminInterface $associationAdmin the associated admin
173
+     * @return void
163 174
      */
164 175
     public function setAssociationAdmin(AdminInterface $associationAdmin);
165 176
 
@@ -184,6 +195,7 @@  discard block
 block discarded – undo
184 195
 
185 196
     /**
186 197
      * set the admin class linked to this FieldDescription.
198
+     * @return void
187 199
      */
188 200
     public function setAdmin(AdminInterface $admin);
189 201
 
@@ -198,11 +210,13 @@  discard block
 block discarded – undo
198 210
      * merge option values related to the provided option name.
199 211
      *
200 212
      * @throws \RuntimeException
213
+     * @return void
201 214
      */
202 215
     public function mergeOption(string $name, array $options = []): void;
203 216
 
204 217
     /**
205 218
      * merge options values.
219
+     * @return void
206 220
      */
207 221
     public function mergeOptions(array $options = []): void;
208 222
 
@@ -210,6 +224,7 @@  discard block
 block discarded – undo
210 224
      * set the original mapping type (only used if the field is linked to an entity).
211 225
      *
212 226
      * @param string|int $mappingType
227
+     * @return void
213 228
      */
214 229
     public function setMappingType($mappingType);
215 230
 
@@ -259,6 +274,7 @@  discard block
 block discarded – undo
259 274
 
260 275
     /**
261 276
      * Defines the help message.
277
+     * @return void
262 278
      */
263 279
     public function setHelp(string $help): void;
264 280
 }
Please login to merge, or discard this patch.
src/Route/RouteCollection.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -62,6 +62,9 @@
 block discarded – undo
62 62
         $this->baseControllerName = $baseControllerName;
63 63
     }
64 64
 
65
+    /**
66
+     * @param string $pattern
67
+     */
65 68
     public function add(
66 69
         string $name,
67 70
         ?string $pattern = null,
Please login to merge, or discard this patch.
src/Admin/AdminInterface.php 1 patch
Doc Comments   +128 added lines patch added patch discarded remove patch
@@ -39,22 +39,49 @@  discard block
 block discarded – undo
39 39
  */
40 40
 interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
41 41
 {
42
+    /**
43
+     * @return void
44
+     */
42 45
     public function setMenuFactory(FactoryInterface $menuFactory): void;
43 46
 
47
+    /**
48
+     * @return FactoryInterface
49
+     */
44 50
     public function getMenuFactory(): ?FactoryInterface;
45 51
 
52
+    /**
53
+     * @return void
54
+     */
46 55
     public function setFormContractor(FormContractorInterface $formContractor): void;
47 56
 
57
+    /**
58
+     * @return void
59
+     */
48 60
     public function setListBuilder(ListBuilderInterface $listBuilder): void;
49 61
 
62
+    /**
63
+     * @return ListBuilderInterface
64
+     */
50 65
     public function getListBuilder(): ?ListBuilderInterface;
51 66
 
67
+    /**
68
+     * @return void
69
+     */
52 70
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder): void;
53 71
 
72
+    /**
73
+     * @return DatagridBuilderInterface
74
+     */
54 75
     public function getDatagridBuilder(): ?DatagridBuilderInterface;
55 76
 
77
+    /**
78
+     * @return void
79
+     */
56 80
     public function setRequest(Request $request): void;
57 81
 
82
+    /**
83
+     * @return void
84
+     */
58 85
     public function setConfigurationPool(Pool $pool): void;
59 86
 
60 87
     /**
@@ -65,12 +92,16 @@  discard block
 block discarded – undo
65 92
      */
66 93
     public function getClass(): string;
67 94
 
95
+    /**
96
+     * @return void
97
+     */
68 98
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription): void;
69 99
 
70 100
     public function getDatagrid(): DatagridInterface;
71 101
 
72 102
     /**
73 103
      * Set base controller name.
104
+     * @return void
74 105
      */
75 106
     public function setBaseControllerName(string $baseControllerName): void;
76 107
 
@@ -81,14 +112,19 @@  discard block
 block discarded – undo
81 112
 
82 113
     /**
83 114
      * Sets a list of templates.
115
+     * @return void
84 116
      */
85 117
     public function setTemplates(array $templates): void;
86 118
 
87 119
     /**
88 120
      * Sets a specific template.
121
+     * @return void
89 122
      */
90 123
     public function setTemplate(string $name, string $template): void;
91 124
 
125
+    /**
126
+     * @return ModelManagerInterface
127
+     */
92 128
     public function getModelManager(): ?ModelManagerInterface;
93 129
 
94 130
     /**
@@ -105,6 +141,7 @@  discard block
 block discarded – undo
105 141
 
106 142
     /**
107 143
      * Returns a form depend on the given $object.
144
+     * @return \Symfony\Component\Form\Form|null
108 145
      */
109 146
     public function getForm(): ?FormInterface;
110 147
 
@@ -130,6 +167,9 @@  discard block
 block discarded – undo
130 167
      */
131 168
     public function getSecurityInformation(): array;
132 169
 
170
+    /**
171
+     * @return void
172
+     */
133 173
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;
134 174
 
135 175
     /**
@@ -154,8 +194,14 @@  discard block
 block discarded – undo
154 194
      */
155 195
     public function hasRoute(string $name): bool;
156 196
 
197
+    /**
198
+     * @return void
199
+     */
157 200
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void;
158 201
 
202
+    /**
203
+     * @return SecurityHandlerInterface
204
+     */
159 205
     public function getSecurityHandler(): ?SecurityHandlerInterface;
160 206
 
161 207
     /**
@@ -174,17 +220,33 @@  discard block
 block discarded – undo
174 220
      * Shorthand method for templating.
175 221
      *
176 222
      * @param object $model
223
+     * @return string
177 224
      */
178 225
     public function id($model): ?string;
179 226
 
227
+    /**
228
+     * @return void
229
+     */
180 230
     public function setValidator(ValidatorInterface $validator): void;
181 231
 
232
+    /**
233
+     * @return ValidatorInterface
234
+     */
182 235
     public function getValidator(): ?ValidatorInterface;
183 236
 
237
+    /**
238
+     * @return FieldDescriptionCollection|null
239
+     */
184 240
     public function getShow(): ?FieldDescriptionCollection;
185 241
 
242
+    /**
243
+     * @return void
244
+     */
186 245
     public function setFormTheme(array $formTheme): void;
187 246
 
247
+    /**
248
+     * @return FieldDescriptionCollection|null
249
+     */
188 250
     public function getList(): ?FieldDescriptionCollection;
189 251
 
190 252
     /**
@@ -192,6 +254,9 @@  discard block
 block discarded – undo
192 254
      */
193 255
     public function getFormTheme(): array;
194 256
 
257
+    /**
258
+     * @return void
259
+     */
195 260
     public function setFilterTheme(array $filterTheme): void;
196 261
 
197 262
     /**
@@ -199,6 +264,9 @@  discard block
 block discarded – undo
199 264
      */
200 265
     public function getFilterTheme(): array;
201 266
 
267
+    /**
268
+     * @return void
269
+     */
202 270
     public function addExtension(AdminExtensionInterface $extension): void;
203 271
 
204 272
     /**
@@ -208,8 +276,14 @@  discard block
 block discarded – undo
208 276
      */
209 277
     public function getExtensions(): array;
210 278
 
279
+    /**
280
+     * @return void
281
+     */
211 282
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void;
212 283
 
284
+    /**
285
+     * @return RouteBuilderInterface
286
+     */
213 287
     public function getRouteBuilder(): ?RouteBuilderInterface;
214 288
 
215 289
     /**
@@ -217,8 +291,14 @@  discard block
 block discarded – undo
217 291
      */
218 292
     public function toString($object): string;
219 293
 
294
+    /**
295
+     * @return void
296
+     */
220 297
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void;
221 298
 
299
+    /**
300
+     * @return LabelTranslatorStrategyInterface
301
+     */
222 302
     public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface;
223 303
 
224 304
     /**
@@ -230,6 +310,9 @@  discard block
 block discarded – undo
230 310
 
231 311
     public function getNewInstance(): object;
232 312
 
313
+    /**
314
+     * @return void
315
+     */
233 316
     public function setUniqid(string $uniqId): void;
234 317
 
235 318
     /**
@@ -249,6 +332,9 @@  discard block
 block discarded – undo
249 332
      */
250 333
     public function getObject($id): ?object;
251 334
 
335
+    /**
336
+     * @return void
337
+     */
252 338
     public function setSubject(?object $subject): void;
253 339
 
254 340
     public function getSubject(): object;
@@ -272,6 +358,7 @@  discard block
 block discarded – undo
272 358
 
273 359
     /**
274 360
      * Call before the batch action, allow you to alter the query and the idx.
361
+     * @return void
275 362
      */
276 363
     public function preBatchAction(string $actionName, ProxyQueryInterface $query, array &$idx, bool $allElements = false): void;
277 364
 
@@ -294,6 +381,7 @@  discard block
 block discarded – undo
294 381
      *
295 382
      * @deprecated this feature cannot be stable, use a custom validator,
296 383
      *             the feature will be removed with Symfony 2.2
384
+     * @return void
297 385
      */
298 386
     public function validate(ErrorElement $errorElement, $object): void;
299 387
 
@@ -301,11 +389,15 @@  discard block
 block discarded – undo
301 389
 
302 390
     /**
303 391
      * Add object security, fe. make the current user owner of the object.
392
+     * @return void
304 393
      */
305 394
     public function createObjectSecurity(object $object): void;
306 395
 
307 396
     public function getParent(): self;
308 397
 
398
+    /**
399
+     * @return void
400
+     */
309 401
     public function setParent(self $admin): void;
310 402
 
311 403
     /**
@@ -317,6 +409,7 @@  discard block
 block discarded – undo
317 409
      * Set the translation domain.
318 410
      *
319 411
      * @param string $translationDomain the translation domain
412
+     * @return void
320 413
      */
321 414
     public function setTranslationDomain(string $translationDomain): void;
322 415
 
@@ -336,6 +429,7 @@  discard block
 block discarded – undo
336 429
 
337 430
     /**
338 431
      * Set the form groups.
432
+     * @return void
339 433
      */
340 434
     public function setFormGroups(array $formGroups): void;
341 435
 
@@ -344,6 +438,9 @@  discard block
 block discarded – undo
344 438
      */
345 439
     public function getFormTabs(): array;
346 440
 
441
+    /**
442
+     * @return void
443
+     */
347 444
     public function setFormTabs(array $formTabs): void;
348 445
 
349 446
     /**
@@ -351,10 +448,14 @@  discard block
 block discarded – undo
351 448
      */
352 449
     public function getShowTabs(): array;
353 450
 
451
+    /**
452
+     * @return void
453
+     */
354 454
     public function setShowTabs(array $showTabs): void;
355 455
 
356 456
     /**
357 457
      * Remove a form group field.
458
+     * @return void
358 459
      */
359 460
     public function removeFieldFromFormGroup(string $key): void;
360 461
 
@@ -367,11 +468,13 @@  discard block
 block discarded – undo
367 468
 
368 469
     /**
369 470
      * Set the show groups.
471
+     * @return void
370 472
      */
371 473
     public function setShowGroups(array $showGroups): void;
372 474
 
373 475
     /**
374 476
      * Reorder items in showGroup.
477
+     * @return void
375 478
      */
376 479
     public function reorderShowGroup(string $group, array $keys): void;
377 480
 
@@ -387,6 +490,7 @@  discard block
 block discarded – undo
387 490
 
388 491
     /**
389 492
      * Sets the list of supported sub classes.
493
+     * @return void
390 494
      */
391 495
     public function setSubClasses(array $subClasses): void;
392 496
 
@@ -425,6 +529,7 @@  discard block
 block discarded – undo
425 529
 
426 530
     /**
427 531
      * Returns Admin`s label.
532
+     * @return string
428 533
      */
429 534
     public function getLabel(): ?string;
430 535
 
@@ -439,6 +544,7 @@  discard block
 block discarded – undo
439 544
 
440 545
     /**
441 546
      * Set the current child status.
547
+     * @return void
442 548
      */
443 549
     public function setCurrentChild(bool $currentChild): void;
444 550
 
@@ -462,6 +568,9 @@  discard block
 block discarded – undo
462 568
      */
463 569
     public function getListModes(): array;
464 570
 
571
+    /**
572
+     * @return void
573
+     */
465 574
     public function setListMode(string $mode): void;
466 575
 
467 576
     /**
@@ -486,12 +595,14 @@  discard block
 block discarded – undo
486 595
 
487 596
     /**
488 597
      * Returns the result link for an object.
598
+     * @return string|null
489 599
      */
490 600
     public function getSearchResultLink(object $object): ?string;
491 601
 
492 602
     /**
493 603
      * Setting to true will enable mosaic button for the admin screen.
494 604
      * Setting to false will hide mosaic button for the admin screen.
605
+     * @return void
495 606
      */
496 607
     public function showMosaicButton(bool $isShown): void;
497 608
 
@@ -517,6 +628,9 @@  discard block
 block discarded – undo
517 628
      */
518 629
     public function getRootCode(): string;
519 630
 
631
+    /**
632
+     * @return void
633
+     */
520 634
     public function setFilterPersister(?FilterPersisterInterface $filterPersister = null): void;
521 635
 
522 636
     /**
@@ -529,14 +643,24 @@  discard block
 block discarded – undo
529 643
      */
530 644
     public function getBaseRouteName(): string;
531 645
 
646
+    /**
647
+     * @param AbstractAdmin $childAdmin
648
+     */
532 649
     public function getSideMenu(string $action, ?self $childAdmin = null): ItemInterface;
533 650
 
651
+    /**
652
+     * @return void
653
+     */
534 654
     public function addParentAssociationMapping(string $code, string $value): void;
535 655
 
656
+    /**
657
+     * @return RouteGeneratorInterface|null
658
+     */
536 659
     public function getRouteGenerator(): ?RouteGeneratorInterface;
537 660
 
538 661
     /**
539 662
      * Returns the current child admin instance.
663
+     * @return AdminInterface|null
540 664
      */
541 665
     public function getCurrentChildAdmin(): ?self;
542 666
 
@@ -546,11 +670,15 @@  discard block
 block discarded – undo
546 670
      */
547 671
     public function getParentAssociationMapping(): ?string;
548 672
 
673
+    /**
674
+     * @return void
675
+     */
549 676
     public function reorderFormGroup(string $group, array $keys): void;
550 677
 
551 678
     /**
552 679
      * This method is being called by the main admin class and the child class,
553 680
      * the getFormBuilder is only call by the main admin class.
681
+     * @return void
554 682
      */
555 683
     public function defineFormBuilder(FormBuilderInterface $formBuilder): void;
556 684
 }
Please login to merge, or discard this patch.
tests/Fixtures/Admin/CommentAdmin.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -18,6 +18,9 @@
 block discarded – undo
18 18
 
19 19
 class CommentAdmin extends AbstractAdmin
20 20
 {
21
+    /**
22
+     * @param string $label
23
+     */
21 24
     public function setClassnameLabel($label): void
22 25
     {
23 26
         $this->classnameLabel = $label;
Please login to merge, or discard this patch.