@@ -131,6 +131,9 @@ discard block |
||
131 | 131 | */ |
132 | 132 | private static $fieldGetters = []; |
133 | 133 | |
134 | + /** |
|
135 | + * @param string $fieldName |
|
136 | + */ |
|
134 | 137 | public function setFieldName(?string $fieldName): void |
135 | 138 | { |
136 | 139 | $this->fieldName = $fieldName; |
@@ -141,6 +144,9 @@ discard block |
||
141 | 144 | return $this->fieldName; |
142 | 145 | } |
143 | 146 | |
147 | + /** |
|
148 | + * @param string $name |
|
149 | + */ |
|
144 | 150 | public function setName(?string $name): void |
145 | 151 | { |
146 | 152 | $this->name = $name; |
@@ -438,6 +444,9 @@ discard block |
||
438 | 444 | return $object->{$fieldName}; |
439 | 445 | } |
440 | 446 | |
447 | + /** |
|
448 | + * @param string $fieldName |
|
449 | + */ |
|
441 | 450 | private function cacheFieldGetter($object, ?string $fieldName, string $method, ?string $getter = null): void |
442 | 451 | { |
443 | 452 | $getterKey = $this->getFieldGetterKey($object, $fieldName); |
@@ -936,6 +936,7 @@ discard block |
||
936 | 936 | |
937 | 937 | /** |
938 | 938 | * NEXT_MAJOR: remove this method. |
939 | + * @param string $subClass |
|
939 | 940 | */ |
940 | 941 | public function addSubClass($subClass): void |
941 | 942 | { |
@@ -1067,6 +1068,9 @@ discard block |
||
1067 | 1068 | return $this->routeGenerator->hasAdminRoute($this, $name); |
1068 | 1069 | } |
1069 | 1070 | |
1071 | + /** |
|
1072 | + * @param string $adminCode |
|
1073 | + */ |
|
1070 | 1074 | public function isCurrentRoute(string $name, ?string $adminCode = null): bool |
1071 | 1075 | { |
1072 | 1076 | if (!$this->hasRequest()) { |
@@ -1309,6 +1313,9 @@ discard block |
||
1309 | 1313 | return $this->baseControllerName; |
1310 | 1314 | } |
1311 | 1315 | |
1316 | + /** |
|
1317 | + * @param string $label |
|
1318 | + */ |
|
1312 | 1319 | public function setLabel(?string $label): void |
1313 | 1320 | { |
1314 | 1321 | $this->label = $label; |
@@ -1822,6 +1829,7 @@ discard block |
||
1822 | 1829 | * |
1823 | 1830 | * NEXT_MAJOR: remove this method |
1824 | 1831 | * |
1832 | + * @param string $domain |
|
1825 | 1833 | * @return string the translated string |
1826 | 1834 | * |
1827 | 1835 | * @deprecated since sonata-project/admin-bundle 3.9, to be removed with 4.0 |
@@ -2002,6 +2010,9 @@ discard block |
||
2002 | 2010 | return $this->managerType; |
2003 | 2011 | } |
2004 | 2012 | |
2013 | + /** |
|
2014 | + * @param string $type |
|
2015 | + */ |
|
2005 | 2016 | public function setManagerType(?string $type): void |
2006 | 2017 | { |
2007 | 2018 | $this->managerType = $type; |
@@ -2409,6 +2420,7 @@ discard block |
||
2409 | 2420 | |
2410 | 2421 | /** |
2411 | 2422 | * {@inheritdoc} |
2423 | + * @param boolean $isShown |
|
2412 | 2424 | */ |
2413 | 2425 | final public function showMosaicButton($isShown): void |
2414 | 2426 | { |
@@ -2535,6 +2547,7 @@ discard block |
||
2535 | 2547 | * NEXT_MAJOR: remove this method. |
2536 | 2548 | * |
2537 | 2549 | * @deprecated Use configureTabMenu instead |
2550 | + * @param string $action |
|
2538 | 2551 | */ |
2539 | 2552 | protected function configureSideMenu(ItemInterface $menu, $action, ?AdminInterface $childAdmin = null): void |
2540 | 2553 | { |
@@ -37,26 +37,59 @@ discard block |
||
37 | 37 | */ |
38 | 38 | interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface |
39 | 39 | { |
40 | + /** |
|
41 | + * @return void |
|
42 | + */ |
|
40 | 43 | public function setMenuFactory(MenuFactoryInterface $menuFactory): void; |
41 | 44 | |
45 | + /** |
|
46 | + * @return MenuFactoryInterface |
|
47 | + */ |
|
42 | 48 | public function getMenuFactory(): ?MenuFactoryInterface; |
43 | 49 | |
50 | + /** |
|
51 | + * @return void |
|
52 | + */ |
|
44 | 53 | public function setFormContractor(FormContractorInterface $formContractor): void; |
45 | 54 | |
55 | + /** |
|
56 | + * @return void |
|
57 | + */ |
|
46 | 58 | public function setListBuilder(ListBuilderInterface $listBuilder): void; |
47 | 59 | |
60 | + /** |
|
61 | + * @return ListBuilderInterface |
|
62 | + */ |
|
48 | 63 | public function getListBuilder(): ?ListBuilderInterface; |
49 | 64 | |
65 | + /** |
|
66 | + * @return void |
|
67 | + */ |
|
50 | 68 | public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder): void; |
51 | 69 | |
70 | + /** |
|
71 | + * @return DatagridBuilderInterface |
|
72 | + */ |
|
52 | 73 | public function getDatagridBuilder(): ?DatagridBuilderInterface; |
53 | 74 | |
75 | + /** |
|
76 | + * @return void |
|
77 | + */ |
|
54 | 78 | public function setTranslator(TranslatorInterface $translator): void; |
55 | 79 | |
80 | + /** |
|
81 | + * @return TranslatorInterface |
|
82 | + */ |
|
56 | 83 | public function getTranslator(): ?TranslatorInterface; |
57 | 84 | |
85 | + /** |
|
86 | + * @return void |
|
87 | + */ |
|
58 | 88 | public function setRequest(Request $request): void; |
59 | 89 | |
90 | + /** |
|
91 | + * @return void |
|
92 | + */ |
|
60 | 93 | public function setConfigurationPool(Pool $pool): void; |
61 | 94 | |
62 | 95 | /** |
@@ -67,12 +100,19 @@ discard block |
||
67 | 100 | */ |
68 | 101 | public function getClass(): string; |
69 | 102 | |
103 | + /** |
|
104 | + * @return void |
|
105 | + */ |
|
70 | 106 | public function attachAdminClass(FieldDescriptionInterface $fieldDescription): void; |
71 | 107 | |
108 | + /** |
|
109 | + * @return DatagridInterface|null |
|
110 | + */ |
|
72 | 111 | public function getDatagrid(): ?DatagridInterface; |
73 | 112 | |
74 | 113 | /** |
75 | 114 | * Set base controller name. |
115 | + * @return void |
|
76 | 116 | */ |
77 | 117 | public function setBaseControllerName(string $baseControllerName): void; |
78 | 118 | |
@@ -83,14 +123,19 @@ discard block |
||
83 | 123 | |
84 | 124 | /** |
85 | 125 | * Sets a list of templates. |
126 | + * @return void |
|
86 | 127 | */ |
87 | 128 | public function setTemplates(array $templates): void; |
88 | 129 | |
89 | 130 | /** |
90 | 131 | * Sets a specific template. |
132 | + * @return void |
|
91 | 133 | */ |
92 | 134 | public function setTemplate(string $name, string $template): void; |
93 | 135 | |
136 | + /** |
|
137 | + * @return ModelManagerInterface |
|
138 | + */ |
|
94 | 139 | public function getModelManager(): ?ModelManagerInterface; |
95 | 140 | |
96 | 141 | /** |
@@ -110,6 +155,7 @@ discard block |
||
110 | 155 | |
111 | 156 | /** |
112 | 157 | * Returns a form depend on the given $object. |
158 | + * @return \Symfony\Component\Form\Form|null |
|
113 | 159 | */ |
114 | 160 | public function getForm(): ?FormInterface; |
115 | 161 | |
@@ -138,6 +184,9 @@ discard block |
||
138 | 184 | */ |
139 | 185 | public function getSecurityInformation(): array; |
140 | 186 | |
187 | + /** |
|
188 | + * @return void |
|
189 | + */ |
|
141 | 190 | public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void; |
142 | 191 | |
143 | 192 | /** |
@@ -179,8 +228,14 @@ discard block |
||
179 | 228 | */ |
180 | 229 | public function hasRoute(string $name): bool; |
181 | 230 | |
231 | + /** |
|
232 | + * @return void |
|
233 | + */ |
|
182 | 234 | public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void; |
183 | 235 | |
236 | + /** |
|
237 | + * @return SecurityHandlerInterface |
|
238 | + */ |
|
184 | 239 | public function getSecurityHandler(): ?SecurityHandlerInterface; |
185 | 240 | |
186 | 241 | /** |
@@ -199,15 +254,28 @@ discard block |
||
199 | 254 | * Shorthand method for templating. |
200 | 255 | * |
201 | 256 | * @param object $entity |
257 | + * @return string |
|
202 | 258 | */ |
203 | 259 | public function id($entity): ?string; |
204 | 260 | |
261 | + /** |
|
262 | + * @return void |
|
263 | + */ |
|
205 | 264 | public function setValidator(ValidatorInterface $validator): void; |
206 | 265 | |
266 | + /** |
|
267 | + * @return ValidatorInterface |
|
268 | + */ |
|
207 | 269 | public function getValidator(): ?ValidatorInterface; |
208 | 270 | |
271 | + /** |
|
272 | + * @return FieldDescriptionCollection|null |
|
273 | + */ |
|
209 | 274 | public function getShow(): ?FieldDescriptionCollection; |
210 | 275 | |
276 | + /** |
|
277 | + * @return void |
|
278 | + */ |
|
211 | 279 | public function setFormTheme(array $formTheme): void; |
212 | 280 | |
213 | 281 | /** |
@@ -215,6 +283,9 @@ discard block |
||
215 | 283 | */ |
216 | 284 | public function getFormTheme(): array; |
217 | 285 | |
286 | + /** |
|
287 | + * @return void |
|
288 | + */ |
|
218 | 289 | public function setFilterTheme(array $filterTheme): void; |
219 | 290 | |
220 | 291 | /** |
@@ -222,6 +293,9 @@ discard block |
||
222 | 293 | */ |
223 | 294 | public function getFilterTheme(): array; |
224 | 295 | |
296 | + /** |
|
297 | + * @return void |
|
298 | + */ |
|
225 | 299 | public function addExtension(AdminExtensionInterface $extension): void; |
226 | 300 | |
227 | 301 | /** |
@@ -231,8 +305,14 @@ discard block |
||
231 | 305 | */ |
232 | 306 | public function getExtensions(): array; |
233 | 307 | |
308 | + /** |
|
309 | + * @return void |
|
310 | + */ |
|
234 | 311 | public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void; |
235 | 312 | |
313 | + /** |
|
314 | + * @return RouteBuilderInterface |
|
315 | + */ |
|
236 | 316 | public function getRouteBuilder(): ?RouteBuilderInterface; |
237 | 317 | |
238 | 318 | /** |
@@ -240,8 +320,14 @@ discard block |
||
240 | 320 | */ |
241 | 321 | public function toString($object): string; |
242 | 322 | |
323 | + /** |
|
324 | + * @return void |
|
325 | + */ |
|
243 | 326 | public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void; |
244 | 327 | |
328 | + /** |
|
329 | + * @return LabelTranslatorStrategyInterface |
|
330 | + */ |
|
245 | 331 | public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface; |
246 | 332 | |
247 | 333 | /** |
@@ -256,6 +342,9 @@ discard block |
||
256 | 342 | */ |
257 | 343 | public function getNewInstance(); |
258 | 344 | |
345 | + /** |
|
346 | + * @return void |
|
347 | + */ |
|
259 | 348 | public function setUniqid(string $uniqId): void; |
260 | 349 | |
261 | 350 | /** |
@@ -275,6 +364,9 @@ discard block |
||
275 | 364 | */ |
276 | 365 | public function getObject($id): ?object; |
277 | 366 | |
367 | + /** |
|
368 | + * @return void |
|
369 | + */ |
|
278 | 370 | public function setSubject(?object $subject): void; |
279 | 371 | |
280 | 372 | public function getSubject(): ?object; |
@@ -313,6 +405,7 @@ discard block |
||
313 | 405 | |
314 | 406 | /** |
315 | 407 | * Call before the batch action, allow you to alter the query and the idx. |
408 | + * @return void |
|
316 | 409 | */ |
317 | 410 | public function preBatchAction(string $actionName, ProxyQueryInterface $query, array &$idx, bool $allElements = false): void; |
318 | 411 | |
@@ -335,6 +428,7 @@ discard block |
||
335 | 428 | * |
336 | 429 | * @deprecated this feature cannot be stable, use a custom validator, |
337 | 430 | * the feature will be removed with Symfony 2.2 |
431 | + * @return void |
|
338 | 432 | */ |
339 | 433 | public function validate(ErrorElement $errorElement, $object): void; |
340 | 434 | |
@@ -344,11 +438,18 @@ discard block |
||
344 | 438 | * Add object security, fe. make the current user owner of the object. |
345 | 439 | * |
346 | 440 | * @param object $object |
441 | + * @return void |
|
347 | 442 | */ |
348 | 443 | public function createObjectSecurity($object): void; |
349 | 444 | |
445 | + /** |
|
446 | + * @return AdminInterface|null |
|
447 | + */ |
|
350 | 448 | public function getParent(): ?self; |
351 | 449 | |
450 | + /** |
|
451 | + * @return void |
|
452 | + */ |
|
352 | 453 | public function setParent(self $admin): void; |
353 | 454 | |
354 | 455 | /** |
@@ -360,6 +461,7 @@ discard block |
||
360 | 461 | * Set the translation domain. |
361 | 462 | * |
362 | 463 | * @param string $translationDomain the translation domain |
464 | + * @return void |
|
363 | 465 | */ |
364 | 466 | public function setTranslationDomain(string $translationDomain): void; |
365 | 467 | |
@@ -381,6 +483,7 @@ discard block |
||
381 | 483 | |
382 | 484 | /** |
383 | 485 | * Set the form groups. |
486 | + * @return void |
|
384 | 487 | */ |
385 | 488 | public function setFormGroups(array $formGroups): void; |
386 | 489 | |
@@ -389,6 +492,9 @@ discard block |
||
389 | 492 | */ |
390 | 493 | public function getFormTabs(); |
391 | 494 | |
495 | + /** |
|
496 | + * @return void |
|
497 | + */ |
|
392 | 498 | public function setFormTabs(array $formTabs): void; |
393 | 499 | |
394 | 500 | /** |
@@ -396,10 +502,14 @@ discard block |
||
396 | 502 | */ |
397 | 503 | public function getShowTabs(); |
398 | 504 | |
505 | + /** |
|
506 | + * @return void |
|
507 | + */ |
|
399 | 508 | public function setShowTabs(array $showTabs): void; |
400 | 509 | |
401 | 510 | /** |
402 | 511 | * Remove a form group field. |
512 | + * @return void |
|
403 | 513 | */ |
404 | 514 | public function removeFieldFromFormGroup(string $key): void; |
405 | 515 | |
@@ -414,21 +524,25 @@ discard block |
||
414 | 524 | |
415 | 525 | /** |
416 | 526 | * Set the show groups. |
527 | + * @return void |
|
417 | 528 | */ |
418 | 529 | public function setShowGroups(array $showGroups): void; |
419 | 530 | |
420 | 531 | /** |
421 | 532 | * Reorder items in showGroup. |
533 | + * @return void |
|
422 | 534 | */ |
423 | 535 | public function reorderShowGroup(string $group, array $keys): void; |
424 | 536 | |
425 | 537 | /** |
426 | 538 | * add a FieldDescription. |
539 | + * @return void |
|
427 | 540 | */ |
428 | 541 | public function addFormFieldDescription(string $name, FieldDescriptionInterface $fieldDescription): void; |
429 | 542 | |
430 | 543 | /** |
431 | 544 | * Remove a FieldDescription. |
545 | + * @return void |
|
432 | 546 | */ |
433 | 547 | public function removeFormFieldDescription(string $name): void; |
434 | 548 | |
@@ -446,11 +560,13 @@ discard block |
||
446 | 560 | * Adds a new class to a list of supported sub classes. |
447 | 561 | * |
448 | 562 | * @param $subClass |
563 | + * @return void |
|
449 | 564 | */ |
450 | 565 | public function addSubClass($subClass): void; |
451 | 566 | |
452 | 567 | /** |
453 | 568 | * Sets the list of supported sub classes. |
569 | + * @return void |
|
454 | 570 | */ |
455 | 571 | public function setSubClasses(array $subClasses): void; |
456 | 572 | |
@@ -489,6 +605,7 @@ discard block |
||
489 | 605 | |
490 | 606 | /** |
491 | 607 | * Returns Admin`s label. |
608 | + * @return string |
|
492 | 609 | */ |
493 | 610 | public function getLabel(): ?string; |
494 | 611 | |
@@ -503,6 +620,7 @@ discard block |
||
503 | 620 | |
504 | 621 | /** |
505 | 622 | * Set the current child status. |
623 | + * @return void |
|
506 | 624 | */ |
507 | 625 | public function setCurrentChild(bool $currentChild): void; |
508 | 626 | |
@@ -530,6 +648,7 @@ discard block |
||
530 | 648 | |
531 | 649 | /** |
532 | 650 | * @param string $mode |
651 | + * @return void |
|
533 | 652 | */ |
534 | 653 | public function setListMode($mode): void; |
535 | 654 | |
@@ -555,12 +674,14 @@ discard block |
||
555 | 674 | |
556 | 675 | /** |
557 | 676 | * Returns the result link for an object. |
677 | + * @return string|null |
|
558 | 678 | */ |
559 | 679 | public function getSearchResultLink(object $object): ?string; |
560 | 680 | |
561 | 681 | /** |
562 | 682 | * Setting to true will enable mosaic button for the admin screen. |
563 | 683 | * Setting to false will hide mosaic button for the admin screen. |
684 | + * @return void |
|
564 | 685 | */ |
565 | 686 | public function showMosaicButton(bool $isShown): void; |
566 | 687 |