XXX: hidden hash
[perl/html-form-simple.git] / lib / HTML / Form / Simple.pm
1 package HTML::Form::Simple;
2
3 use strict;
4 use warnings;
5
6 use XML::Quote;
7
8 our $VERSION = '1.00';
9
10
11 sub new {
12         bless {}, $_[0];
13 }
14
15 sub _attr {
16         my $self = shift;
17         my $expect = shift;
18         my $attr = ref $_[-1] eq 'HASH' ? pop : {};
19         push @_, undef for @_+1 .. $expect;
20         push @_, $attr;
21         return @_;
22 }
23
24 sub quote {
25         my $self = shift;
26         return XML::Quote::xml_quote_min($_[0]);
27 }
28
29 sub tag {
30         my ($self, $tag, $attr) = @_;
31
32         # strip empty if it shouldn't be
33         defined $attr->{$_} and $attr->{$_} eq '' and delete $attr->{$_}
34                 for qw(id type class style);
35
36         my $return = '<' . $tag;
37
38         # add booleans
39         delete $attr->{$_} and $return .= ' '.$_
40                 for qw(selected checked disabled readonly);
41
42         $return .= sprintf ' %s="%s"', $_, $self->quote($attr->{$_})
43                 for sort grep { defined $attr->{$_} } keys %$attr;
44
45         return $return . '>';
46 }
47
48
49 sub start {
50         my ($self, $attr) = @_;
51
52         return $self->tag(form => $attr);
53 }
54
55 sub stop {
56         return '</form>';
57 }
58
59
60 sub submit {
61         my $self = shift;
62         my ($value, $attr) = $self->_attr(1, @_);
63
64         $attr->{value} = $value if defined $value;
65         $attr->{type} = 'submit' unless defined $attr->{type};
66
67         return $self->tag(input => $attr);
68 }
69
70 sub hidden {
71         my $self = shift;
72         my ($name, $value, $attr) = $self->_attr(2, @_);
73
74         if (ref $name eq 'HASH') {
75                 my @return = map { $self->hidden($_, $name->{$_}, $attr) } sort keys %$name;
76                 return wantarray ? @return : join(defined $, ? $, : '', @return);
77         }
78
79         $attr->{name } = $name  if defined $name;
80         $attr->{value} = $value if defined $value;
81         $attr->{type} = 'hidden' unless defined $attr->{type};
82
83         return $self->tag(input => $attr);
84 }
85
86 sub input {
87         my $self = shift;
88         my ($name, $value, $attr) = $self->_attr(2, @_);
89
90         $attr->{name } = $name  if defined $name;
91         $attr->{value} = $value if defined $value;
92         $attr->{id}   = $attr->{name} unless defined $attr->{id};
93         $attr->{type} = 'text' unless defined $attr->{type} or defined $attr->{rows};
94         $value = delete $attr->{value} if defined $attr->{rows};
95
96         return defined $attr->{rows} ? sprintf(
97                 '%s%s</textarea>',
98                 $self->tag(textarea => $attr),
99                 $self->quote(defined $value ? $value : '')
100         ) : $self->tag(input => $attr);
101 }
102
103 sub select {
104         my $self = shift;
105         my ($name, $rows, $default, $attr) = $self->_attr(3, @_);
106
107         $default = $attr->{value} unless defined $default;
108         delete $attr->{value};  # never a parent attribute
109
110         $attr->{name} = $name;
111         $attr->{id}   = $attr->{name} unless defined $attr->{id};
112         $attr->{type} = 'select' unless defined $attr->{type};
113
114         my @options = map { ref $_ ? $_ : {value => $_} } @$rows;
115
116         my @return;
117
118         if ($attr->{type} eq 'select') {
119                 delete $attr->{type};
120                 if (defined $default) {
121                         for (@options) {
122                                 $_->{selected} = 1 if defined $_->{value} and $_->{value} eq $default;
123                         }
124                 }
125                 @return = (
126                         $self->tag(select => $attr),
127                         (map { $self->tag(option => $_) } @options),
128                         '</select>',
129                 );
130         }
131         else {
132                 if (defined $attr->{id} and $attr->{id} ne '') {
133                         defined $_->{id}
134                                 or defined $_->{value} and $_->{id} = $attr->{id}.'_'.$_->{value}
135                                         for @options;
136                 }
137                 if (defined $attr->{label}) {
138                         defined $_->{value} and not defined $_->{label}
139                                 and $_->{label} = $attr->{label}->{$_->{value}}
140                                         for @options;
141                         delete $attr->{label};
142                 }
143                 if (defined $default) {
144                         for (@options) {
145                                 $_->{checked} = 1 if defined $_->{value} and $_->{value} eq $default;
146                         }
147                 }
148                 $_ = {%$attr, %$_} for @options;
149                 @return = map {
150                         my $label = delete $_->{label};
151                         defined $label && $label ne ''
152                                 ? '<label>'.$self->tag(input => $_)." $label</label>"
153                                 :           $self->tag(input => $_)
154                 } @options;
155         }
156
157         return wantarray ? @return : join(defined $, ? $, : '', @return);
158 }
159
160 sub radio {
161         my $self = shift;
162         my ($name, $label, $value, $attr) = $self->_attr(3, @_);
163
164         if (not defined $value) {
165                 if (defined $label) {
166                         $value = ref $label eq 'ARRAY' ? [1 .. $#$label+1] : [1];
167                 }
168                 else {
169                         $value = [{}];
170                 }
171         }
172         elsif (ref $value ne 'ARRAY') {
173                 $value = [$value];
174         }
175
176         if (defined $label) {
177                 $_ = ref $_ eq 'HASH' ? {%$_} : {value => $_} for @$value;
178                 $_->{label} = ref $label eq 'ARRAY' ? shift @$label : $label for @$value;
179         }
180
181         $self->select($name, $value, {%$attr, type => 'radio'});
182 }
183
184 sub check {
185         my $self = shift;
186         my ($name, $label, $checked, $attr) = $self->_attr(3, @_);
187
188         my $rows = defined $label ? ref $label eq 'ARRAY' ? $label : [$label] : [{}];
189         ref $_ eq 'HASH' or $_ = {label => $_} for @$rows;
190         if (defined $checked) {
191                 if (ref $checked eq 'ARRAY') {
192                         $_->{checked} = shift @$checked for @$rows;
193                         push @$rows, map { {checked => $_} } @$checked;
194                 }
195                 else {
196                         $_->{checked} = $checked for @$rows;
197                 }
198         }
199         exists $rows->[$_]->{value} or $rows->[$_]->{value} = $_ + 1 for 0 .. $#$rows;
200
201         $self->select($name, $rows, {%$attr, type => 'checkbox'});
202 }
203
204 1;
205
206 =head1 NAME
207
208 HTML::Form::Simple
209
210 =head1 SYNOPSIS
211
212         my $input = HTML::Form::Simple->new;
213         say $input->start; # <form>
214         printf "<label>%s: %s</label>\n", @$_ for (
215                 [ 'Your Name' => $input->text(
216                         user => 'Mr. Default'
217                 ) ],
218                 [ Message => $input->text(
219                         msg => 'Textarea default', {rows => 4, style => 'background:red'}
220                 ) ],
221                 [ Gender => join ' or ', $input->radio(
222                         sex => ['m', 'f']
223                 ) ],
224                 [ Colour => scalar $input->select(
225                         favcolour => [qw(Blue Green Red)], 'Green'
226                 ) ],
227                 [ Options => $input->check(
228                         spam => 'Receive weekly newsletter'
229                 ) ],
230         );
231         say $input->stop; # </form>
232