Use the field name as array key

Author: ivanvermeyen

src/FormFieldPrefixer.php

@@ -23,8 +23,14 @@ class FormFieldPrefixer
     protected $arrayKey = null;
 
     /**
-     * Indicator if we are generating a form field name
-     * with a multi dimensional array.
+     * Indicator if we are generating a form field name as an array.
+     *
+     * @var bool
+     */
+    protected $isArray = false;
+
+    /**
+     * Indicator if we are generating a form field name with a multi dimensional array.
      *
      * @var bool
      */
@@ -75,9 +81,10 @@ public function withPrefix($prefix)
      *
      * @return $this
      */
-    public function asArray($arrayKey, $multiDimensional = false)
+    public function asArray($arrayKey = null, $multiDimensional = false)
     {
         $this->arrayKey = $arrayKey;
+        $this->isArray = true;
         $this->multiDimensional = $multiDimensional && $this->prefix !== null;
 
         return $this;
@@ -229,11 +236,11 @@ public function validationKey($key)
      */
     public function isArray()
     {
-        return ! is_null($this->arrayKey);
+        return $this->isArray;
     }
 
     /**
-     * Check if the form field is an array.
+     * Check if the form field is a multi dimensional array.
      *
      * @return bool
      */
@@ -252,6 +259,16 @@ public function hasPrefix()
         return !! $this->prefix;
     }
 
+    /**
+     * Check if the form field has an array key.
+     *
+     * @return bool
+     */
+    public function hasArrayKey()
+    {
+        return ! is_null($this->arrayKey);
+    }
+
     /**
      * Build the attribute.
      *
@@ -307,7 +324,7 @@ protected function buildAttributeValue($name, $useArraySyntax, $separator = null
         $separator = $separator ?: $this->getDefaultSeparator();
 
         $prefix = $this->buildName($name);
-        $arrayKey = $this->buildArrayKey($useArraySyntax, $separator);
+        $arrayKey = $this->buildArrayKey($name, $useArraySyntax, $separator);
         $arrayName = $this->buildArrayName($name, $useArraySyntax, $separator);
 
         $identifier = $prefix . $arrayKey . $arrayName;
@@ -332,7 +349,7 @@ protected function buildName($name)
             return $name;
         }
 
-        if ($this->isMultiDimensionalArray()) {
+        if ($this->isMultiDimensionalArray() || ($this->isArray() && ! $this->hasArrayKey())) {
             return $this->prefix;
         }
 
@@ -342,18 +359,19 @@ protected function buildName($name)
     /**
      * Build the array key part of the form field identifier if needed.
      *
+     * @param string $name
      * @param bool $useArraySyntax
      * @param string $separator
      *
      * @return string
      */
-    protected function buildArrayKey($useArraySyntax, $separator)
+    protected function buildArrayKey($name, $useArraySyntax, $separator)
     {
         if ( ! $this->isArray()) {
             return '';
         }
 
-        return $this->buildArrayIdentifier($this->arrayKey, $useArraySyntax, $separator);
+        return $this->buildArrayIdentifier($this->arrayKey ?: $name, $useArraySyntax, $separator);
     }
 
     /**
@@ -368,7 +386,7 @@ protected function buildArrayKey($useArraySyntax, $separator)
      */
     protected function buildArrayName($name, $useArraySyntax, $separator)
     {
-        if ( ! $this->hasPrefix() || ! $this->isMultiDimensionalArray()) {
+        if ( ! $this->isMultiDimensionalArray()) {
             return '';
         }
 
@@ -398,7 +416,7 @@ protected function buildArrayIdentifier($value, $useArraySyntax, $separator)
      */
     protected function buildJavaScriptValueKey($key)
     {
-        if ($this->isMultiDimensionalArray()) {
+        if ($this->isMultiDimensionalArray() || ($this->isArray() && ! $this->hasArrayKey())) {
             $key = "'{$key}'";
         }
 

tests/Feature/OldInputValueTest.php

@@ -92,6 +92,20 @@ public function it_builds_the_value_attribute_with_prefixed_arrays()
         $this->assertEquals('value="test value"', $prefixer->value('abc'));
     }
 
+    /** @test */
+    public function it_builds_the_value_attribute_with_prefixed_arrays_using_the_field_name_as_array_key()
+    {
+        Session::flashInput([
+            'prefix' => [
+                'abc' => 'test value'
+            ]
+        ]);
+
+        $prefixer = (new FormFieldPrefixer('prefix'))->asArray();
+
+        $this->assertEquals('value="test value"', $prefixer->value('abc'));
+    }
+
     /** @test */
     public function it_builds_the_value_attribute_with_multi_dimensional_arrays()
     {

tests/Feature/OldSelectedOptionTest.php

@@ -103,6 +103,22 @@ public function it_builds_the_selected_attribute_with_prefixed_arrays()
         $this->assertEquals('', $prefixer->select('abc'));
     }
 
+    /** @test */
+    public function it_builds_the_selected_attribute_with_prefixed_arrays_using_the_field_name_as_array_key()
+    {
+        Session::flashInput([
+            'prefix' => [
+                'abc' => 'selected option value'
+            ]
+        ]);
+
+        $prefixer = (new FormFieldPrefixer('prefix'))->asArray();
+
+        $this->assertEquals('selected="selected"', $prefixer->selected('abc', 'selected option value'));
+        $this->assertEquals('', $prefixer->selected('abc', 'other option value'));
+        $this->assertEquals('', $prefixer->select('abc'));
+    }
+
     /** @test */
     public function it_builds_the_selected_attribute_with_multi_dimensional_arrays()
     {

tests/Unit/FormFieldPrefixerTest.php

@@ -41,7 +41,7 @@ public function it_builds_input_identifiers_with_a_prefix_via_a_method_call()
     }
 
     /** @test */
-    public function it_builds_input_identifiers_as_an_array()
+    public function it_builds_input_identifiers_as_an_array_without_prefix()
     {
         $prefixer = (new FormFieldPrefixer())->asArray('arrayKey');
 
@@ -62,6 +62,17 @@ public function it_builds_input_identifiers_as_an_array_with_prefix()
         $this->assertEquals('prefix_abc.arrayKey', $prefixer->validationKey('abc'));
     }
 
+    /** @test */
+    public function it_builds_input_identifiers_using_the_field_name_as_array_key()
+    {
+        $prefixer = (new FormFieldPrefixer('prefix'))->asArray();
+
+        $this->assertEquals('name="prefix[abc]"', $prefixer->name('abc'));
+        $this->assertEquals('id="prefix_abc"', $prefixer->id('abc'));
+        $this->assertEquals('for="prefix_abc"', $prefixer->for('abc'));
+        $this->assertEquals('prefix.abc', $prefixer->validationKey('abc'));
+    }
+
     /** @test */
     public function it_builds_input_identifiers_as_a_multi_dimensional_array_with_prefix()
     {