Additional static code analysis rules and according autofixes

Author: populov

phpcs.xml

@@ -13,4 +13,22 @@
     <rule ref="PSR2">
         <exclude name="Generic.Files.LineLength"/>
     </rule>
-</ruleset>
+    <rule ref="PSR1.Classes.ClassDeclaration.MissingNamespace" />
+    <rule ref="Generic.Commenting.DocComment.MissingShort" />
+    <rule ref="Generic.Commenting.DocComment.SpacingBeforeTags" />
+    <rule ref="Generic.Commenting.DocComment.SpacingBeforeTags" />
+    <rule ref="MySource.Commenting.FunctionComment.InvalidReturn" />
+    <rule ref="MySource.Commenting.FunctionComment.MissingParamComment" />
+    <rule ref="MySource.Commenting.FunctionComment.TypeHintMissing" />
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax" />
+    <rule ref="Generic.Classes.DuplicateClassName" />
+    <rule ref="Generic.CodeAnalysis.EmptyStatement" />
+    <rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall" />
+    <rule ref="Generic.CodeAnalysis.JumbledIncrementer" />
+    <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement" />
+    <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier" />
+    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter" />
+    <rule ref="Generic.CodeAnalysis.UselessOverridingMethod" />
+    <rule ref="Generic.Commenting.Fixme" />
+    <rule ref="Generic.Commenting.Todo" />
+    <rule ref="Generic.ControlStructures.InlineControlStructure" /></ruleset>

src/FluentValidationServiceProvider.php

@@ -7,6 +7,7 @@
 
 /**
  * Service provider substitutes default Laravel's validation factory
+ *
  * @see FluentValidatorFactory
  */
 class FluentValidationServiceProvider extends ValidationServiceProvider

src/GenericRuleSet.php

@@ -42,6 +42,7 @@ class GenericRuleSet extends RuleSet
 
     /**
      * The field under validation must be an integer.
+     *
      * @return IntRuleSet
      */
     public function int(): IntRuleSet
@@ -51,6 +52,7 @@ public function int(): IntRuleSet
 
     /**
      * The field under validation must be numeric.
+     *
      * @return NumericRuleSet
      */
     public function numeric(): NumericRuleSet
@@ -60,6 +62,7 @@ public function numeric(): NumericRuleSet
 
     /**
      * The field under validation must be a string. If you would like to allow the field to also be null, you should assign the nullable rule to the field.
+     *
      * @return StringRuleSet
      */
     public function string(): StringRuleSet
@@ -69,6 +72,7 @@ public function string(): StringRuleSet
 
     /**
      * The field under validation must be able to be cast as a boolean. Accepted input are true,  false, 1, 0, "1", and "0".
+     *
      * @return GenericRuleSet
      */
     public function boolean(): GenericRuleSet
@@ -78,6 +82,7 @@ public function boolean(): GenericRuleSet
 
     /**
      * The field under validation must be a valid date according to the strtotime PHP function.
+     *
      * @return DateRuleSet
      */
     public function date(): DateRuleSet
@@ -87,6 +92,7 @@ public function date(): DateRuleSet
 
     /**
      * The field under validation must be a successfully uploaded file.
+     *
      * @return FileRuleSet
      */
     public function file(): FileRuleSet

src/ImageRuleSet.php

@@ -23,6 +23,7 @@ class ImageRuleSet extends FileRuleSet
 
     /**
      * ImageRuleSet constructor.
+     *
      * @param array|\Closure|Dimensions $constraints
      * @param array $rules
      */
@@ -34,6 +35,7 @@ public function __construct(array $rules = [], $constraints = [])
 
     /**
      * The field under validation must be a successfully uploaded file.
+     *
      * @return $this|static
      */
     public function file()

src/NumericRuleSet.php

@@ -18,6 +18,7 @@ public function __construct(array $rules = [])
 
     /**
      * The field under validation must be numeric and must have an exact length of value.
+     *
      * @return NumericRuleSet
      * @param int $length
      */
@@ -28,6 +29,7 @@ public function digits($length): NumericRuleSet
 
     /**
      * The field under validation must have a length between the given min and max.
+     *
      * @param $minLength
      * @param $maxLength
      * @return NumericRuleSet

src/RequiredRules.php

@@ -24,6 +24,7 @@ public function required()
 
     /**
      * The field under validation must be present and not empty only if any of the other specified fields are present.
+     *
      * @param \string[] $otherFields
      * @return static
      */
@@ -34,6 +35,7 @@ public function requiredWith(string ...$otherFields)
 
     /**
      * The field under validation must be present and not empty only if all of the other specified fields are present.
+     *
      * @param \string[] ...$otherFields
      * @return static
      */
@@ -44,6 +46,7 @@ public function requiredWithAll(string ...$otherFields)
 
     /**
      * The field under validation must be present and not empty only when any of the other specified fields are not present.
+     *
      * @param \string[] ...$otherFields
      * @return static
      */
@@ -54,6 +57,7 @@ public function requiredWithout(string ...$otherFields)
 
     /**
      * The field under validation must be present and not empty only when all of the other specified fields are not present.
+     *
      * @param \string[] ...$otherFields
      * @return static
      */
@@ -64,6 +68,7 @@ public function requiredWithoutAll(string ...$otherFields)
 
     /**
      * The field under validation must be present and not empty if the anotherField field is equal to any value.
+     *
      * @param string $anotherField
      * @param mixed $value
      * @return static
@@ -75,6 +80,7 @@ public function requiredIf(string $anotherField, $value)
 
     /**
      * The field under validation must be present and not empty unless the anotherField field is equal to any value.
+     *
      * @param string $anotherField
      * @param mixed $value
      * @return static

src/Rule.php

@@ -81,6 +81,7 @@ public static function required(): GenericRuleSet
 
     /**
      * The field under validation must be an integer.
+     *
      * @return IntRuleSet
      */
     public static function int(): IntRuleSet
@@ -90,6 +91,7 @@ public static function int(): IntRuleSet
 
     /**
      * The field under validation must be numeric.
+     *
      * @return NumericRuleSet
      */
     public static function numeric(): NumericRuleSet
@@ -99,6 +101,7 @@ public static function numeric(): NumericRuleSet
 
     /**
      * The field under validation must be a string. If you would like to allow the field to also be null, you should assign the nullable rule to the field.
+     *
      * @return StringRuleSet
      */
     public static function string(): StringRuleSet
@@ -108,6 +111,7 @@ public static function string(): StringRuleSet
 
     /**
      * The field under validation must be a successfully uploaded file.
+     *
      * @return FileRuleSet
      */
     public static function file(): FileRuleSet
@@ -117,6 +121,7 @@ public static function file(): FileRuleSet
 
     /**
      * The field under validation must be a valid date according to the strtotime PHP function.
+     *
      * @return DateRuleSet
      */
     public static function date(): DateRuleSet
@@ -126,6 +131,7 @@ public static function date(): DateRuleSet
 
     /**
      * The file under validation must be an image (jpeg, png, bmp, gif, or svg)
+     *
      * @param array|\Closure|\Illuminate\Validation\Rules\Dimensions $constraints
      * @return ImageRuleSet
      */

src/SimpleRules.php

@@ -12,6 +12,7 @@ trait SimpleRules
 {
     /**
      * The field under validation must exist in anotherField's values.
+     *
      * @param string $anotherFiled
      * @return static
      */
@@ -22,6 +23,7 @@ public function inArray(string $anotherFiled)
 
     /**
      * The field under validation must be included in the given list of values.
+     *
      * @param array ...$values
      * @return static
      */
@@ -33,6 +35,7 @@ public function in(...$values)
 
     /**
      * The field under validation must not be included in the given list of values.
+     *
      * @param array ...$values
      * @return static
      */
@@ -44,6 +47,7 @@ public function notIn(...$values)
 
     /**
      * The given field must match the field under validation.
+     *
      * @param string $anotherField
      * @return static
      */
@@ -54,6 +58,7 @@ public function same(string $anotherField)
 
     /**
      * The field under validation must have a different value than field.
+     *
      * @param string $anotherFiled
      * @return static
      */
@@ -64,6 +69,7 @@ public function different(string $anotherFiled)
 
     /**
      * The field under validation must have a minimum value. Strings, numerics, arrays, and files are evaluated in the same fashion as the size rule.
+     *
      * @param integer $minimalValue For numeric data, value corresponds to a given integer value.
      *                              For an array, size corresponds to the count of the array.
      *                              For string data, value corresponds to the number of characters.
@@ -77,6 +83,7 @@ public function min($minimalValue)
 
     /**
      * The field under validation must be less than or equal to a maximum value. Strings, numerics, arrays, and files are evaluated in the same fashion as the size rule.
+     *
      * @param integer $maximalValue For numeric data, value corresponds to a given integer value.
      *                              For an array, size corresponds to the count of the array.
      *                              For string data, value corresponds to the number of characters.
@@ -90,6 +97,7 @@ public function max($maximalValue)
 
     /**
      * The field under validation must have a size between the given min and max. Strings, numerics, arrays, and files are evaluated in the same fashion as the size rule.
+     *
      * @param integer $minimalValue For numeric data, value corresponds to a given integer value.
      *                              For an array, size corresponds to the count of the array.
      *                              For string data, value corresponds to the number of characters.
@@ -123,6 +131,7 @@ public function size(int $value)
 
     /**
      * Run validation checks against a field only if that field is present in the input array.
+     *
      * @return static
      */
     public function sometimes()
@@ -132,6 +141,7 @@ public function sometimes()
 
     /**
      * The field under validation must pass custom validation rule.
+     *
      * @param string $customRule
      * @return GenericRuleSet
      * @throws ConfigurationException

src/StringRuleSet.php

@@ -63,6 +63,7 @@ public function regex(string $pattern, bool $ignoreCase = false): StringRuleSet
 
     /**
      * Field under validation must match one of values of specified Enum
+     *
      * @see https://github.com/Saritasa/php-common#enum
      *
      * @param string $enumClass Enumeration to validate against