XXX: hidden options
[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         $attr->{name } = $name  if defined $name;
75         $attr->{value} = $value if defined $value;
76         $attr->{type} = 'hidden' unless defined $attr->{type};
77
78         return $self->tag(input => $attr);
79 }
80
81 sub input {
82         my $self = shift;
83         my ($name, $value, $attr) = $self->_attr(2, @_);
84
85         $attr->{name } = $name  if defined $name;
86         $attr->{value} = $value if defined $value;
87         $attr->{id}   = $attr->{name} unless defined $attr->{id};
88         $attr->{type} = 'text' unless defined $attr->{type} or defined $attr->{rows};
89         $value = delete $attr->{value} if defined $attr->{rows};
90
91         return defined $attr->{rows} ? sprintf(
92                 '%s%s</textarea>',
93                 $self->tag(textarea => $attr),
94                 $self->quote(defined $value ? $value : '')
95         ) : $self->tag(input => $attr);
96 }
97
98 sub select {
99         my $self = shift;
100         my ($name, $rows, $default, $attr) = $self->_attr(3, @_);
101
102         $default = $attr->{value} unless defined $default;
103         delete $attr->{value};  # never a parent attribute
104
105         $attr->{name} = $name;
106         $attr->{id}   = $attr->{name} unless defined $attr->{id};
107         $attr->{type} = 'select' unless defined $attr->{type};
108
109         my @options = map { ref $_ ? $_ : {value => $_} } @$rows;
110
111         if ($attr->{type} eq 'select') {
112                 delete $attr->{type};
113                 if (defined $default) {
114                         for (@options) {
115                                 $_->{selected} = 1 if defined $_->{value} and $_->{value} eq $default;
116                         }
117                 }
118                 my @return = (
119                         $self->tag(select => $attr),
120                         (map { $self->tag(option => $_) } @options),
121                         '</select>',
122                 );
123                 return wantarray ? @return : join('', @return);
124         }
125         else {
126                 if (defined $attr->{id} and $attr->{id} ne '') {
127                         defined $_->{id} or defined $_->{value} and $_->{id} = $attr->{id}.'_'.$_->{value}
128                                 for @options;
129                 }
130                 if (defined $attr->{label}) {
131                         defined $_->{value} and not defined $_->{label}
132                                 and $_->{label} = $attr->{label}->{$_->{value}}
133                                         for @options;
134                         delete $attr->{label};
135                 }
136                 if (defined $default) {
137                         for (@options) {
138                                 $_->{checked} = 1 if defined $_->{value} and $_->{value} eq $default;
139                         }
140                 }
141                 $_ = {%$attr, %$_} for @options;
142                 my @return = map {
143                         my $label = delete $_->{label};
144                         defined $label && $label ne ''
145                                 ? '<label>'.$self->tag(input => $_)." $label</label>"
146                                 :           $self->tag(input => $_)
147                 } @options;
148                 return wantarray ? @return : join('', @return);
149         }
150 }
151
152 sub radio {
153         my $self = shift;
154         my ($name, $label, $value, $attr) = $self->_attr(3, @_);
155
156         if (not defined $value) {
157                 if (defined $label) {
158                         $value = ref $label eq 'ARRAY' ? [1 .. $#$label+1] : [1];
159                 }
160                 else {
161                         $value = [{}];
162                 }
163         }
164         elsif (ref $value ne 'ARRAY') {
165                 $value = [$value];
166         }
167
168         if (defined $label) {
169                 $_ = ref $_ eq 'HASH' ? {%$_} : {value => $_} for @$value;
170                 $_->{label} = ref $label eq 'ARRAY' ? shift @$label : $label for @$value;
171         }
172
173         $self->select($name, $value, {%$attr, type => 'radio'});
174 }
175
176 sub check {
177         my $self = shift;
178         my ($name, $label, $checked, $attr) = $self->_attr(3, @_);
179
180         my $rows = defined $label ? ref $label eq 'ARRAY' ? $label : [$label] : [{}];
181         ref $_ eq 'HASH' or $_ = {label => $_} for @$rows;
182         if (defined $checked) {
183                 if (ref $checked eq 'ARRAY') {
184                         $_->{checked} = shift @$checked for @$rows;
185                         push @$rows, map { {checked => $_} } @$checked;
186                 }
187                 else {
188                         $_->{checked} = $checked for @$rows;
189                 }
190         }
191         exists $rows->[$_]->{value} or $rows->[$_]->{value} = $_ + 1 for 0 .. $#$rows;
192
193         $self->select($name, $rows, {%$attr, type => 'checkbox'});
194 }
195
196 1;
197
198 =head1 NAME
199
200 HTML::Form::Simple
201
202 =head1 SYNOPSIS
203
204         my $input = HTML::Form::Simple->new;
205         say $input->start; # <form>
206         printf "<label>%s: %s</label>\n", @$_ for (
207                 [ 'Your Name' => $input->text(
208                         user => 'Mr. Default'
209                 ) ],
210                 [ Message => $input->text(
211                         msg => 'Textarea default', {rows => 4, style => 'background:red'}
212                 ) ],
213                 [ Gender => join ' or ', $input->radio(
214                         sex => ['m', 'f']
215                 ) ],
216                 [ Colour => scalar $input->select(
217                         favcolour => [qw(Blue Green Red)], 'Green'
218                 ) ],
219                 [ Options => $input->check(
220                         spam => 'Receive weekly newsletter'
221                 ) ],
222         );
223         say $input->stop; # </form>
224