Skip to content

Commit 7aa094a

Browse files
extext
committed
form: support addons
1 parent 9b92e78 commit 7aa094a

File tree

12 files changed

+166
-11
lines changed

12 files changed

+166
-11
lines changed

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# 1.3.0
2+
3+
## Features
4+
5+
- Form: support addons: prefix and suffix.
6+
17
# 1.2.4
28

39
## Breaking changes

‎docs/layout.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
'*' => 'layout/groups.php',
1111
],
1212
'Checkboxes' => 'layout/checkboxes.php',
13+
'Addons' => 'layout/addons.php',
1314
'Layout hints' => [
1415
'table' => 'layout/layout_hints.php',
1516
'*' => false,

‎docs/layout/addons.php‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?php /*~*/
2+
use NitroXy\PHPForms\Form;
3+
global $layout;
4+
$data = ['a' => 'Value 1', 'b' => 'Value 2', 'c' => 'Value 3', 'd' => 'Value 4'];
5+
?>
6+
<?php
7+
Form::from_array('example_prefix_suffix', $data, function($f){
8+
$f->text_field('a', 'Text 1');
9+
$f->text_field('b', 'Text 2', ['prefix' => 'Prefix']);
10+
$f->text_field('c', 'Text 3', ['suffix' => 'Suffix']);
11+
$f->text_field('d', 'Text 4', ['prefix' => 'Prefix', 'suffix' => 'Suffix']);
12+
}, ['layout' => $layout]);

‎docs/style.css‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414

1515
.form.table .form-field {
1616
padding-right: 10px;
17+
width: 200px;
18+
}
19+
20+
.form.table input:not([type="radio"]):not([type="checkbox"]) {
21+
width: 100%;
1722
}
1823

1924
.form.table .form-hint {
@@ -26,6 +31,17 @@
2631
width: 100%;
2732
}
2833

34+
.form.table .form-addon {
35+
display: inline-table;
36+
}
37+
38+
.form.table .form-suffix, .form.table .form-prefix {
39+
display: table-cell;
40+
width: auto;
41+
background: #eee;
42+
padding: 0 8px;
43+
}
44+
2945
.required label:after {
3046
content: '*';
3147
color: #a00;

‎docs/usage.php‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,34 @@ static protected function default_options(){
8787
margin-right: 15px;
8888
}
8989
EOT
90+
, 'css'); ?></td>
91+
</tr>
92+
<tr>
93+
<td><code>.form-group</code></td>
94+
<td>Class added to row wrapper for for groups.</td>
95+
<td></td>
96+
</tr>
97+
<tr>
98+
<td><code>.form-addon</code></td>
99+
<td>Class wrapping addons and field when addons are used.</td>
100+
<td><?php code(<<<EOT
101+
/* suggested structural style */
102+
.form-addon {
103+
display: inline-table;
104+
}
105+
EOT
106+
, 'css'); ?></td>
107+
</tr>
108+
<tr>
109+
<td><code>.form-prefix, .form-suffix</code></td>
110+
<td>Class added to addons.</td>
111+
<td><?php code(<<<EOT
112+
/* suggested structural style */
113+
.form-prefix, .form-suffix {
114+
display: table-cell;
115+
width: auto;
116+
}
117+
EOT
90118
, 'css'); ?></td>
91119
</tr>
92120
<tr>

‎src/Form.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,7 @@ public function get_name(){ return $this->key; }
496496
public function get_label(){ return $this->label; }
497497
public function get_content(){ return $this->content; }
498498
public function get_hint(){ return $this->hint; }
499+
public function get_addons(){ return [false, false]; }
499500
public function layout_hints(){ return 0; }
500501
public function get_id() { return false; }
501502
public function set_container($container){ $this->container = $container; }

‎src/lib/FormContainer.php‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,16 @@ public function __construct($form){
1212

1313
/**
1414
* Generates any kind of input, used by most other fields. Note that
15-
* this function should not be called directly, use
16-
* <code>custom_field()</code> instead. Common options for all
17-
* fields:
15+
* this function should not be called directly, use
16+
* <code>custom_field()</code> instead. Common options for all
17+
* fields:
1818
*
1919
* @option 'value' {string} If value is set as an attribute it
2020
* forces the value (irregardless of the object).
21-
* @option 'required' {boolean} Set field to required (using HTML
21+
* @option 'required' {boolean} Set field to required (using HTML
2222
* <code>required</code> attribute).
23+
* @option 'prefix' {string} Add a prefix addon.
24+
* @option 'suffix' {string} Add a suffix addon.
2325
*/
2426
public function factory($type, $key, $label=null, array $attr=array()){
2527
if ( $label && !is_string($label) ){
@@ -129,7 +131,7 @@ public function manual($key, $label, $content, $hint){
129131
*
130132
* @option remove {boolean} If true a checkbox to remove the current value will be added.
131133
* @option current {html} If set to non-false the content will be displayed as the
132-
* current value, e.g can be set to <img ..> to display the
134+
* current value, e.g can be set to &lt;img ..&gt; to display the
133135
* current uploaded image.
134136
*/
135137
public function upload_field($key, $label=null, array $attr=array()) {
@@ -225,10 +227,10 @@ public function link($text, $href, $label=false, array $attr=array()){
225227
* Create textarea.
226228
*
227229
* @option 'tworow' {boolean} Layout hint to use two rows having the
228-
* label on one row label and the textfield below.
230+
* label on one row label and the textfield below.
229231
* @option 'fill' {boolean} Layout hint used together with
230-
* <code>'tworow'</code> to fill the entire row (not just
231-
* label + content).
232+
* <code>'tworow'</code> to fill the entire row (not just
233+
* label + content).
232234
*/
233235
public function textarea($key, $label=null, array $attr=array()){
234236
$this->fields[] = $this->factory('textarea', $key, $label, $attr);

‎src/lib/FormInput.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ class FormInput implements FormField {
1010
protected $tworow = 0;
1111
protected $fill = 0;
1212
protected $icon = false;
13+
protected $prefix = false;
14+
protected $suffix = false;
1315
protected $container = null;
1416
protected $attr = array();
1517

@@ -34,6 +36,8 @@ public function __construct($key, $id, $name, $value, $type, $label, $attr) {
3436
$this->pop_attr('tworow', $attr, $this->tworow);
3537
$this->pop_attr('fill', $attr, $this->fill);
3638
$this->pop_attr('icon', $attr, $this->icon);
39+
$this->pop_attr('prefix', $attr, $this->prefix);
40+
$this->pop_attr('suffix', $attr, $this->suffix);
3741

3842
if ( $value !== null ) $attr['value'] = $value;
3943
if ( $id != null ) $attr['id'] = $id;
@@ -84,6 +88,10 @@ public function get_icon(){
8488
return $this->icon;
8589
}
8690

91+
public function get_addons(){
92+
return [$this->prefix, $this->suffix];
93+
}
94+
8795
public function get_value(){
8896
return array_key_exists('value', $this->attr) ? $this->attr['value'] : null;
8997
}

‎src/lib/FormLayoutBootstrap.php‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ public function render_field($field, $error){
1111
$hint = $field->get_hint();
1212
$required = $field->attribute('required');
1313

14+
/* addons */
15+
list($prefix, $suffix) = $field->get_addons();
16+
$have_addon = (boolean)($prefix || $suffix);
17+
if ( $prefix ) $prefix = "<div class=\"input-group-addon\">{$prefix}</div>";
18+
if ( $suffix ) $suffix = "<div class=\"input-group-addon\">{$suffix}</div>";
19+
1420
$class = ['form-group'];
1521
if ( $error ){
1622
$class[] = 'has-error';
@@ -40,7 +46,11 @@ public function render_field($field, $error){
4046
if ( $label ){
4147
echo " <label for=\"$id\" class=\"control-label\">{$label}</label>";
4248
}
43-
echo " $content";
49+
if ( $have_addon ){
50+
echo " <div class=\"input-group\">{$prefix}{$content}{$suffix}</div>";
51+
} else {
52+
echo " $content";
53+
}
4454
if ( $hint ){
4555
echo " <span class=\"help-block\">$hint</span>";
4656
}

‎src/lib/FormLayoutPlain.php‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,22 @@ public function render_field($field, $error){
1717

1818
$row_attr = FormUtils::serialize_attr(['class' => $class]);
1919

20+
if ( $field instanceof FormInput ){
21+
list($prefix, $suffix) = $field->get_addons();
22+
$have_addon = (boolean)($prefix || $suffix);
23+
if ( $prefix ) $prefix = "<span class=\"form-prefix\">{$prefix}</span>";
24+
if ( $suffix ) $suffix = "<span class=\"form-suffix\">{$suffix}</span>";
25+
} else {
26+
$have_addon = false;
27+
}
28+
2029
echo "<div {$row_attr}>\n";
2130
if ( $label !== false ) echo "<span class=\"form-label\">$label</span>\n";
22-
if ( $content !== false) echo "<span class=\"form-field\">$content</span>\n";
31+
if ( $have_addon ){
32+
echo "<span class=\"form-field\"><span class=\"form-addon\">{$prefix}{$content}{$suffix}</span></span>\n";
33+
} else if ( $content !== false ){
34+
echo "<span class=\"form-field\">$content</span>\n";
35+
}
2336
if($error !== false) echo "<span class=\"form-error\">$error</span>\n";
2437
if($hint !== false) echo "<span class=\"form-hint\">$hint</span>\n";
2538
echo '</div>';

0 commit comments

Comments
 (0)