Webmin/Checkboxes.pm

   1 package Webmin::Checkboxes;
   2 use Webmin::Input;
   3 use WebminCore;
   4 @ISA = ( "Webmin::Input" );
   5
   6 =head2 new Webmin::Checkboxes(name, value|&values, &options, [disabled])
   7 Create a list of checkboxes, of which zero or more may be selected
   8 =cut
   9 sub new
  10 {
  11 if (defined(&Webmin::Theme::Checkboxes::new)) {
  12         return new Webmin::Theme::Checkboxes(@_[1..$#_]);
  13         }
  14 my ($self, $name, $value, $options, $disabled) = @_;
  15 $self = { };
  16 bless($self);
  17 $self->set_name($name);
  18 $self->set_value($value);
  19 $self->set_options($options);
  20 $self->set_disabled($disabled);
  21 return $self;
  22 }
  23
  24 =head2 add_option(name, [label])
  25 =cut
  26 sub add_option
  27 {
  28 my ($self, $name, $label) = @_;
  29 push(@{$self->{'options'}}, [ $name, $label ]);
  30 }
  31
  32 =head2 html()
  33 Returns the HTML for all the checkboxes, one after the other
  34 =cut
  35 sub html
  36 {
  37 my ($self) = @_;
  38 my $rv;
  39 for(my $i=0; $i<@{$self->{'options'}}; $i++) {
  40         $rv .= $self->one_html($i)."\n";
  41         }
  42 return $rv;
  43 }
  44
  45 =head2 one_html(number)
  46 Returns the HTML for a single one of the checkboxes
  47 =cut
  48 sub one_html
  49 {
  50 my ($self, $num) = @_;
  51 my $opt = $self->{'options'}->[$num];
  52 my $value = $self->get_value();
  53 my %sel = map { $_, 1 } (ref($value) ? @$value : ( $value ));
  54 return &ui_checkbox($self->get_name(), $opt->[0],
  55                           defined($opt->[1]) ? $opt->[1] : $opt->[0],
  56                           $sel{$opt->[0]}, undef, $self->get_disabled()).
  57        ($num == 0 ? &ui_hidden("ui_exists_".$self->get_name(), 1) : "");
  58 }
  59
  60 =head2 get_value()
  61 Returns a hash ref of all selected values
  62 =cut
  63 sub get_value
  64 {
  65 my ($self) = @_;
  66 my $in = $self->{'form'} ? $self->{'form'}->{'in'} : undef;
  67 if ($in && (defined($in->{$self->{'name'}}) ||
  68             defined($in->{"ui_exists_".$self->{'name'}}))) {
  69         return [ split(/\0/, $in->{$self->{'name'}}) ];
  70         }
  71 elsif ($in && defined($in->{"ui_value_".$self->{'name'}})) {
  72         return [ split(/\0/, $in->{"ui_value_".$self->{'name'}}) ];
  73         }
  74 else {
  75         return $self->{'value'};
  76         }
  77 }
  78
  79 sub set_options
  80 {
  81 my ($self, $options) = @_;
  82 $self->{'options'} = $options;
  83 }
  84
  85 sub get_options
  86 {
  87 my ($self) = @_;
  88 return $self->{'options'};
  89 }
  90
  91 =head2 validate()
  92 Returns a list of error messages for this field
  93 =cut
  94 sub validate
  95 {
  96 my ($self) = @_;
  97 my $value = $self->get_value();
  98 if ($self->{'mandatory'} && !@$value) {
  99         return ( $self->{'mandmesg'} || $text{'ui_checkmandatory'} );
 100         }
 101 return ( );
 102 }
 103
 104 =head2 get_input_names()
 105 Returns the actual names of all HTML elements that make up this input
 106 =cut
 107 sub get_input_names
 108 {
 109 my ($self) = @_;
 110 my @rv;
 111 for(my $i=0; $i<@{$self->{'options'}}; $i++) {
 112         push(@rv, $self->{'name'}."[".$i."]");
 113         }
 114 return @rv;
 115 }
 116
 117 1;
 118
 119