framework/printer.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Blue Static ISSO Framework
   5 || # Copyright (c)2002-[#]year[#] Blue Static
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * Printer
  24 * printer.php
  25 *
  26 * @package      ISSO
  27 */
  28
  29 /**
  30 * Printer
  31 *
  32 * This framework generates standard HTML through various functions. The purpose
  33 * is generally so that things like the admin system can be created without templates.
  34 *
  35 * Constants:
  36 *               ISSO_PRINTER_DONE_HEADER - An internal constant that is used to check to see
  37 *                                                                       if the page header has already been printed
  38 *               ISSO_PRINTER_HIDE_SETUP - Will stop the page footer data (copyright and debug
  39 *                                                                       box) from being printed
  40 *               ISSO_PRINTER_NO_NAVIGATION - Do not show the navigation frame from ISSO.Printer.Navigation
  41 *
  42 * @author               Blue Static
  43 * @copyright    Copyright (c)2002 - [#]year[#], Blue Static
  44 * @version              $Revision$
  45 * @package              ISSO
  46 *
  47 */
  48 class Printer
  49 {
  50         /**
  51         * Framework registry object
  52         * @var  object
  53         * @access       private
  54         */
  55         var $registry = null;
  56
  57         /**
  58         * Realm that we are operating in (displayed in the <title>)
  59         * @var  string
  60         * @access       private
  61         */
  62         var $realm = '[UNDEFINED REALM]';
  63
  64         /**
  65         * CSS to place in the page
  66         * @var  string
  67         * @access       private
  68         */
  69         var $css = '';
  70
  71         /**
  72         * Extra code to place
  73         * @var  sring
  74         * @access       private
  75         */
  76         var $code = '';
  77
  78         /**
  79         * Page-start hooko
  80         * @var  string
  81         * @access       private
  82         */
  83         var $page_start_hook = ':=NO METHOD=:';
  84
  85         /**
  86         * Language information array: ('langcode' =>, 'direction' =>, 'charset' =>)
  87         * @var  array
  88         * @access       private
  89         */
  90         var $language = array('langcode' => 'en_US', 'direction' => 'ltr', 'charset' => 'utf-8');
  91
  92         // ###################################################################
  93         /**
  94         * Constructor
  95         */
  96         function __construct(&$registry)
  97         {
  98                 $this->registry =& $registry;
  99         }
 100
 101         // ###################################################################
 102         /**
 103         * (PHP 4) Constructor
 104         */
 105         function Printer(&$registry)
 106         {
 107                 $this->__construct($registry);
 108         }
 109
 110         // ###################################################################
 111         /**
 112         * Sets the realm
 113         *
 114         * @access       public
 115         *
 116         * @param        string  Realm
 117         */
 118         function setRealm($realm)
 119         {
 120                 $this->realm = $realm;
 121         }
 122
 123         // ###################################################################
 124         /**
 125         * Gets the realm
 126         *
 127         * @access       public
 128         *
 129         * @return       string  Realm
 130         */
 131         function getRealm()
 132         {
 133                 return $this->realm;
 134         }
 135
 136         // ###################################################################
 137         /**
 138         * Gets the language array information
 139         *
 140         * @access       public
 141         *
 142         * @return       array   Language array
 143         */
 144         function getLanguageInformation()
 145         {
 146                 return $this->language;
 147         }
 148
 149         // ###################################################################
 150         /**
 151         * Sets the language array information
 152         *
 153         * @access       public
 154         *
 155         * @param        array   Language array
 156         */
 157         function setLanguageInformation($lang)
 158         {
 159                 $this->language = $lang;
 160         }
 161
 162         // ###################################################################
 163         /**
 164         * Creates a redirect to another page; constructs the header and footer
 165         * (therefore execution stops)
 166         *
 167         * @access       public
 168         *
 169         * @param        string  Location to redirect to
 170         * @param        string  Redirect message to be shown
 171         * @param        array   An aray of POST variables to send through on the redirect
 172         */
 173         function redirect($location, $message = null, $postvars = array())
 174         {
 175                 $timeout = 10 * 200;
 176
 177                 if ($postvars)
 178                 {
 179                         $js = <<<JS
 180         <script type="text/javascript">
 181         <!--
 182                 var timeout = $timeout;
 183
 184                 if (timeout > 0)
 185                 {
 186                         setTimeout("redirect()", $timeout);
 187                 }
 188                 else
 189                 {
 190                         redirect();
 191                 }
 192
 193                 function redirect()
 194                 {
 195                         document.forms.postvars.submit();
 196                 }
 197
 198         //-->
 199         </script>
 200 JS;
 201                 }
 202                 else
 203                 {
 204                         $js =  <<<JS
 205         <script type="text/javascript">
 206         <!--
 207                 var timeout = $timeout;
 208
 209                 if (timeout > 0)
 210                 {
 211                         setTimeout("redirect()", $timeout);
 212                 }
 213                 else
 214                 {
 215                         redirect();
 216                 }
 217
 218                 function redirect()
 219                 {
 220                         window.location = "$location";
 221                 }
 222         //-->
 223         </script>
 224 JS;
 225                 }
 226
 227                 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
 228                 {
 229                         define('ISSO_PRINTER_NO_NAVIGATION', 1);
 230                 }
 231
 232                 $this->page_start(T('Redirect'));
 233
 234                 if ($postvars)
 235                 {
 236                         $this->form_start($location, null, false, 'postvars');
 237
 238                         foreach ($postvars AS $key => $value)
 239                         {
 240                                 $this->form_hidden_field($key, $value);
 241                         }
 242
 243                         $this->form_end();
 244                 }
 245
 246                 $redir = sprintf(T('Please wait to be redirected. If you are not redirected in a few seconds, click <a href="%1$s">here</a>.'), $location);
 247                 $override = false;
 248                 if ($message == null)
 249                 {
 250                         $showmessage = $redir;
 251                 }
 252                 else
 253                 {
 254                         $showmessage = '<blockquote>' . $message . '</blockquote>';
 255                         $showmessage .= "\n<p>" . $redir . "</p>";
 256                         $override = true;
 257                 }
 258
 259                 $this->page_message(T('Redirect'), $showmessage, $override);
 260
 261                 $this->page_code($js);
 262
 263                 $this->page_end();
 264         }
 265
 266         // ###################################################################
 267         /**
 268         * Throws a fatal error; constructs the header and footer
 269         *
 270         * @access       public
 271         *
 272         * @param        string  Error messsage text
 273         */
 274         function error($message)
 275         {
 276                 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
 277                 {
 278                         define('ISSO_PRINTER_NO_NAVIGATION', 1);
 279                 }
 280
 281                 $this->page_start(T('Error'));
 282                 $this->page_message(T('Error'), $message);
 283                 $this->page_end();
 284
 285                 exit;
 286         }
 287
 288         // ###################################################################
 289         /**
 290         * Outputs the header of the page: doctype, <html>, <head>, <title>,
 291         * <body> and imbeds the style information
 292         *
 293         * @access       public
 294         *
 295         * @param        string  Title of the page
 296         * @param        string  Class of the page to be applied to the body
 297         * @param        string  Extra HTML to imbed in the <head> tag
 298         * @param        string  <body> onLoad action to imbed
 299         */
 300         function page_start($actiontitle, $pageclass = null, $extra = '', $onload = false)
 301         {
 302                 if ($this->registry->debug AND isset($_GET['query']))
 303                 {
 304                         ob_start();
 305                 }
 306
 307                 if (defined('ISSO_PRINTER_DONE_HEADER') AND constant('ISSO_PRINTER_DONE_HEADER'))
 308                 {
 309                         return;
 310                 }
 311
 312                 $title = sprintf(T('%1$s - %2$s - %3$s'), $this->registry->getApplication(), $this->realm, $actiontitle);
 313
 314                 echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
 315                 echo "<html xml:lang=\"" . $this->language['langcode'] . "\" lang=\"" . $this->language['langcode'] . "\" dir=\"" . $this->language['direction'] . "\">\n<head>";
 316                 echo "\n\t<title>$title</title>";
 317                 echo "\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=" . $this->language['charset'] . "\" />";
 318                 echo $this->css;
 319                 echo $this->code;
 320                 echo ($extra ? "\n$extra" : '');
 321                 echo "\n</head>\n<body" . ($pageclass != null ? " class=\"$pageclass\"" : '') . ($onload ? " onload=\"$onload\"" : '') . ">\n";
 322
 323                 if ($this->registry->is_loaded('printer_navigation') AND (!defined('ISSO_PRINTER_NO_NAVIGATION') OR (defined('ISSO_PRINTER_NO_NAVIGATION') AND constant('ISSO_PRINTER_NO_NAVIGATION') != true)))
 324                 {
 325                         echo $this->registry->modules['printer_navigation']->generate_header_html();
 326                 }
 327
 328                 if (!defined('ISSO_PRINTER_DONE_HEADER'))
 329                 {
 330                         define('ISSO_PRINTER_DONE_HEADER', 1);
 331                 }
 332         }
 333
 334         // ###################################################################
 335         /**
 336         * Links CSS to the page from a given relative path
 337         *
 338         * @access       public
 339         *
 340         * @param        string  Relative path to the CSS file
 341         */
 342         function css_link($path)
 343         {
 344                 $this->css .= "\n\t<link rel=\"stylesheet\" href=\"$path\" />";
 345         }
 346
 347         // ###################################################################
 348         /**
 349         * Imbeds actual CSS information into the page in <style> tags
 350         *
 351         * @access       public
 352         *
 353         * @param        string  Path of the CSS file to be imbeded
 354         */
 355         function css_imbed($path)
 356         {
 357                 $data = require_once($path);
 358                 $css = preg_replace('#/\*(.*?)\*/(\r|\n)*#s', '', $css);
 359                 $css = trim($css);
 360                 $this->css .= "\n\t<style type=\"text/css\">\n\t<!--\n" . $css . "\n\t//-->\n\t</style>";
 361         }
 362
 363         // ###################################################################
 364         /**
 365         * Places raw HTML code directly into the documet at the current
 366         * position
 367         *
 368         * @access       public
 369         *
 370         * @param        string  HTML code
 371         */
 372         function page_code($code)
 373         {
 374                 if (defined('ISSO_PRINTER_DONE_HEADER'))
 375                 {
 376                         echo "\n\n$code\n\n";
 377                 }
 378                 else
 379                 {
 380                         $this->code .= "\n\n$code\n\n";
 381                 }
 382         }
 383
 384         // ###################################################################
 385         /**
 386         * A block function that produces a table with a message in it. This
 387         * does not print the header and footer.
 388         *
 389         * @access       public
 390         *
 391         * @param        string  The title of the message (appears at the top of the block)
 392         * @param        string  Content of the message
 393         * @param        bool    Override the message: control the entire output (no <blockquote>)?
 394         */
 395         function page_message($title, $message, $overridemessage = false)
 396         {
 397                 $this->table_start(true, '75%');
 398                 $this->table_head($title, 1);
 399                 $this->row_span(($overridemessage ? $message : "<blockquote>$message</blockquote>"), ':swap:', 'left', 1);
 400                 $this->table_end();
 401         }
 402
 403         // ###################################################################
 404         /**
 405         * Produces an entire page layout that asks the user whether or not
 406         * they want to perform X action and provides a link to the YES and NO
 407         * action
 408         *
 409         * @access       public
 410         *
 411         * @param        string  Message that asks if they want to do X
 412         * @param        string  Location to go for YES
 413         * @param        string  DO action to pass
 414         * @param        array   Hidden parameters to pass to the next page
 415         */
 416         function page_confirm($message, $location, $action, $params)
 417         {
 418                 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
 419                 {
 420                         define('ISSO_PRINTER_NO_NAVIGATION', 1);
 421                 }
 422
 423                 $this->page_start(T('Confirm'));
 424
 425                 $this->form_start($location, $action);
 426                 foreach ($params AS $key => $value)
 427                 {
 428                         $this->form_hidden_field($key, $value);
 429                 }
 430
 431                 $this->table_start(true, '75%');
 432                 $this->table_head(T('Confirm'), 1);
 433                 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
 434                 $this->row_submit('<input type="button" class="button" name="no" value="  ' . T('No') . '  " onclick="history.back(1); return false;" />', T('Yes'), '');
 435                 $this->table_end();
 436
 437                 $this->form_end();
 438
 439                 $this->page_end();
 440         }
 441
 442         // ###################################################################
 443         /**
 444         * Closes the HTML document structure an adds the copyright; this also
 445         * stops execution of the page
 446         *
 447         * @access       public
 448         */
 449         function page_end()
 450         {
 451                 if ($this->registry->is_loaded('printer_navigation') AND (!defined('ISSO_PRINTER_NO_NAVIGATION') OR (defined('ISSO_PRINTER_NO_NAVIGATION') AND constant('ISSO_PRINTER_NO_NAVIGATION') != true)))
 452                 {
 453                         echo $this->registry->modules['printer_navigation']->generate_footer_html();
 454                 }
 455
 456                 $copyright = "\n<br />\n<p align=\"center\" class=\"copyright\">\n\t<a href=\"http://www.bluestatic.org\" target=\"_blank\">" . $this->registry->getApplication() . ' ' . $this->registry->getAppVersion() . ", &copy;2002 - " . date('Y') . " Blue Static</a>\n</p>";
 457
 458                 if (!defined('ISSO_PRINTER_HIDE_SETUP'))
 459                 {
 460                         echo "\n$copyright";
 461                         echo $this->registry->construct_debug_block(false);
 462                         echo $this->registry->modules[ISSO_DB_LAYER]->dblink->ConstructHTMLDebugBlock();
 463                 }
 464
 465                 echo "\n\n</body>\n</html>";
 466
 467                 exit;
 468         }
 469
 470         // -------------------------------------------------------------------
 471
 472         // ###################################################################
 473         /**
 474         * Opens a <table> tag with styling
 475         *
 476         * @access       public
 477         *
 478         * @param        bool    Whether to add a <br /> before the table
 479         * @param        string  Value of the width attribute
 480         */
 481         function table_start($break = true, $width = '90%')
 482         {
 483                 if ($break)
 484                 {
 485                         echo '<br />';
 486                 }
 487
 488                 echo "\n<table cellpadding=\"4\" cellspacing=\"1\" border=\"0\" align=\"center\" width=\"$width\" class=\"tborder\">\n";
 489         }
 490
 491         // ###################################################################
 492         /**
 493         * Adds a table row that is sued to head the entire table
 494         *
 495         * @access       public
 496         *
 497         * @param        string  Title string
 498         * @param        integer Colspan attribute value
 499         * @param        bool    Whether to bold the title
 500         */
 501         function table_head($title, $colspan = 2, $strong = true)
 502         {
 503                 echo "<tr>\n\t<td class=\"tcat\" align=\"center\" colspan=\"$colspan\">"  . (($strong) ? "<strong>$title</strong>" : $title) . "</td>\n</tr>\n";
 504         }
 505
 506         // ###################################################################
 507         /**
 508         * Creates column headings; useful for a grid-style page. This uses a
 509         * different styling than table_head() and is usually used directly
 510         * after a table header.
 511         *
 512         * @access       public
 513         *
 514         * @param        array   Array of titles to print
 515         */
 516         function table_column_head($columnarray)
 517         {
 518                 if (is_array($columnarray))
 519                 {
 520                         $render = "<tr valign=\"top\" align=\"center\">\n";
 521
 522                         foreach ($columnarray AS $header)
 523                         {
 524                                 $render .= "\t<td class=\"thead\" align=\"center\">$header</td>\n";
 525                         }
 526
 527                         $render .= "</tr>\n";
 528
 529                         echo $render;
 530                 }
 531         }
 532
 533         // ###################################################################
 534         /**
 535         * Closes a <table> tag
 536         *
 537         * @access       public
 538         */
 539         function table_end()
 540         {
 541                 echo "\n</table>\n";
 542         }
 543
 544         // -------------------------------------------------------------------
 545
 546         // ###################################################################
 547         /**
 548         * Starts a <form> tag and adds the DO hidden input field
 549         *
 550         * @access       public
 551         *
 552         * @param        string  Action/name of the file to action to
 553         * @param        string  Value of the DO parameter; used to do-branch
 554         * @param        bool    Enctype attribute; used for mime/multi-part
 555         * @param        string  Name of the form; this only matters for DOM access
 556         * @param        string  Method to action as; POST or GET (default is POST)
 557         */
 558         function form_start($action, $do, $enctype = false, $name = 'inputform', $submitmethod = 'post')
 559         {
 560                 echo "\n<!-- input form -->\n<form name=\"$name\" action=\"$action\"" . (($enctype) ? " enctype=\"$enctype\"" : '') . " method=\"$submitmethod\">\n";
 561
 562                 if ($do !== null)
 563                 {
 564                         $this->form_hidden_field('do', $do);
 565                 }
 566         }
 567
 568         // ###################################################################
 569         /**
 570         * Adds a hidden field at the current location
 571         *
 572         * @access       public
 573         *
 574         * @param        string  Name of the field
 575         * @param        string  Value of the field
 576         */
 577         function form_hidden_field($name, $value)
 578         {
 579                 echo "<input type=\"hidden\" name=\"$name\" value=\"$value\" />\n";
 580         }
 581
 582         // ###################################################################
 583         /**
 584         * Closes a <form> tag
 585         *
 586         * @access       public
 587         */
 588         function form_end()
 589         {
 590                 echo "</form>\n<!-- / input form -->\n";
 591         }
 592
 593         // -------------------------------------------------------------------
 594
 595         // ###################################################################
 596         /**
 597         * Creates a table row that spans an entire row; this is used to divide
 598         * sections, usually
 599         *
 600         * @access       public
 601         *
 602         * @param        string  Text to place in the row
 603         * @param        string  Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
 604         * @param        string  Alignment of the text in the row
 605         * @param        integer Colspan attribute
 606         */
 607         function row_span($text, $class = ':swap:', $align = 'left', $colspan = 2)
 608         {
 609                 if ($class === ':swap:')
 610                 {
 611                         $this->registry->modules['functions']->exec_swap_bg();
 612                         $row_class = $this->registry->modules['functions']->bgcolour;
 613                         $is_style_element = false;
 614                 }
 615                 else
 616                 {
 617                         if (preg_match('#:style:(.*?)#i', $class))
 618                         {
 619                                 $is_style_element = true;
 620                                 $style = str_replace(':style:', '', $class);
 621                         }
 622                         else
 623                         {
 624                                 $row_class = $class;
 625                                 $is_style_element = false;
 626                         }
 627                 }
 628
 629                 echo "\n<tr>\n\t<td ". (($is_style_element) ? "style=\"$style\"" : "class=\"$row_class\"") . " colspan=\"$colspan\" align=\"$align\">$text</td>\n</tr>";
 630         }
 631
 632         // ###################################################################
 633         /**
 634         * Creates a table row that has more than two columns; this is used in
 635         * conjunction with table_column_head() usually; it takes an array of
 636         * values
 637         *
 638         * @access       public
 639         *
 640         * @param        array   Array of values in form value => alignment key (c for center, l for left, and r for right)
 641         */
 642         function row_multi_item($row_array)
 643         {
 644                 $this->registry->modules['functions']->exec_swap_bg();
 645
 646                 foreach ($row_array AS $item => $align)
 647                 {
 648                         $row_data["$align"][] = $item;
 649                 }
 650
 651                 echo "<tr valign=\"top\">";
 652
 653                 foreach ($row_data AS $align_key => $item_array)
 654                 {
 655                         if ($align_key == 'c')
 656                         {
 657                                 $align = 'center';
 658                         }
 659                         else if ($align_key == 'l')
 660                         {
 661                                 $align = 'left';
 662                         }
 663                         else if ($align_key == 'r')
 664                         {
 665                                 $align = 'right';
 666                         }
 667
 668                         foreach ($item_array AS $value)
 669                         {
 670                                 echo "\n\t<td class=\"{$this->registry->modules['functions']->bgcolour}\" align=\"$align\">$value</td>";
 671                         }
 672                 }
 673
 674                 echo "\n</tr>\n";
 675         }
 676
 677         // ###################################################################
 678         /**
 679         * Generic row creation function that has two columns: label and value;
 680         * this is used for many other form functions, but can also be used for
 681         * non-editable fields
 682         *
 683         * @access       public
 684         *
 685         * @param        string  Label text
 686         * @param        string  HTML or text to place in the value column
 687         * @param        string  Vertical align (valign attribute) for the row
 688         * @param        integer Colspan attribute
 689         * @param        string  Class to style the row with; default is to alternate
 690         */
 691         function row_text($label, $value = '&nbsp;', $valign = 'top', $colspan = 2, $class = -1)
 692         {
 693                 global $IS_SETTINGS;
 694
 695                 if ($class == -1)
 696                 {
 697                         if (!$IS_SETTINGS)
 698                         {
 699                                 $this->registry->modules['functions']->exec_swap_bg();
 700                                 $row_class = $this->registry->modules['functions']->bgcolour;
 701                         }
 702                         else
 703                         {
 704                                 $row_class = 'alt2';
 705                         }
 706                 }
 707                 else
 708                 {
 709                         $row_class = $class;
 710                 }
 711
 712                 echo "<tr valign=\"$valign\">";
 713                 echo "\n\t<td class=\"$row_class\">$label</td>";
 714                 echo "\n\t<td class=\"$row_class\" colspan=\"" . ($colspan - 1) . "\">$value</td>";
 715
 716                 echo "\n</tr>\n";
 717         }
 718
 719         // ###################################################################
 720         /**
 721         * Creates a table row with an <input> text field as the value column
 722         *
 723         * @access       public
 724         *
 725         * @param        string  Label text
 726         * @param        string  Name of the <input> field
 727         * @param        string  Value of the field
 728         * @param        integer Colspan attribute
 729         * @param        integer Size of the <input> field
 730         * @param        integer Length attribute; use FALSE for no length to be specified
 731         * @param        bool    Whether to make this a password field
 732         * @param        string  Vertical align (valign attribute)
 733         */
 734         function row_input($label, $name, $value = '', $colspan = 2, $size = 35, $length = false, $password = false, $lalign = 'top')
 735         {
 736                 $this->row_text($label, "<input type=\"" . (($password) ? 'password' : 'text') . "\" class=\"input\" name=\"$name\" value=\"$value\" size=\"$size\" " . (($length) ? "maxlength=\"$length\" " : '') . "/>", $lalign, $colspan);
 737         }
 738
 739         // ###################################################################
 740         /**
 741         * Creates a table row with a <textarea> as the value column
 742         *
 743         * @access       public
 744         *
 745         * @param        string  Label text
 746         * @param        string  Name of the <textarea>
 747         * @param        string  Value of the <textarea>
 748         * @param        integer Colspan attribute
 749         * @param        integer Number of rows in the <textarea>
 750         * @param        integer Number of colums in the <textarea>
 751         * @param        bool    Whether or not to use monospacing font
 752         * @param        string  Extra style attributes to apply to the <textarea>
 753         */
 754         function row_textarea($label, $name, $value = '', $colspan = 2, $rows = 7, $cols = 50, $code = false, $style = '')
 755         {
 756                 $this->row_text($label, "<textarea name=\"$name\" class=\"" . (($code) ? 'code' : 'input') . "\" rows=\"$rows\" cols=\"$cols\"" . (($style) ? ' style="' . $style . '"' : '') . ">$value</textarea>", 'top', $colspan);
 757         }
 758
 759         // ###################################################################
 760         /**
 761         * Creates a table row with the tfoot class
 762         *
 763         * @access       public
 764         *
 765         * @param        string  Extra text or HTML to insert into the row
 766         * @param        integer Colspan attribute
 767         */
 768         function row_tfoot($data, $colspan = 2)
 769         {
 770                 echo $this->row_span($data, 'tfoot', 'center', $colspan);
 771         }
 772
 773         // ###################################################################
 774         /**
 775         * Creates a tfoot table row with submit buttons
 776         *
 777         * @access       public
 778         *
 779         * @param        string  Extra HTML to imbed in the row after the buttons
 780         * @param        string  Submit button text (by default it uses pre-translated "Submit" from :save:)
 781         * @param        string  Reset button text (default it uses pre-translated "Reset" from :reset:)
 782         * @param        integer Colspan attribute
 783         */
 784         function row_submit($extra = false, $submit = ':save:', $reset = ':reset:', $colspan = 2)
 785         {
 786                 if ($submit === ':save:')
 787                 {
 788                         $submit = "  " . T('Submit') . "  ";
 789                 }
 790                 else
 791                 {
 792                         $submit = "  $submit  ";
 793                 }
 794
 795                 if ($reset === ':reset:')
 796                 {
 797                         $reset = "  " . T('Reset') . "  ";
 798                 }
 799                 else
 800                 {
 801                         $reset = (($reset) ? "  $reset  " : '');
 802                 }
 803
 804                 $output = "\n\t\t<input type=\"submit\" class=\"button\" name=\"__submit__\" value=\"$submit\" accesskey=\"s\" />";
 805                 $output .= ($reset ? "\n\t\t<input type=\"reset\" class=\"button\" name=\"__reset__\" value=\"$reset\" accesskey=\"r\" />" : '');
 806                 $output .= ($extra ? "\n\t\t$extra" : '');
 807                 $output .= "\n\t";
 808                 $this->row_tfoot($output, $colspan);
 809         }
 810
 811         // ###################################################################
 812         /**
 813         * Creates an upload row; you need to specify some other paramaters in
 814         * form_start() for this to work
 815         *
 816         * @access       public
 817         *
 818         * @param        string  Label text
 819         * @param        string  Upload name
 820         * @param        integer Colspan attribute
 821         */
 822         function row_upload($label, $name, $colspan = 2)
 823         {
 824                 $this->row_text($label, "<input type=\"file\" class=\"button\" name=\"$name\" size=\"35\" />", 'top', $colspan);
 825         }
 826
 827         // ###################################################################
 828         /**
 829         * Adds a name-value pair to an array that is constructed into a
 830         * <select> list
 831         *
 832         * @access       public
 833         *
 834         * @param        string  Text displayed for the option
 835         * @param        string  Value of the option
 836         * @param        bool    Whether or not to select this particluar option
 837         */
 838         function list_item($name, $value, $selected = false)
 839         {
 840                 global $listitem;
 841
 842                 $listitem["$value"] = array('name' => $name, 'selected' => $selected);
 843         }
 844
 845         // ###################################################################
 846         /**
 847         * Assembles a <select> table row from list_item() items
 848         *
 849         * @access       public
 850         *
 851         * @param        string  Label text
 852         * @param        string  Name of the <select>
 853         * @param        bool    Automatically submit the form on a change?
 854         * @param        integer Colspan attribute
 855         */
 856         function row_list($label, $name, $is_jump = false, $colspan = 2)
 857         {
 858                 global $listitem;
 859
 860                 foreach ($listitem AS $value => $option)
 861                 {
 862                         $optionlist .= "\n\t<option value=\"$value\"" . ($option['selected'] == true ? ' selected="selected"' : '') . ">$option[name]</option>";
 863                 }
 864
 865                 $listitem = array();
 866
 867                 $this->row_text($label, "\n<select class=\"button\" name=\"$name\"" . (($is_jump) ? " onchange=\"this.form.submit();\"" : '') . ">$optionlist\n</select>" . (($is_jump) ? "\n<input type=\"submit\" class=\"button\" value=\"  " . T('Go') . "  \" accesskey=\"g\" />" : '') . "\n", $colspan);
 868         }
 869
 870         // ###################################################################
 871         /**
 872         * Assembles a list of checkboxes from list_item() items
 873         *
 874         * @access       public
 875         *
 876         * @param        string  Label text
 877         * @param        string  Name of the <input>s
 878         * @param        integer Colspan attribute
 879         */
 880         function row_checkbox($label, $name, $colspan = 2)
 881         {
 882                 global $listitem;
 883
 884                 foreach ($listitem AS $value => $box)
 885                 {
 886                         $optionlist[] = "\n\t<input type=\"checkbox\" class=\"button\" name=\"{$name}[]\" value=\"$value\"" . ($box['selected'] == true ? ' checked="checked"' : '') . " /> $box[name]";
 887                 }
 888
 889                 $listitem = array();
 890
 891                 $this->row_text($label, "\n" . implode('<br />', $optionlist) . "\n", $colspan);
 892         }
 893
 894         // ###################################################################
 895         /**
 896         * Creates a row with two radio buttons: yes and now
 897         *
 898         * @access       public
 899         *
 900         * @param        string  Label text
 901         * @param        string  Name of the BOOL flag
 902         * @param        bool    TRUE to select the YES by default; FALSE for NO
 903         * @param        integer Colspan attribute
 904         */
 905         function row_yesno($label, $name, $value, $colspan = 2)
 906         {
 907                 $this->row_text($label, "<input type=\"radio\" name=\"$name\" value=\"1\"" . (($value) ? ' checked="checked"' : '') . " /> " . T('Yes') . " <input type=\"radio\" name=\"$name\" value=\"0\"" . ((!$value) ? ' checked="checked"' : '') . "  /> " . T('No'), $colspan);
 908         }
 909 }
 910