@@ -44,6 +44,8 @@ |
||
44 | 44 | |
45 | 45 | /** |
46 | 46 | * @param FieldDescriptionInterface|string $name |
47 | + * @param string $type |
|
48 | + * @param string $fieldType |
|
47 | 49 | * |
48 | 50 | * @throws \LogicException |
49 | 51 | */ |
@@ -41,6 +41,7 @@ |
||
41 | 41 | |
42 | 42 | /** |
43 | 43 | * @param FieldDescriptionInterface|string $name |
44 | + * @param string $type |
|
44 | 45 | * |
45 | 46 | * @throws \LogicException |
46 | 47 | */ |
@@ -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 | |
@@ -380,6 +479,7 @@ discard block |
||
380 | 479 | |
381 | 480 | /** |
382 | 481 | * Set the form groups. |
482 | + * @return void |
|
383 | 483 | */ |
384 | 484 | public function setFormGroups(array $formGroups): void; |
385 | 485 | |
@@ -388,6 +488,9 @@ discard block |
||
388 | 488 | */ |
389 | 489 | public function getFormTabs(): array; |
390 | 490 | |
491 | + /** |
|
492 | + * @return void |
|
493 | + */ |
|
391 | 494 | public function setFormTabs(array $formTabs): void; |
392 | 495 | |
393 | 496 | /** |
@@ -395,10 +498,14 @@ discard block |
||
395 | 498 | */ |
396 | 499 | public function getShowTabs(): array; |
397 | 500 | |
501 | + /** |
|
502 | + * @return void |
|
503 | + */ |
|
398 | 504 | public function setShowTabs(array $showTabs): void; |
399 | 505 | |
400 | 506 | /** |
401 | 507 | * Remove a form group field. |
508 | + * @return void |
|
402 | 509 | */ |
403 | 510 | public function removeFieldFromFormGroup(string $key): void; |
404 | 511 | |
@@ -411,21 +518,25 @@ discard block |
||
411 | 518 | |
412 | 519 | /** |
413 | 520 | * Set the show groups. |
521 | + * @return void |
|
414 | 522 | */ |
415 | 523 | public function setShowGroups(array $showGroups): void; |
416 | 524 | |
417 | 525 | /** |
418 | 526 | * Reorder items in showGroup. |
527 | + * @return void |
|
419 | 528 | */ |
420 | 529 | public function reorderShowGroup(string $group, array $keys): void; |
421 | 530 | |
422 | 531 | /** |
423 | 532 | * add a FieldDescription. |
533 | + * @return void |
|
424 | 534 | */ |
425 | 535 | public function addFormFieldDescription(string $name, FieldDescriptionInterface $fieldDescription): void; |
426 | 536 | |
427 | 537 | /** |
428 | 538 | * Remove a FieldDescription. |
539 | + * @return void |
|
429 | 540 | */ |
430 | 541 | public function removeFormFieldDescription(string $name): void; |
431 | 542 | |
@@ -443,11 +554,13 @@ discard block |
||
443 | 554 | * Adds a new class to a list of supported sub classes. |
444 | 555 | * |
445 | 556 | * @param $subClass |
557 | + * @return void |
|
446 | 558 | */ |
447 | 559 | public function addSubClass($subClass): void; |
448 | 560 | |
449 | 561 | /** |
450 | 562 | * Sets the list of supported sub classes. |
563 | + * @return void |
|
451 | 564 | */ |
452 | 565 | public function setSubClasses(array $subClasses): void; |
453 | 566 | |
@@ -486,6 +599,7 @@ discard block |
||
486 | 599 | |
487 | 600 | /** |
488 | 601 | * Returns Admin`s label. |
602 | + * @return string |
|
489 | 603 | */ |
490 | 604 | public function getLabel(): ?string; |
491 | 605 | |
@@ -500,6 +614,7 @@ discard block |
||
500 | 614 | |
501 | 615 | /** |
502 | 616 | * Set the current child status. |
617 | + * @return void |
|
503 | 618 | */ |
504 | 619 | public function setCurrentChild(bool $currentChild): void; |
505 | 620 | |
@@ -525,6 +640,9 @@ discard block |
||
525 | 640 | */ |
526 | 641 | public function getListModes(): array; |
527 | 642 | |
643 | + /** |
|
644 | + * @return void |
|
645 | + */ |
|
528 | 646 | public function setListMode(string $mode): void; |
529 | 647 | |
530 | 648 | /** |
@@ -549,12 +667,14 @@ discard block |
||
549 | 667 | |
550 | 668 | /** |
551 | 669 | * Returns the result link for an object. |
670 | + * @return string|null |
|
552 | 671 | */ |
553 | 672 | public function getSearchResultLink(object $object): ?string; |
554 | 673 | |
555 | 674 | /** |
556 | 675 | * Setting to true will enable mosaic button for the admin screen. |
557 | 676 | * Setting to false will hide mosaic button for the admin screen. |
677 | + * @return void |
|
558 | 678 | */ |
559 | 679 | public function showMosaicButton(bool $isShown): void; |
560 | 680 |
@@ -43,7 +43,7 @@ |
||
43 | 43 | } |
44 | 44 | |
45 | 45 | /** |
46 | - * @param FieldDescriptionInterface|string $name |
|
46 | + * @param \Sonata\AdminBundle\Admin\BaseFieldDescription $name |
|
47 | 47 | */ |
48 | 48 | public function addIdentifier($name, ?string $type = null, array $fieldDescriptionOptions = []): self |
49 | 49 | { |