Generalise dumpqueryresults and rename to dumptable

[ypp-sc-tools.main.git] / yarrg / web / dumptable

diff --git a/yarrg/web/dumptable b/yarrg/web/dumptable
new file mode 100644 (file)
index 0000000..20dc25f
--- /dev/null
+++ b/yarrg/web/dumptable
@@ -0,0 +1,104 @@
+<%doc>
+
+ This is part of the YARRG website.  YARRG is a tool and website
+ for assisting players of Yohoho Puzzle Pirates.
+
+ Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ Copyright (C) 2009 Clare Boothby
+
+  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+   basically means that every installation of the website will let you
+   download the source.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as
+ published by the Free Software Foundation, either version 3 of the
+ License, or (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+ Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
+ are used without permission.  This program is not endorsed or
+ sponsored by Three Rings.
+
+
+ This Mason component is helpful for debugging and developing.  It
+ outputs plain HTML tables eg for SQL query results.  You can either:
+    <& dumptable, sth = $executed_statement_handle &>
+ in which case it will consume the results of the statement and
+ print them unconditionally, or do the equivalent of:
+    <& dumptable:start, sth => $sth,              [ qa => $qa ] &> or
+    <& dumptable:start, cols => [ 'column',... ], [ qa => $qa ] &>
+    %  my $row;
+    %  while ($row= $sth->fetchrow_hashref) {
+    <& dumptable:row, sth|cols => ..., row => $row, [ qa => $qa ] &>
+    %       do something else with $row
+    %  }
+    <& dumptable:end, [ qa => $qa ] &>
+ where if you pass $qa, dumptable will check whether debug
+ is enabled and produce no output if it isn't.  NB you don't want
+ this approach if your loop body produces output because it'll be
+ interleaved with dumptable's table.
+
+</%doc>
+<%args>
+$sth
+</%args>
+
+<%method start>
+<%args>
+$sth => undef
+$cols => $sth->{NAME}
+$qa => undef
+</%args>
+%      if (!$qa || $qa->{'debug'}) {
+<table frame=box rules=all>
+<tr>
+%              foreach my $field (@$cols) {
+<th><% $field |h %>
+%              }
+</tr>
+%      }
+</%method>
+
+<%method row>
+<%args>
+$sth => undef
+$cols => $sth->{NAME}
+$row
+$qa => undef
+</%args>
+%      if (!$qa || $qa->{'debug'}) {
+<tr>
+%              foreach my $field (@$cols) {
+%                      my $cell= $row->{$field};
+<td>
+<% $cell |h %>
+</td>
+%              }
+</tr>
+%      }
+</%method>
+
+<%method end>
+<%args>
+$qa => undef
+</%args>
+%      if (!$qa || $qa->{'debug'}) {
+</table>
+%      }
+</%method>
+
+<& SELF:start, sth => $sth &>
+%      my $row;
+%      while ($row= $sth->fetchrow_hashref) {
+<& SELF:row, sth => $sth, row => $row &>
+%      }
+<& SELF:end &>