Fix phpdocs (#91)

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2008 by Yii Software LLC (http://www.yiisoft.com)
+Copyright © 2008 by Yii Software (https://www.yiiframework.com/)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -11,7 +11,7 @@ are met:
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
- * Neither the name of Yii Software LLC nor the names of its
+ * Neither the name of Yii Software nor the names of its
    contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.
 

src/DataSetInterface.php

@@ -19,6 +19,7 @@ public function getAttributeValue(string $attribute);
 
     /**
      * If there is such attribute in the set
+     * @return bool
      */
     public function hasAttribute(string $attribute): bool;
 }

src/Rule/Ip.php

@@ -382,6 +382,7 @@ public function disallowSubnet(): self
     /**
      * The method checks whether the IP address with specified CIDR is allowed according to the [[ranges]] list.
      *
+     * @return bool
      * @see ranges
      */
     private function isAllowed(string $ip): bool

src/Rule/Json.php

@@ -34,19 +34,19 @@ private function isValidJson($value): bool
         // Regular expression is built based on JSON grammar specified at
         // https://tools.ietf.org/html/rfc8259
         $regex = <<<'REGEX'
-/
-(?(DEFINE)
-    (?<json>(?>\s*(?&object)\s*|\s*(?&array)\s*))
-    (?<object>(?>\{\s*(?>(?&member)(?>\s*,\s*(?&member))*)?\s*\}))
-    (?<member>(?>(?&string)\s*:\s*(?&value)))
-    (?<array>(?>\[\s*(?>(?&value)(?>\s*,\s*(?&value))*)?\s*\]))
-    (?<value>(?>)false|null|true|(?&object)|(?&array)|(?&number)|(?&string))
-    (?<number>(?>-?(?>0|[1-9]\d*)(?>\.\d+)?(?>[eE][-+]?\d+)?))
-    (?<string>(?>"(?>\\(?>["\\\/bfnrt]|u[a-fA-F0-9]{4})|[^"\\\0-\x1F\x7F]+)*"))
-)
-\A(?&json)\z
-/x
-REGEX;
+        /
+        (?(DEFINE)
+            (?<json>(?>\s*(?&object)\s*|\s*(?&array)\s*))
+            (?<object>(?>\{\s*(?>(?&member)(?>\s*,\s*(?&member))*)?\s*\}))
+            (?<member>(?>(?&string)\s*:\s*(?&value)))
+            (?<array>(?>\[\s*(?>(?&value)(?>\s*,\s*(?&value))*)?\s*\]))
+            (?<value>(?>)false|null|true|(?&object)|(?&array)|(?&number)|(?&string))
+            (?<number>(?>-?(?>0|[1-9]\d*)(?>\.\d+)?(?>[eE][-+]?\d+)?))
+            (?<string>(?>"(?>\\(?>["\\\/bfnrt]|u[a-fA-F0-9]{4})|[^"\\\0-\x1F\x7F]+)*"))
+        )
+        \A(?&json)\z
+        /x
+        REGEX;
 
         return is_string($value) && preg_match($regex, $value) === 1;
     }

src/Rules.php

@@ -12,7 +12,7 @@
 final class Rules
 {
     /**
-     * @var Rule[]
+     * @var Rule[] $rules
      */
     private array $rules = [];
 
@@ -24,7 +24,7 @@ public function __construct(iterable $rules = [])
     }
 
     /**
-     * @param Rule|callable
+     * @param Rule|callable $rule
      */
     public function add($rule): void
     {

src/Validator.php

@@ -10,7 +10,7 @@
 final class Validator implements ValidatorInterface
 {
     /**
-     * @var Rules[]
+     * @var Rules[] $attributeRules
      */
     private array $attributeRules = [];
 
@@ -42,7 +42,7 @@ public function validate(DataSetInterface $dataSet): ResultSet
 
     /**
      * @param string $attribute
-     * @param Rule|callable
+     * @param Rule|callable $rule
      */
     public function addRule(string $attribute, $rule): void
     {

src/ValidatorFactory.php

@@ -40,7 +40,7 @@ private function normalizeRules(array $rules)
     }
 
     /**
-     * @param Rule|callable
+     * @param Rule|callable $rule
      */
     private function normalizeRule($rule): Rule
     {

src/ValidatorFactoryInterface.php

@@ -7,7 +7,8 @@
 interface ValidatorFactoryInterface
 {
     /**
-     * @param Rule[]
+     * @param Rule[] $rules
+     * @return ValidatorInterface
      */
     public function create(array $rules): ValidatorInterface;
 }