Merge branch 'addons'

Author: ext

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.3.0
+
+## Features
+
+  - Form: support addons: prefix and suffix.
+
 # 1.2.4
 
 ## Breaking changes

docs/index.php

@@ -95,13 +95,6 @@
 				<?php include('overview/objects.php'); ?>
 			</div>
 
-			<h2 id="controls">Supported controls</h2>
-			<p>The basic form of all fields is <code>$f->field($key, $label, $options);</code></p>
-			<?php display('overview/controls.php'); ?>
-			<div class="example">
-				<?php include('overview/controls.php'); ?>
-			</div>
-
 			<h2 id="nested" >Nested data/"forms"</h2>
 			<p>Forms can be nested by using <code>fields_for</code> to allow either sending to unrelated objects or multiple instances of the same class.</p>
 			<?php display('overview/nested.php'); ?>

docs/layout.php

@@ -10,10 +10,12 @@
 		'*'         => 'layout/groups.php',
 	],
 	'Checkboxes' => 'layout/checkboxes.php',
+	'Addons' => 'layout/addons.php',
 	'Layout hints' => [
 		'table'     => 'layout/layout_hints.php',
 		'*'         => false,
 	],
+	'Supported controls' => 'layout/smoke.php',
 ];
 
 require '../vendor/autoload.php';

docs/layout/addons.php

@@ -0,0 +1,12 @@
+<?php /*~*/
+use NitroXy\PHPForms\Form;
+global $layout;
+$data = ['a' => 'Value 1', 'b' => 'Value 2', 'c' => 'Value 3', 'd' => 'Value 4'];
+?>
+<?php
+Form::from_array('example_prefix_suffix', $data, function($f){
+	$f->text_field('a', 'Text 1');
+	$f->text_field('b', 'Text 2', ['prefix' => 'Prefix']);
+	$f->text_field('c', 'Text 3', ['suffix' => 'Suffix']);
+	$f->text_field('d', 'Text 4', ['prefix' => 'Prefix', 'suffix' => 'Suffix']);
+}, ['layout' => $layout]);

docs/overview/controls.php renamed to docs/layout/smoke.php

@@ -1,10 +1,11 @@
 <?php /*~*/
 use NitroXy\PHPForms\Form;
 use NitroXy\PHPForms\FormSelect;
+global $layout;
 ?>
 <?php
 
-Form::create('example5', function($f){
+Form::create('smoketest', function($f){
 	$f->hidden_field('name', 'Hidden (this wont show at all)', ['value' => '8']);
 	$f->text_field('text_field', 'Text', ['hint' => 'Use the "type" option to use custom type such as number.']);
 	$f->password_field('password_field', 'Password', ['hint' => 'Passwords are not persistent if autocomplete is off', 'autocomplete' => 'off']);
@@ -33,4 +34,4 @@
 		$f->text_field('text2', 'Input 2');
 		$f->text_field('text3', 'Input 3');
 	});
-}, ['layout' => 'bootstrap']);
+}, ['layout' => $layout]);

docs/style.css

@@ -14,6 +14,11 @@
 
 .form.table .form-field {
 	padding-right: 10px;
+	width: 200px;
+}
+
+.form.table input:not([type="radio"]):not([type="checkbox"]) {
+	width: 100%;
 }
 
 .form.table .form-hint {
@@ -26,6 +31,17 @@
 	width: 100%;
 }
 
+.form.table .form-addon {
+	display: inline-table;
+}
+
+.form.table .form-suffix, .form.table .form-prefix {
+	display: table-cell;
+	width: auto;
+	background: #eee;
+	padding: 0 8px;
+}
+
 .required label:after {
 	content: '*';
 	color: #a00;

docs/usage.php

@@ -87,6 +87,34 @@ static protected function default_options(){
 	margin-right: 15px;
 }
 EOT
+, 'css'); ?></td>
+					</tr>
+					<tr>
+						<td><code>.form-group</code></td>
+						<td>Class added to row wrapper for for groups.</td>
+						<td></td>
+					</tr>
+					<tr>
+						<td><code>.form-addon</code></td>
+						<td>Class wrapping addons and field when addons are used.</td>
+						<td><?php code(<<<EOT
+/* suggested structural style */
+.form-addon {
+	display: inline-table;
+}
+EOT
+, 'css'); ?></td>
+					</tr>
+					<tr>
+						<td><code>.form-prefix, .form-suffix</code></td>
+						<td>Class added to addons.</td>
+						<td><?php code(<<<EOT
+/* suggested structural style */
+.form-prefix, .form-suffix {
+	display: table-cell;
+	width: auto;
+}
+EOT
 , 'css'); ?></td>
 					</tr>
 					<tr>

src/Form.php

@@ -376,132 +376,3 @@ public function generate_data($key, array &$attr){
 		return array($id, $name, $value);
 	}
 }
-
-class TextAreaField extends FormInput {
-	private $value = '';
-
-	public function __construct($key, $id, $name, $value, $label, $attr) {
-		parent::__construct($key, $id, $name, null, null, $label, $attr);
-		$this->value = $value;
-	}
-
-	public function get_content(array $extra_attr = array()){
-		$attr = array_merge_recursive($extra_attr, $this->attr);
-		$value = htmlspecialchars($this->value);
-		return "<textarea " . $this->serialize_attr($attr) . " >{$value}</textarea>";
-	}
-}
-
-class StaticField extends FormInput {
-	protected $text = null;
-
-	public function __construct($text, $label, $attr){
-		parent::__construct(false, false, false, null, null, $label, $attr);
-		$this->text = $text;
-	}
-
-	public function render($layout, $res) {
-		$layout->render_static($this);
-	}
-
-	public function get_content(array $extra_attr = array()){
-		$attr = array_merge_recursive($extra_attr, $this->attr);
-		$this->pop_attr('icon', $attr, $icon); /* layout reads icon data, puts html back into attr */
-		return $icon . $this->text;
-	}
-
-	public function get_hint(){ return false; }
-	public function get_label(){ return $this->label; }
-	public function layout_hints(){ return 0; }
-	public function get_id() { return false; }
-}
-
-class LinkField extends StaticField {
-	protected $href = null;
-
-	public function __construct($label, $attr){
-		$this->pop_attr('text', $attr, $text);
-		parent::__construct($text, $label, $attr);
-	}
-
-	public function render($layout, $res) {
-		$layout->render_static($this);
-	}
-
-	public function get_content(array $extra_attr = array()){
-		$attr = array_merge_recursive($extra_attr, $this->attr);
-		$this->pop_attr('icon', $attr, $icon); /* layout reads icon data, puts html back into attr */
-		return "<a " . $this->serialize_attr($attr) . ">$icon{$this->text}</a>";
-	}
-
-	public function get_hint(){ return false; }
-	public function get_label(){ return $this->label; }
-	public function layout_hints(){ return 0; }
-	public function get_id() { return false; }
-}
-
-class HintField implements FormField {
-	private $text = null;
-	private $label = null;
-	private $attr = array('class' => 'form-hint');
-	protected $container = null;
-
-	public function __construct($text, $label, $attr){
-		$this->text = $text;
-		$this->label = $label;
-		$this->attr = array_merge($this->attr, $attr);
-	}
-
-	public function render($layout, $res) {
-		$layout->render_hint($this);
-	}
-
-	public function get_hint(){ return false; }
-	public function get_content(){ return $this->text; }
-	public function get_label(){ return $this->label; }
-	public function layout_hints(){ return 0; }
-	public function get_id() { return false; }
-	public function set_container($container){ $this->container = $container; }
-	public function get_container(){ return $this->container; }
-
-	public function attribute($key, $default=false){
-		return array_key_exists($key, $this->attr) ? $this->attr[$key] : $default;
-	}
-}
-
-class ManualField implements FormField {
-	private $key = null;
-	private $label = null;
-	private $content = null;
-	private $hint = null;
-	protected $container = null;
-
-	public function __construct($key, $label, $content, $hint){
-		$this->key = $key;
-		$this->label = $label;
-		$this->content = $content;
-		$this->hint = $hint;
-	}
-
-	public function render($layout, $res) {
-		$layout->render_field($this, $this->get_error($res));
-	}
-
-	public function get_error($res){
-		if ( !($this->key && isset($res->errors[$this->key])) ) return false;
-		return ucfirst($res->errors[$this->key][0]); /* get first error only */
-	}
-
-	public function get_name(){ return $this->key; }
-	public function get_label(){ return $this->label; }
-	public function get_content(){ return $this->content; }
-	public function get_hint(){ return $this->hint; }
-	public function layout_hints(){ return 0; }
-	public function get_id() { return false; }
-	public function set_container($container){ $this->container = $container; }
-	public function get_container(){ return $this->container; }
-
-	public function attribute($key, $default=false){
-		return $default; /* no sane way to get attributes from manual fields */
-	}
-}

src/lib/FormContainer.php

@@ -12,14 +12,16 @@ public function __construct($form){
 
 	/**
 	 * Generates any kind of input, used by most other fields. Note that
-   * this function should not be called directly, use
-   * <code>custom_field()</code> instead. Common options for all
-   * fields:
+	 * this function should not be called directly, use
+	 * <code>custom_field()</code> instead. Common options for all
+	 * fields:
 	 *
 	 * @option 'value' {string} If value is set as an attribute it
 	 *         forces the value (irregardless of the object).
-   * @option 'required' {boolean} Set field to required (using HTML
+	 * @option 'required' {boolean} Set field to required (using HTML
 	 *         <code>required</code> attribute).
+	 * @option 'prefix' {string} Add a prefix addon.
+	 * @option 'suffix' {string} Add a suffix addon.
 	 */
 	public function factory($type, $key, $label=null, array $attr=array()){
 		if ( $label && !is_string($label) ){
@@ -129,7 +131,7 @@ public function manual($key, $label, $content, $hint){
 	 *
 	 * @option remove {boolean} If true a checkbox to remove the current value will be added.
 	 * @option current {html} If set to non-false the content will be displayed as the
-	 *                 current value, e.g can be set to <img ..>  to display the
+	 *                 current value, e.g can be set to &lt;img ..&gt; to display the
 	 *                 current uploaded image.
 	 */
 	public function upload_field($key, $label=null, array $attr=array()) {
@@ -225,10 +227,10 @@ public function link($text, $href, $label=false, array $attr=array()){
 	 * Create textarea.
 	 *
 	 * @option 'tworow' {boolean} Layout hint to use two rows having the
-   *          label on one row label and the textfield below.
+	 *          label on one row label and the textfield below.
 	 * @option 'fill' {boolean} Layout hint used together with
-   *         <code>'tworow'</code> to fill the entire row (not just
-   *         label + content).
+	 *         <code>'tworow'</code> to fill the entire row (not just
+	 *         label + content).
 	 */
 	public function textarea($key, $label=null, array $attr=array()){
 		$this->fields[] = $this->factory('textarea', $key, $label, $attr);

src/lib/FormInput.php

@@ -10,6 +10,8 @@ class FormInput implements FormField {
 	protected $tworow = 0;
 	protected $fill = 0;
 	protected $icon = false;
+	protected $prefix = false;
+	protected $suffix = false;
 	protected $container = null;
 	protected $attr = array();
 
@@ -34,6 +36,8 @@ public function __construct($key, $id, $name, $value, $type, $label, $attr) {
 		$this->pop_attr('tworow', $attr, $this->tworow);
 		$this->pop_attr('fill', $attr, $this->fill);
 		$this->pop_attr('icon', $attr, $this->icon);
+		$this->pop_attr('prefix', $attr, $this->prefix);
+		$this->pop_attr('suffix', $attr, $this->suffix);
 
 		if ( $value !== null ) $attr['value'] = $value;
 		if (    $id != null ) $attr['id'] = $id;
@@ -84,6 +88,10 @@ public function get_icon(){
 		return $this->icon;
 	}
 
+	public function get_addons(){
+		return [$this->prefix, $this->suffix];
+	}
+
 	public function get_value(){
 		return array_key_exists('value', $this->attr) ? $this->attr['value'] : null;
 	}

src/lib/FormLayoutBootstrap.php

@@ -11,6 +11,12 @@ public function render_field($field, $error){
 		$hint = $field->get_hint();
 		$required = $field->attribute('required');
 
+		/* addons */
+		list($prefix, $suffix) = $field->get_addons();
+		$have_addon = (boolean)($prefix || $suffix);
+		if ( $prefix ) $prefix = "<div class=\"input-group-addon\">{$prefix}</div>";
+		if ( $suffix ) $suffix = "<div class=\"input-group-addon\">{$suffix}</div>";
+
 		$class = ['form-group'];
 		if ( $error ){
 			$class[] = 'has-error';
@@ -40,7 +46,11 @@ public function render_field($field, $error){
 		if ( $label ){
 			echo "	<label for=\"$id\" class=\"control-label\">{$label}</label>";
 		}
-		echo "	$content";
+		if ( $have_addon ){
+			echo "	<div class=\"input-group\">{$prefix}{$content}{$suffix}</div>";
+		} else {
+			echo "	$content";
+		}
 		if ( $hint ){
 			echo "	<span class=\"help-block\">$hint</span>";
 		}

src/lib/FormLayoutPlain.php

@@ -17,9 +17,22 @@ public function render_field($field, $error){
 
 		$row_attr = FormUtils::serialize_attr(['class' => $class]);
 
+		if ( $field instanceof FormInput ){
+			list($prefix, $suffix) = $field->get_addons();
+			$have_addon = (boolean)($prefix || $suffix);
+			if ( $prefix ) $prefix = "<span class=\"form-prefix\">{$prefix}</span>";
+			if ( $suffix ) $suffix = "<span class=\"form-suffix\">{$suffix}</span>";
+		} else {
+			$have_addon = false;
+		}
+
 		echo "<div {$row_attr}>\n";
 		if ( $label !== false )  echo "<span class=\"form-label\">$label</span>\n";
-		if ( $content !== false) echo "<span class=\"form-field\">$content</span>\n";
+		if ( $have_addon ){
+			echo "<span class=\"form-field\"><span class=\"form-addon\">{$prefix}{$content}{$suffix}</span></span>\n";
+		} else if ( $content !== false ){
+			echo "<span class=\"form-field\">$content</span>\n";
+		}
 		if($error !== false)     echo "<span class=\"form-error\">$error</span>\n";
 		if($hint !== false)      echo "<span class=\"form-hint\">$hint</span>\n";
 		echo '</div>';