2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework [#]issoversion[#]
5 || # Copyright ©2002-[#]year[#] Blue Static
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
40 * ISSO_PRINTER_NO_NAVIGATION - Do not show the navigation frame from ISSO.Printer.Navigation
43 * @copyright Copyright ©2002 - [#]year[#], Blue Static
51 * Framework registry object
58 * Realm that we are operating in (displayed in the <title>)
62 var $realm = '[UNDEFINED REALM]';
65 * CSS to place in the page
83 var $page_start_hook = ':=NO METHOD=:';
86 * Language information array: ('langcode' =>, 'direction' =>, 'charset' =>)
90 var $language = array('langcode' => 'en_US', 'direction' => 'ltr', 'charset' => 'utf-8');
92 // ###################################################################
96 function __construct(&$registry)
98 $this->registry
=& $registry;
101 // ###################################################################
103 * (PHP 4) Constructor
105 function Printer(&$registry)
107 $this->__construct($registry);
110 // ###################################################################
116 * @param string Realm
118 function setRealm($realm)
120 $this->realm
= $realm;
123 // ###################################################################
129 * @return string Realm
136 // ###################################################################
138 * Gets the language array information
142 * @return array Language array
144 function getLanguageInformation()
146 return $this->language
;
149 // ###################################################################
151 * Sets the language array information
155 * @param array Language array
157 function setLanguageInformation($lang)
159 $this->language
= $lang;
162 // ###################################################################
164 * Creates a redirect to another page; constructs the header and footer
165 * (therefore execution stops)
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
173 function redirect($location, $message = null
, $postvars = array())
180 <script type
="text/javascript">
182 var timeout
= $timeout;
186 setTimeout("redirect()", $timeout);
195 document
.forms
.postvars
.submit();
205 <script type
="text/javascript">
207 var timeout
= $timeout;
211 setTimeout("redirect()", $timeout);
220 window
.location
= "$location";
227 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
229 define('ISSO_PRINTER_NO_NAVIGATION', 1);
232 $this->page_start(_('Redirect'));
236 $this->form_start($location, null
, false
, 'postvars');
238 foreach ($postvars AS $key => $value)
240 $this->form_hidden_field($key, $value);
246 $redir = sprintf(_('Please wait to be redirected. If you are not redirected in a few seconds, click <a href="%1$s">here</a>.'), $location);
248 if ($message == null
)
250 $showmessage = $redir;
254 $showmessage = '<blockquote>' . $message . '</blockquote>';
255 $showmessage .= "\n<p>" . $redir . "</p>";
259 $this->page_message(_('Redirect'), $showmessage, $override);
261 $this->page_code($js);
266 // ###################################################################
268 * Throws a fatal error; constructs the header and footer
272 * @param string Error messsage text
274 function error($message)
276 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
278 define('ISSO_PRINTER_NO_NAVIGATION', 1);
281 $this->page_start(_('Error'));
282 $this->page_message(_('Error'), $message);
288 // ###################################################################
290 * Outputs the header of the page: doctype, <html>, <head>, <title>,
291 * <body> and imbeds the style information
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
300 function page_start($actiontitle, $pageclass = null
, $extra = '', $onload = false
)
302 $this->registry
->check_isso_fields(get_class($this));
304 if ($this->registry
->debug
AND isset($_GET['query']))
309 if (defined('ISSO_PRINTER_DONE_HEADER') AND constant('ISSO_PRINTER_DONE_HEADER'))
314 $title = sprintf(_('%1$s - %2$s - %3$s'), $this->registry
->application
, $this->realm
, $actiontitle);
316 echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
317 echo "<html xml:lang=\"" . $this->language
['langcode'] . "\" lang=\"" . $this->language
['langcode'] . "\" dir=\"" . $this->language
['direction'] . "\">\n<head>";
318 echo "\n\t<title>$title</title>";
319 echo "\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=" . $this->language
['charset'] . "\" />";
322 echo ($extra ?
"\n$extra" : '');
323 echo "\n</head>\n<body" . ($pageclass != null ?
" class=\"$pageclass\"" : '') . ($onload ?
" onload=\"$onload\"" : '') . ">\n";
325 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
)))
327 echo $this->registry
->modules
['printer_navigation']->generate_header_html();
330 if (!defined('ISSO_PRINTER_DONE_HEADER'))
332 define('ISSO_PRINTER_DONE_HEADER', 1);
336 // ###################################################################
338 * Links CSS to the page from a given relative path
342 * @param string Relative path to the CSS file
344 function css_link($path)
346 $this->css
.= "\n\t<link rel=\"stylesheet\" href=\"$path\" />";
349 // ###################################################################
351 * Imbeds actual CSS information into the page in <style> tags
355 * @param string Path of the CSS file to be imbeded
357 function css_imbed($path)
359 $data = require_once($path);
360 $css = preg_replace('#/\*(.*?)\*/(\r|\n)*#s', '', $css);
362 $this->css
.= "\n\t<style type=\"text/css\">\n\t<!--\n" . $css . "\n\t//-->\n\t</style>";
365 // ###################################################################
367 * Places raw HTML code directly into the documet at the current
372 * @param string HTML code
374 function page_code($code)
376 if (defined('ISSO_PRINTER_DONE_HEADER'))
378 echo "\n\n$code\n\n";
382 $this->code
.= "\n\n$code\n\n";
386 // ###################################################################
388 * A block function that produces a table with a message in it. This
389 * does not print the header and footer.
393 * @param string The title of the message (appears at the top of the block)
394 * @param string Content of the message
395 * @param bool Override the message: control the entire output (no <blockquote>)?
397 function page_message($title, $message, $overridemessage = false
)
399 $this->table_start(true
, '75%');
400 $this->table_head($title, 1);
401 $this->row_span(($overridemessage ?
$message : "<blockquote>$message</blockquote>"), ':swap:', 'left', 1);
405 // ###################################################################
407 * Produces an entire page layout that asks the user whether or not
408 * they want to perform X action and provides a link to the YES and NO
413 * @param string Message that asks if they want to do X
414 * @param string Location to go for YES
415 * @param string DO action to pass
416 * @param array Hidden parameters to pass to the next page
418 function page_confirm($message, $location, $action, $params)
420 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
422 define('ISSO_PRINTER_NO_NAVIGATION', 1);
425 $this->page_start(_('Confirm'));
427 $this->form_start($location, $action);
428 foreach ($params AS $key => $value)
430 $this->form_hidden_field($key, $value);
433 $this->table_start(true
, '75%');
434 $this->table_head(_('Confirm'), 1);
435 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
436 $this->row_submit('<input type="button" class="button" name="no" value=" ' . _('No') . ' " onclick="history.back(1); return false;" />', _('Yes'), '');
444 // ###################################################################
446 * Closes the HTML document structure an adds the copyright; this also
447 * stops execution of the page
453 if ($this->registry
->debug
AND isset($_GET['query']))
458 if (is_array($this->registry
->modules
[ISSO_DB_LAYER
]->history
))
460 foreach ($this->registry
->modules
[ISSO_DB_LAYER
]->history
AS $query)
462 echo $this->registry
->modules
[ISSO_DB_LAYER
]->construct_query_debug($query);
468 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
)))
470 echo $this->registry
->modules
['printer_navigation']->generate_footer_html();
473 $copyright = "\n<br />\n<p align=\"center\" class=\"copyright\">\n\t<a href=\"http://www.bluestatic.org\" target=\"_blank\">" . $this->registry
->get('application') . ' ' . $this->registry
->get('appversion') . ", ©2002 - " . date('Y') . " Blue Static</a>\n</p>";
475 if (!defined('ISSO_PRINTER_HIDE_SETUP'))
478 echo $this->registry
->construct_debug_block(false
);
481 echo "\n\n</body>\n</html>";
486 // -------------------------------------------------------------------
488 // ###################################################################
490 * Opens a <table> tag with styling
494 * @param bool Whether to add a <br /> before the table
495 * @param string Value of the width attribute
497 function table_start($break = true
, $width = '90%')
504 echo "\n<table cellpadding=\"4\" cellspacing=\"1\" border=\"0\" align=\"center\" width=\"$width\" class=\"tborder\">\n";
507 // ###################################################################
509 * Adds a table row that is sued to head the entire table
513 * @param string Title string
514 * @param integer Colspan attribute value
515 * @param bool Whether to bold the title
517 function table_head($title, $colspan = 2, $strong = true
)
519 echo "<tr>\n\t<td class=\"tcat\" align=\"center\" colspan=\"$colspan\">" . (($strong) ?
"<strong>$title</strong>" : $title) . "</td>\n</tr>\n";
522 // ###################################################################
524 * Creates column headings; useful for a grid-style page. This uses a
525 * different styling than table_head() and is usually used directly
526 * after a table header.
530 * @param array Array of titles to print
532 function table_column_head($columnarray)
534 if (is_array($columnarray))
536 $render = "<tr valign=\"top\" align=\"center\">\n";
538 foreach ($columnarray AS $header)
540 $render .= "\t<td class=\"thead\" align=\"center\">$header</td>\n";
543 $render .= "</tr>\n";
549 // ###################################################################
551 * Closes a <table> tag
560 // -------------------------------------------------------------------
562 // ###################################################################
564 * Starts a <form> tag and adds the DO hidden input field
568 * @param string Action/name of the file to action to
569 * @param string Value of the DO parameter; used to do-branch
570 * @param bool Enctype attribute; used for mime/multi-part
571 * @param string Name of the form; this only matters for DOM access
572 * @param string Method to action as; POST or GET (default is POST)
574 function form_start($action, $do, $enctype = false
, $name = 'inputform', $submitmethod = 'post')
576 echo "\n<!-- input form -->\n<form name=\"$name\" action=\"$action\"" . (($enctype) ?
" enctype=\"$enctype\"" : '') . " method=\"$submitmethod\">\n";
580 $this->form_hidden_field('do', $do);
584 // ###################################################################
586 * Adds a hidden field at the current location
590 * @param string Name of the field
591 * @param string Value of the field
593 function form_hidden_field($name, $value)
595 echo "<input type=\"hidden\" name=\"$name\" value=\"$value\" />\n";
598 // ###################################################################
600 * Closes a <form> tag
606 echo "</form>\n<!-- / input form -->\n";
609 // -------------------------------------------------------------------
611 // ###################################################################
613 * Creates a table row that spans an entire row; this is used to divide
618 * @param string Text to place in the row
619 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
620 * @param string Alignment of the text in the row
621 * @param integer Colspan attribute
623 function row_span($text, $class = ':swap:', $align = 'left', $colspan = 2)
625 if ($class === ':swap:')
627 $this->registry
->modules
['functions']->exec_swap_bg();
628 $row_class = $this->registry
->modules
['functions']->bgcolour
;
629 $is_style_element = false
;
633 if (preg_match('#:style:(.*?)#i', $class))
635 $is_style_element = true
;
636 $style = str_replace(':style:', '', $class);
641 $is_style_element = false
;
645 echo "\n<tr>\n\t<td ". (($is_style_element) ?
"style=\"$style\"" : "class=\"$row_class\"") . " colspan=\"$colspan\" align=\"$align\">$text</td>\n</tr>";
648 // ###################################################################
650 * Creates a table row that has more than two columns; this is used in
651 * conjunction with table_column_head() usually; it takes an array of
656 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
658 function row_multi_item($row_array)
660 $this->registry
->modules
['functions']->exec_swap_bg();
662 foreach ($row_array AS $item => $align)
664 $row_data["$align"][] = $item;
667 echo "<tr valign=\"top\">";
669 foreach ($row_data AS $align_key => $item_array)
671 if ($align_key == 'c')
675 else if ($align_key == 'l')
679 else if ($align_key == 'r')
684 foreach ($item_array AS $value)
686 echo "\n\t<td class=\"{$this->registry->modules['functions']->bgcolour}\" align=\"$align\">$value</td>";
693 // ###################################################################
695 * Generic row creation function that has two columns: label and value;
696 * this is used for many other form functions, but can also be used for
697 * non-editable fields
701 * @param string Label text
702 * @param string HTML or text to place in the value column
703 * @param string Vertical align (valign attribute) for the row
704 * @param integer Colspan attribute
705 * @param string Class to style the row with; default is to alternate
707 function row_text($label, $value = ' ', $valign = 'top', $colspan = 2, $class = -1)
715 $this->registry
->modules
['functions']->exec_swap_bg();
716 $row_class = $this->registry
->modules
['functions']->bgcolour
;
728 echo "<tr valign=\"$valign\">";
729 echo "\n\t<td class=\"$row_class\">$label</td>";
730 echo "\n\t<td class=\"$row_class\" colspan=\"" . ($colspan - 1) . "\">$value</td>";
735 // ###################################################################
737 * Creates a table row with an <input> text field as the value column
741 * @param string Label text
742 * @param string Name of the <input> field
743 * @param string Value of the field
744 * @param integer Colspan attribute
745 * @param integer Size of the <input> field
746 * @param integer Length attribute; use FALSE for no length to be specified
747 * @param bool Whether to make this a password field
748 * @param string Vertical align (valign attribute)
750 function row_input($label, $name, $value = '', $colspan = 2, $size = 35, $length = false
, $password = false
, $lalign = 'top')
752 $this->row_text($label, "<input type=\"" . (($password) ?
'password' : 'text') . "\" class=\"input\" name=\"$name\" value=\"$value\" size=\"$size\" " . (($length) ?
"maxlength=\"$length\" " : '') . "/>", $lalign, $colspan);
755 // ###################################################################
757 * Creates a table row with a <textarea> as the value column
761 * @param string Label text
762 * @param string Name of the <textarea>
763 * @param string Value of the <textarea>
764 * @param integer Colspan attribute
765 * @param integer Number of rows in the <textarea>
766 * @param integer Number of colums in the <textarea>
767 * @param bool Whether or not to use monospacing font
768 * @param string Extra style attributes to apply to the <textarea>
770 function row_textarea($label, $name, $value = '', $colspan = 2, $rows = 7, $cols = 50, $code = false
, $style = '')
772 $this->row_text($label, "<textarea name=\"$name\" class=\"" . (($code) ?
'code' : 'input') . "\" rows=\"$rows\" cols=\"$cols\"" . (($style) ?
' style="' . $style . '"' : '') . ">$value</textarea>", 'top', $colspan);
775 // ###################################################################
777 * Creates a table row with the tfoot class
781 * @param string Extra text or HTML to insert into the row
782 * @param integer Colspan attribute
784 function row_tfoot($data, $colspan = 2)
786 echo $this->row_span($data, 'tfoot', 'center', $colspan);
789 // ###################################################################
791 * Creates a tfoot table row with submit buttons
795 * @param string Extra HTML to imbed in the row after the buttons
796 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
797 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
798 * @param integer Colspan attribute
800 function row_submit($extra = false
, $submit = ':save:', $reset = ':reset:', $colspan = 2)
802 if ($submit === ':save:')
804 $submit = " " . _('Submit') . " ";
808 $submit = " $submit ";
811 if ($reset === ':reset:')
813 $reset = " " . _('Reset') . " ";
817 $reset = (($reset) ?
" $reset " : '');
820 $output = "\n\t\t<input type=\"submit\" class=\"button\" name=\"__submit__\" value=\"$submit\" accesskey=\"s\" />";
821 $output .= ($reset ?
"\n\t\t<input type=\"reset\" class=\"button\" name=\"__reset__\" value=\"$reset\" accesskey=\"r\" />" : '');
822 $output .= ($extra ?
"\n\t\t$extra" : '');
824 $this->row_tfoot($output, $colspan);
827 // ###################################################################
829 * Creates an upload row; you need to specify some other paramaters in
830 * form_start() for this to work
834 * @param string Label text
835 * @param string Upload name
836 * @param integer Colspan attribute
838 function row_upload($label, $name, $colspan = 2)
840 $this->row_text($label, "<input type=\"file\" class=\"button\" name=\"$name\" size=\"35\" />", 'top', $colspan);
843 // ###################################################################
845 * Adds a name-value pair to an array that is constructed into a
850 * @param string Text displayed for the option
851 * @param string Value of the option
852 * @param bool Whether or not to select this particluar option
854 function list_item($name, $value, $selected = false
)
858 $listitem["$value"] = array('name' => $name, 'selected' => $selected);
861 // ###################################################################
863 * Assembles a <select> table row from list_item() items
867 * @param string Label text
868 * @param string Name of the <select>
869 * @param bool Automatically submit the form on a change?
870 * @param integer Colspan attribute
872 function row_list($label, $name, $is_jump = false
, $colspan = 2)
876 foreach ($listitem AS $value => $option)
878 $optionlist .= "\n\t<option value=\"$value\"" . ($option['selected'] == true ?
' selected="selected"' : '') . ">$option[name]</option>";
883 $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=\" " . _('Go') . " \" accesskey=\"g\" />" : '') . "\n", $colspan);
886 // ###################################################################
888 * Assembles a list of checkboxes from list_item() items
892 * @param string Label text
893 * @param string Name of the <input>s
894 * @param integer Colspan attribute
896 function row_checkbox($label, $name, $colspan = 2)
900 foreach ($listitem AS $value => $box)
902 $optionlist[] = "\n\t<input type=\"checkbox\" class=\"button\" name=\"{$name}[]\" value=\"$value\"" . ($box['selected'] == true ?
' checked="checked"' : '') . " /> $box[name]";
907 $this->row_text($label, "\n" . implode('<br />', $optionlist) . "\n", $colspan);
910 // ###################################################################
912 * Creates a row with two radio buttons: yes and now
916 * @param string Label text
917 * @param string Name of the BOOL flag
918 * @param bool TRUE to select the YES by default; FALSE for NO
919 * @param integer Colspan attribute
921 function row_yesno($label, $name, $value, $colspan = 2)
923 $this->row_text($label, "<input type=\"radio\" name=\"$name\" value=\"1\"" . (($value) ?
' checked="checked"' : '') . " /> " . _('Yes') . " <input type=\"radio\" name=\"$name\" value=\"0\"" . ((!$value) ?
' checked="checked"' : '') . " /> " . _('No'), $colspan);
927 /*=====================================================================*\
928 || ###################################################################
931 || ###################################################################
932 \*=====================================================================*/