2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
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.
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
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 \*=====================================================================*/
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.
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
42 * _printer_page_start() - Define function to echo() data after the page header
45 * @author Iris Studios, Inc.
46 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
54 * Framework registry object
61 * Realm that we are operating in (displayed in the <title>)
65 var $realm = '[UNDEFINED REALM]';
68 * CSS to place in the page
75 * Fields array that is used in this module
80 'realm' => array(REQ_YES
, null
, false
)
83 // ###################################################################
87 function __construct(&$registry)
89 $this->registry
=& $registry;
92 // ###################################################################
96 function Printer(&$registry)
98 $this->__construct($registry);
101 // ###################################################################
107 * @param string Field name
108 * @param mixed Value of the field
110 function set($name, $value)
112 $this->registry
->do_set($name, $value, 'printer');
115 // ###################################################################
121 * @param string Field name
123 * @return mixed Value of the field
125 function get($fieldname)
127 return $this->registry
->do_get($fieldname, 'printer');
130 // ###################################################################
132 * Creates a redirect to another page; constructs the header and footer
133 * (therefore execution stops)
137 * @param string Location to redirect to
138 * @param integer Time to wait before the redirect
139 * @param array An aray of POST variables to send through on the redirect
141 function redirect($location, $timeout = 10, $postvars = array())
143 $timeout = $timeout * 200;
148 <script type
="text/javascript">
150 var timeout
= $timeout;
154 setTimeout("redirect()", $timeout);
163 document
.forms
.postvars
.submit();
173 <script type
="text/javascript">
175 var timeout
= $timeout;
179 setTimeout("redirect()", $timeout);
188 window
.location
= "$location";
195 $this->page_start($this->registry
->modules
['localize']->string('Redirect'));
199 $this->form_start($location, null
, false
, 'postvars');
201 foreach ($postvars AS $key => $value)
203 $this->form_hidden_field($key, $value);
209 $this->page_message($this->registry
->modules
['localize']->string('Redirect'), 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));
211 $this->page_code($js);
216 // ###################################################################
218 * Throws a fatal error; constructs the header and footer
222 * @param string Error messsage text
224 function error($message)
226 $this->page_start($this->registry
->modules
['localize']->string('Error'));
227 $this->page_message($this->registry
->modules
['localize']->string('Error'), $message);
233 // ###################################################################
235 * Outputs the header of the page: doctype, <html>, <head>, <title>,
236 * <body> and imbeds the style information
240 * @param string Title of the page
241 * @param string Class of the page to be applied to the body
242 * @param integer Margin of the <div> that all content is placed in
243 * @param string Extra HTML to imbed in the <head> tag
244 * @param string <body> onLoad action to imbed
245 * @param integer Margin of the actual <body > tag
246 * @param string Relative path where the CSS data is stored
247 * @param bool Will force re-print the header if it has already been printed
249 function page_start($actiontitle, $pageclass = ':default:', $pagemargin = 15, $extra = '', $onload = false
, $margin = 0, $dotpath = '.', $override = false
)
251 $this->registry
->check_isso_fields(get_class($this));
253 if ($this->registry
->debug
AND isset($_GET['query']))
258 if (defined('ISSO_PRINTER_DONE_HEADER') AND !$override)
260 if (constant('ISSO_PRINTER_DONE_HEADER') AND !$override)
266 $title = sprintf($this->registry
->modules
['localize']->string('%1$s - %2$s - %3$s'), $this->registry
->application
, $this->realm
, $actiontitle);
268 echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
269 echo "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n<head>";
270 echo "\n\t<title>$title</title>";
271 echo "\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />";
273 echo ($extra ?
"\n$extra" : '');
274 echo "\n</head>\n<body style=\"margin: {$margin}px;\"" . (($pageclass !== ':default:') ?
" class=\"$pageclass\"" : '') . (($onload) ?
" onload=\"$onload\"" : '') . ">\n";
276 if (!defined('ISSO_PRINTER_HIDE_SETUP') AND function_exists('_printer_page_start'))
278 _printer_page_start();
281 echo "<div style=\"margin: {$pagemargin}px;\">\n<!-- / page head -->\n\n";
283 if (!defined('ISSO_PRINTER_DONE_HEADER'))
285 define('ISSO_PRINTER_DONE_HEADER', 1);
289 // ###################################################################
291 * Links CSS to the page from a given relative path
295 * @param string Relative path to the CSS file
297 function css_link($path)
299 $this->css
.= "\n\t<link rel=\"stylesheet\" href=\"$path\" />";
302 // ###################################################################
304 * Imbeds actual CSS information into the page in <style> tags
308 * @param string Path of the CSS file to be imbeded
310 function css_imbed($path)
312 $data = require_once($path);
313 $css = preg_replace('#/\*(.*?)\*/(\r|\n)*#s', '', $css);
315 $this->css
.= "\n\t<style type=\"text/css\">\n\t<!--\n" . $css . "\n\t//-->\n\t</style>";
318 // ###################################################################
320 * Places raw HTML code directly into the documet at the current
325 * @param string HTML code
327 function page_code($code)
329 echo "\n\n$code\n\n";
332 // ###################################################################
334 * A block function that produces a table with a message in it. This
335 * does not print the header and footer.
339 * @param string The title of the message (appears at the top of the block)
340 * @param string Content of the message
342 function page_message($title, $message)
344 $this->table_start(true
, '75%');
345 $this->table_head($title, 1);
346 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
350 // ###################################################################
352 * Produces an entire page layout that asks the user whether or not
353 * they want to perform X action and provides a link to the YES and NO
358 * @param string Message that asks if they want to do X
359 * @param string Location to go for YES
360 * @param string DO action to pass
361 * @param array Hidden parameters to pass to the next page
363 function page_confirm($message, $location, $action, $params)
365 $this->page_start($this->registry
->modules
['localize']->string('Confirm'));
367 $this->form_start($location, $action);
368 foreach ($params AS $key => $value)
370 $this->form_hidden_field($key, $value);
373 $this->table_start(true
, '75%');
374 $this->table_head($this->registry
->modules
['localize']->string('Confirm'), 1);
375 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
376 $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'), '');
384 // ###################################################################
386 * Closes the HTML document structure an adds the copyright; this also
387 * stops execution of the page
393 if ($this->registry
->debug
AND isset($_GET['query']))
398 if (is_array($this->registry
->modules
[ISSO_DB_LAYER
]->history
))
401 foreach ($this->registry
->modules
[ISSO_DB_LAYER
]->history
AS $query)
403 echo $query . "\n\n<hr />\n\n";
410 $copyright = "\n<br />\n<p align=\"center\" class=\"copyright\">\n\t<a href=\"http://www.iris-studios.com\" target=\"_blank\">" . $this->registry
->application
. ' ' . $this->registry
->appversion
. ", © 2002 - " . date('Y') . " Iris Studios, Inc.</a>\n</p>";
412 if (!defined('ISSO_PRINTER_HIDE_SETUP'))
414 echo "\n<!-- page end -->\n</div>\n$copyright";
415 echo $this->registry
->construct_debug_block(false
);
419 echo "\n<!-- page end -->\n</div>";
422 echo "\n\n</body>\n</html>";
427 // -------------------------------------------------------------------
429 // ###################################################################
431 * Opens a <table> tag with styling
435 * @param bool Whether to add a <br /> before the table
436 * @param string Value of the width attribute
438 function table_start($break = true
, $width = '90%')
445 echo "\n<table cellpadding=\"4\" cellspacing=\"0\" border=\"0\" align=\"center\" width=\"$width\" class=\"tborder\">\n";
448 // ###################################################################
450 * Adds a table row that is sued to head the entire table
454 * @param string Title string
455 * @param integer Colspan attribute value
456 * @param bool Whether to bold the title
458 function table_head($title, $colspan = 2, $strong = true
)
460 echo "<tr>\n\t<td class=\"tcat\" align=\"center\" colspan=\"$colspan\">" . (($strong) ?
"<strong>$title</strong>" : $title) . "</td>\n</tr>\n";
463 // ###################################################################
465 * Creates column headings; useful for a grid-style page. This uses a
466 * different styling than table_head() and is usually used directly
467 * after a table header.
471 * @param array Array of titles to print
473 function table_column_head($columnarray)
475 if (is_array($columnarray))
477 $render = "<tr valign=\"top\" align=\"center\">\n";
479 foreach ($columnarray AS $header)
481 $render .= "\t<td class=\"thead\" align=\"center\">$header</td>\n";
484 $render .= "</tr>\n";
490 // ###################################################################
492 * Closes a <table> tag
501 // -------------------------------------------------------------------
503 // ###################################################################
505 * Starts a <form> tag and adds the DO hidden input field
509 * @param string Action/name of the file to action to
510 * @param string Value of the DO parameter; used to do-branch
511 * @param bool Enctype attribute; used for mime/multi-part
512 * @param string Name of the form; this only matters for DOM access
513 * @param string Method to action as; POST or GET (default is POST)
515 function form_start($action, $do, $enctype = false
, $name = 'inputform', $submitmethod = 'post')
517 echo "\n<!-- input form -->\n<form name=\"$name\" action=\"$action\"" . (($enctype) ?
" enctype=\"$enctype\"" : '') . " method=\"$submitmethod\">\n";
521 $this->form_hidden_field('do', $do);
525 // ###################################################################
527 * Adds a hidden field at the current location
531 * @param string Name of the field
532 * @param string Value of the field
534 function form_hidden_field($name, $value)
536 echo "<input type=\"hidden\" name=\"$name\" value=\"$value\" />\n";
539 // ###################################################################
541 * Closes a <form> tag
547 echo "</form>\n<!-- / input form -->\n";
550 // -------------------------------------------------------------------
552 // ###################################################################
554 * Creates a table row that spans an entire row; this is used to divide
559 * @param string Text to place in the row
560 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
561 * @param string Alignment of the text in the row
562 * @param integer Colspan attribute
564 function row_span($text, $class = ':swap:', $align = 'left', $colspan = 2)
566 if ($class === ':swap:')
568 $this->registry
->modules
['functions']->exec_swap_bg();
569 $row_class = $this->registry
->modules
['functions']->bgcolour
;
570 $is_style_element = false
;
574 if (preg_match('#:style:(.*?)#i', $class))
576 $is_style_element = true
;
577 $style = str_replace(':style:', '', $class);
582 $is_style_element = false
;
586 echo "\n<tr>\n\t<td ". (($is_style_element) ?
"style=\"$style\"" : "class=\"$row_class\"") . " colspan=\"$colspan\" align=\"$align\">$text</td>\n</tr>";
589 // ###################################################################
591 * Creates a table row that has more than two columns; this is used in
592 * conjunction with table_column_head() usually; it takes an array of
597 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
599 function row_multi_item($row_array)
601 $this->registry
->modules
['functions']->exec_swap_bg();
603 foreach ($row_array AS $item => $align)
605 $row_data["$align"][] = $item;
608 echo "<tr valign=\"top\">";
610 foreach ($row_data AS $align_key => $item_array)
612 if ($align_key == 'c')
616 else if ($align_key == 'l')
620 else if ($align_key == 'r')
625 foreach ($item_array AS $value)
627 echo "\n\t<td class=\"{$this->registry->modules['functions']->bgcolour}\" align=\"$align\">$value</td>";
634 // ###################################################################
636 * Generic row creation function that has two columns: label and value;
637 * this is used for many other form functions, but can also be used for
638 * non-editable fields
642 * @param string Label text
643 * @param string HTML or text to place in the value column
644 * @param string Vertical align (valign attribute) for the row
645 * @param integer Colspan attribute
646 * @param string Class to style the row with; default is to alternate
648 function row_text($label, $value = ' ', $valign = 'top', $colspan = 2, $class = -1)
656 $this->registry
->modules
['functions']->exec_swap_bg();
657 $row_class = $this->registry
->modules
['functions']->bgcolour
;
669 echo "<tr valign=\"$valign\">";
670 echo "\n\t<td class=\"$row_class\">$label</td>";
671 echo "\n\t<td class=\"$row_class\">$value</td>";
675 echo "\n\t<td class=\"$row_class\" colspan=\"" . $colspan - 2 . "\"> </td>";
681 // ###################################################################
683 * Creates a table row with an <input> text field as the value column
687 * @param string Label text
688 * @param string Name of the <input> field
689 * @param string Value of the field
690 * @param integer Colspan attribute
691 * @param integer Size of the <input> field
692 * @param integer Length attribute; use FALSE for no length to be specified
693 * @param bool Whether to make this a password field
694 * @param string Vertical align (valign attribute)
696 function row_input($label, $name, $value = '', $colspan = 2, $size = 35, $length = false
, $password = false
, $lalign = 'top')
698 $this->row_text($label, "<input type=\"" . (($password) ?
'password' : 'text') . "\" class=\"input\" name=\"$name\" value=\"$value\" size=\"$size\" " . (($length) ?
"maxlength=\"$length\" " : '') . "/>", $lalign, $colspan);
701 // ###################################################################
703 * Creates a table row with a <textarea> as the value column
707 * @param string Label text
708 * @param string Name of the <textarea>
709 * @param string Value of the <textarea>
710 * @param integer Colspan attribute
711 * @param integer Number of rows in the <textarea>
712 * @param integer Number of colums in the <textarea>
713 * @param bool Whether or not to use monospacing font
714 * @param string Extra style attributes to apply to the <textarea>
716 function row_textarea($label, $name, $value = '', $colspan = 2, $rows = 7, $cols = 50, $code = false
, $style = '')
718 $this->row_text($label, "<textarea name=\"$name\" class=\"" . (($code) ?
'code' : 'input') . "\" rows=\"$rows\" cols=\"$cols\"" . (($style) ?
' style="' . $style . '"' : '') . ">$value</textarea>", 'top', $colspan);
721 // ###################################################################
723 * Creates a table row with the tfoot class
727 * @param string Extra text or HTML to insert into the row
728 * @param integer Colspan attribute
730 function row_tfoot($data, $colspan = 2)
732 echo $this->row_span($data, 'tfoot', 'center', $colspan);
735 // ###################################################################
737 * Creates a tfoot table row with submit buttons
741 * @param string Extra HTML to imbed in the row after the buttons
742 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
743 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
744 * @param integer Colspan attribute
746 function row_submit($extra = false
, $submit = ':save:', $reset = ':reset:', $colspan = 2)
748 if ($submit === ':save:')
750 $submit = " " . $this->registry
->modules
['localize']->string('Submit') . " ";
754 $submit = " $submit ";
757 if ($reset === ':reset:')
759 $reset = " " . $this->registry
->modules
['localize']->string('Reset') . " ";
763 $reset = (($reset) ?
" $reset " : '');
766 $output = "\n\t\t<input type=\"submit\" class=\"button\" name=\"__submit__\" value=\"$submit\" accesskey=\"s\" />";
767 $output .= ($reset ?
"\n\t\t<input type=\"reset\" class=\"button\" name=\"__reset__\" value=\"$reset\" accesskey=\"r\" />" : '');
768 $output .= ($extra ?
"\n\t\t$extra" : '');
770 $this->row_tfoot($output, $colspan);
773 // ###################################################################
775 * Creates an upload row; you need to specify some other paramaters in
776 * form_start() for this to work
780 * @param string Label text
781 * @param string Upload name
782 * @param integer Colspan attribute
784 function row_upload($label, $name, $colspan = 2)
786 $this->row_text($label, "<input type=\"file\" class=\"button\" name=\"$name\" size=\"35\" />", 'top', $colspan);
789 // ###################################################################
791 * Adds a name-value pair to an array that is constructed into a
796 * @param string Text displayed for the option
797 * @param string Value of the option
798 * @param bool Whether or not to select this particluar option
800 function list_item($name, $value, $selected = false
)
804 $listitem[] = "\n\t<option value=\"$value\"" . (($selected == true
) ?
' selected="selected"' : '') . ">$name</option>";
807 // ###################################################################
809 * Assembles a <select> table row from list_item() items
813 * @param string Label text
814 * @param string Name of the <select>
815 * @param bool Automatically submit the form on a change?
816 * @param integer Colspan attribute
818 function row_list($label, $name, $is_jump = false
, $colspan = 2)
822 foreach ($listitem AS $option)
824 $optionlist .= $option;
829 $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);
832 // ###################################################################
834 * Creates a row with two radio buttons: yes and now
838 * @param string Label text
839 * @param string Name of the BOOL flag
840 * @param bool TRUE to select the YES by default; FALSE for NO
841 * @param integer Colspan attribute
843 function row_yesno($label, $name, $value, $colspan = 2)
845 $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);
849 /*=====================================================================*\
850 || ###################################################################
853 || ###################################################################
854 \*=====================================================================*/