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
54 private $registry = null;
57 * Realm that we are operating in (displayed in the <title>)
60 private $realm = '[UNDEFINED REALM]';
63 * CSS to place in the page
78 private $page_start_hook = ':=NO METHOD=:';
81 * Language information array: ('langcode' =>, 'direction' =>, 'charset' =>)
84 private $language = array('langcode' => 'en_US', 'direction' => 'ltr', 'charset' => 'utf-8');
87 * Fields array that is used in this module
90 private $fields = array(
91 'realm' => array(REQ_YES
, null, false)
94 // ###################################################################
98 public function __construct(&$registry)
100 $this->registry
=& $registry;
103 // ###################################################################
107 * @param string Field name
108 * @param mixed Value of the field
110 public function set($name, $value)
112 $this->registry
->do_set($name, $value, 'printer');
115 // ###################################################################
117 * Gets the language array information
119 * @return array Language array
121 public function getLanguageInformation()
123 return $this->language
;
126 // ###################################################################
128 * Sets the language array information
130 * @param array Language array
132 public function setLanguageInformation($lang)
134 $this->language
= $lang;
137 // ###################################################################
141 * @param string Field name
143 * @return mixed Value of the field
145 public function get($fieldname)
147 return $this->registry
->do_get($fieldname, 'printer');
150 // ###################################################################
152 * Creates a redirect to another page; constructs the header and footer
153 * (therefore execution stops)
155 * @param string Location to redirect to
156 * @param string Redirect message to be shown
157 * @param array An aray of POST variables to send through on the redirect
159 public function redirect($location, $message = null, $postvars = array())
166 <script type="text/javascript">
168 var timeout = $timeout;
172 setTimeout("redirect()", $timeout);
181 document.forms.postvars.submit();
191 <script type="text/javascript">
193 var timeout = $timeout;
197 setTimeout("redirect()", $timeout);
206 window.location = "$location";
213 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
215 define('ISSO_PRINTER_NO_NAVIGATION', 1);
218 $this->page_start($this->registry
->modules
['localize']->string('Redirect'));
222 $this->form_start($location, null, false, 'postvars');
224 foreach ($postvars AS $key => $value)
226 $this->form_hidden_field($key, $value);
232 $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);
234 if ($message == null)
236 $showmessage = $redir;
240 $showmessage = '<blockquote>' . $message . '</blockquote>';
241 $showmessage .= "\n<p>" . $redir . "</p>";
245 $this->page_message($this->registry
->modules
['localize']->string('Redirect'), $showmessage, $override);
247 $this->page_code($js);
252 // ###################################################################
254 * Throws a fatal error; constructs the header and footer
256 * @param string Error messsage text
258 public function error($message)
260 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
262 define('ISSO_PRINTER_NO_NAVIGATION', 1);
265 $this->page_start($this->registry
->modules
['localize']->string('Error'));
266 $this->page_message($this->registry
->modules
['localize']->string('Error'), $message);
272 // ###################################################################
274 * Outputs the header of the page: doctype, <html>, <head>, <title>,
275 * <body> and imbeds the style information
277 * @param string Title of the page
278 * @param string Class of the page to be applied to the body
279 * @param string Extra HTML to imbed in the <head> tag
280 * @param string <body> onLoad action to imbed
282 public function page_start($actiontitle, $pageclass = null, $extra = '', $onload = false)
284 $this->registry
->check_isso_fields(get_class($this));
286 if ($this->registry
->debug
AND isset($_GET['query']))
291 if (defined('ISSO_PRINTER_DONE_HEADER') AND constant('ISSO_PRINTER_DONE_HEADER'))
296 $title = sprintf($this->registry
->modules
['localize']->string('%1$s - %2$s - %3$s'), $this->registry->application, $this->realm, $actiontitle);
298 echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
299 echo "<html xml:lang=\"" . $this->language['langcode
'] . "\" lang=\"" . $this->language['langcode
'] . "\" dir=\"" . $this->language['direction
'] . "\">\n<head>";
300 echo "\n\t<title>$title</title>";
301 echo "\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=" . $this->language['charset
'] . "\" />";
304 echo ($extra ? "\n$extra" : '');
305 echo "\n</head>\n<body" . ($pageclass != null ? " class=\"$pageclass\"" : '') . ($onload ? " onload=\"$onload\"" : '') . ">\n";
307 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)))
309 echo $this->registry->modules['printer_navigation
']->generate_header_html();
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
322 * @param string Relative path to the CSS file
324 public function css_link($path)
326 $this->css .= "\n\t<link rel=\"stylesheet\" href=\"$path\" />";
329 // ###################################################################
331 * Imbeds actual CSS information into the page in <style> tags
333 * @param string Path of the CSS file to be imbeded
335 public function css_imbed($path)
337 $data = require_once($path);
338 $css = preg_replace('#/\*(.*?)\*/(\r|\n)*#s', '', $css);
340 $this->css
.= "\n\t<style type=\"text/css\">\n\t<!--\n" . $css . "\n\t//-->\n\t</style>";
343 // ###################################################################
345 * Places raw HTML code directly into the documet at the current
348 * @param string HTML code
350 public function page_code($code)
352 if (defined('ISSO_PRINTER_DONE_HEADER'))
354 echo "\n\n$code\n\n";
358 $this->code
.= "\n\n$code\n\n";
362 // ###################################################################
364 * A block function that produces a table with a message in it. This
365 * does not print the header and footer.
367 * @param string The title of the message (appears at the top of the block)
368 * @param string Content of the message
369 * @param bool Override the message: control the entire output (no <blockquote>)?
371 public function page_message($title, $message, $overridemessage = false)
373 $this->table_start(true, '75%');
374 $this->table_head($title, 1);
375 $this->row_span(($overridemessage ? $message : "<blockquote>$message</blockquote>"), ':swap:', 'left', 1);
379 // ###################################################################
381 * Produces an entire page layout that asks the user whether or not
382 * they want to perform X action and provides a link to the YES and NO
385 * @param string Message that asks if they want to do X
386 * @param string Location to go for YES
387 * @param string DO action to pass
388 * @param array Hidden parameters to pass to the next page
390 public function page_confirm($message, $location, $action, $params)
392 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
394 define('ISSO_PRINTER_NO_NAVIGATION', 1);
397 $this->page_start($this->registry
->modules
['localize']->string('Confirm'));
399 $this->form_start($location, $action);
400 foreach ($params AS $key => $value)
402 $this->form_hidden_field($key, $value);
405 $this->table_start(true, '75%');
406 $this->table_head($this->registry
->modules
['localize']->string('Confirm'), 1);
407 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
408 $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'), '');
416 // ###################################################################
418 * Closes the HTML document structure an adds the copyright; this also
419 * stops execution of the page
421 public function page_end()
423 if ($this->registry
->debug
AND isset($_GET['query']))
428 if (is_array($this->registry
->modules
[ISSO_DB_LAYER
]->history
))
430 foreach ($this->registry
->modules
[ISSO_DB_LAYER
]->history
AS $query)
432 echo $this->registry
->modules
[ISSO_DB_LAYER
]->construct_query_debug($query);
438 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)))
440 echo $this->registry
->modules
['printer_navigation']->generate_footer_html();
443 $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>";
445 if (!defined('ISSO_PRINTER_HIDE_SETUP'))
448 echo $this->registry->construct_debug_block(false);
451 echo "\n\n
</body
>\n</html
>";
456 // -------------------------------------------------------------------
458 // ###################################################################
460 * Opens a <table> tag with styling
462 * @param bool Whether to add a <br /> before the table
463 * @param string Value of the width attribute
465 public function table_start($break = true, $width = '90%')
472 echo "\n
<table cellpadding
=\"4\" cellspacing
=\"1\" border
=\"0\" align
=\"center\" width
=\"$width\" class=\"tborder\"
>\n";
475 // ###################################################################
477 * Adds a table row that is sued to head the entire table
479 * @param string Title string
480 * @param integer Colspan attribute value
481 * @param bool Whether to bold the title
483 public function table_head($title, $colspan = 2, $strong = true)
485 echo "<tr
>\n\t<td
class=\"tcat\" align
=\"center\" colspan
=\"$colspan\">" . (($strong) ? "<strong
>$title</strong
>" : $title) . "</td
>\n</tr
>\n";
488 // ###################################################################
490 * Creates column headings; useful for a grid-style page. This uses a
491 * different styling than table_head() and is usually used directly
492 * after a table header.
494 * @param array Array of titles to print
496 public function table_column_head($columnarray)
498 if (is_array($columnarray))
500 $render = "<tr valign
=\"top\" align
=\"center\"
>\n";
502 foreach ($columnarray AS $header)
504 $render .= "\t
<td
class=\"thead\" align
=\"center\"
>$header</td
>\n";
507 $render .= "</tr
>\n";
513 // ###################################################################
515 * Closes a <table> tag
517 public function table_end()
522 // -------------------------------------------------------------------
524 // ###################################################################
526 * Starts a <form> tag and adds the DO hidden input field
528 * @param string Action/name of the file to action to
529 * @param string Value of the DO parameter; used to do-branch
530 * @param bool Enctype attribute; used for mime/multi-part
531 * @param string Name of the form; this only matters for DOM access
532 * @param string Method to action as; POST or GET (default is POST)
534 public function form_start($action, $do, $enctype = false, $name = 'inputform', $submitmethod = 'post')
536 echo "\n
<!-- input form
-->\n<form name
=\"$name\" action
=\"$action\"" . (($enctype) ? " enctype
=\"$enctype\"" : '') . " method
=\"$submitmethod\">\n";
540 $this->form_hidden_field('do', $do);
544 // ###################################################################
546 * Adds a hidden field at the current location
548 * @param string Name of the field
549 * @param string Value of the field
551 public function form_hidden_field($name, $value)
553 echo "<input type
=\"hidden\" name
=\"$name\" value
=\"$value\" />\n";
556 // ###################################################################
558 * Closes a <form> tag
560 public function form_end()
562 echo "</form
>\n<!-- / input form
-->\n";
565 // -------------------------------------------------------------------
567 // ###################################################################
569 * Creates a table row that spans an entire row; this is used to divide
572 * @param string Text to place in the row
573 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
574 * @param string Alignment of the text in the row
575 * @param integer Colspan attribute
577 public function row_span($text, $class = ':swap:', $align = 'left', $colspan = 2)
579 if ($class === ':swap:')
581 $this->registry->modules['functions']->exec_swap_bg();
582 $row_class = $this->registry->modules['functions']->bgcolour;
583 $is_style_element = false;
587 if (preg_match('#:style:(.*?)#i', $class))
589 $is_style_element = true;
590 $style = str_replace(':style:', '', $class);
595 $is_style_element = false;
599 echo "\n
<tr
>\n\t<td
". (($is_style_element) ? "style
=\"$style\"" : "class=\"$row_class\"") . " colspan
=\"$colspan\" align
=\"$align\">$text</td
>\n</tr
>";
602 // ###################################################################
604 * Creates a table row that has more than two columns; this is used in
605 * conjunction with table_column_head() usually; it takes an array of
608 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
610 public function row_multi_item($row_array)
612 $this->registry->modules['functions']->exec_swap_bg();
614 foreach ($row_array AS $item => $align)
616 $row_data["$align"][] = $item;
619 echo "<tr valign=\"top\">";
621 foreach ($row_data AS $align_key => $item_array)
623 if ($align_key == 'c')
627 else if ($align_key == 'l')
631 else if ($align_key == 'r')
636 foreach ($item_array AS $value)
638 echo "\n\t<td class=\"{$this->registry->modules['functions']->bgcolour}\" align=\"$align\">$value</td>";
645 // ###################################################################
647 * Generic row creation function that has two columns: label and value;
648 * this is used for many other form functions, but can also be used for
649 * non-editable fields
651 * @param string Label text
652 * @param string HTML or text to place in the value column
653 * @param string Vertical align (valign attribute) for the row
654 * @param integer Colspan attribute
655 * @param string Class to style the row with; default is to alternate
657 public function row_text($label, $value = ' ', $valign = 'top', $colspan = 2, $class = -1)
665 $this->registry
->modules
['functions']->exec_swap_bg();
666 $row_class = $this->registry
->modules
['functions']->bgcolour
;
678 echo "<tr valign=\"$valign\">";
679 echo "\n\t<td class=\"$row_class\">$label</td>";
680 echo "\n\t<td class=\"$row_class\" colspan=\"" . ($colspan - 1) . "\">$value</td>";
685 // ###################################################################
687 * Creates a table row with an <input> text field as the value column
689 * @param string Label text
690 * @param string Name of the <input> field
691 * @param string Value of the field
692 * @param integer Colspan attribute
693 * @param integer Size of the <input> field
694 * @param integer Length attribute; use FALSE for no length to be specified
695 * @param bool Whether to make this a password field
696 * @param string Vertical align (valign attribute)
698 public function row_input($label, $name, $value = '', $colspan = 2, $size = 35, $length = false, $password = false, $lalign = 'top')
700 $this->row_text($label, "<input type=\"" . (($password) ? 'password' : 'text') . "\" class=\"input\" name=\"$name\" value=\"$value\" size=\"$size\" " . (($length) ? "maxlength=\"$length\" " : '') . "/>", $lalign, $colspan);
703 // ###################################################################
705 * 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 public 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
725 * @param string Extra text or HTML to insert into the row
726 * @param integer Colspan attribute
728 public function row_tfoot($data, $colspan = 2)
730 echo $this->row_span($data, 'tfoot', 'center', $colspan);
733 // ###################################################################
735 * Creates a tfoot table row with submit buttons
737 * @param string Extra HTML to imbed in the row after the buttons
738 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
739 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
740 * @param integer Colspan attribute
742 public function row_submit($extra = false, $submit = ':save:', $reset = ':reset:', $colspan = 2)
744 if ($submit === ':save:')
746 $submit = " " . $this->registry
->modules
['localize']->string('Submit') . " ";
750 $submit = " $submit ";
753 if ($reset === ':reset:')
755 $reset = " " . $this->registry
->modules
['localize']->string('Reset') . " ";
759 $reset = (($reset) ? " $reset " : '');
762 $output = "\n\t\t<input type=\"submit\" class=\"button\" name=\"__submit__\" value=\"$submit\" accesskey=\"s\" />";
763 $output .= ($reset ? "\n\t\t<input type=\"reset\" class=\"button\" name=\"__reset__\" value=\"$reset\" accesskey=\"r\" />" : '');
764 $output .= ($extra ? "\n\t\t$extra" : '');
766 $this->row_tfoot($output, $colspan);
769 // ###################################################################
771 * Creates an upload row; you need to specify some other paramaters in
772 * form_start() for this to work
774 * @param string Label text
775 * @param string Upload name
776 * @param integer Colspan attribute
778 public function row_upload($label, $name, $colspan = 2)
780 $this->row_text($label, "<input type
=\"file\"
class=\"button\" name
=\"$name\" size
=\"35\" />", 'top', $colspan);
783 // ###################################################################
785 * Adds a name-value pair to an array that is constructed into a
788 * @param string Text displayed for the option
789 * @param string Value of the option
790 * @param bool Whether or not to select this particluar option
792 public function list_item($name, $value, $selected = false)
796 $listitem["$value"] = array('name' => $name, 'selected' => $selected);
799 // ###################################################################
801 * Assembles a <select> table row from list_item() items
803 * @param string Label text
804 * @param string Name of the <select>
805 * @param bool Automatically submit the form on a change?
806 * @param integer Colspan attribute
808 public function row_list($label, $name, $is_jump = false, $colspan = 2)
812 foreach ($listitem AS $value => $option)
814 $optionlist .= "\n\t<option value=\"$value\"" . ($option['selected'] == true ? ' selected="selected"' : '') . ">$option[name]</option>";
819 $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);
822 // ###################################################################
824 * Assembles a list of checkboxes from list_item() items
826 * @param string Label text
827 * @param string Name of the <input>s
828 * @param integer Colspan attribute
830 public function row_checkbox($label, $name, $colspan = 2)
834 foreach ($listitem AS $value => $box)
836 $optionlist[] = "\n\t<input type=\"checkbox\" class=\"button\" name=\"{$name}[]\" value=\"$value\"" . ($box['selected'] == true ? ' checked="checked"' : '') . " /> $box[name]";
841 $this->row_text($label, "\n" . implode('<br />', $optionlist) . "\n", $colspan);
844 // ###################################################################
846 * Creates a row with two radio buttons: yes and now
848 * @param string Label text
849 * @param string Name of the BOOL flag
850 * @param bool TRUE to select the YES by default; FALSE for NO
851 * @param integer Colspan attribute
853 public function row_yesno($label, $name, $value, $colspan = 2)
855 $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);
859 /*=====================================================================*\
860 || ###################################################################
863 || ###################################################################
864 \*=====================================================================*/