Add options param to toArray

popphp · May 17, 2024 · 7e7905e · 7e7905e
1 parent 50fe505
commit 7e7905e
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 6 deletions.
diff --git a/src/Form.php b/src/Form.php
@@ -564,16 +564,29 @@ public function count(): int
     /**
      * Method to get the field values as an array
      *
+     * @param  array $options
      * @return array
      */
-    public function toArray(): array
+    public function toArray(array $options = []): array
     {
         $fieldValues = [];
 
         foreach ($this->fieldsets as $fieldset) {
             $fieldValues = array_merge($fieldValues, $fieldset->toArray());
         }
 
+        if (!empty($options)) {
+            if (isset($options['exclude'])) {
+                if (!is_array($options['exclude'])) {
+                    $options['exclude'] = [$options['exclude']];
+                }
+                $fieldValues = array_diff_key($fieldValues, array_flip($options['exclude']));
+            }
+            if (isset($options['filter'])) {
+                $fieldValues = array_filter($fieldValues, $options['filter']);
+            }
+        }
+
         return $fieldValues;
     }
 

diff --git a/src/FormInterface.php b/src/FormInterface.php
@@ -39,9 +39,10 @@ public function count(): int;
     /**
      * Get values
      *
+     * @param  array $options
      * @return array
      */
-    public function toArray(): array;
+    public function toArray(array $options = []): array;
 
     /**
      * Method to iterate over object
@@ -116,4 +117,4 @@ public function offsetSet(mixed $offset, mixed $value): void;
      */
     public function offsetUnset(mixed $offset): void;
 
-}
+}
diff --git a/src/FormValidator.php b/src/FormValidator.php
@@ -506,11 +506,26 @@ public function count(): int
     /**
      * Get values
      *
+     * @param  array $options
      * @return array
      */
-    public function toArray(): array
+    public function toArray(array $options = []): array
     {
-        return $this->values;
+        $fieldValues = $this->values;
+
+        if (!empty($options)) {
+            if (isset($options['exclude'])) {
+                if (!is_array($options['exclude'])) {
+                    $options['exclude'] = [$options['exclude']];
+                }
+                $fieldValues = array_diff_key($fieldValues, array_flip($options['exclude']));
+            }
+            if (isset($options['filter'])) {
+                $fieldValues = array_filter($fieldValues, $options['filter']);
+            }
+        }
+
+        return $fieldValues;
     }
 
     /**
@@ -560,4 +575,4 @@ public function __unset(string $name): void
         }
     }
 
-}
+}