Merge pull request #67 from peter279k/add_type_hint

Complete type hints and annotation comments

Author: emsifa

src/Attribute.php

@@ -5,24 +5,45 @@
 class Attribute
 {
 
+    /** @var array */
     protected $rules = [];
 
+    /** @var string */
     protected $key;
 
+    /** @var string|null */
     protected $alias;
 
+    /** @var Rakit\Validation\Validation */
     protected $validation;
 
+    /** @var bool */
     protected $required = false;
 
+    /** @var Rakit\Validation\Validation|null */
     protected $primaryAttribute = null;
 
+    /** @var array */
     protected $otherAttributes = [];
 
+    /** @var array */
     protected $keyIndexes = [];
 
-    public function __construct(Validation $validation, $key, $alias = null, array $rules = array())
-    {
+    /**
+     * Constructor
+     *
+     * @param Rakit\Validation\Validation  $validation
+     * @param string      $key
+     * @param string|null $alias
+     * @param array       $rules
+     * @return void
+     */
+    public function __construct(
+        Validation $validation,
+        string $key,
+        $alias = null,
+        array $rules = []
+    ) {
         $this->validation = $validation;
         $this->alias = $alias;
         $this->key = $key;
@@ -31,21 +52,44 @@ public function __construct(Validation $validation, $key, $alias = null, array $
         }
     }
 
+    /**
+     * Set the primary attribute
+     *
+     * @param Rakit\Validation\Attribute $primaryAttribute
+     * @return void
+     */
     public function setPrimaryAttribute(Attribute $primaryAttribute)
     {
         $this->primaryAttribute = $primaryAttribute;
     }
 
+    /**
+     * Set key indexes
+     *
+     * @param array $keyIndexes
+     * @return void
+     */
     public function setKeyIndexes(array $keyIndexes)
     {
         $this->keyIndexes = $keyIndexes;
     }
 
+    /**
+     * Get primary attributes
+     *
+     * @return Rakit\Validation\Attribute|null
+     */
     public function getPrimaryAttribute()
     {
         return $this->primaryAttribute;
     }
 
+    /**
+     * Set other attributes
+     *
+     * @param array $otherAttributes
+     * @return void
+     */
     public function setOtherAttributes(array $otherAttributes)
     {
         $this->otherAttributes = [];
@@ -54,59 +98,120 @@ public function setOtherAttributes(array $otherAttributes)
         }
     }
 
+    /**
+     * Add other attributes
+     *
+     * @param Rakit\Validation\Attribute $otherAttribute
+     * @return void
+     */
     public function addOtherAttribute(Attribute $otherAttribute)
     {
         $this->otherAttributes[] = $otherAttribute;
     }
 
-    public function getOtherAttributes()
+    /**
+     * Get other attributes
+     *
+     * @return array
+     */
+    public function getOtherAttributes(): array
     {
         return $this->otherAttributes;
     }
 
+    /**
+     * Add rule
+     *
+     * @param Rakit\Validation\Rule $rule
+     * @return void
+     */
     public function addRule(Rule $rule)
     {
         $rule->setAttribute($this);
         $rule->setValidation($this->validation);
         $this->rules[$rule->getKey()] = $rule;
     }
 
-    public function getRule($ruleKey)
+    /**
+     * Get rule
+     *
+     * @param string $ruleKey
+     * @return void
+     */
+    public function getRule(string $ruleKey)
     {
         return $this->hasRule($ruleKey)? $this->rules[$ruleKey] : null;
     }
 
-    public function getRules()
+    /**
+     * Get rules
+     *
+     * @return array
+     */
+    public function getRules(): array
     {
         return $this->rules;
     }
 
-    public function hasRule($ruleKey)
+    /**
+     * Check the $ruleKey has in the rule
+     *
+     * @param string $ruleKey
+     * @return bool
+     */
+    public function hasRule(string $ruleKey): bool
     {
         return isset($this->rules[$ruleKey]);
     }
 
-    public function setRequired($required)
+    /**
+     * Set required
+     *
+     * @param boolean $required
+     * @return void
+     */
+    public function setRequired(bool $required)
     {
         $this->required = $required;
     }
 
-    public function isRequired()
+    /**
+     * Set rule is required
+     *
+     * @return boolean
+     */
+    public function isRequired(): bool
     {
-        return $this->required === true;
+        return $this->required;
     }
 
-    public function getKey()
+    /**
+     * Get key
+     *
+     * @return string
+     */
+    public function getKey(): string
     {
         return $this->key;
     }
 
-    public function getKeyIndexes()
+    /**
+     * Get key indexes
+     *
+     * @return array
+     */
+    public function getKeyIndexes(): array
     {
         return $this->keyIndexes;
     }
 
-    public function getValue($key = null)
+    /**
+     * Get value
+     *
+     * @param string|null $key
+     * @return void
+     */
+    public function getValue(string $key = null)
     {
         if ($key && $this->isArrayAttribute()) {
             $key = $this->resolveSiblingKey($key);
@@ -119,17 +224,33 @@ public function getValue($key = null)
         return $this->validation->getValue($key);
     }
 
-    public function isArrayAttribute()
+    /**
+     * Get that is array attribute
+     *
+     * @return boolean
+     */
+    public function isArrayAttribute(): bool
     {
         return count($this->getKeyIndexes()) > 0;
     }
 
-    public function isUsingDotNotation()
+    /**
+     * Check this attribute is using dot notation
+     *
+     * @return boolean
+     */
+    public function isUsingDotNotation(): bool
     {
         return strpos($this->getKey(), '.') !== false;
     }
 
-    public function resolveSiblingKey($key)
+    /**
+     * Resolve sibling key
+     *
+     * @param string $key
+     * @return string
+     */
+    public function resolveSiblingKey(string $key): string
     {
         $indexes = $this->getKeyIndexes();
         $keys = explode("*", $key);
@@ -141,6 +262,11 @@ public function resolveSiblingKey($key)
         return call_user_func_array('sprintf', $args);
     }
 
+    /**
+     * Get humanize key
+     *
+     * @return string
+     */
     public function getHumanizedKey()
     {
         $primaryAttribute = $this->getPrimaryAttribute();
@@ -160,11 +286,22 @@ public function getHumanizedKey()
         return ucfirst($key);
     }
 
-    public function setAlias($alias)
+    /**
+     * Set alias
+     *
+     * @param string $alias
+     * @return void
+     */
+    public function setAlias(string $alias)
     {
         $this->alias = $alias;
     }
 
+    /**
+     * Get alias
+     *
+     * @return string|null
+     */
     public function getAlias()
     {
         return $this->alias;