# ABSTRACT: ** Please provide abstract **

package Form::Processor::Field::Select;
$Form::Processor::Field::Select::VERSION = '1.162360';
use strict;
use warnings;
use base 'Form::Processor::Field';



use Rose::Object::MakeMethods::Generic (
    array => [

        # Array of hashes with value and label.
        options => { interface => 'get_set_init' },
        reset_options => { interface => 'reset', hash_key => 'options' },
    ],
    scalar => [
        multiple => { interface => 'get_set_init' },
        size     => { interface => 'get_set_init' },

        label_column     => { interface => 'get_set_init' },
        active_column    => { interface => 'get_set_init' },
        auto_widget_size => { interface => 'get_set_init' },
        sort_order       => {},
    ],
);


sub init_options { [] }

sub init_widget {'select'}


sub init_multiple {0}


sub init_auto_widget_size {0}


sub select_widget {
    my $field = shift;

    my $size = $field->auto_widget_size;

    return $field->widget unless $field->widget eq 'select' && $size;

    my $options = $field->options || [];

    return 'select' if @$options > $size;

    return $field->multiple ? 'checkbox' : 'radio';
}




sub init_size {0}



sub init_label_column {'name'}



sub init_active_column {'active'}







sub as_label {
    my $field = shift;

    my $value = $field->value;
    return unless defined $value;

    for ( $field->options ) {
        return $_->{label} if $_->{value} eq $value;
    }

    return;
}



1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Form::Processor::Field::Select - ** Please provide abstract **

=head1 VERSION

version 1.162360

=head1 SYNOPSIS

See L<Form::Processor>

=head1 DESCRIPTION

This is a field that includes a list of possible valid options.
This can be used for select and mulitple-select fields.

=head2 Widget

Fields can be given a widget type that is used as a hint for
the code that renders the field.

This field's widget type is: "select".

=head2 Subclass

Fields may inherit from other fields.  This field
inherits from: "Field"

=head1 NAME

Form::Processor::Field::Select

=head1 METHODS

=head2 options

This is an array of hashes for this field.
Each has must have a label and value keys.

=head2 multiple

If true allows multiple input values

=head2 auto_widget_size

This is a way to provide a hint as to when to automatically
select the widget to display for fields with a small number of options.
For example, this can be used to decided to display a radio select for
select lists smaller than the size specified.

See L<select_widget> below.

=head2 select_widget

If the widget is 'select' for the field then will look if the field
also has a L<auto_widget_size>.  If the options list is less than or equal
to the L<auto_widget_size> then will return C<radio> if L<multiple> is false,
otherwise will return C<checkbox>.

=head2 size

This can be used to store how many items should be offered in the UI
at a given time.

Defaults to 0.

=head2 label_column

Sets or returns the name of the method to call on the foreign class
to fetch the text to use for the select list.

Refers to the method (or column) name to use in a related
object class for the label for select lists.

Defaults to "name"

=head2 active_column

Sets or returns the name of a boolean column that is used as a flag to indicate that
a row is active or not.  Rows that are not active are ignored.

The default is "active".

If this column exists on the class then the list of options will included only
rows that are marked "active".

The exception is any columns that are marked inactive, but are also part of the
input data will be included with brackets around the label.  This allows
updating records that might have data that is now considered inactive.

=head2 sort_order

Sets or returns the column used in the foreign class for sorting the
options labels.  Default is undefined.

If this column exists in the foreign table then labels returned will be sorted
by this column.

If not defined or the column is not found as a method on the foreign class then
the label_column is used as the sort condition.

=head2 as_label

Returns the option label for the option value that matches the field's current value.
Can be helpful for displaying information about the field in a more friendly format.

This does a string compare, although probably al

=head1 SUPPORT / WARRANTY

L<Form::Processor> is free software and is provided WITHOUT WARRANTY OF ANY KIND.
Users are expected to review software for fitness and usability.

=head1 AUTHOR

Bill Moseley <mods@hank.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Bill Moseley.

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