Merge pull request #665 from ukeloop/refactor/rules_class

Refactored the `Rules` Class

Author: rudiedirkx

src/Kris/LaravelFormBuilder/Rules.php

@@ -2,9 +2,10 @@
 
 namespace Kris\LaravelFormBuilder;
 
+use InvalidArgumentException;
+
 class Rules
 {
-
     /**
      * @var string|null
      */
@@ -30,108 +31,124 @@ class Rules
      * @param array $attributes
      * @param array $messages
      */
-    public function __construct(array $rules, array $attributes = [], array $messages = []) {
+    public function __construct(array $rules, array $attributes = [], array $messages = [])
+    {
         $this->rules = $rules;
         $this->attributes = $attributes;
         $this->messages = $messages;
     }
 
     /**
      * @param string $name
+     * @return $this
      */
-    public function setFieldName($name) {
+    public function setFieldName($name)
+    {
         $this->fieldName = $name;
 
         return $this;
     }
 
     /**
-     * @param string $fieldName
+     * @param string|null $fieldName
+     * @return array|mixed
      */
-    public function getFieldRules($fieldName = null) {
-      $fieldName = $this->ensureFieldName($fieldName);
+    public function getFieldRules($fieldName = null)
+    {
+        $fieldName = $this->ensureFieldName($fieldName);
 
-      $rules = $this->rules;
-      return isset($rules[$fieldName]) ? $rules[$fieldName] : [];
+        $rules = $this->rules;
+        return $rules[$fieldName] ?? [];
     }
 
     /**
-     * @param mixes $rule
-     * @param string $fieldName
+     * @param mixed $rule
+     * @param string|null $fieldName
+     * @return void
      */
-    public function addFieldRule($rule, $fieldName = null) {
-      $rules = $this->getFieldRules($fieldName);
-      $rules[] = $rule;
-      $this->setFieldRules($rules, $fieldName);
+    public function addFieldRule($rule, $fieldName = null)
+    {
+        $rules = $this->getFieldRules($fieldName);
+        $rules[] = $rule;
+        $this->setFieldRules($rules, $fieldName);
     }
 
     /**
      * @param array $rules
-     * @param string $fieldName
+     * @param string|null $fieldName
+     * @return void
      */
-    public function setFieldRules(array $rules, $fieldName = null) {
-      $fieldName = $this->ensureFieldName($fieldName);
-      $this->rules[$fieldName] = $rules;
+    public function setFieldRules(array $rules, $fieldName = null)
+    {
+        $fieldName = $this->ensureFieldName($fieldName);
+        $this->rules[$fieldName] = $rules;
     }
 
     /**
-     * @param string $fieldName
+     * @param string|null $fieldName
+     * @return string|null
+     * @throws InvalidArgumentException
      */
-    protected function ensureFieldName($fieldName) {
-      if (!$fieldName) {
-        if (!$this->fieldName) {
-          throw new InvalidArgumentException("Field functions on non-field Rules need explicit field name");
+    protected function ensureFieldName($fieldName)
+    {
+        if (!$fieldName) {
+            if (!$this->fieldName) {
+                throw new InvalidArgumentException("Field functions on non-field Rules need explicit field name");
+            }
+
+            $fieldName = $this->fieldName;
         }
 
-        $fieldName = $this->fieldName;
-      }
-
-      return $fieldName;
+        return $fieldName;
     }
 
     /**
-     * @param array $rules
-     * @param array $attributes
-     * @param array $messages
+     * @param array|static $rules
+     * @return $this
      */
-    public function append($rules) {
-      if (is_array($rules)) {
-        $rules = static::fromArray($rules);
-      }
+    public function append($rules)
+    {
+        if (is_array($rules)) {
+            $rules = static::fromArray($rules);
+        }
 
-      $this->rules = array_replace_recursive($this->rules, $rules->getRules());
-      $this->attributes = array_replace_recursive($this->attributes, $rules->getAttributes());
-      $this->messages = array_replace_recursive($this->messages, $rules->getMessages());
+        $this->rules = array_replace_recursive($this->rules, $rules->getRules());
+        $this->attributes = array_replace_recursive($this->attributes, $rules->getAttributes());
+        $this->messages = array_replace_recursive($this->messages, $rules->getMessages());
 
-      return $this;
+        return $this;
     }
 
     /**
      * @return array
      */
-    public function getRules() {
-      return $this->rules;
+    public function getRules()
+    {
+        return $this->rules;
     }
 
     /**
      * @return array
      */
-    public function getAttributes() {
-      return $this->attributes;
+    public function getAttributes()
+    {
+        return $this->attributes;
     }
 
     /**
      * @return array
      */
-    public function getMessages() {
-      return $this->messages;
+    public function getMessages()
+    {
+        return $this->messages;
     }
 
     /**
      * @param array[] $rules
      * @return static
      */
-    static public function fromArray($rules) {
+    public static function fromArray($rules)
+    {
         if (!$rules) {
             return new static([]);
         }
@@ -144,5 +161,4 @@ static public function fromArray($rules) {
 
         return new static($rules['rules'], $rules['attributes'], $rules['error_messages']);
     }
-
 }