Add missing return types

symfony · Apr 28, 2023 · cb76849 · cb76849
1 parent 8428ce6
commit cb76849
Show file tree

Hide file tree

Showing 8 changed files with 111 additions and 3 deletions.
diff --git a/AbstractType.php b/AbstractType.php
@@ -48,11 +48,17 @@ public function configureOptions(OptionsResolver $resolver)
     {
     }
 
+    /**
+     * @return string
+     */
     public function getBlockPrefix()
     {
         return StringUtil::fqcnToBlockPrefix(static::class) ?: '';
     }
 
+    /**
+     * @return string|null
+     */
     public function getParent()
     {
         return FormType::class;

diff --git a/ButtonBuilder.php b/ButtonBuilder.php
@@ -52,6 +52,8 @@ public function __construct(?string $name, array $options = [])
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function add(string|FormBuilderInterface $child, string $type = null, array $options = []): static
@@ -62,6 +64,8 @@ public function add(string|FormBuilderInterface $child, string $type = null, arr
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function create(string $name, string $type = null, array $options = []): FormBuilderInterface
@@ -72,6 +76,8 @@ public function create(string $name, string $type = null, array $options = []):
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function get(string $name): FormBuilderInterface
@@ -82,6 +88,8 @@ public function get(string $name): FormBuilderInterface
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function remove(string $name): static
@@ -116,6 +124,8 @@ public function getForm(): Button
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function addEventListener(string $eventName, callable $listener, int $priority = 0): static
@@ -126,6 +136,8 @@ public function addEventListener(string $eventName, callable $listener, int $pri
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function addEventSubscriber(EventSubscriberInterface $subscriber): static
@@ -136,6 +148,8 @@ public function addEventSubscriber(EventSubscriberInterface $subscriber): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false): static
@@ -146,6 +160,8 @@ public function addViewTransformer(DataTransformerInterface $viewTransformer, bo
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function resetViewTransformers(): static
@@ -156,6 +172,8 @@ public function resetViewTransformers(): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false): static
@@ -166,6 +184,8 @@ public function addModelTransformer(DataTransformerInterface $modelTransformer,
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function resetModelTransformers(): static
@@ -196,6 +216,8 @@ public function setAttributes(array $attributes): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setDataMapper(DataMapperInterface $dataMapper = null): static
@@ -222,6 +244,8 @@ public function setDisabled(bool $disabled): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setEmptyData(mixed $emptyData): static
@@ -232,6 +256,8 @@ public function setEmptyData(mixed $emptyData): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setErrorBubbling(bool $errorBubbling): static
@@ -242,6 +268,8 @@ public function setErrorBubbling(bool $errorBubbling): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setRequired(bool $required): static
@@ -252,6 +280,8 @@ public function setRequired(bool $required): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setPropertyPath(string|PropertyPathInterface|null $propertyPath): static
@@ -262,6 +292,8 @@ public function setPropertyPath(string|PropertyPathInterface|null $propertyPath)
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setMapped(bool $mapped): static
@@ -272,6 +304,8 @@ public function setMapped(bool $mapped): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setByReference(bool $byReference): static
@@ -282,6 +316,8 @@ public function setByReference(bool $byReference): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setCompound(bool $compound): static
@@ -304,6 +340,8 @@ public function setType(ResolvedFormTypeInterface $type): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setData(mixed $data): static
@@ -314,6 +352,8 @@ public function setData(mixed $data): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setDataLocked(bool $locked): static
@@ -324,6 +364,8 @@ public function setDataLocked(bool $locked): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setFormFactory(FormFactoryInterface $formFactory)
@@ -334,6 +376,8 @@ public function setFormFactory(FormFactoryInterface $formFactory)
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setAction(string $action): static
@@ -344,6 +388,8 @@ public function setAction(string $action): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setMethod(string $method): static
@@ -354,6 +400,8 @@ public function setMethod(string $method): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setRequestHandler(RequestHandlerInterface $requestHandler): static
@@ -380,6 +428,8 @@ public function setAutoInitialize(bool $initialize): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setInheritData(bool $inheritData): static
@@ -402,6 +452,8 @@ public function getFormConfig(): FormConfigInterface
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function setIsEmptyCallback(?callable $isEmptyCallback): static
@@ -412,6 +464,8 @@ public function setIsEmptyCallback(?callable $isEmptyCallback): static
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function getEventDispatcher(): EventDispatcherInterface
@@ -570,6 +624,8 @@ public function getDataLocked(): bool
 
     /**
      * Unsupported method.
+     *
+     * @return never
      */
     public function getFormFactory(): FormFactoryInterface
     {
@@ -579,6 +635,8 @@ public function getFormFactory(): FormFactoryInterface
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function getAction(): string
@@ -589,6 +647,8 @@ public function getAction(): string
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function getMethod(): string
@@ -599,6 +659,8 @@ public function getMethod(): string
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function getRequestHandler(): RequestHandlerInterface
@@ -649,6 +711,8 @@ public function getOption(string $name, mixed $default = null): mixed
     /**
      * Unsupported method.
      *
+     * @return never
+     *
      * @throws BadMethodCallException
      */
     public function getIsEmptyCallback(): ?callable

diff --git a/Extension/Core/DataAccessor/PropertyPathAccessor.php b/Extension/Core/DataAccessor/PropertyPathAccessor.php
@@ -74,7 +74,7 @@ public function isWritable(object|array $data, FormInterface $form): bool
         return null !== $form->getPropertyPath();
     }
 
-    private function getPropertyValue(object|array $data, PropertyPathInterface $propertyPath)
+    private function getPropertyValue(object|array $data, PropertyPathInterface $propertyPath): mixed
     {
         try {
             return $this->propertyAccessor->getValue($data, $propertyPath);

diff --git a/Extension/Core/Type/ChoiceType.php b/Extension/Core/Type/ChoiceType.php
@@ -62,6 +62,9 @@ public function __construct(ChoiceListFactoryInterface $choiceListFactory = null
         $this->translator = $translator;
     }
 
+    /**
+     * @return void
+     */
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
         $unknownValues = [];
@@ -215,6 +218,9 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         }, 256);
     }
 
+    /**
+     * @return void
+     */
     public function buildView(FormView $view, FormInterface $form, array $options)
     {
         $choiceTranslationDomain = $options['choice_translation_domain'];
@@ -269,6 +275,9 @@ public function buildView(FormView $view, FormInterface $form, array $options)
         }
     }
 
+    /**
+     * @return void
+     */
     public function finishView(FormView $view, FormInterface $form, array $options)
     {
         if ($options['expanded']) {
@@ -286,6 +295,9 @@ public function finishView(FormView $view, FormInterface $form, array $options)
         }
     }
 
+    /**
+     * @return void
+     */
     public function configureOptions(OptionsResolver $resolver)
     {
         $emptyData = static function (Options $options) {
@@ -383,7 +395,7 @@ public function getBlockPrefix(): string
     /**
      * Adds the sub fields for an expanded choice field.
      */
-    private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options)
+    private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options): void
     {
         foreach ($choiceViews as $name => $choiceView) {
             // Flatten groups
@@ -401,7 +413,7 @@ private function addSubForms(FormBuilderInterface $builder, array $choiceViews,
         }
     }
 
-    private function addSubForm(FormBuilderInterface $builder, string $name, ChoiceView $choiceView, array $options)
+    private function addSubForm(FormBuilderInterface $builder, string $name, ChoiceView $choiceView, array $options): void
     {
         $choiceOpts = [
             'value' => $choiceView->value,