[WIP] Update type hints and PHPDocs

Author: emsifa

src/Attribute.php

@@ -8,19 +8,19 @@ class Attribute
     /** @var array */
     protected $rules = [];
 
-    /** @var mixed */
+    /** @var string */
     protected $key;
 
-    /** @var mixed */
+    /** @var string|null */
     protected $alias;
 
-    /** @var mixed */
+    /** @var Rakit\Validation\Validation */
     protected $validation;
 
     /** @var bool */
     protected $required = false;
 
-    /** @var Attribute */
+    /** @var Rakit\Validation\Validation|null */
     protected $primaryAttribute = null;
 
     /** @var array */
@@ -32,14 +32,18 @@ class Attribute
     /**
      * Constructor
      *
-     * @param Validation $validation
-     * @param mixed $key
-     * @param mixed $alias
-     * @param array $rules
+     * @param Rakit\Validation\Validation  $validation
+     * @param string      $key
+     * @param string|null $alias
+     * @param array       $rules
      * @return void
      */
-    public function __construct(Validation $validation, $key, $alias = null, array $rules = [])
-    {
+    public function __construct(
+        Validation $validation,
+        string $key,
+        $alias = null,
+        array $rules = []
+    ) {
         $this->validation = $validation;
         $this->alias = $alias;
         $this->key = $key;
@@ -51,7 +55,7 @@ public function __construct(Validation $validation, $key, $alias = null, array $
     /**
      * Set the primary attribute
      *
-     * @param Attribute $primaryAttribute
+     * @param Rakit\Validation\Attribute $primaryAttribute
      * @return void
      */
     public function setPrimaryAttribute(Attribute $primaryAttribute)
@@ -73,7 +77,7 @@ public function setKeyIndexes(array $keyIndexes)
     /**
      * Get primary attributes
      *
-     * @return mixed
+     * @return Rakit\Validation\Attribute|null
      */
     public function getPrimaryAttribute()
     {
@@ -97,7 +101,7 @@ public function setOtherAttributes(array $otherAttributes)
     /**
      * Add other attributes
      *
-     * @param Attribute $otherAttribute
+     * @param Rakit\Validation\Attribute $otherAttribute
      * @return void
      */
     public function addOtherAttribute(Attribute $otherAttribute)
@@ -118,7 +122,7 @@ public function getOtherAttributes(): array
     /**
      * Add rule
      *
-     * @param Rule $rule
+     * @param Rakit\Validation\Rule $rule
      * @return void
      */
     public function addRule(Rule $rule)
@@ -131,10 +135,10 @@ public function addRule(Rule $rule)
     /**
      * Get rule
      *
-     * @param mixed $ruleKey
+     * @param string $ruleKey
      * @return void
      */
-    public function getRule($ruleKey)
+    public function getRule(string $ruleKey)
     {
         return $this->hasRule($ruleKey)? $this->rules[$ruleKey] : null;
     }
@@ -152,21 +156,21 @@ public function getRules(): array
     /**
      * Check the $ruleKey has in the rule
      *
-     * @param mixed $ruleKey
+     * @param string $ruleKey
      * @return bool
      */
-    public function hasRule($ruleKey): bool
+    public function hasRule(string $ruleKey): bool
     {
         return isset($this->rules[$ruleKey]);
     }
 
     /**
      * Set required
      *
-     * @param mixed $required
+     * @param boolean $required
      * @return void
      */
-    public function setRequired($required)
+    public function setRequired(bool $required)
     {
         $this->required = $required;
     }
@@ -204,10 +208,10 @@ public function getKeyIndexes(): array
     /**
      * Get value
      *
-     * @param mixed $key
+     * @param string|null $key
      * @return void
      */
-    public function getValue($key = null)
+    public function getValue(string $key = null)
     {
         if ($key && $this->isArrayAttribute()) {
             $key = $this->resolveSiblingKey($key);
@@ -225,28 +229,28 @@ public function getValue($key = null)
      *
      * @return boolean
      */
-    public function isArrayAttribute()
+    public function isArrayAttribute(): bool
     {
         return count($this->getKeyIndexes()) > 0;
     }
 
     /**
-     * Check that is using dot notation
+     * Check this attribute is using dot notation
      *
      * @return boolean
      */
-    public function isUsingDotNotation()
+    public function isUsingDotNotation(): bool
     {
         return strpos($this->getKey(), '.') !== false;
     }
 
     /**
      * Resolve sibling key
      *
-     * @param mixed $key
-     * @return mixed
+     * @param string $key
+     * @return string
      */
-    public function resolveSiblingKey($key)
+    public function resolveSiblingKey(string $key): string
     {
         $indexes = $this->getKeyIndexes();
         $keys = explode("*", $key);
@@ -285,18 +289,18 @@ public function getHumanizedKey()
     /**
      * Set alias
      *
-     * @param mixed $alias
+     * @param string $alias
      * @return void
      */
-    public function setAlias($alias)
+    public function setAlias(string $alias)
     {
         $this->alias = $alias;
     }
 
     /**
      * Get alias
      *
-     * @return mixed
+     * @return string|null
      */
     public function getAlias()
     {

src/ErrorBag.php

@@ -20,14 +20,14 @@ public function __construct(array $messages = [])
     }
 
     /**
-     * Add key,rule and message
+     * Add message for given key and rule
      *
-     * @param mixed $key
-     * @param mixed $rule
-     * @param mixed $message
+     * @param string $key
+     * @param string $rule
+     * @param string $message
      * @return void
      */
-    public function add($key, $rule, $message)
+    public function add(string $key, string $rule, string $message)
     {
         if (!isset($this->messages[$key])) {
             $this->messages[$key] = [];
@@ -37,7 +37,7 @@ public function add($key, $rule, $message)
     }
 
     /**
-     * Get results count
+     * Get messages count
      *
      * @return int
      */
@@ -49,10 +49,10 @@ public function count(): int
     /**
      * Check given key is existed
      *
-     * @param mixed $key
+     * @param string $key
      * @return bool
      */
-    public function has($key): bool
+    public function has(string $key): bool
     {
         list($key, $ruleName) = $this->parsekey($key);
         if ($this->isWildcardKey($key)) {
@@ -72,10 +72,10 @@ public function has($key): bool
     /**
      * Get the first value of array
      *
-     * @param mixed $key
+     * @param string $key
      * @return mixed
      */
-    public function first($key)
+    public function first(string $key)
     {
         list($key, $ruleName) = $this->parsekey($key);
         if ($this->isWildcardKey($key)) {
@@ -98,13 +98,13 @@ public function first($key)
     }
 
     /**
-     * Given $key and $format then get the results
+     * Get messages from given key, can be use custom format
      *
-     * @param mixed $key
+     * @param string $key
      * @param string $format
      * @return array
      */
-    public function get($key, string $format = ':message'): array
+    public function get(string $key, string $format = ':message'): array
     {
         list($key, $ruleName) = $this->parsekey($key);
         $results = [];
@@ -129,7 +129,7 @@ public function get($key, string $format = ':message'): array
     }
 
     /**
-     * Get all results
+     * Get all messages
      *
      * @param string $format
      * @return array
@@ -147,7 +147,7 @@ public function all(string $format = ':message'): array
     }
 
     /**
-     * Get the first result of results
+     * Get the first message from existing keys
      *
      * @param string $format
      * @param boolean $dotNotation
@@ -168,7 +168,7 @@ public function firstOfAll(string $format = ':message', bool $dotNotation = fals
     }
 
     /**
-     * Get messagees
+     * Get plain array messages
      *
      * @return array
      */
@@ -180,10 +180,10 @@ public function toArray(): array
     /**
      * Parse $key to get the array of $key and $ruleName
      *
-     * @param mixed $key
+     * @param string $key
      * @return array
      */
-    protected function parseKey($key): array
+    protected function parseKey(string $key): array
     {
         $expl = explode(':', $key, 2);
         $key = $expl[0];
@@ -197,19 +197,19 @@ protected function parseKey($key): array
      * @param mixed $key
      * @return bool
      */
-    protected function isWildcardKey($key): bool
+    protected function isWildcardKey(string $key): bool
     {
         return false !== strpos($key, '*');
     }
 
     /**
      * Filter messages with wildcard key
      *
-     * @param mixed $key
-     * @param mixed $ruleName
+     * @param string $key
+     * @param mixed  $ruleName
      * @return array
      */
-    protected function filterMessagesForWildcardKey($key, $ruleName = null): array
+    protected function filterMessagesForWildcardKey(string $key, $ruleName = null): array
     {
         $messages = $this->messages;
         $pattern = preg_quote($key, '#');
@@ -236,11 +236,11 @@ protected function filterMessagesForWildcardKey($key, $ruleName = null): array
     /**
      * Get formatted message
      *
-     * @param mixed $message
-     * @param mixed $format
+     * @param string $message
+     * @param string $format
      * @return string
      */
-    protected function formatMessage($message, $format): string
+    protected function formatMessage(string $message, string $format): string
     {
         return str_replace(':message', $message, $format);
     }