5 include( '/elements/tr-select-reason.html',
8 'field' => 'reasonnum', # field name
9 'reason_class' => 'C', # one of those in %FS::reason_type::class_name
10 'label' => 'Your Label', # field display label
13 'cgi' => $cgi, #easiest way for things to be properly "sticky" on errors
16 'control_button' => 'element_name', #button to be enabled when a reason is
19 'hide_add' => '1', # setting this will hide the add new reason link,
20 # even if the user has access to add a new reason.
21 'hide_onload' => '1', # setting this will hide reason select box on page load,
22 # allowing for it do be displayed later.
23 'pre_options' => [ 0 => 'all'], # an array of pre options. Defaults to 0 => 'select reason...'
25 #deprecated ways to keep things "sticky" on errors
26 # (requires duplicate code in each using file to parse cgi params)
27 'curr_value' => $curr_value,
29 'typenum' => $typenum,
37 % # note style improvements.
38 % # - no more conditionally included code here
39 % # - callers are not expected to pass javascript fragments
40 % # - no redundant checking of ACLs or parameters
41 % # - form fields are grouped for easy management
42 % # - use the standard select-table widget instead of ad hoc crap
43 <& /elements/xmlhttp.html,
44 url => $p . 'misc/xmlhttp-reason-hint.html',
45 subs => [ 'get_hint' ],
48 <SCRIPT TYPE="text/javascript">
49 function <% $id %>_changed() {
50 var select_reason = document.getElementById('<% $id %>');
52 get_hint(select_reason.value, function(stuff) {
53 document.getElementById('<% $id %>_hint').innerHTML = stuff || '';
56 // toggle submit button state
57 var submit_button = document.getElementById(<% $opt{control_button} |js_string %>);
59 submit_button.disabled = ( select_reason.value == 0 );
62 // toggle visibility of 'new reason' fields
63 var new_fields = document.getElementById('<% $id %>_new_fields');
64 if ( select_reason.value == -1 ) {
65 new_fields.disabled = false;
66 new_fields.style.display = '';
68 new_fields.disabled = true;
69 new_fields.style.display = 'none';
73 <&| onload.js &> <% $id %>_changed(); </&>
76 %# sadly can't just use add_inline here, as we have non-text fields
78 <& tr-select-table.html,
83 'records' => \@reasons,
84 'label_callback' => sub { my $reason = shift;
85 $reason->type . ' : ' . $reason->reason },
86 'name_col' => 'label',
88 'pre_options' => \@pre_options,
89 'post_options' => \@post_options,
90 'curr_value' => $init_reason,
91 'onchange' => $id.'_changed()',
92 'hide_onload' => $opt{'hide_onload'},
95 % # "add new reason" fields
96 % # should be a <fieldset>, but that doesn't fit well into the table
98 % if ( $curuser->access_right($add_access_right) && !$hide_addnew ) {
99 <TR id="<% $id %>_new_fields">
101 <TABLE CLASS="inv" STYLE="text-align: left">
103 <& tr-input-text.html,
104 label => 'New reason',
105 field => $id.'_new_reason'
108 % my @types = qsearch( 'reason_type', { 'class' => $class } );
109 % if (scalar(@types) < 1) { # we should never reach this
112 <P><% mt('No reason types. Please add some.') |h %></P>
115 % } elsif (scalar(@types) == 1) {
117 label => 'Reason type',
118 field => $id.'_new_reason_type',
119 curr_value => $types[0]->typenum,
120 formatted_value => $types[0]->type,
122 % } else { # more than one type, the normal case
123 <& tr-select-table.html,
124 label => 'Reason type',
125 field => $id.'_new_reason_type',
126 table => 'reason_type',
128 hashref => { 'class' => $class },
133 % if ( $class eq 'C' ) {
135 label => 'Credit the unused portion of service when canceling',
136 field => $id.'_new_unused_credit',
140 % if ( $class eq 'S' ) {
142 label => 'Credit the unused portion of service when suspending',
143 field => $id.'_new_unused_credit',
146 <& tr-select-table.html,
147 label => 'Charge a suspension fee',
148 field => $id.'_new_feepart',
150 hashref => { disabled => '' },
151 name_col => 'itemdesc',
152 value_col => 'feepart',
153 empty_label => 'none',
156 label => 'When this package is',
157 field => $id.'_new_fee_on_unsuspend',
158 options => [ '', 'Y' ],
159 labels => { '' => 'suspended', 'Y' => 'unsuspended' },
162 label => 'Delay fee until the next bill',
163 field => $id.'_new_fee_hold',
166 %# deprecated, but still accessible through the "Suspend Reasons" UI
167 %# <& tr-select-part_pkg.html,
168 %# label => 'Charge this fee when unsuspending',
169 %# field => $id.'_new_unsuspend_pkgpart',
170 %# hashref => { disabled => '', freq => '0' },
171 %# empty_label => 'none',
173 %# <& tr-checkbox.html,
174 %# label => 'Hold unsuspension fee until the next bill',
175 %# field => $id.'_new_unsuspend_hold',
182 % } # if the current user can add a reason
184 % # container for hints (hints themselves come from xmlhttp-reason-hint)
186 <TD COLSPAN=2 ALIGN="center" id="<% $id %>_hint" style="font-size:small">
192 my $curuser = $FS::CurrentUser::CurrentUser;
195 my $name = $opt{'field'};
196 my $class = $opt{'reason_class'};
197 my $label = $opt{'label'} ? $opt{'label'} : 'Reason';
198 my $hide_addnew = $opt{'hide_addnew'} ? $opt{'hide_addnew'} : '';
202 $init_reason = $opt{'cgi'}->param($name);
204 $init_reason = $opt{'curr_value'};
207 my $id = $opt{'id'} || $name;
208 $id =~ s/\./_/g; # for edit/part_event
210 my $label_id = $opt{'label_id'} || '';
212 my $add_access_right;
214 $add_access_right = 'Add on-the-fly cancel reason';
215 } elsif ($class eq 'S') {
216 $add_access_right = 'Add on-the-fly suspend reason';
217 } elsif ($class eq 'R') {
218 $add_access_right = 'Add on-the-fly credit reason';
219 } elsif ($class eq 'X') {
220 $add_access_right = 'Add on-the-fly void credit reason';
221 } elsif ($class eq 'F') {
222 $add_access_right = 'Add on-the-fly refund reason';
224 die "illegal class: $class";
227 my $select = join(',',
229 FS::Record::concat_sql([ 'type', "' : '", 'reason' ]) . ' AS label',
232 my @reasons = qsearch({
235 'addl_from' => ' LEFT JOIN reason_type'.
236 ' ON (reason.reason_type = reason_type.typenum)',
237 'hashref' => { disabled => '' },
238 'extra_sql' => " AND reason_type.class = '$class'",
239 'order_by' => ' ORDER BY type, reason',
242 my @pre_options = ( 0 => 'Select reason...' );
243 @pre_options = @{ $opt{'pre_options'} } if $opt{'pre_options'};
246 if ( $curuser->access_right($add_access_right) && !$hide_addnew ) {
247 @post_options = ( -1 => 'Add new reason' );