combine ticket notification scrips, #15353
[freeside.git] / httemplate / elements / tr-select-reason.html
index 71997c2..5a79d68 100755 (executable)
@@ -1,3 +1,34 @@
+<%doc>
+
+Example:
+
+  include( '/elements/tr-select-reason.html',
+
+    #required 
+    'field'         => 'reasonnum',
+    'reason_class'  => 'C', # currently 'C', 'R',  or 'S'
+                           # for cancel, credit, or suspend
+
+    #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',
+
+    #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>
+
 <SCRIPT TYPE="text/javascript">
   function sh_add<% $func_suffix %>()
   {
 </SCRIPT>
 
 <TR>
-  <TD ALIGN="right">Reason</TD>
+  <TD ALIGN="right"><% mt('Reason') |h %></TD>
   <TD>
     <SELECT id="<% $id %>" name="<% $name %>" onFocus="sh_add<% $func_suffix %>()" onChange="sh_add<% $func_suffix %>()">
-%    my @reasons = qsearch( { table =>'reason', 
-%                             hashref => {},
-%                             extra_sql => $extra_sql,
-%                             addl_from => 'LEFT JOIN reason_type ON reason_type.typenum = reason.reason_type',
-%                           });
-      <OPTION VALUE="" <% ($init_reason eq "") ? 'SELECTED' : '' %>>Select Reason...</OPTION>
+      <OPTION VALUE="" <% ($init_reason eq '') ? 'SELECTED' : '' %>><% mt('Select Reason...') |h %></OPTION>
 %    foreach my $reason (@reasons) {
       <OPTION VALUE="<% $reason->reasonnum %>" <% ($init_reason == $reason->reasonnum) ? 'SELECTED' : '' %>><% $reason->reasontype->type %> : <% $reason->reason %></OPTION>
 %    }
 %    if ($curuser->access_right($add_access_right)) {
-      <OPTION VALUE="-1" <% ($init_reason == -1) ? 'SELECTED' : '' %>>Add new reason</OPTION>
+      <OPTION VALUE="-1" <% ($init_reason == -1) ? 'SELECTED' : '' %>><% mt('Add new reason') |h %></OPTION>
 %    }
 %
     </SELECT>
   </TD>
 </TR>
 
+%   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>
+  <TD ALIGN="right">
+    <P id="new<% $name %>TLabel" style="display:<% $display %>"><% mt('Reason Type') |h %></P>
+  </TD>
+  <TD>
+    <P id="new<% $name %>T" disabled="<% $disabled %>" style="display:<% $display %>"><% $types[0]->type %>
+    <INPUT type="hidden" name="new<% $name %>T" value="<% $types[0]->typenum %>">
+  </TD>
+</TR>
+
+%   }else{
+
 <TR>
   <TD ALIGN="right">
-    <P id="new<% $id %>TLabel" style="display:<% $display %>">Reason Type</P>
+    <P id="new<% $id %>TLabel" style="display:<% $display %>"><% mt('Reason Type') |h %></P>
   </TD>
   <TD>
     <SELECT id="new<% $id %>T" name="new<% $name %>T" "<% $disabled %>" style="display:<% $display %>">
-%     for my $type (qsearch( 'reason_type', { 'class' => $class } )){
+%     for my $type (@types) {
         <OPTION VALUE="<% $type->typenum %>" <% ($init_type == $type->typenum) ? 'SELECTED' : '' %>><% $type->type %></OPTION>
 %     }
     </SELECT>
   </TD>
 </TR>
+%   }
 
 <TR>
   <TD ALIGN="right">
-    <P id="new<% $id %>Label" style="display:<% $display %>">New Reason</P>
+    <P id="new<% $id %>Label" style="display:<% $display %>"><% mt('New Reason') |h %></P>
   </TD>
-  <TD><INPUT id="new<% $id %>" name="new<% $name %>" type="text" value="<% $init_newreason %>" "<% $disabled %>" style="display:<% $display %>"></TD>
+  <TD><INPUT id="new<% $id %>" name="new<% $name %>" type="text" value="<% $init_newreason |h %>" "<% $disabled %>" style="display:<% $display %>"></TD>
 </TR>
 
 <%init>
@@ -79,7 +126,13 @@ my %opt = @_;
 
 my $name = $opt{'field'};
 my $class = $opt{'reason_class'};
-my $init_reason = $opt{'curr_value'};
+
+my $init_reason;
+if ( $opt{'cgi'} ) {
+  $init_reason = $opt{'cgi'}->param($name);
+} else {
+  $init_reason = $opt{'curr_value'};
+}
 
 my $controlledbutton = $opt{'control_button'};
 
@@ -94,6 +147,9 @@ if ($class eq 'C') {
 } elsif ($class eq 'S') {
   $access_right = 'Suspend customer package';
   $add_access_right = 'Add on-the-fly suspend reason';
+} elsif ($class eq 'R') {
+  $access_right = 'Post credit';
+  $add_access_right = 'Add on-the-fly credit reason';
 } else {
   die "illegal class: $class";
 }
@@ -109,11 +165,25 @@ if ($init_reason == -1 || ref($init_reason) ) {
     $init_type      = $init_reason->{'typenum'};
     $init_newreason = $init_reason->{'reason'};
     $init_reason = -1;
+  } elsif ( $opt{'cgi'} ) {
+    $init_type      = $opt{'cgi'}->param( "new${name}T" );
+    $init_newreason = $opt{'cgi'}->param( "new$name"    );
   }
 
 }
 
-my $extra_sql = "WHERE class = '$class' ORDER BY reason_type";
+my $extra_sql =
+  "WHERE class = '$class' and (disabled = '' OR disabled is NULL)";
+
+my @reasons = qsearch({
+  table     => 'reason', 
+  hashref   => {},
+  extra_sql => $extra_sql,
+  addl_from => 'LEFT JOIN reason_type '.
+               ' ON reason_type.typenum = reason.reason_type',
+  order_by  => 'ORDER BY reason_type.type ASC, reason.reason ASC',
+});
+
 my $curuser = $FS::CurrentUser::CurrentUser;
 
 </%init>