start of package class web UI (add/edit package classes, package class selection...
[freeside.git] / httemplate / search / elements / search.html
index d19fb4a..6cf5741 100644 (file)
@@ -1,5 +1,83 @@
 <%
 
+  # options example...  
+  # (everything not commented required is optional)
+  #
+  # # basic options, required
+  # 'title'       => 'Page title',
+  # 'name'        => 'items', #name for the records returned
+  #
+  # # some HTML callbacks...
+  # 'menubar'          => '', #menubar arrayref
+  # 'html_init'        => '', #after the header/menubar and before the pager
+  # 'html_foot'        => '', #at the bottom
+  # 'html_posttotal'   => '', #at the bottom
+  #                           # (these three can be strings or coderefs)
+  # 
+  #
+  # #literal SQL query string or qsearch hashref, required
+  # 'query'       => {
+  #                    'table'     => 'tablename',
+  #                    #everything else is optional...
+  #                    'hashref'   => { 'field' => 'value',
+  #                                     'field' => { 'op'    => '<',
+  #                                                  'value' => '54',
+  #                                                },
+  #                                   },
+  #                    'select'    => '*',
+  #                    'addl_from' => '', #'LEFT JOIN othertable USING ( key )',
+  #                    'extra_sql' => '', #'AND otherstuff', #'WHERE onlystuff',
+  #                    
+  #
+  #                  },
+  #                  # "select * from tablename";
+  #
+  # #required unless 'query' is an SQL query string (shouldn't be...)
+  # 'count_query' => 'SELECT COUNT(*) FROM tablename',
+  #
+  # 'count_addl' => [], #additional count fields listref of sprintf strings
+  #                     # [ $money_char.'%.2f total paid', ],
+  #
+  # #listref of column labels, <TH>
+  # #required unless 'query' is an SQL query string
+  # # (if not specified the database column names will be used)
+  # 'header'      => [ '#', 'Item' ],
+  #
+  # 'disable_download' => '', # set true to hide the CSV/Excel download links
+  # 'disable_nonefound' => '', # set true to disable the "No matching Xs found"
+  #                            # message
+  #
+  # #listref - each item is a literal column name (or method) or coderef
+  # #if not specified all columns will be shown
+  # 'fields'      => [
+  #                    'column',
+  #                    sub { my $row = shift; $row->column; },
+  #                  ],
+  #
+  # #listref of column footers
+  # 'footer'      => [],
+  # 
+  # #listref - each item is the empty string, or a listref of ...
+  # 'links'       =>
+  #
+  #
+  # 'align'       => 'lrc.', #one letter for each column, left/right/center/none
+  #                          # can also pass a listref with full values:
+  #                          # [ 'left', 'right', 'center', '' ]
+  #
+  # #listrefs...
+  # #currently only HTML, maybe eventually Excel too
+  # 'color'       => [],
+  # 'size'        => [],
+  # 'style'       => [],
+  # 
+  # #redirect if there's only one item...
+  # # listref of URL base and column name (or method)
+  # # or a coderef that returns the same
+  # 'redirect' =>
+
+  my $DEBUG = 0;
+
   my(%opt) = @_;
   #warn join(' / ', map { "$_ => $opt{$_}" } keys %opt ). "\n";
 
   my $header = $opt{'header'};
   my $rows;
   if ( ref($opt{'query'}) ) {
+
     #eval "use FS::$opt{'query'};";
     $rows = [ qsearch(
       $opt{'query'}->{'table'}, 
       '',
       (exists($opt{'query'}->{'addl_from'}) ? $opt{'query'}->{'addl_from'} : '')
     ) ];
+
   } else {
+
     my $sth = dbh->prepare("$opt{'query'} $limit")
       or die "Error preparing $opt{'query'}: ". dbh->errstr;
     $sth->execute
     $rows = $sth->fetchall_arrayref;
 
     $header ||= $sth->{NAME};
+
   }
 
+  warn scalar(@$rows). ' rows returned from '.
+       ( ref($opt{'query'}) ? 'qsearch query' : 'literal SQL query' )
+    if $DEBUG || $opt{'debug'};
+
+  # display the results - csv, xls or html
+
   if ( $type eq 'csv' ) {
 
     #http_header('Content-Type' => 'text/comma-separated-values' ); #IE chokes
       redirect( $url. $rows->[0]->$method() );
     } else {
       ( my $xlsname = $opt{'name'} ) =~ s/\W//g;
-      $opt{'name'} =~ s/s$// if $total == 1;
+      #$opt{'name'} =~ s/s$// if $total == 1;
+      $opt{'name'} =~ s/((s)e)?s$/$2/ if $total == 1;  #should use Lingua::bs
+                                                       # to "depluralize"
 
       my @menubar = ();
       if ( $opt{'menubar'} ) {
       } else {
         @menubar = ( 'Main menu' => $p );
       }
+
+
   %>
   <%= include( '/elements/header.html', $opt{'title'},
                  include( '/elements/menubar.html', @menubar )
              )
   %>
-  <%= defined($opt{'html_init'}) ? $opt{'html_init'} : '' %>
+  <%= defined($opt{'html_init'}) 
+        ? ( ref($opt{'html_init'})
+              ? &{$opt{'html_init'}}()
+              : $opt{'html_init'}
+          )
+        : ''
+  %>
   <% my $pager = include ( '/elements/pager.html',
                              'offset'     => $offset,
                              'num_rows'   => scalar(@$rows),
                          );
   %>
   <% unless ( $total ) { %>
-    No matching <%= $opt{'name'} %> found.<BR>
+    <% unless ( $opt{'disable_nonefound'} ) { %>
+      No matching <%= $opt{'name'} %> found.<BR>
+    <% } %>
   <% } else { %>
   
     <TABLE>
       <TR>
         <TD VALIGN="bottom">
-          <%= $total %> total <%= $opt{'name'} %><BR>
+          <%= $total %> total <%= $opt{'name'} %>
+          <%= defined($opt{'html_posttotal'}) 
+                ? ( ref($opt{'html_posttotal'})
+                      ? &{$opt{'html_posttotal'}}()
+                      : $opt{'html_posttotal'}
+                  )
+                : ''
+          %>
+          <BR>
           <% if ( $opt{'count_addl'} ) { %>
             <% my $n=0; foreach my $count ( @{$opt{'count_addl'}} ) { %>
               <%= sprintf( $count, $count_arrayref->[++$n] ) %><BR>
             <% } %>
           <% } %>
         </TD>
-        <TD ALIGN="right">
-          <% $cgi->param('_type', "$xlsname.xls" ); %>
-          Download full results<BR>
-          as <A HREF="<%= $cgi->self_url %>">Excel spreadsheet</A><BR>
-          <% $cgi->param('_type', 'csv'); %>
-          as <A HREF="<%= $cgi->self_url %>">CSV file</A>
-        </TD>
+        <% unless ( $opt{'disable_download'} ) { %>
+          <TD ALIGN="right">
+            <% $cgi->param('_type', "$xlsname.xls" ); %>
+            Download full results<BR>
+            as <A HREF="<%= $cgi->self_url %>">Excel spreadsheet</A><BR>
+            <% $cgi->param('_type', 'csv'); %>
+            as <A HREF="<%= $cgi->self_url %>">CSV file</A>
+          </TD>
+        <% } %>
       </TR>
       <TR>
         <TD COLSPAN=2>
             <%= include('/elements/table-grid.html') %>
 
               <TR>
-              <% foreach my $header ( @$header ) { %>
+              <% 
+                 foreach my $header ( @$header ) { %>
                    <TH CLASS="grid" BGCOLOR="#cccccc"><%= $header %></TH>
               <% } %>
               </TR>
                      <% } %>
                    <% } else { %>
                      <% foreach ( @$row ) { %>
-                          <TD CLASS="grid" BGCOLOR="$bgcolor"><%= $_ %></TD>
+                          <TD CLASS="grid" BGCOLOR="<%= $bgcolor %>"><%= $_ %></TD>
                      <% } %>
                    <% } %>
                    </TR>
       </TABLE>
   
   <% } %>
-  </BODY>
-  </HTML>
+  <%= defined($opt{'html_foot'}) 
+        ? ( ref($opt{'html_foot'})
+              ? &{$opt{'html_foot'}}()
+              : $opt{'html_foot'}
+          )
+        : ''
+  %>
+  <%= include( '/elements/footer.html' ) %>
   <% } %>
 <% } %>