summaryrefslogtreecommitdiff
path: root/httemplate/elements/tr-select-reason.html
blob: 64648ba54a55b85cb26f58ddb11fb9c6e1b5affe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<%doc>

Example:

  include( '/elements/tr-select-reason.html',

    #required 
    'field'          => 'reasonnum',     # field name
    'reason_class'   => 'C',             # one of those in %FS::reason_type::class_name
    'label'          => 'Your Label',    # field display label

    #recommended
    'cgi' => $cgi, #easiest way for things to be properly "sticky" on errors

    #optional
    'control_button' => 'element_name',  #button to be enabled when a reason is
                                         #selected
    'id'             => 'element_id',
    'hide_add'       => '1',             # setting this will hide the add new reason link,
                                         # even if the user has access to add a new reason.
    'hide_onload'    => '1',             # setting this will hide reason select box on page load,
                                         # allowing for it do be displayed later.
    'pre_options'    => [ 0 => 'all'],   # an array of pre options.  Defaults to 0 => 'select reason...'

    #deprecated ways to keep things "sticky" on errors
    # (requires duplicate code in each using file to parse cgi params)
    'curr_value'     => $curr_value,
    'curr_value'     => {
                          'typenum' => $typenum,
                          'reason'  => $reason,
                        },

  )

</%doc>

% # note style improvements.
% # - no more conditionally included code here
% # - callers are not expected to pass javascript fragments
% # - no redundant checking of ACLs or parameters
% # - form fields are grouped for easy management
% # - use the standard select-table widget instead of ad hoc crap
<& /elements/xmlhttp.html,
  url => $p . 'misc/xmlhttp-reason-hint.html',
  subs => [ 'get_hint' ],
  skip_empty => 1,
&>
<SCRIPT TYPE="text/javascript">
  function <% $id %>_changed() {
    var select_reason = document.getElementById('<% $id %>');

    get_hint(select_reason.value, function(stuff) {
      document.getElementById('<% $id %>_hint').innerHTML = stuff || '';
    });

    // toggle submit button state
    var submit_button = document.getElementById(<% $opt{control_button} |js_string %>);
    if (submit_button) {
      submit_button.disabled = ( select_reason.value == 0 );
    }

    // toggle visibility of 'new reason' fields
    var new_fields = document.getElementById('<% $id %>_new_fields');
    if ( select_reason.value == -1 ) {
      new_fields.disabled = false;
      new_fields.style.display = '';
    } else {
      new_fields.disabled = true;
      new_fields.style.display = 'none';
    }

  }
  <&| onload.js &> <% $id %>_changed(); </&>
</SCRIPT>

%# sadly can't just use add_inline here, as we have non-text fields

<& tr-select-table.html,
  'label'           => $label,
  'field'           => $name,
  'id'              => $id,
  'table'           => 'reason',
  'records'         => \@reasons,
  'label_callback'  => sub { my $reason = shift;
                             $reason->type . ' : ' .  $reason->reason },
  'disable_empty'   => 1,
  'pre_options'     => \@pre_options,
  'post_options'    => \@post_options,
  'curr_value'      => $init_reason,
  'onchange'        => $id.'_changed()',
  'hide_onload'     => $opt{'hide_onload'},
&>

% # "add new reason" fields
% # should be a <fieldset>, but that doesn't fit well into the table

% if ( $curuser->access_right($add_access_right) && !$hide_addnew ) {
<TR id="<% $id %>_new_fields">
  <TD COLSPAN=2>
    <TABLE CLASS="inv" STYLE="text-align: left">

      <& tr-input-text.html,
        label => 'New reason',
        field => $id.'_new_reason'
      &>

%   my @types = qsearch( 'reason_type', { 'class' => $class } );
%   if (scalar(@types) < 1) {  # we should never reach this
      <TR>
        <TD ALIGN="right">
          <P><% mt('No reason types. Please add some.') |h %></P>
        </TD>
      </TR>
%   } elsif (scalar(@types) == 1) {
      <& tr-fixed.html,
        label => 'Reason type',
        field => $id.'_new_reason_type',
        curr_value => $types[0]->typenum,
        formatted_value => $types[0]->type,
      &>
%   } else { # more than one type, the normal case
      <& tr-select-table.html,
        label         => 'Reason type',
        field         => $id.'_new_reason_type',
        table         => 'reason_type',
        name_col      => 'type',
        hashref       => { 'class' => $class },
        disable_empty => 1,
      &>
%   } # scalar(@types)

%   if ( $class eq 'C' ) {
      <& tr-checkbox.html,
        label => 'Credit the unused portion of service when canceling',
        field => $id.'_new_unused_credit',
        value => 'Y'
      &>
%   }
%   if ( $class eq 'S' ) {
      <& tr-checkbox.html,
        label => 'Credit the unused portion of service when suspending',
        field => $id.'_new_unused_credit',
        value => 'Y'
      &>
      <& tr-select-table.html,
        label     => 'Charge a suspension fee',
        field     => $id.'_new_feepart',
        table     => 'part_fee',
        hashref   => { disabled => '' },
        name_col  => 'itemdesc',
        value_col => 'feepart',
        empty_label => 'none',
      &>
      <& tr-select.html,
        label     => 'When this package is',
        field     => $id.'_new_fee_on_unsuspend',
        options   => [ '', 'Y' ],
        labels    => { '' => 'suspended', 'Y' => 'unsuspended' },
      &>
      <& tr-checkbox.html,
        label     => 'Delay fee until the next bill',
        field     => $id.'_new_fee_hold',
        value     => 'Y',
      &>
%# deprecated, but still accessible through the "Suspend Reasons" UI
%#      <& tr-select-part_pkg.html,
%#        label   => 'Charge this fee when unsuspending',
%#        field   => $id.'_new_unsuspend_pkgpart',
%#        hashref => { disabled => '', freq => '0' },
%#        empty_label => 'none',
%#      &>
%#      <& tr-checkbox.html,
%#        label => 'Hold unsuspension fee until the next bill',
%#        field => $id.'_new_unsuspend_hold',
%#        value => 'Y',
%#      &>
%   }
    </table>
  </td>
</tr>
% } # if the current user can add a reason

% # container for hints (hints themselves come from xmlhttp-reason-hint)
<TR>
  <TD COLSPAN=2 ALIGN="center" id="<% $id %>_hint" style="font-size:small">
  </TD>
</TR>

<%init>

my $curuser = $FS::CurrentUser::CurrentUser;
my %opt = @_;

my $name = $opt{'field'};
my $class = $opt{'reason_class'};
my $label = $opt{'label'} ? $opt{'label'} : 'Reason';
my $hide_addnew = $opt{'hide_addnew'} ? $opt{'hide_addnew'} : '';

my $init_reason;
if ( $opt{'cgi'} ) {
  $init_reason = $opt{'cgi'}->param($name);
}
$init_reason ||= $opt{'curr_value'};

my $id = $opt{'id'} || $name;
$id =~ s/\./_/g; # for edit/part_event

my $label_id = $opt{'label_id'} || '';

my $add_access_right = $FS::reason_type::class_add_access_right{$class}
  or die "unknown class: $class";

my @reasons = qsearch({
  'table'           => 'reason',
  'addl_from'       => ' LEFT JOIN reason_type'.
                       ' ON (reason.reason_type = reason_type.typenum)',
  'hashref'         => { disabled => '' },
  'extra_sql'       => " AND reason_type.class = '$class'",
  'order_by'        => ' ORDER BY type, reason',
});


my @pre_options = ( 0 => 'Select reason...' );
@pre_options = @{ $opt{'pre_options'} } if $opt{'pre_options'};

my @post_options;
if ( $curuser->access_right($add_access_right) && !$hide_addnew ) {
  @post_options = ( -1 => 'Add new reason' );
}

</%init>