Skip to content

Commit be4ba59

Browse files
nicolas-grekasnicolas-grekas
committed
Cleanup more @return annotations
1 parent ee58990 commit be4ba59

File tree

55 files changed

+211
-213
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+211
-213
lines changed

‎AbstractRendererEngine.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ public function getResourceHierarchyLevel(FormView $view, array $blockNameHierar
132132
*
133133
* @see getResourceForBlock()
134134
*
135-
* @return bool True if the resource could be loaded, false otherwise
135+
* @return bool
136136
*/
137137
abstract protected function loadResourceForBlockName(string $cacheKey, FormView $view, string $blockName);
138138

‎Button.php

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function __construct(FormConfigInterface $config)
4949
*
5050
* @param mixed $offset
5151
*
52-
* @return bool Always returns false
52+
* @return bool
5353
*/
5454
#[\ReturnTypeWillChange]
5555
public function offsetExists($offset)
@@ -158,7 +158,7 @@ public function get(string $name)
158158
/**
159159
* Unsupported method.
160160
*
161-
* @return bool Always returns false
161+
* @return bool
162162
*/
163163
public function has(string $name)
164164
{
@@ -235,7 +235,7 @@ public function getViewData()
235235
/**
236236
* Unsupported method.
237237
*
238-
* @return array Always returns an empty array
238+
* @return array
239239
*/
240240
public function getExtraData()
241241
{
@@ -255,7 +255,7 @@ public function getConfig()
255255
/**
256256
* Returns whether the button is submitted.
257257
*
258-
* @return bool true if the button was submitted
258+
* @return bool
259259
*/
260260
public function isSubmitted()
261261
{
@@ -265,7 +265,7 @@ public function isSubmitted()
265265
/**
266266
* Returns the name by which the button is identified in forms.
267267
*
268-
* @return string The name of the button
268+
* @return string
269269
*/
270270
public function getName()
271271
{
@@ -293,7 +293,7 @@ public function addError(FormError $error)
293293
/**
294294
* Unsupported method.
295295
*
296-
* @return bool Always returns true
296+
* @return bool
297297
*/
298298
public function isValid()
299299
{
@@ -303,7 +303,7 @@ public function isValid()
303303
/**
304304
* Unsupported method.
305305
*
306-
* @return bool Always returns false
306+
* @return bool
307307
*/
308308
public function isRequired()
309309
{
@@ -325,7 +325,7 @@ public function isDisabled()
325325
/**
326326
* Unsupported method.
327327
*
328-
* @return bool Always returns true
328+
* @return bool
329329
*/
330330
public function isEmpty()
331331
{
@@ -335,7 +335,7 @@ public function isEmpty()
335335
/**
336336
* Unsupported method.
337337
*
338-
* @return bool Always returns true
338+
* @return bool
339339
*/
340340
public function isSynchronized()
341341
{
@@ -432,7 +432,7 @@ public function createView(FormView $parent = null)
432432
/**
433433
* Unsupported method.
434434
*
435-
* @return int Always returns 0
435+
* @return int
436436
*/
437437
#[\ReturnTypeWillChange]
438438
public function count()
@@ -443,7 +443,7 @@ public function count()
443443
/**
444444
* Unsupported method.
445445
*
446-
* @return \EmptyIterator Always returns an empty iterator
446+
* @return \EmptyIterator
447447
*/
448448
#[\ReturnTypeWillChange]
449449
public function getIterator()

‎ButtonBuilder.php

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ public function remove(string $name)
107107
/**
108108
* Unsupported method.
109109
*
110-
* @return bool Always returns false
110+
* @return bool
111111
*/
112112
public function has(string $name)
113113
{
@@ -117,7 +117,7 @@ public function has(string $name)
117117
/**
118118
* Returns the children.
119119
*
120-
* @return array Always returns an empty array
120+
* @return array
121121
*/
122122
public function all()
123123
{
@@ -127,7 +127,7 @@ public function all()
127127
/**
128128
* Creates the button.
129129
*
130-
* @return Button The button
130+
* @return Button
131131
*/
132132
public function getForm()
133133
{
@@ -457,7 +457,7 @@ public function getPropertyPath()
457457
/**
458458
* Unsupported method.
459459
*
460-
* @return bool Always returns false
460+
* @return bool
461461
*/
462462
public function getMapped()
463463
{
@@ -467,7 +467,7 @@ public function getMapped()
467467
/**
468468
* Unsupported method.
469469
*
470-
* @return bool Always returns false
470+
* @return bool
471471
*/
472472
public function getByReference()
473473
{
@@ -477,7 +477,7 @@ public function getByReference()
477477
/**
478478
* Unsupported method.
479479
*
480-
* @return bool Always returns false
480+
* @return bool
481481
*/
482482
public function getCompound()
483483
{
@@ -487,7 +487,7 @@ public function getCompound()
487487
/**
488488
* Returns the form type used to construct the button.
489489
*
490-
* @return ResolvedFormTypeInterface The button's type
490+
* @return ResolvedFormTypeInterface
491491
*/
492492
public function getType()
493493
{
@@ -497,7 +497,7 @@ public function getType()
497497
/**
498498
* Unsupported method.
499499
*
500-
* @return array Always returns an empty array
500+
* @return array
501501
*/
502502
public function getViewTransformers()
503503
{
@@ -507,7 +507,7 @@ public function getViewTransformers()
507507
/**
508508
* Unsupported method.
509509
*
510-
* @return array Always returns an empty array
510+
* @return array
511511
*/
512512
public function getModelTransformers()
513513
{
@@ -525,7 +525,7 @@ public function getDataMapper()
525525
/**
526526
* Unsupported method.
527527
*
528-
* @return bool Always returns false
528+
* @return bool
529529
*/
530530
public function getRequired()
531531
{
@@ -535,7 +535,7 @@ public function getRequired()
535535
/**
536536
* Returns whether the button is disabled.
537537
*
538-
* @return bool Whether the button is disabled
538+
* @return bool
539539
*/
540540
public function getDisabled()
541541
{
@@ -545,7 +545,7 @@ public function getDisabled()
545545
/**
546546
* Unsupported method.
547547
*
548-
* @return bool Always returns false
548+
* @return bool
549549
*/
550550
public function getErrorBubbling()
551551
{
@@ -563,7 +563,7 @@ public function getEmptyData()
563563
/**
564564
* Returns additional attributes of the button.
565565
*
566-
* @return array An array of key-value combinations
566+
* @return array
567567
*/
568568
public function getAttributes()
569569
{
@@ -573,7 +573,7 @@ public function getAttributes()
573573
/**
574574
* Returns whether the attribute with the given name exists.
575575
*
576-
* @return bool Whether the attribute exists
576+
* @return bool
577577
*/
578578
public function hasAttribute(string $name)
579579
{
@@ -585,7 +585,7 @@ public function hasAttribute(string $name)
585585
*
586586
* @param mixed $default The value returned if the attribute does not exist
587587
*
588-
* @return mixed The attribute value
588+
* @return mixed
589589
*/
590590
public function getAttribute(string $name, $default = null)
591591
{
@@ -611,7 +611,7 @@ public function getDataClass()
611611
/**
612612
* Unsupported method.
613613
*
614-
* @return bool Always returns false
614+
* @return bool
615615
*/
616616
public function getDataLocked()
617617
{
@@ -659,7 +659,7 @@ public function getRequestHandler()
659659
/**
660660
* Unsupported method.
661661
*
662-
* @return bool Always returns false
662+
* @return bool
663663
*/
664664
public function getAutoInitialize()
665665
{
@@ -669,7 +669,7 @@ public function getAutoInitialize()
669669
/**
670670
* Unsupported method.
671671
*
672-
* @return bool Always returns false
672+
* @return bool
673673
*/
674674
public function getInheritData()
675675
{
@@ -679,7 +679,7 @@ public function getInheritData()
679679
/**
680680
* Returns all options passed during the construction of the button.
681681
*
682-
* @return array The passed options
682+
* @return array
683683
*/
684684
public function getOptions()
685685
{
@@ -689,7 +689,7 @@ public function getOptions()
689689
/**
690690
* Returns whether a specific option exists.
691691
*
692-
* @return bool Whether the option exists
692+
* @return bool
693693
*/
694694
public function hasOption(string $name)
695695
{
@@ -701,7 +701,7 @@ public function hasOption(string $name)
701701
*
702702
* @param mixed $default The value returned if the option does not exist
703703
*
704-
* @return mixed The option value
704+
* @return mixed
705705
*/
706706
public function getOption(string $name, $default = null)
707707
{
@@ -721,7 +721,7 @@ public function getIsEmptyCallback(): ?callable
721721
/**
722722
* Unsupported method.
723723
*
724-
* @return int Always returns 0
724+
* @return int
725725
*/
726726
#[\ReturnTypeWillChange]
727727
public function count()
@@ -732,7 +732,7 @@ public function count()
732732
/**
733733
* Unsupported method.
734734
*
735-
* @return \EmptyIterator Always returns an empty iterator
735+
* @return \EmptyIterator
736736
*/
737737
#[\ReturnTypeWillChange]
738738
public function getIterator()

‎ChoiceList/ChoiceListInterface.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public function getChoices();
5555
* Null and false MUST NOT conflict when being casted to string.
5656
* For this some default incremented values SHOULD be computed.
5757
*
58-
* @return string[] The choice values
58+
* @return string[]
5959
*/
6060
public function getValues();
6161

@@ -86,7 +86,7 @@ public function getValues();
8686
* this method SHOULD be equivalent to {@link getValues()}.
8787
* The $groupBy callback parameter SHOULD be used instead.
8888
*
89-
* @return string[] The choice values
89+
* @return string[]
9090
*/
9191
public function getStructuredValues();
9292

@@ -121,7 +121,7 @@ public function getOriginalKeys();
121121
* @param string[] $values An array of choice values. Non-existing values in
122122
* this array are ignored
123123
*
124-
* @return array An array of choices
124+
* @return array
125125
*/
126126
public function getChoicesForValues(array $values);
127127

@@ -134,7 +134,7 @@ public function getChoicesForValues(array $values);
134134
* @param array $choices An array of choices. Non-existing choices in this
135135
* array are ignored
136136
*
137-
* @return string[] An array of choice values
137+
* @return string[]
138138
*/
139139
public function getValuesForChoices(array $choices);
140140
}

‎ChoiceList/Factory/CachingFactoryDecorator.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public function __construct(ChoiceListFactoryInterface $decoratedFactory)
7474
/**
7575
* Returns the decorated factory.
7676
*
77-
* @return ChoiceListFactoryInterface The decorated factory
77+
* @return ChoiceListFactoryInterface
7878
*/
7979
public function getDecoratedFactory()
8080
{

‎ChoiceList/Factory/ChoiceListFactoryInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ interface ChoiceListFactoryInterface
3333
*
3434
* @param callable|null $filter The callable filtering the choices
3535
*
36-
* @return ChoiceListInterface The choice list
36+
* @return ChoiceListInterface
3737
*/
3838
public function createListFromChoices(iterable $choices, callable $value = null/*, callable $filter = null*/);
3939

@@ -46,7 +46,7 @@ public function createListFromChoices(iterable $choices, callable $value = null/
4646
*
4747
* @param callable|null $filter The callable filtering the choices
4848
*
49-
* @return ChoiceListInterface The choice list
49+
* @return ChoiceListInterface
5050
*/
5151
public function createListFromLoader(ChoiceLoaderInterface $loader, callable $value = null/*, callable $filter = null*/);
5252

@@ -82,7 +82,7 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, callable $va
8282
* @param array|callable|null $attr The callable generating the HTML attributes
8383
* @param array|callable $labelTranslationParameters The parameters used to translate the choice labels
8484
*
85-
* @return ChoiceListView The choice list view
85+
* @return ChoiceListView
8686
*/
8787
public function createView(ChoiceListInterface $list, $preferredChoices = null, $label = null, callable $index = null, callable $groupBy = null, $attr = null/*, $labelTranslationParameters = []*/);
8888
}

‎ChoiceList/Factory/PropertyAccessDecorator.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public function __construct(ChoiceListFactoryInterface $decoratedFactory, Proper
5050
/**
5151
* Returns the decorated factory.
5252
*
53-
* @return ChoiceListFactoryInterface The decorated factory
53+
* @return ChoiceListFactoryInterface
5454
*/
5555
public function getDecoratedFactory()
5656
{

0 commit comments

Comments
 (0)