2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]issoversion[#]
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 * $this->page_start_hook - 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
86 var $page_start_hook = ':=NO METHOD=:';
89 * Fields array that is used in this module
94 'realm' => array(REQ_YES
, null
, false
),
95 'page_start_hook' => array(REQ_NO
, null
, false
)
98 // ###################################################################
102 function __construct(&$registry)
104 $this->registry
=& $registry;
107 // ###################################################################
109 * (PHP 4) Constructor
111 function Printer(&$registry)
113 $this->__construct($registry);
116 // ###################################################################
122 * @param string Field name
123 * @param mixed Value of the field
125 function set($name, $value)
127 $this->registry
->do_set($name, $value, 'printer');
130 // ###################################################################
136 * @param string Field name
138 * @return mixed Value of the field
140 function get($fieldname)
142 return $this->registry
->do_get($fieldname, 'printer');
145 // ###################################################################
147 * Creates a redirect to another page; constructs the header and footer
148 * (therefore execution stops)
152 * @param string Location to redirect to
153 * @param string Redirect message to be shown
154 * @param array An aray of POST variables to send through on the redirect
156 function redirect($location, $message = null
, $postvars = array())
163 <script type
="text/javascript">
165 var timeout
= $timeout;
169 setTimeout("redirect()", $timeout);
178 document
.forms
.postvars
.submit();
188 <script type
="text/javascript">
190 var timeout
= $timeout;
194 setTimeout("redirect()", $timeout);
203 window
.location
= "$location";
210 $this->page_start($this->registry
->modules
['localize']->string('Redirect'));
214 $this->form_start($location, null
, false
, 'postvars');
216 foreach ($postvars AS $key => $value)
218 $this->form_hidden_field($key, $value);
224 $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 if ($message == null
)
228 $showmessage = $redir;
232 $showmessage = '<blockquote>' . $message . '</blockquote>';
233 $showmessage .= "\n<p>" . $redir . "</p>";
237 $this->page_message($this->registry
->modules
['localize']->string('Redirect'), $showmessage, $override);
239 $this->page_code($js);
244 // ###################################################################
246 * Throws a fatal error; constructs the header and footer
250 * @param string Error messsage text
252 function error($message)
254 $this->page_start($this->registry
->modules
['localize']->string('Error'));
255 $this->page_message($this->registry
->modules
['localize']->string('Error'), $message);
261 // ###################################################################
263 * Outputs the header of the page: doctype, <html>, <head>, <title>,
264 * <body> and imbeds the style information
268 * @param string Title of the page
269 * @param string Class of the page to be applied to the body
270 * @param integer Margin of the <div> that all content is placed in
271 * @param string Extra HTML to imbed in the <head> tag
272 * @param string <body> onLoad action to imbed
273 * @param integer Margin of the actual <body > tag
274 * @param string Relative path where the CSS data is stored
275 * @param bool Will force re-print the header if it has already been printed
277 function page_start($actiontitle, $pageclass = ':default:', $pagemargin = 15, $extra = '', $onload = false
, $margin = 0, $dotpath = '.', $override = false
)
279 $this->registry
->check_isso_fields(get_class($this));
281 if ($this->registry
->debug
AND isset($_GET['query']))
286 if (defined('ISSO_PRINTER_DONE_HEADER') AND !$override)
288 if (constant('ISSO_PRINTER_DONE_HEADER') AND !$override)
294 $title = sprintf($this->registry
->modules
['localize']->string('%1$s - %2$s - %3$s'), $this->registry
->application
, $this->realm
, $actiontitle);
296 echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
297 echo "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n<head>";
298 echo "\n\t<title>$title</title>";
299 echo "\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />";
302 echo ($extra ?
"\n$extra" : '');
303 echo "\n</head>\n<body style=\"margin: {$margin}px;\"" . (($pageclass !== ':default:') ?
" class=\"$pageclass\"" : '') . (($onload) ?
" onload=\"$onload\"" : '') . ">\n";
305 if (is_callable($this->page_start_hook
))
307 call_user_func($this->page_start_hook
);
310 echo "<div style=\"margin: {$pagemargin}px;\">\n<!-- / page head -->\n\n";
312 if (!defined('ISSO_PRINTER_DONE_HEADER'))
314 define('ISSO_PRINTER_DONE_HEADER', 1);
318 // ###################################################################
320 * Links CSS to the page from a given relative path
324 * @param string Relative path to the CSS file
326 function css_link($path)
328 $this->css
.= "\n\t<link rel=\"stylesheet\" href=\"$path\" />";
331 // ###################################################################
333 * Imbeds actual CSS information into the page in <style> tags
337 * @param string Path of the CSS file to be imbeded
339 function css_imbed($path)
341 $data = require_once($path);
342 $css = preg_replace('#/\*(.*?)\*/(\r|\n)*#s', '', $css);
344 $this->css
.= "\n\t<style type=\"text/css\">\n\t<!--\n" . $css . "\n\t//-->\n\t</style>";
347 // ###################################################################
349 * Places raw HTML code directly into the documet at the current
354 * @param string HTML code
356 function page_code($code)
358 if (defined('ISSO_PRINTER_DONE_HEADER'))
360 echo "\n\n$code\n\n";
364 $this->code
.= "\n\n$code\n\n";
368 // ###################################################################
370 * A block function that produces a table with a message in it. This
371 * does not print the header and footer.
375 * @param string The title of the message (appears at the top of the block)
376 * @param string Content of the message
377 * @param bool Override the message: control the entire output (no <blockquote>)?
379 function page_message($title, $message, $overridemessage = false
)
381 $this->table_start(true
, '75%');
382 $this->table_head($title, 1);
383 $this->row_span(($overridemessage ?
$message : "<blockquote>$message</blockquote>"), ':swap:', 'left', 1);
387 // ###################################################################
389 * Produces an entire page layout that asks the user whether or not
390 * they want to perform X action and provides a link to the YES and NO
395 * @param string Message that asks if they want to do X
396 * @param string Location to go for YES
397 * @param string DO action to pass
398 * @param array Hidden parameters to pass to the next page
400 function page_confirm($message, $location, $action, $params)
402 $this->page_start($this->registry
->modules
['localize']->string('Confirm'));
404 $this->form_start($location, $action);
405 foreach ($params AS $key => $value)
407 $this->form_hidden_field($key, $value);
410 $this->table_start(true
, '75%');
411 $this->table_head($this->registry
->modules
['localize']->string('Confirm'), 1);
412 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
413 $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'), '');
421 // ###################################################################
423 * Closes the HTML document structure an adds the copyright; this also
424 * stops execution of the page
430 if ($this->registry
->debug
AND isset($_GET['query']))
435 if (is_array($this->registry
->modules
[ISSO_DB_LAYER
]->history
))
437 foreach ($this->registry
->modules
[ISSO_DB_LAYER
]->history
AS $query)
439 echo $this->registry
->modules
[ISSO_DB_LAYER
]->construct_query_debug($query);
445 $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') . ", ©2002 - " . date('Y') . " Iris Studios, Inc.</a>\n</p>";
447 if (!defined('ISSO_PRINTER_HIDE_SETUP'))
449 echo "\n<!-- page end -->\n</div>\n$copyright";
450 echo $this->registry
->construct_debug_block(false
);
454 echo "\n<!-- page end -->\n</div>";
457 echo "\n\n</body>\n</html>";
462 // -------------------------------------------------------------------
464 // ###################################################################
466 * Opens a <table> tag with styling
470 * @param bool Whether to add a <br /> before the table
471 * @param string Value of the width attribute
473 function table_start($break = true
, $width = '90%')
480 echo "\n<table cellpadding=\"4\" cellspacing=\"0\" border=\"0\" align=\"center\" width=\"$width\" class=\"tborder\">\n";
483 // ###################################################################
485 * Adds a table row that is sued to head the entire table
489 * @param string Title string
490 * @param integer Colspan attribute value
491 * @param bool Whether to bold the title
493 function table_head($title, $colspan = 2, $strong = true
)
495 echo "<tr>\n\t<td class=\"tcat\" align=\"center\" colspan=\"$colspan\">" . (($strong) ?
"<strong>$title</strong>" : $title) . "</td>\n</tr>\n";
498 // ###################################################################
500 * Creates column headings; useful for a grid-style page. This uses a
501 * different styling than table_head() and is usually used directly
502 * after a table header.
506 * @param array Array of titles to print
508 function table_column_head($columnarray)
510 if (is_array($columnarray))
512 $render = "<tr valign=\"top\" align=\"center\">\n";
514 foreach ($columnarray AS $header)
516 $render .= "\t<td class=\"thead\" align=\"center\">$header</td>\n";
519 $render .= "</tr>\n";
525 // ###################################################################
527 * Closes a <table> tag
536 // -------------------------------------------------------------------
538 // ###################################################################
540 * Starts a <form> tag and adds the DO hidden input field
544 * @param string Action/name of the file to action to
545 * @param string Value of the DO parameter; used to do-branch
546 * @param bool Enctype attribute; used for mime/multi-part
547 * @param string Name of the form; this only matters for DOM access
548 * @param string Method to action as; POST or GET (default is POST)
550 function form_start($action, $do, $enctype = false
, $name = 'inputform', $submitmethod = 'post')
552 echo "\n<!-- input form -->\n<form name=\"$name\" action=\"$action\"" . (($enctype) ?
" enctype=\"$enctype\"" : '') . " method=\"$submitmethod\">\n";
556 $this->form_hidden_field('do', $do);
560 // ###################################################################
562 * Adds a hidden field at the current location
566 * @param string Name of the field
567 * @param string Value of the field
569 function form_hidden_field($name, $value)
571 echo "<input type=\"hidden\" name=\"$name\" value=\"$value\" />\n";
574 // ###################################################################
576 * Closes a <form> tag
582 echo "</form>\n<!-- / input form -->\n";
585 // -------------------------------------------------------------------
587 // ###################################################################
589 * Creates a table row that spans an entire row; this is used to divide
594 * @param string Text to place in the row
595 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
596 * @param string Alignment of the text in the row
597 * @param integer Colspan attribute
599 function row_span($text, $class = ':swap:', $align = 'left', $colspan = 2)
601 if ($class === ':swap:')
603 $this->registry
->modules
['functions']->exec_swap_bg();
604 $row_class = $this->registry
->modules
['functions']->bgcolour
;
605 $is_style_element = false
;
609 if (preg_match('#:style:(.*?)#i', $class))
611 $is_style_element = true
;
612 $style = str_replace(':style:', '', $class);
617 $is_style_element = false
;
621 echo "\n<tr>\n\t<td ". (($is_style_element) ?
"style=\"$style\"" : "class=\"$row_class\"") . " colspan=\"$colspan\" align=\"$align\">$text</td>\n</tr>";
624 // ###################################################################
626 * Creates a table row that has more than two columns; this is used in
627 * conjunction with table_column_head() usually; it takes an array of
632 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
634 function row_multi_item($row_array)
636 $this->registry
->modules
['functions']->exec_swap_bg();
638 foreach ($row_array AS $item => $align)
640 $row_data["$align"][] = $item;
643 echo "<tr valign=\"top\">";
645 foreach ($row_data AS $align_key => $item_array)
647 if ($align_key == 'c')
651 else if ($align_key == 'l')
655 else if ($align_key == 'r')
660 foreach ($item_array AS $value)
662 echo "\n\t<td class=\"{$this->registry->modules['functions']->bgcolour}\" align=\"$align\">$value</td>";
669 // ###################################################################
671 * Generic row creation function that has two columns: label and value;
672 * this is used for many other form functions, but can also be used for
673 * non-editable fields
677 * @param string Label text
678 * @param string HTML or text to place in the value column
679 * @param string Vertical align (valign attribute) for the row
680 * @param integer Colspan attribute
681 * @param string Class to style the row with; default is to alternate
683 function row_text($label, $value = ' ', $valign = 'top', $colspan = 2, $class = -1)
691 $this->registry
->modules
['functions']->exec_swap_bg();
692 $row_class = $this->registry
->modules
['functions']->bgcolour
;
704 echo "<tr valign=\"$valign\">";
705 echo "\n\t<td class=\"$row_class\">$label</td>";
706 echo "\n\t<td class=\"$row_class\">$value</td>";
710 echo "\n\t<td class=\"$row_class\" colspan=\"" . $colspan - 2 . "\"> </td>";
716 // ###################################################################
718 * Creates a table row with an <input> text field as the value column
722 * @param string Label text
723 * @param string Name of the <input> field
724 * @param string Value of the field
725 * @param integer Colspan attribute
726 * @param integer Size of the <input> field
727 * @param integer Length attribute; use FALSE for no length to be specified
728 * @param bool Whether to make this a password field
729 * @param string Vertical align (valign attribute)
731 function row_input($label, $name, $value = '', $colspan = 2, $size = 35, $length = false
, $password = false
, $lalign = 'top')
733 $this->row_text($label, "<input type=\"" . (($password) ?
'password' : 'text') . "\" class=\"input\" name=\"$name\" value=\"$value\" size=\"$size\" " . (($length) ?
"maxlength=\"$length\" " : '') . "/>", $lalign, $colspan);
736 // ###################################################################
738 * Creates a table row with a <textarea> as the value column
742 * @param string Label text
743 * @param string Name of the <textarea>
744 * @param string Value of the <textarea>
745 * @param integer Colspan attribute
746 * @param integer Number of rows in the <textarea>
747 * @param integer Number of colums in the <textarea>
748 * @param bool Whether or not to use monospacing font
749 * @param string Extra style attributes to apply to the <textarea>
751 function row_textarea($label, $name, $value = '', $colspan = 2, $rows = 7, $cols = 50, $code = false
, $style = '')
753 $this->row_text($label, "<textarea name=\"$name\" class=\"" . (($code) ?
'code' : 'input') . "\" rows=\"$rows\" cols=\"$cols\"" . (($style) ?
' style="' . $style . '"' : '') . ">$value</textarea>", 'top', $colspan);
756 // ###################################################################
758 * Creates a table row with the tfoot class
762 * @param string Extra text or HTML to insert into the row
763 * @param integer Colspan attribute
765 function row_tfoot($data, $colspan = 2)
767 echo $this->row_span($data, 'tfoot', 'center', $colspan);
770 // ###################################################################
772 * Creates a tfoot table row with submit buttons
776 * @param string Extra HTML to imbed in the row after the buttons
777 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
778 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
779 * @param integer Colspan attribute
781 function row_submit($extra = false
, $submit = ':save:', $reset = ':reset:', $colspan = 2)
783 if ($submit === ':save:')
785 $submit = " " . $this->registry
->modules
['localize']->string('Submit') . " ";
789 $submit = " $submit ";
792 if ($reset === ':reset:')
794 $reset = " " . $this->registry
->modules
['localize']->string('Reset') . " ";
798 $reset = (($reset) ?
" $reset " : '');
801 $output = "\n\t\t<input type=\"submit\" class=\"button\" name=\"__submit__\" value=\"$submit\" accesskey=\"s\" />";
802 $output .= ($reset ?
"\n\t\t<input type=\"reset\" class=\"button\" name=\"__reset__\" value=\"$reset\" accesskey=\"r\" />" : '');
803 $output .= ($extra ?
"\n\t\t$extra" : '');
805 $this->row_tfoot($output, $colspan);
808 // ###################################################################
810 * Creates an upload row; you need to specify some other paramaters in
811 * form_start() for this to work
815 * @param string Label text
816 * @param string Upload name
817 * @param integer Colspan attribute
819 function row_upload($label, $name, $colspan = 2)
821 $this->row_text($label, "<input type=\"file\" class=\"button\" name=\"$name\" size=\"35\" />", 'top', $colspan);
824 // ###################################################################
826 * Adds a name-value pair to an array that is constructed into a
831 * @param string Text displayed for the option
832 * @param string Value of the option
833 * @param bool Whether or not to select this particluar option
835 function list_item($name, $value, $selected = false
)
839 $listitem["$value"] = array('name' => $name, 'selected' => $selected);
842 // ###################################################################
844 * Assembles a <select> table row from list_item() items
848 * @param string Label text
849 * @param string Name of the <select>
850 * @param bool Automatically submit the form on a change?
851 * @param integer Colspan attribute
853 function row_list($label, $name, $is_jump = false
, $colspan = 2)
857 foreach ($listitem AS $value => $option)
859 $optionlist .= "\n\t<option value=\"$value\"" . ($option['selected'] == true ?
' selected="selected"' : '') . ">$option[name]</option>";
864 $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);
867 // ###################################################################
869 * Assembles a list of checkboxes from list_item() items
873 * @param string Label text
874 * @param string Name of the <input>s
875 * @param integer Colspan attribute
877 function row_checkbox($label, $name, $colspan = 2)
881 foreach ($listitem AS $value => $box)
883 $optionlist[] = "\n\t<input type=\"checkbox\" class=\"button\" name=\"{$name}[]\" value=\"$value\"" . ($box['selected'] == true ?
' checked="checked"' : '') . " /> $box[name]";
888 $this->row_text($label, "\n" . implode('<br />', $optionlist) . "\n", $colspan);
891 // ###################################################################
893 * Creates a row with two radio buttons: yes and now
897 * @param string Label text
898 * @param string Name of the BOOL flag
899 * @param bool TRUE to select the YES by default; FALSE for NO
900 * @param integer Colspan attribute
902 function row_yesno($label, $name, $value, $colspan = 2)
904 $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);
908 /*=====================================================================*\
909 || ###################################################################
912 || ###################################################################
913 \*=====================================================================*/