From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

CFRANKS / HTML-FormFu-2.07 / lib / HTML / FormFu / Element / Checkbox.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
—
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

              
use strict;
package HTML::FormFu::Element::Checkbox;
$HTML::FormFu::Element::Checkbox::VERSION = '2.07';
# ABSTRACT: Checkbox form field
use Moose;
extends 'HTML::FormFu::Element';
with 'HTML::FormFu::Role::Element::Input';
use HTML::FormFu::Constants qw( $EMPTY_STR );
__PACKAGE__->mk_output_accessors(qw( default ));
after BUILD => sub {
    my ( $self, $args ) = @_;
    $self->field_type('checkbox');
    $self->value(1);
    $self->multi_layout( [ 'field', 'label', ] );
    return;
};
sub process_value {
    my ( $self, $input ) = @_;
    # ignore submitted input
    return $self->value;
}
sub prepare_attrs {
    my ( $self, $render ) = @_;
    my $form      = $self->form;
    my $submitted = $form->submitted;
    my $default   = $self->default;
    my $original  = $self->value;
    my $value
        = defined $self->name
        ? $self->get_nested_hash_value( $form->input, $self->nested_name )
        : undef;
    if ( defined $value and ref $value eq 'ARRAY' ) {
        $value = $original if grep { $_ eq $original } @$value;
    }
    if (   $submitted
        && defined $value
        && defined $original
        && $value eq $original )
    {
        $render->{attributes}{checked} = 'checked';
    }
    elsif ($submitted
        && $self->retain_default
        && ( !defined $value || $value eq $EMPTY_STR ) )
    {
        $render->{attributes}{checked} = 'checked';
    }
    elsif ($submitted) {
        delete $render->{attributes}{checked};
    }
    elsif ( defined $default && defined $original && $default eq $original ) {
        $render->{attributes}{checked} = 'checked';
    }
    $self->SUPER::prepare_attrs($render);
    return;
}
__PACKAGE__->meta->make_immutable;
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
HTML::FormFu::Element::Checkbox - Checkbox form field
=head1 VERSION
version 2.07
=head1 SYNOPSIS
    my $e = $form->element( Checkbox => 'foo' );
=head1 DESCRIPTION
Checkbox form field.
=head1 METHODS
=head2 value
Default Value: 1
=head2 default_empty_value
Inherited. See L<HTML::FormFu::Role::Element::Field/default_empty_value> for details.
=head2 multi_layout
Overrides the default value of
L<multi_layout|HTML::FormFu::Role::Element::Field/multi_layout>
to swap the C<field> and C<label> around.
=head1 SEE ALSO
Is a sub-class of, and inherits methods from
L<HTML::FormFu::Role::Element::Input>,
L<HTML::FormFu::Role::Element::Field>,
L<HTML::FormFu::Element>
L<HTML::FormFu>
=head1 AUTHOR
Carl Franks, C<cfranks@cpan.org>
=head1 LICENSE
This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.
=head1 AUTHOR
Carl Franks <cpan@fireartist.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2018 by Carl Franks.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut