rt/share/html/Widgets/Form/Select

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2016 Best Practical Solutions, LLC
   6 %#                                          <sales@bestpractical.com>
   7 %#
   8 %# (Except where explicitly superseded by other copyright notices)
   9 %#
  10 %#
  11 %# LICENSE:
  12 %#
  13 %# This work is made available to you under the terms of Version 2 of
  14 %# the GNU General Public License. A copy of that license should have
  15 %# been provided with this software, but in any event can be snarfed
  16 %# from www.gnu.org.
  17 %#
  18 %# This work is distributed in the hope that it will be useful, but
  19 %# WITHOUT ANY WARRANTY; without even the implied warranty of
  20 %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 %# General Public License for more details.
  22 %#
  23 %# You should have received a copy of the GNU General Public License
  24 %# along with this program; if not, write to the Free Software
  25 %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 %# 02110-1301 or visit their web page on the internet at
  27 %# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 %#
  29 %#
  30 %# CONTRIBUTION SUBMISSION POLICY:
  31 %#
  32 %# (The following paragraph is not intended to limit the rights granted
  33 %# to you to modify and distribute this software under the terms of
  34 %# the GNU General Public License and is only of importance to you if
  35 %# you choose to contribute your changes and enhancements to the
  36 %# community by submitting them to Best Practical Solutions, LLC.)
  37 %#
  38 %# By intentionally submitting any modifications, corrections or
  39 %# derivatives to this work, or any other work intended for use with
  40 %# Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 %# you are the copyright holder for those contributions and you grant
  42 %# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 %# royalty-free, perpetual, license to use, copy, create derivative
  44 %# works based on those contributions, and sublicense and distribute
  45 %# those contributions and any derivatives thereof.
  46 %#
  47 %# END BPS TAGGED BLOCK }}}
  48 <%DOC>
  49 see docs/extending/using_forms_widgets.pod
  50 </%DOC>
  51 <div id="form-box-<% lc $Name %>" class="widget">
  52 % if ( $Description ) {
  53 <span class="label"><% $Description %></span>
  54 % }
  55 <span class="value"><& SELF:InputOnly, %ARGS &></span>
  56 <span class="hints"><% $Hints %></span>
  57 </div>
  58 <%ARGS>
  59 $Name
  60 $Description      => undef,
  61 $Hints            => ''
  62 </%ARGS>
  63
  64 <%METHOD InputOnly>
  65 <%ARGS>
  66 $Name
  67 $Description      => undef,
  68
  69 @Values           => (),
  70 $ValuesCallback   => undef,
  71 %ValuesLabel      => (),
  72 @CurrentValue     => (),
  73
  74 $Default            => 1,
  75 @DefaultValue       => (),
  76 $DefaultLabel       => undef,
  77
  78 $Alternative      => 0,
  79 $AlternativeLabel => loc('other...'),
  80
  81 $Multiple         => 0,
  82 </%ARGS>
  83 <select name="<% $Name %>" <% $Multiple ? 'multiple="multiple"' : '' |n%>>
  84
  85 % if ( $Default ) {
  86 % my $selected = '';
  87 % $selected = 'selected="selected"' unless $CurrentValue[0];
  88 <option value="__empty_value__" <% $selected |n %>><% $DefaultLabel %></option>
  89 % }
  90
  91 % foreach my $v( @Values ) {
  92 % my $selected = '';
  93 % $selected = 'selected="selected"' if delete $CurrentValue{ $v };
  94 <option value="<% $v %>" <% $selected |n %>><% loc($ValuesLabel{ $v } || $v) %></option>
  95 % }
  96
  97 % if ( $Alternative ) {
  98 %     my $selected = '';
  99 %     $selected = 'selected="selected"' if keys %CurrentValue;
 100 <option value="__alternative_value__" <% $selected |n %>><% $AlternativeLabel %></option>
 101 % }
 102
 103 </select>
 104 % if ( $Alternative ) {
 105 <input type="text" class="alternative" name="Alternative-<% $Name %>" value="<% join ', ', @CurrentValue %>" />
 106 % }
 107 <%INIT>
 108 my %CurrentValue = map {$_ => 1} grep defined, @CurrentValue;
 109 if ( $ValuesCallback ) {
 110     my $values = $ValuesCallback->(
 111         CurrentUser => $session{'CurrentUser'},
 112         Name        => $Name,
 113     );
 114     if ( ref $values eq 'ARRAY' ) {
 115         @Values = @$values;
 116     } else {
 117         %ValuesLabel = %$values;
 118         @Values = keys %ValuesLabel;
 119     }
 120 }
 121 unless (defined $DefaultLabel ) {
 122     $DefaultLabel = loc('Use system default ([_1])',
 123         join ', ', map loc($ValuesLabel{$_} || $_), grep defined,
 124             @DefaultValue
 125     );
 126 }
 127 </%INIT>
 128 </%METHOD>
 129
 130 <%METHOD Process>
 131 <%ARGS>
 132 $Name
 133
 134 $Arguments        => {},
 135
 136 @Values           => (),
 137 %ValuesLabel      => (),
 138
 139 $Default          => 0,
 140 @DefaultValue     => (),
 141
 142 $Alternative      => 0,
 143 $Multiple         => 0,
 144 </%ARGS>
 145 <%INIT>
 146 my $value = $Arguments->{ $Name };
 147 if( !defined $value || $value eq '__empty_value__' ) {
 148     return undef if $Default;
 149     return [ @DefaultValue ] if $Multiple;
 150     return $DefaultValue[0];
 151 }
 152 $value = [$value] unless ref $value;
 153
 154 if ( $Alternative ) {
 155     my $alt = $Arguments->{ "Alternative-". $Name };
 156     if( $Multiple ) {
 157         push @$value, split /\s*,\s*/, $alt;
 158     } else {
 159         push @$value, $alt;
 160     }
 161 }
 162
 163 splice @$value, 1 unless $Multiple;
 164
 165 # XXX: check values
 166
 167 return $value->[0] unless $Multiple;
 168 return $value;
 169 </%INIT>
 170 </%METHOD>