httemplate/elements/select-tiered.html

   1 <%doc>
   2 Usage:
   3
   4 <& /elements/select-tiered.html,
   5   tiers       => [
   6     { table => 'table1', ... }, # most select-table options are supported
   7     { table => 'table2', ..., link_col = 't2num' }, # foreign key in table1
   8   ],
   9   prefix      => '', # to avoid name conflicts
  10   curr_value  => 42, # in the last table
  11   field       => 'fieldname', # NAME attribute of the last element
  12 &>
  13
  14 This creates a group of SELECT elements (similar to select-table.html) for
  15 drill-down navigation of data with one-to-many relationships.
  16
  17 'tiers' is required, and must be an arrayref of hashes, each describing one
  18 tier of selection (from most general to most specific).  Each tier can
  19 contain the following:
  20 - table, select, addl_from, hashref, extra_sql: as in FS::Record::qsearch.
  21 - records, an arrayref of exact records.  Either this or "table" must be
  22   provided.
  23 - field: the NAME attribute of the select element.  Optional.
  24 - name_col: the column/method name to obtain the record's text label in the
  25   select element.
  26 - value_col: the column/method name to obtain the record's value, which is
  27   sent on form submission.  Defaults to the primary key.
  28 - link_col: the column/method name to associate the record to the value_col
  29   of a record in the previous table's value_col.  (That is, the foreign key.)
  30 - empty_label: the label to use for an option with the logical meaning of
  31   "all of these" and a value of ''.
  32 - curr_value: the currently selected value.  This will constrain the current
  33   values of preceding tiers.
  34 - multiple: set to true for a multiple-style selector.  This should work but
  35   isn't fully tested.
  36 - after: an HTML string to be inserted after the select element, before
  37   the next one.  By default there's nothing between them.
  38 - onchange: an additional javascript function to be called on change.
  39
  40 For convenience, "curr_value" and "field" can be passed as part of the
  41 main argument list, and will be applied to the last tier.
  42
  43 </%doc>
  44 % $i = 0;
  45 % foreach my $tier (@$tiers) {
  46 %   my $onchange;
  47 %   $onchange="${pre}select_change(this, $i)"
  48 %     if $i < scalar(@$tiers) - 1;
  49 %
  50 %   $onchange .= ';'.$tier->{onchange}."(this, $i);"
  51 %     if $tier->{onchange};
  52 %
  53 %   $onchange = "onchange='$onchange'" if $onchange;
  54 <SELECT
  55   NAME="<% $tier->{field} %>"
  56   ID="<% $pre."select_".$i %>"
  57   <%$onchange%>
  58   <% $tier->{multiple} ? 'MULTIPLE' : '' %>
  59   >
  60 %   if ( $i == 0 ) {
  61 %     my $options = $tiers_by_key->[0]->{''};
  62 %     #foreach ( sort keys %$options ) {
  63 %     foreach ( sort { lc($options->{$a}) cmp lc($options->{$b}) }
  64 %                 keys %$options
  65 %             )
  66 %     {
  67   <OPTION VALUE="<%$_ |h%>" <% $curr_values->[$i] eq $_ ? 'SELECTED' : ''%>>
  68   <% $options->{$_} |h%></OPTION>
  69 %     }
  70 %   }
  71 %   $i++;
  72 </SELECT>
  73 <% $tier->{after} %>
  74 % } #foreach $tier
  75
  76 <SCRIPT type="text/javascript">
  77 var <% $pre %>tiers = <% $json->encode($tiers_by_key) %>;
  78 var <% $pre %>curr_values = <% $json->encode($curr_values) %>;
  79 function <% $pre %>select_change(select_this, i) {
  80
  81   i++; // operate on the next tier selector
  82   var next_options = new Object; // use like a hash
  83   // slight hack here: empty_label implies not multiple, so if the 'all'
  84   // option is selected, it will be the "value" property of the select.
  85   var all = (select_this.value == '');
  86   // combine all of the options of this one
  87   for (var j = 0; j < select_this.options.length; j++) {
  88     var this_opt = select_this.options[j];
  89     if ( this_opt.selected || all ) {
  90       for (var next_key in <% $pre %>tiers[i][this_opt.value]) {
  91         next_options[next_key] = <% $pre %>tiers[i][this_opt.value][next_key];
  92       } // for next_key
  93     } // if selected
  94   } // for this_opt
  95
  96   var select_next = document.getElementById('<% $pre."select_" %>' + i);
  97   select_next.options.length = 0; // clear it
  98   for (var next_key in next_options) {
  99     var o = document.createElement('OPTION');
 100     o.value = next_key;
 101     o.text = next_options[next_key];
 102
 103     if ( next_key == '' ) {
 104       select_next.add(o, select_next.options[0]); //insert at top
 105     } else {
 106       select_next.add(o, null); //append
 107     }
 108     // then select it if we're selecting them all, or if it's the only one,
 109     // or if it's the current value at that tier
 110     o.selected = select_next.multiple
 111               || (next_options.length == 1)
 112               || (next_key == <% $pre %>curr_values[i])
 113               ;
 114   }
 115   if ( i < <% scalar(@$tiers) - 1 %> ) {
 116     <% $pre %>select_change(select_next, i);
 117   }
 118   return;
 119 }
 120 <% $pre %>select_change(document.getElementById('<% $pre %>select_0'), 0);
 121 </SCRIPT>
 122 <%init>
 123 my %opt = @_;
 124 my $pre = $opt{prefix} || '';
 125 my $tiers = $opt{tiers} or die "no tiers defined";
 126
 127 my $json = Cpanel::JSON::XS->new();
 128 $json->canonical;
 129 $json->allow_nonref(1);
 130
 131 my $i;
 132 for( $i = 0; $i < @$tiers; $i++ ) {
 133   my $tier = $tiers->[$i];
 134   my $key = $tier->{value_col};
 135   my $name_col = $tier->{name_col};
 136   if ( !exists($tier->{records}) ) {
 137     # minor false laziness w/ select-table
 138     my $dbdef_table = dbdef->table($tier->{table})
 139       or die "can't find dbdef for ".$tier->{table}." table\n";
 140     $key ||= $dbdef_table->primary_key;
 141     my $hashref = $tier->{hashref} || {};
 142     my $select = $tier->{select} || '*';
 143     # we don't yet support agent_virt
 144     $tier->{records} = [ qsearch({
 145         'select'    => $select, # the real magic
 146         'table'     => $tier->{table},
 147         'addl_from' => $tier->{addl_from},
 148         'hashref'   => $hashref,
 149         'extra_sql' => $tier->{extra_sql},
 150     }) ];
 151   }
 152
 153   # set up options
 154   my %children_of;
 155   if ( $i == 0 ) {
 156     $children_of{''} = {
 157       map { $_->$key => $_->$name_col } @{ $tier->{records} }
 158     };
 159   }
 160   else {
 161     my $link_col = $tier->{link_col}
 162       or die "no link_col in '".$tier->{table}."' tier\n";
 163     # %children_of maps the option values in the previous tier
 164     # to hashes of their linked options in this tier.
 165     foreach my $rec (@{ $tier->{records} }) {
 166       $children_of{ $rec->$link_col } ||= {};
 167       $children_of{ $rec->$link_col }->{ $rec->$key } = $rec->$name_col;
 168     }
 169   }
 170
 171   if ( defined $tier->{empty_label} ) {
 172     foreach my $key (keys %children_of) {
 173       # only create "all" options if there are multiple choices
 174       if ( scalar(keys %{ $children_of{$key} }) > 1 ) {
 175         $children_of{$key}->{''} = $tier->{empty_label};
 176       }
 177     }
 178     # ensure that there's always at least one empty label
 179     $children_of{''}->{''} = $tier->{empty_label};
 180   }
 181   $tier->{by_key} = \%children_of;
 182 }
 183
 184 $i = scalar(@$tiers) - 1;
 185 $tiers->[$i]->{curr_value} ||= $opt{curr_value};
 186 $tiers->[$i]->{field} ||= $opt{field};
 187
 188 # We expect the usual case to be $opt{curr_value}, i.e.
 189 # current value in the last tier.  So trace it backward.
 190 while($i >= 1) {
 191   my $curr_value = $tiers->[$i]->{curr_value};
 192   last if !defined($curr_value);
 193
 194   my $tier = $tiers->[$i];
 195   foreach my $key ( %{ $tier->{by_key} } ) {
 196     my $options = $tier->{by_key}->{$key};
 197     if ( exists( $options->{$curr_value} ) ) {
 198       $tiers->[$i-1]->{curr_value} = $key;
 199       last;
 200     }
 201   }
 202   $i--;
 203 }
 204
 205 my $tiers_by_key = [ map { $_->{by_key} } @$tiers ];
 206 my $curr_values = [ map { $_->{curr_value} || '' } @$tiers ];
 207 </%init>