@@ -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 | |
@@ -140,6 +186,9 @@ discard block |
||
140 | 186 | */ |
141 | 187 | public function getSecurityInformation(): array; |
142 | 188 | |
189 | + /** |
|
190 | + * @return void |
|
191 | + */ |
|
143 | 192 | public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void; |
144 | 193 | |
145 | 194 | /** |
@@ -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 | /** |
@@ -253,6 +339,9 @@ discard block |
||
253 | 339 | |
254 | 340 | public function getNewInstance(): object; |
255 | 341 | |
342 | + /** |
|
343 | + * @return void |
|
344 | + */ |
|
256 | 345 | public function setUniqid(string $uniqId): void; |
257 | 346 | |
258 | 347 | /** |
@@ -272,6 +361,9 @@ discard block |
||
272 | 361 | */ |
273 | 362 | public function getObject($id): ?object; |
274 | 363 | |
364 | + /** |
|
365 | + * @return void |
|
366 | + */ |
|
275 | 367 | public function setSubject(?object $subject): void; |
276 | 368 | |
277 | 369 | /** |
@@ -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 | |
@@ -342,6 +436,7 @@ discard block |
||
342 | 436 | |
343 | 437 | /** |
344 | 438 | * Add object security, fe. make the current user owner of the object. |
439 | + * @return void |
|
345 | 440 | */ |
346 | 441 | public function createObjectSecurity(object $object): void; |
347 | 442 | |
@@ -350,6 +445,9 @@ discard block |
||
350 | 445 | */ |
351 | 446 | public function getParent(): ?self; |
352 | 447 | |
448 | + /** |
|
449 | + * @return void |
|
450 | + */ |
|
353 | 451 | public function setParent(self $admin): void; |
354 | 452 | |
355 | 453 | /** |
@@ -361,6 +459,7 @@ discard block |
||
361 | 459 | * Set the translation domain. |
362 | 460 | * |
363 | 461 | * @param string $translationDomain the translation domain |
462 | + * @return void |
|
364 | 463 | */ |
365 | 464 | public function setTranslationDomain(string $translationDomain): void; |
366 | 465 | |
@@ -382,6 +481,7 @@ discard block |
||
382 | 481 | |
383 | 482 | /** |
384 | 483 | * Set the form groups. |
484 | + * @return void |
|
385 | 485 | */ |
386 | 486 | public function setFormGroups(array $formGroups): void; |
387 | 487 | |
@@ -390,6 +490,9 @@ discard block |
||
390 | 490 | */ |
391 | 491 | public function getFormTabs(); |
392 | 492 | |
493 | + /** |
|
494 | + * @return void |
|
495 | + */ |
|
393 | 496 | public function setFormTabs(array $formTabs): void; |
394 | 497 | |
395 | 498 | /** |
@@ -397,10 +500,14 @@ discard block |
||
397 | 500 | */ |
398 | 501 | public function getShowTabs(); |
399 | 502 | |
503 | + /** |
|
504 | + * @return void |
|
505 | + */ |
|
400 | 506 | public function setShowTabs(array $showTabs): void; |
401 | 507 | |
402 | 508 | /** |
403 | 509 | * Remove a form group field. |
510 | + * @return void |
|
404 | 511 | */ |
405 | 512 | public function removeFieldFromFormGroup(string $key): void; |
406 | 513 | |
@@ -415,21 +522,25 @@ discard block |
||
415 | 522 | |
416 | 523 | /** |
417 | 524 | * Set the show groups. |
525 | + * @return void |
|
418 | 526 | */ |
419 | 527 | public function setShowGroups(array $showGroups): void; |
420 | 528 | |
421 | 529 | /** |
422 | 530 | * Reorder items in showGroup. |
531 | + * @return void |
|
423 | 532 | */ |
424 | 533 | public function reorderShowGroup(string $group, array $keys): void; |
425 | 534 | |
426 | 535 | /** |
427 | 536 | * add a FieldDescription. |
537 | + * @return void |
|
428 | 538 | */ |
429 | 539 | public function addFormFieldDescription(string $name, FieldDescriptionInterface $fieldDescription): void; |
430 | 540 | |
431 | 541 | /** |
432 | 542 | * Remove a FieldDescription. |
543 | + * @return void |
|
433 | 544 | */ |
434 | 545 | public function removeFormFieldDescription(string $name): void; |
435 | 546 | |
@@ -447,11 +558,13 @@ discard block |
||
447 | 558 | * Adds a new class to a list of supported sub classes. |
448 | 559 | * |
449 | 560 | * @param $subClass |
561 | + * @return void |
|
450 | 562 | */ |
451 | 563 | public function addSubClass($subClass): void; |
452 | 564 | |
453 | 565 | /** |
454 | 566 | * Sets the list of supported sub classes. |
567 | + * @return void |
|
455 | 568 | */ |
456 | 569 | public function setSubClasses(array $subClasses): void; |
457 | 570 | |
@@ -490,6 +603,7 @@ discard block |
||
490 | 603 | |
491 | 604 | /** |
492 | 605 | * Returns Admin`s label. |
606 | + * @return string |
|
493 | 607 | */ |
494 | 608 | public function getLabel(): ?string; |
495 | 609 | |
@@ -504,6 +618,7 @@ discard block |
||
504 | 618 | |
505 | 619 | /** |
506 | 620 | * Set the current child status. |
621 | + * @return void |
|
507 | 622 | */ |
508 | 623 | public function setCurrentChild(bool $currentChild): void; |
509 | 624 | |
@@ -529,6 +644,9 @@ discard block |
||
529 | 644 | */ |
530 | 645 | public function getListModes(): array; |
531 | 646 | |
647 | + /** |
|
648 | + * @return void |
|
649 | + */ |
|
532 | 650 | public function setListMode(string $mode): void; |
533 | 651 | |
534 | 652 | /** |
@@ -553,12 +671,14 @@ discard block |
||
553 | 671 | |
554 | 672 | /** |
555 | 673 | * Returns the result link for an object. |
674 | + * @return string|null |
|
556 | 675 | */ |
557 | 676 | public function getSearchResultLink(object $object): ?string; |
558 | 677 | |
559 | 678 | /** |
560 | 679 | * Setting to true will enable mosaic button for the admin screen. |
561 | 680 | * Setting to false will hide mosaic button for the admin screen. |
681 | + * @return void |
|
562 | 682 | */ |
563 | 683 | public function showMosaicButton(bool $isShown): void; |
564 | 684 |
@@ -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; |
@@ -270,6 +276,9 @@ discard block |
||
270 | 276 | return null !== $this->associationAdmin; |
271 | 277 | } |
272 | 278 | |
279 | + /** |
|
280 | + * @param string $fieldName |
|
281 | + */ |
|
273 | 282 | public function getFieldValue(?object $object, ?string $fieldName) |
274 | 283 | { |
275 | 284 | if ($this->isVirtual() || null === $object) { |
@@ -20,6 +20,7 @@ discard block |
||
20 | 20 | { |
21 | 21 | /** |
22 | 22 | * set the field name. |
23 | + * @return void |
|
23 | 24 | */ |
24 | 25 | public function setFieldName(?string $fieldName): void; |
25 | 26 | |
@@ -32,6 +33,7 @@ discard block |
||
32 | 33 | |
33 | 34 | /** |
34 | 35 | * Set the name. |
36 | + * @return void |
|
35 | 37 | */ |
36 | 38 | public function setName(?string $name): void; |
37 | 39 | |
@@ -55,6 +57,7 @@ discard block |
||
55 | 57 | * Define an option, an option is has a name and a value. |
56 | 58 | * |
57 | 59 | * @param mixed $value |
60 | + * @return void |
|
58 | 61 | */ |
59 | 62 | public function setOption(string $name, $value): void; |
60 | 63 | |
@@ -66,6 +69,7 @@ discard block |
||
66 | 69 | * Then the value are copied across to the related property value. |
67 | 70 | * |
68 | 71 | * @param array<string, mixed> $options |
72 | + * @return void |
|
69 | 73 | */ |
70 | 74 | public function setOptions(array $options): void; |
71 | 75 | |
@@ -78,6 +82,7 @@ discard block |
||
78 | 82 | |
79 | 83 | /** |
80 | 84 | * Sets the template used to render the field. |
85 | + * @return void |
|
81 | 86 | */ |
82 | 87 | public function setTemplate(string $template): void; |
83 | 88 | |
@@ -91,21 +96,25 @@ discard block |
||
91 | 96 | /** |
92 | 97 | * Sets the field type. The type is a mandatory field as it's used to select the correct template |
93 | 98 | * or the logic associated to the current FieldDescription object. |
99 | + * @return void |
|
94 | 100 | */ |
95 | 101 | public function setType(?string $type): void; |
96 | 102 | |
97 | 103 | /** |
98 | 104 | * Returns the type. |
105 | + * @return string |
|
99 | 106 | */ |
100 | 107 | public function getType(): ?string; |
101 | 108 | |
102 | 109 | /** |
103 | 110 | * set the parent Admin (only used in nested admin). |
111 | + * @return void |
|
104 | 112 | */ |
105 | 113 | public function setParent(AdminInterface $parent); |
106 | 114 | |
107 | 115 | /** |
108 | 116 | * Returns the parent Admin (only used in nested admin). |
117 | + * @return AdminInterface|null |
|
109 | 118 | */ |
110 | 119 | public function getParent(): ?AdminInterface; |
111 | 120 | |
@@ -121,6 +130,7 @@ discard block |
||
121 | 130 | |
122 | 131 | /** |
123 | 132 | * Returns the related Target Entity. |
133 | + * @return string |
|
124 | 134 | */ |
125 | 135 | public function getTargetEntity(): ?string; |
126 | 136 | |
@@ -152,11 +162,13 @@ discard block |
||
152 | 162 | * set the association admin instance (only used if the field is linked to an Admin). |
153 | 163 | * |
154 | 164 | * @param AdminInterface $associationAdmin the associated admin |
165 | + * @return void |
|
155 | 166 | */ |
156 | 167 | public function setAssociationAdmin(AdminInterface $associationAdmin); |
157 | 168 | |
158 | 169 | /** |
159 | 170 | * Returns the associated Admin instance (only used if the field is linked to an Admin). |
171 | + * @return AdminInterface |
|
160 | 172 | */ |
161 | 173 | public function getAssociationAdmin(): ?AdminInterface; |
162 | 174 | |
@@ -174,6 +186,7 @@ discard block |
||
174 | 186 | |
175 | 187 | /** |
176 | 188 | * set the admin class linked to this FieldDescription. |
189 | + * @return void |
|
177 | 190 | */ |
178 | 191 | public function setAdmin(AdminInterface $admin); |
179 | 192 | |
@@ -186,11 +199,13 @@ discard block |
||
186 | 199 | * merge option values related to the provided option name. |
187 | 200 | * |
188 | 201 | * @throws \RuntimeException |
202 | + * @return void |
|
189 | 203 | */ |
190 | 204 | public function mergeOption(string $name, array $options = []): void; |
191 | 205 | |
192 | 206 | /** |
193 | 207 | * merge options values. |
208 | + * @return void |
|
194 | 209 | */ |
195 | 210 | public function mergeOptions(array $options = []): void; |
196 | 211 | |
@@ -198,6 +213,7 @@ discard block |
||
198 | 213 | * set the original mapping type (only used if the field is linked to an entity). |
199 | 214 | * |
200 | 215 | * @param string|int $mappingType |
216 | + * @return void |
|
201 | 217 | */ |
202 | 218 | public function setMappingType($mappingType); |
203 | 219 |