refactor #167 Add more return types and fix missing typehints (sstok)

This PR was merged into the 2.0-dev branch. labels: bc-break Discussion ---------- | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | yes | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | This should be the last major BC break, all types, type extensions etc. now have return types (including void). Commits ------- 58b052b Add more return types and fix missing typehints
rollerworks · Aug 16, 2017 · 62df166 · 62df166
2 parents 55798d5 + 58b052b
commit 62df166
Show file tree

Hide file tree

Showing 56 changed files with 153 additions and 151 deletions.
diff --git a/src/ConditionErrorMessage.php b/src/ConditionErrorMessage.php
@@ -113,10 +113,14 @@ public static function rawMessage(string $path, string $message, $cause = null):
     /**
      * @param array $translatedParameters An array of parameter names that need
      *                                    to be translated prior to there usage
+     *
+     * @return $this
      */
-    public function setTranslatedParameters(array $translatedParameters)
+    public function setTranslatedParameters(array $translatedParameters): self
     {
         $this->translatedParameters = $translatedParameters;
+
+        return $this;
     }
 
     public function __toString(): string

diff --git a/src/ConditionOptimizer/ChainOptimizer.php b/src/ConditionOptimizer/ChainOptimizer.php
@@ -49,7 +49,7 @@ public static function create(): ChainOptimizer
      *
      * @throws \InvalidArgumentException
      *
-     * @return self
+     * @return $this
      */
     public function addOptimizer(SearchConditionOptimizer $optimizer)
     {
@@ -72,7 +72,7 @@ public function addOptimizer(SearchConditionOptimizer $optimizer)
     /**
      * {@inheritdoc}
      */
-    public function process(SearchCondition $condition)
+    public function process(SearchCondition $condition): void
     {
         krsort($this->optimizers, SORT_NUMERIC);
 

diff --git a/src/ConditionOptimizer/DuplicateRemover.php b/src/ConditionOptimizer/DuplicateRemover.php
@@ -40,7 +40,7 @@
  */
 final class DuplicateRemover implements SearchConditionOptimizer
 {
-    public function process(SearchCondition $condition)
+    public function process(SearchCondition $condition): void
     {
         $this->removeDuplicatesInGroup($condition->getValuesGroup(), $condition->getFieldSet());
     }
@@ -50,7 +50,7 @@ public function getPriority(): int
         return 5;
     }
 
-    private function removeDuplicatesInGroup(ValuesGroup $valuesGroup, FieldSet $fieldSet)
+    private function removeDuplicatesInGroup(ValuesGroup $valuesGroup, FieldSet $fieldSet): void
     {
         foreach ($valuesGroup->getFields() as $fieldName => $values) {
             $this->removeDuplicatesInValuesBag($fieldSet->get($fieldName), $values);
@@ -62,7 +62,7 @@ private function removeDuplicatesInGroup(ValuesGroup $valuesGroup, FieldSet $fie
         }
     }
 
-    private function removeDuplicatesInValuesBag(FieldConfig $config, ValuesBag $valuesBag)
+    private function removeDuplicatesInValuesBag(FieldConfig $config, ValuesBag $valuesBag): void
     {
         $comparator = $config->getValueComparator();
         $options = $config->getOptions();
@@ -82,8 +82,8 @@ private function removeDuplicateValues(
         ValuesBag $valuesBag,
         ValueComparator $comparator,
         array $options,
-        $exclude = false
-    ) {
+        bool $exclude = false
+    ): void {
         foreach ($values as $i => $value) {
             foreach ($values as $c => $value2) {
                 if ($i === $c || !$comparator->isEqual($value, $value2, $options)) {

diff --git a/src/ConditionOptimizer/RangeOptimizer.php b/src/ConditionOptimizer/RangeOptimizer.php
@@ -30,7 +30,7 @@
  */
 final class RangeOptimizer implements SearchConditionOptimizer
 {
-    public function process(SearchCondition $condition)
+    public function process(SearchCondition $condition): void
     {
         $fieldSet = $condition->getFieldSet();
         $supportsRanges = false;
@@ -56,7 +56,7 @@ public function getPriority(): int
         return -5;
     }
 
-    private function normalizeRangesInGroup(ValuesGroup $valuesGroup, FieldSet $fieldSet)
+    private function normalizeRangesInGroup(ValuesGroup $valuesGroup, FieldSet $fieldSet): void
     {
         foreach ($valuesGroup->getFields() as $fieldName => $values) {
             $config = $fieldSet->get($fieldName);
@@ -71,7 +71,7 @@ private function normalizeRangesInGroup(ValuesGroup $valuesGroup, FieldSet $fiel
         }
     }
 
-    private function normalizeRangesInValuesBag(FieldConfig $config, ValuesBag $valuesBag)
+    private function normalizeRangesInValuesBag(FieldConfig $config, ValuesBag $valuesBag): void
     {
         $comparator = $config->getValueComparator();
         $options = $config->getOptions();
@@ -151,7 +151,7 @@ private function removeOverlappingSingleValues(
         ValueComparator $comparator,
         array $options,
         bool $exclude = false
-    ) {
+    ): void {
         foreach ($ranges as $i => $range) {
             foreach ($singleValues as $c => $value) {
                 if ($this->isValInRange($value, $range, $comparator, $options)) {
@@ -180,7 +180,7 @@ private function removeOverlappingRanges(
         ValuesBag $valuesBag,
         ValueComparator $comparator,
         array $options
-    ) {
+    ): void {
         foreach ($ranges as $i => $range) {
             // If the range is already removed just ignore it.
             if (!isset($ranges[$i])) {
@@ -219,7 +219,7 @@ private function optimizeConnectedRanges(
         ValueComparator $comparator,
         array $options,
         bool $exclude = false
-    ) {
+    ): void {
         $class = $exclude ? ExcludedRange::class : Range::class;
 
         foreach ($ranges as $i => $range) {
@@ -300,12 +300,12 @@ private function isRangeInRange(Range $range1, Range $range, ValueComparator $co
 
     private function isBoundEqual(
         ValueComparator $comparator,
-        $options,
+        array $options,
         $value1,
         $value2,
-        $value1Inclusive,
-        $value2Inclusive
-    ) {
+        bool $value1Inclusive,
+        bool $value2Inclusive
+    ): bool {
         if (!$comparator->isEqual($value1, $value2, $options)) {
             return false;
         }

diff --git a/src/ConditionOptimizer/ValuesToRange.php b/src/ConditionOptimizer/ValuesToRange.php
@@ -32,7 +32,7 @@ final class ValuesToRange implements SearchConditionOptimizer
 {
     private $comparators = [];
 
-    public function process(SearchCondition $condition)
+    public function process(SearchCondition $condition): void
     {
         $fieldSet = $condition->getFieldSet();
         $valuesGroup = $condition->getValuesGroup();

diff --git a/src/Exporter/JsonExporter.php b/src/Exporter/JsonExporter.php
@@ -42,7 +42,7 @@ public function __construct(ArrayExporter $arrayExporter = null)
      *
      * @return string
      */
-    public function exportCondition(SearchCondition $condition)
+    public function exportCondition(SearchCondition $condition): string
     {
         return json_encode($this->exporter->exportCondition($condition));
     }

diff --git a/src/Exporter/XmlExporter.php b/src/Exporter/XmlExporter.php
@@ -71,7 +71,7 @@ protected function exportGroup(ValuesGroup $valuesGroup, FieldSet $fieldSet, boo
         // no-op
     }
 
-    private function exportGroupNode(\DOMNode $parent, ValuesGroup $valuesGroup, FieldSet $fieldSet)
+    private function exportGroupNode(\DOMNode $parent, ValuesGroup $valuesGroup, FieldSet $fieldSet): void
     {
         $fields = $valuesGroup->getFields();
 
@@ -108,7 +108,7 @@ private function exportGroupNode(\DOMNode $parent, ValuesGroup $valuesGroup, Fie
         }
     }
 
-    private function exportValuesToNode(ValuesBag $valuesBag, \DOMNode $parent, FieldConfig $field)
+    private function exportValuesToNode(ValuesBag $valuesBag, \DOMNode $parent, FieldConfig $field): void
     {
         if ($valuesBag->hasSimpleValues()) {
             $valuesNode = $this->document->createElement('simple-values');
@@ -198,7 +198,7 @@ private function exportValuesToNode(ValuesBag $valuesBag, \DOMNode $parent, Fiel
         }
     }
 
-    private function exportRangeValueToNode(\DOMNode $parent, Range $range, FieldConfig $field)
+    private function exportRangeValueToNode(\DOMNode $parent, Range $range, FieldConfig $field): void
     {
         $rangeNode = $this->document->createElement('range');
 

diff --git a/src/Extension/Core/ChoiceList/ArrayChoiceList.php b/src/Extension/Core/ChoiceList/ArrayChoiceList.php
@@ -204,7 +204,7 @@ public function isValuesConstant(): bool
      *                                   corresponding values
      * @param array    $structuredValues The values indexed by the original keys
      */
-    private function flatten(array $choices, callable $value, &$choicesByValues, &$keysByValues, &$structuredValues)
+    private function flatten(array $choices, callable $value, &$choicesByValues, &$keysByValues, &$structuredValues): void
     {
         if (null === $choicesByValues) {
             $choicesByValues = [];

diff --git a/src/Extension/Core/ChoiceList/Factory/CachingFactoryDecorator.php b/src/Extension/Core/ChoiceList/Factory/CachingFactoryDecorator.php
@@ -154,7 +154,7 @@ private static function generateHash($value, string $namespace = ''): string
      * @param array $array  The array to flatten
      * @param array $output The flattened output
      */
-    private static function flatten(array $array, &$output)
+    private static function flatten(array $array, &$output): void
     {
         if (null === $output) {
             $output = [];

diff --git a/src/Extension/Core/ChoiceList/Factory/DefaultChoiceListFactory.php b/src/Extension/Core/ChoiceList/Factory/DefaultChoiceListFactory.php
@@ -115,7 +115,7 @@ public function createView(ChoiceList $list, $preferredChoices = null, $label =
         return new ChoiceListView($otherViews, $preferredViews);
     }
 
-    private static function addChoiceView($choice, $value, $label, $keys, &$index, $attr, $isPreferred, &$preferredViews, &$otherViews)
+    private static function addChoiceView($choice, $value, $label, $keys, &$index, $attr, $isPreferred, &$preferredViews, &$otherViews): void
     {
         // $value may be an integer or a string, since it's stored in the array
         // keys. We want to guarantee it's a string though.
@@ -150,7 +150,7 @@ private static function addChoiceView($choice, $value, $label, $keys, &$index, $
         }
     }
 
-    private static function addChoiceViewsGroupedBy($groupBy, $label, $choices, $keys, &$index, $attr, $isPreferred, &$preferredViews, &$otherViews)
+    private static function addChoiceViewsGroupedBy($groupBy, $label, $choices, $keys, &$index, $attr, $isPreferred, &$preferredViews, &$otherViews): void
     {
         foreach ($groupBy as $key => $value) {
             if (null === $value) {
@@ -200,7 +200,7 @@ private static function addChoiceViewsGroupedBy($groupBy, $label, $choices, $key
         }
     }
 
-    private static function addChoiceViewGroupedBy($groupBy, $choice, $value, $label, $keys, &$index, $attr, $isPreferred, &$preferredViews, &$otherViews)
+    private static function addChoiceViewGroupedBy($groupBy, $choice, $value, $label, $keys, &$index, $attr, $isPreferred, &$preferredViews, &$otherViews): void
     {
         $groupLabel = call_user_func($groupBy, $choice, $keys[$value], $value);
 

diff --git a/src/Extension/Core/ChoiceList/View/ChoiceListView.php b/src/Extension/Core/ChoiceList/View/ChoiceListView.php
@@ -66,7 +66,7 @@ public function __construct(array $choices = [], array $preferredChoices = [])
         $this->preferredChoices = $preferredChoices;
     }
 
-    public function initChoicesByLabel()
+    public function initChoicesByLabel(): void
     {
         $this->choicesByLabel = [];
 

diff --git a/src/Extension/Core/DataTransformer/BirthdayTransformer.php b/src/Extension/Core/DataTransformer/BirthdayTransformer.php
@@ -98,7 +98,7 @@ private function transformWhenInteger($value)
         return $value;
     }
 
-    private function validateDate(\DateTimeInterface $value)
+    private function validateDate(\DateTimeInterface $value): void
     {
         static $currentDate;
 

diff --git a/src/Extension/Core/Type/BaseDateTimeType.php b/src/Extension/Core/Type/BaseDateTimeType.php
@@ -31,7 +31,7 @@ abstract class BaseDateTimeType extends AbstractFieldType
         \IntlDateFormatter::SHORT,
     ];
 
-    protected function validateFormat(string $name, $value)
+    protected function validateFormat(string $name, $value): void
     {
         if (!in_array($value, self::$acceptedFormats, true)) {
             throw new InvalidConfigurationException(
@@ -41,7 +41,7 @@ protected function validateFormat(string $name, $value)
         }
     }
 
-    protected function validateDateFormat(string $name, string $format)
+    protected function validateDateFormat(string $name, string $format): void
     {
         if (null !== $format &&
             (false === strpos($format, 'y') || false === strpos($format, 'M') || false === strpos($format, 'd'))

diff --git a/src/Extension/Core/Type/BirthdayType.php b/src/Extension/Core/Type/BirthdayType.php
@@ -39,7 +39,7 @@ public function __construct()
     /**
      * {@inheritdoc}
      */
-    public function buildType(FieldConfig $config, array $options)
+    public function buildType(FieldConfig $config, array $options): void
     {
         $config->setValueComparator($this->valueComparator);
         $config->setValueTypeSupport(Range::class, true);
@@ -65,7 +65,7 @@ public function buildType(FieldConfig $config, array $options)
     /**
      * {@inheritdoc}
      */
-    public function buildView(SearchFieldView $view, FieldConfig $config, array $options)
+    public function buildView(SearchFieldView $view, FieldConfig $config, array $options): void
     {
         $view->vars['allow_age'] = $options['allow_age'];
         $view->vars['allow_future_date'] = $options['allow_future_date'];
@@ -74,7 +74,7 @@ public function buildView(SearchFieldView $view, FieldConfig $config, array $opt
     /**
      * {@inheritdoc}
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'allow_age' => true,
@@ -95,7 +95,7 @@ public function configureOptions(OptionsResolver $resolver)
     /**
      * {@inheritdoc}
      */
-    public function getParent()
+    public function getParent(): ?string
     {
         return DateType::class;
     }

diff --git a/src/Extension/Core/Type/ChoiceType.php b/src/Extension/Core/Type/ChoiceType.php
@@ -48,7 +48,7 @@ public function __construct(ChoiceListFactory $choiceListFactory = null)
     /**
      * {@inheritdoc}
      */
-    public function buildType(FieldConfig $config, array $options)
+    public function buildType(FieldConfig $config, array $options): void
     {
         $choiceList = $this->createChoiceList($options);
         $config->setAttribute('choice_list', $choiceList);
@@ -85,7 +85,7 @@ public function buildType(FieldConfig $config, array $options)
     /**
      * {@inheritdoc}
      */
-    public function buildView(SearchFieldView $view, FieldConfig $config, array $options)
+    public function buildView(SearchFieldView $view, FieldConfig $config, array $options): void
     {
         /** @var ChoiceListView $choiceListView */
         $choiceListView = $config->getAttribute('choice_list_view');
@@ -101,7 +101,7 @@ public function buildView(SearchFieldView $view, FieldConfig $config, array $opt
     /**
      * {@inheritdoc}
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $choiceTranslationDomainNormalizer = function (Options $options, $choiceTranslationDomain) {
             if (true === $choiceTranslationDomain) {

diff --git a/src/Extension/Core/Type/CountryType.php b/src/Extension/Core/Type/CountryType.php
@@ -31,7 +31,7 @@ final class CountryType extends AbstractFieldType implements ChoiceLoader
     /**
      * {@inheritdoc}
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'choice_loader' => $this,
@@ -42,7 +42,7 @@ public function configureOptions(OptionsResolver $resolver)
     /**
      * {@inheritdoc}
      */
-    public function getParent()
+    public function getParent(): ?string
     {
         return ChoiceType::class;
     }

diff --git a/src/Extension/Core/Type/CurrencyType.php b/src/Extension/Core/Type/CurrencyType.php
@@ -31,7 +31,7 @@ final class CurrencyType extends AbstractFieldType implements ChoiceLoader
     /**
      * {@inheritdoc}
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'choice_loader' => $this,
@@ -43,7 +43,7 @@ public function configureOptions(OptionsResolver $resolver)
     /**
      * {@inheritdoc}
      */
-    public function getParent()
+    public function getParent(): ?string
     {
         return ChoiceType::class;
     }

diff --git a/src/Extension/Core/Type/DateTimeType.php b/src/Extension/Core/Type/DateTimeType.php
@@ -65,7 +65,7 @@ public function __construct()
     /**
      * {@inheritdoc}
      */
-    public function buildType(FieldConfig $config, array $options)
+    public function buildType(FieldConfig $config, array $options): void
     {
         $config->setValueComparator($this->valueComparator);
         $config->setValueTypeSupport(Range::class, true);
@@ -107,7 +107,7 @@ public function buildType(FieldConfig $config, array $options)
     /**
      * {@inheritdoc}
      */
-    public function buildView(SearchFieldView $view, FieldConfig $config, array $options)
+    public function buildView(SearchFieldView $view, FieldConfig $config, array $options): void
     {
         $pattern = $options['pattern'];
 
@@ -128,7 +128,7 @@ public function buildView(SearchFieldView $view, FieldConfig $config, array $opt
     /**
      * {@inheritdoc}
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults(
             [