form: arbitrary options

Author: ext

CHANGELOG.md

@@ -10,11 +10,11 @@
 
 ## Features
 
+  - Form: allow arbitrary attributes to be passed to form.
   - Styling: checkboxes uses `form-checkbox` class.
   - Styling: all layouts now adds `form-group` class.
   - Styling: required fields get a `required` class.
 
-
 # 1.2.3
 
 ## Features

docs/options.php

@@ -30,6 +30,8 @@
 				<dd>Form layout ("plain", "table", "bootstrap" or an instance of <code>FormLayout</code>)</dd>
 				<dt>prefix</dt>
 				<dd>Use custom prefix when generating names and ID</dd>
+				<dt>attr</dt>
+				<dd>Array with arbitrary attributes to pass directly to form.</dd>
 				<dt>Other</dt>
 				<dd>Form also accepts <code>style</code>, <code>class</code> and <code>data</code> which is just passed directly to the form.</dd>
 			</dl>

src/Form.php

@@ -14,12 +14,13 @@ class Form extends FormContainer {
 		'layout' => 'table',                 /* layout engine, one of {plain, table, bootstrap, unbuffered} or a class extending FormLayout. If unbuffered fields is written directly. */
 		'prefix' => false,                   /* use a custom prefix in front of all names, default is nothing for arrays and class name for objects */
 		'style' => '',                       /* add custom style to form, e.g. width */
-		'class' => array(),                  /* additional classes (accepts string or array) */
-		'data' => array(),                   /* extra data attributes */
+		'class' => [],                       /* additional classes (accepts string or array) */
+		'data' => [],                        /* extra data attributes */
+		'attr' => [],                        /* extra arbitrary attributes */
 	);
 
 	public $id = "";
-	public $attr = array('class' => array('form'));
+	public $attr = ['class' => ['form']];
 
 	private $res = null;
 	private $name_pattern = '%s';
@@ -165,6 +166,11 @@ private function parse_options($user){
 		if (   $options['prefix'] ) $this->name_pattern = $options['prefix'] . '[%s]';
 		if (  $options['enctype'] ) $this->attr['enctype'] = $options['enctype'];
 		if (     $options['data'] ) $this->attr['data'] =  $options['data'];
+
+		/* arbitrary options */
+		if ( $options['attr'] ){
+			$this->attr = array_merge($this->attr, $options['attr']);
+		}
 	}
 
 	private function parse_method($method){

tests/DOMParser.php

@@ -21,9 +21,9 @@ protected function onNotSuccessfulTest(Exception $e){
 		throw $e;
 	}
 
-	protected function generate($func){
+	protected function generate($func, array $options=[]){
 		ob_start();
-		Form::create('id', $func, ['layout' => 'table']);
+		Form::create('id', $func, array_merge(['layout' => 'table'], $options));
 		$this->html = ob_get_contents();
 		ob_end_clean();
 	}

tests/LayoutTableTest.php

@@ -14,6 +14,17 @@ public function testHiddenField(){
 		]);
 	}
 
+	public function testFormArbitraryAttribute(){
+		$this->generate(function($f){
+			$f->hidden_field('foo', '1');
+		}, ['attr' => ['foo' => 'bar']]);
+		$this->validate([
+			['form_start', ['foo' => 'bar']],
+			['input', ['type' => 'hidden', 'name' => 'foo', 'value' => 1]],
+			['form_end'],
+		]);
+	}
+
 	public function testTextField(){
 		$this->generate(function($f){
 			$f->text_field('foo', 'Test field');