httemplate/elements/select-table.html

   1 <%doc>
   2
   3 Example:
   4
   5   include( '/elements/select-table.html',
   6
   7     ##
   8     # required
   9     ##
  10     'table'          => 'table_name',
  11     'name_col'       => 'name_column',
  12
  13     #strongly recommended (you want your forms to be "sticky" on errors, right?)
  14     'curr_value'     => 'current_value',
  15     #'value' => #deprecated form of 'curr_value',
  16
  17     ##
  18     # optional
  19     ##
  20
  21     #search params
  22     'hashref'          => {},
  23     'addl_from'        => '',
  24     'extra_sql'        => '',
  25     'agent_virt'       => 0, #set true and make sure the result is JOINed to
  26                              #something with agentnum (usually cust_main)
  27     'agent_null'       => 0, #set true to always show un-agented entries
  28     'agent_null_right' => '', #right to see un-agented entries
  29     #or
  30     'records'        => \@records, #instead of search params
  31
  32     #instead of the primary key... only for special cases
  33     'value_col'      => 'columnname',
  34
  35     #basic params controlling the resulting <SELECT>
  36     'pre_options'    => [ 'value' => 'option' ], #before normal options
  37     'post_options'   => [ 'value' => 'option' ], #after normal options
  38     'empty_label'    => '', #better specify it though, the default might change
  39     'multiple'       => 0, # bool
  40     'disable_empty'  => 0, # bool (implied by multiple)
  41     'label_showkey'  => 0, # bool
  42     'label_callback' => sub { my $record = shift; return "label"; },
  43
  44     #more params controlling HTML stuff about the <SELECT>
  45     'element_name'   => '', #HTML element name, defaults to the name of
  46                             # the primary key column
  47     'field'          => '', #synonym for element_name
  48     'element_etc'    => '', #additional attributes (i.e. "DISABLED") for the
  49                             #<SELECT> element
  50     'onchange'       => '', #javascript code
  51
  52     #params (well, a param) controlling the <OPTION>s
  53     'extra_option_attributes' => [ 'field' ], #field or method in $table objects
  54                                               #(are prefixed w/data- per HTML5)
  55
  56     #special return options
  57     'js_only'      => 0, #set true to return only the JS portions (i.e. nothing)
  58     'html_only'    => 0, #set true to return only the HTML portions (no-op, i.e. return everything)
  59
  60     #debugging
  61     'debug'          => 0, #set true to enable
  62
  63   )
  64
  65 </%doc>
  66 % unless ( $opt{'js_only'} ) {
  67
  68 <SELECT <% $opt{'multiple'} ? 'MULTIPLE' : '' %>
  69         NAME = "<% $opt{'element_name'} || $opt{'field'} || $key %>"
  70         ID   = "<% $opt{'id'} || $key %>"
  71         <% $onchange %>
  72         <% $opt{'element_etc'} %>
  73 >
  74
  75 % while ( @pre_options ) {
  76 %   my $pre_opt   = shift(@pre_options);
  77 %   my $pre_label = shift(@pre_options);
  78 %   my $selected =    ( ref($value) && $value->{$pre_opt} )
  79 %                  || ( $value eq $pre_opt );
  80     <OPTION VALUE="<% $pre_opt %>"
  81             <% $selected ? 'SELECTED' : '' %>
  82     ><% $pre_label %>
  83 % }
  84
  85 % unless ( $opt{'multiple'} || $opt{'disable_empty'} ) {
  86     <OPTION VALUE=""><% $opt{'empty_label'} || 'all' %>
  87 % }
  88
  89 % foreach my $record ( sort {    $a->$name_col() cmp $b->$name_col()
  90 %                             || $a->$key()      <=> $b->$key()
  91 %                           }
  92 %                           @records
  93 %                    )
  94 % {
  95 %   my $recvalue = $record->$key();
  96 %   my $selected;
  97 %   if ( $opt{'all_selected'} ) {
  98 %     $selected = 1;
  99 %   } elsif ( $opt{'compare_sub'} && !ref($value) ) {
 100 %     $selected = &{ $opt{'compare_sub'} }( $value, $recvalue );
 101 %   } else {
 102 %     $selected =    ( ref($value) && $value->{$recvalue} )
 103 %                 || ( $value && $value eq $recvalue ); #not == because of value_col
 104 %   }
 105     <OPTION VALUE="<% $recvalue %>"
 106             <% $selected ? ' SELECTED' : '' %>
 107 %           foreach my $att ( @{ $opt{'extra_option_attributes'} } ) {
 108               data-<% $att %>="<% $record->$att() |h %>"
 109 %           }
 110     ><% $opt{'label_showkey'} ? "$recvalue: " : '' %>
 111      <% $opt{'label_callback'}
 112           ? &{ $opt{'label_callback'} }( $record )
 113           : $record->$name_col()
 114      %>
 115 % }
 116
 117 % while ( @post_options ) {
 118 %   my $post_opt   = shift(@post_options);
 119 %   my $post_label = shift(@post_options);
 120 %   my $selected =    ( ref($value) && $value->{$post_opt} )
 121 %                  || ( $value eq $post_opt );
 122     <OPTION VALUE="<% $post_opt %>"
 123             <% $selected ? 'SELECTED' : '' %>
 124     ><% $post_label %>
 125 % }
 126
 127 </SELECT>
 128
 129 %}
 130 <%init>
 131
 132 my( %opt ) = @_;
 133
 134 warn "elements/select-table.html: \n". Dumper(\%opt)
 135   if exists $opt{debug} && $opt{debug};
 136
 137 $opt{'extra_option_attributes'} ||= [];
 138
 139 my $onchange = '';
 140 if ( $opt{'onchange'} ) {
 141   $onchange = $opt{'onchange'};
 142   $onchange .= '(this)' unless $onchange =~ /\(\w*\);?$/;
 143   $onchange =~ s/\(what\);/\(this\);/g; #ugh, terrible hack.  all onchange
 144                                         #callbacks should act the same
 145   $onchange = 'onChange="'. $onchange. '"';
 146 }
 147
 148 my $dbdef_table = dbdef->table($opt{'table'})
 149   or die "can't find dbdef for ". $opt{'table'}. " table\n";
 150
 151 my $key = $opt{'value_col'} || $dbdef_table->primary_key;
 152
 153 my $name_col = $opt{'name_col'};
 154
 155 my $value = $opt{'curr_value'} || $opt{'value'};
 156 $value = [ split(/\s*,\s*/, $value) ] if $opt{'multiple'} && $value =~ /,/;
 157
 158 #my $addl_from = $opt{'addl_from'} || '';
 159 my $extra_sql = $opt{'extra_sql'} || '';
 160 my $hashref   = $opt{'hashref'} || {};
 161
 162 if ( $opt{'agent_virt'} ) {
 163   $extra_sql .=
 164     ( $extra_sql =~ /WHERE/i || scalar(keys %$hashref ) ? ' AND ' : ' WHERE ' ).
 165     $FS::CurrentUser::CurrentUser->agentnums_sql(
 166                                     'null'       => $opt{'agent_null'},
 167                                     'null_right' => $opt{'agent_null_right'},
 168                                    );
 169 }
 170
 171 my @records = ();
 172 if ( $opt{'records'} ) {
 173   @records = @{ $opt{'records'} };
 174 } else {
 175   @records = qsearch( {
 176     'table'     => $opt{'table'},
 177     'addl_from' => $opt{'addl_from'},
 178     'hashref'   => $hashref,
 179     'extra_sql' => $extra_sql,
 180     'order_by'  => ( $opt{'order_by'} || "ORDER BY $name_col" ),
 181   });
 182 }
 183
 184 if ( ref( $value ) eq 'ARRAY' ) {
 185   $value = { map { $_ => 1 } @$value };
 186 }
 187
 188 unless (    !ref($value) && $value < 1 # !$value #ignore negatives too
 189          or ! exists( $opt{hashref}->{disabled} ) #??
 190          #or grep { $value == $_->$key() } @records
 191        ) {
 192   delete $opt{hashref}->{disabled};
 193
 194   foreach my $v ( ref($value) ? keys %$value : ($value) ) {
 195     next if grep { $v == $_->$key() } @records;
 196
 197     $opt{hashref}->{$key} = $v;
 198     my $record = qsearchs( {
 199       'table'     => $opt{table},
 200       'addl_from' => $opt{'addl_from'},
 201       'hashref'   => $hashref,
 202       'extra_sql' => $extra_sql,
 203     });
 204     push @records, $record if $record;
 205
 206   }
 207 }
 208
 209 my @pre_options  = $opt{pre_options}  ? @{ $opt{pre_options} } : ();
 210 my @post_options = $opt{post_options} ? @{ $opt{post_options} } : ();
 211
 212 </%init>