printer.php

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