Merge pull request #11004 from lilHermit/lilHermit/contextarray-nesting

Make ArrayContext easier to work with

Allow schema/required/default values to be defined once
and re-used across multi-record forms.

src/View/Form/ArrayContext.php

@@ -177,7 +177,12 @@ class ArrayContext implements ContextInterface
             return null;
         }
 
-        return Hash::get($this->_context['defaults'], $field);
+        // Using Hash::check here incase the default value is actually null
+        if (Hash::check($this->_context['defaults'], $field)) {
+            return Hash::get($this->_context['defaults'], $field);
+        }
+
+        return Hash::get($this->_context['defaults'], $this->stripNesting($field));
     }
 
     /**
@@ -194,6 +199,9 @@ class ArrayContext implements ContextInterface
             return false;
         }
         $required = Hash::get($this->_context['required'], $field);
+        if ($required === null) {
+            $required = Hash::get($this->_context['required'], $this->stripNesting($field));
+        }
 
         return (bool)$required;
     }
@@ -221,7 +229,11 @@ class ArrayContext implements ContextInterface
         if (!is_array($this->_context['schema'])) {
             return null;
         }
+
         $schema = Hash::get($this->_context['schema'], $field);
+        if ($schema === null) {
+            $schema = Hash::get($this->_context['schema'], $this->stripNesting($field));
+        }
 
         return isset($schema['type']) ? $schema['type'] : null;
     }
@@ -237,10 +249,13 @@ class ArrayContext implements ContextInterface
         if (!is_array($this->_context['schema'])) {
             return [];
         }
-        $schema = (array)Hash::get($this->_context['schema'], $field);
+        $schema = Hash::get($this->_context['schema'], $field);
+        if ($schema === null) {
+            $schema = Hash::get($this->_context['schema'], $this->stripNesting($field));
+        }
         $whitelist = ['length' => null, 'precision' => null];
 
-        return array_intersect_key($schema, $whitelist);
+        return array_intersect_key((array)$schema, $whitelist);
     }
 
     /**
@@ -273,4 +288,17 @@ class ArrayContext implements ContextInterface
 
         return Hash::get($this->_context['errors'], $field);
     }
+
+    /**
+     * Strips out any numeric nesting
+     *
+     * For example users.0.age will output as users.age
+     *
+     * @param string $field A dot separated path
+     * @return string A string with stripped numeric nesting
+     */
+    protected function stripNesting($field)
+    {
+        return preg_replace('/\.\d*\./', '.', $field);
+    }
 }

tests/TestCase/View/Form/ArrayContextTest.php

@@ -169,6 +169,9 @@ class ArrayContextTest extends TestCase
     /**
      * Test getting default value
      *
+     * Tests includes making sure numeric elements are stripped but not keys beginning with numeric
+     * value
+     *
      * @return void
      */
     public function testValDefault()
@@ -176,10 +179,14 @@ class ArrayContextTest extends TestCase
         $context = new ArrayContext($this->request, [
             'defaults' => [
                 'title' => 'Default value',
+                'users' => ['tags' => 'common1', '9tags' => 'common2']
             ]
         ]);
 
         $this->assertEquals('Default value', $context->val('title'));
+        $this->assertEquals('common1', $context->val('users.0.tags'));
+        $this->assertEquals('common1', $context->val('users.99.tags'));
+        $this->assertEquals('common2', $context->val('users.9.9tags'));
         $result = $context->val('title', ['default' => 'explicit default']);
         $this->assertEquals('explicit default', $result);
     }
@@ -195,12 +202,14 @@ class ArrayContextTest extends TestCase
             'required' => [
                 'Comments' => [
                     'required' => true,
-                    'nope' => false
+                    'nope' => false,
+                    'tags' => true
                 ]
             ]
         ]);
         $this->assertTrue($context->isRequired('Comments.required'));
         $this->assertFalse($context->isRequired('Comments.nope'));
+        $this->assertTrue($context->isRequired('Comments.0.tags'));
         $this->assertFalse($context->isRequired('Articles.id'));
     }
 
@@ -226,12 +235,14 @@ class ArrayContextTest extends TestCase
             'schema' => [
                 'Comments' => [
                     'id' => ['type' => 'integer'],
+                    'tags' => ['type' => 'string'],
                     'comment' => ['length' => 255]
                 ]
             ]
         ]);
         $this->assertNull($context->type('Comments.undefined'));
         $this->assertEquals('integer', $context->type('Comments.id'));
+        $this->assertEquals('string', $context->type('Comments.0.tags'));
         $this->assertNull($context->type('Comments.comment'));
     }
 
@@ -260,10 +271,12 @@ class ArrayContextTest extends TestCase
                     'comment' => ['type' => 'string', 'length' => 255],
                     'decimal' => ['type' => 'decimal', 'precision' => 2, 'length' => 5],
                     'floaty' => ['type' => 'float', 'precision' => 2, 'length' => 5],
+                    'tags' => ['type' => 'string', 'length' => 25],
                 ]
             ]
         ]);
         $this->assertEquals([], $context->attributes('Comments.id'));
+        $this->assertEquals(['length' => 25], $context->attributes('Comments.0.tags'));
         $this->assertEquals(['length' => 255], $context->attributes('Comments.comment'));
         $this->assertEquals(['precision' => 2, 'length' => 5], $context->attributes('Comments.decimal'));
         $this->assertEquals(['precision' => 2, 'length' => 5], $context->attributes('Comments.floaty'));