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.
35 * @author Iris Studios, Inc.
36 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
44 * Framework registry object
50 * Realm that we are operating in (displayed in the <title>)
53 var $realm = '[UNDEFINED REALM]';
56 * CSS to place in the page
61 // ###################################################################
65 function __construct(&$registry)
67 $this->registry
=& $registry;
70 // ###################################################################
74 function Printer(&$registry)
76 $this->__construct($registry);
79 // ###################################################################
81 * Creates a redirect to another page; constructs the header and footer
82 * (therefore execution stops)
86 * @param string Location to redirect to
87 * @param integer Time to wait before the redirect
89 function redirect($location, $timeout = 10)
91 $timeout = $timeout * 200;
95 <script type
="text/javascript">
97 var timeout
= $timeout;
101 setTimeout("redirect()", $timeout);
110 window
.location
= "$location";
116 $this->page_start($this->registry
->modules
['localize']->string('Redirect'), ':default:', 15, $js);
118 $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));
123 // ###################################################################
125 * Throws a fatal error; constructs the header and footer
129 * @param string Error messsage text
131 function error($message)
133 $this->page_start($this->registry
->modules
['localize']->string('Error'));
134 $this->page_message($this->registry
->modules
['localize']->string('Error'), $message);
140 // ###################################################################
142 * Outputs the header of the page: doctype, <html>, <head>, <title>,
143 * <body> and imbeds the style information
147 * @param string Title of the page
148 * @param string Class of the page to be applied to the body
149 * @param integer Margin of the <div> that all content is placed in
150 * @param string Extra HTML to imbed in the <head> tag
151 * @param string <body> onLoad action to imbed
152 * @param integer Margin of the actual <body > tag
153 * @param string Relative path where the CSS data is stored
154 * @param bool Will force re-print the header if it has already been printed
156 function page_start($actiontitle, $pageclass = ':default:', $pagemargin = 15, $extra = '', $onload = false
, $margin = 0, $dotpath = '.', $override = false
)
158 if ($this->registry
->debug
AND isset($_GET['query']))
163 if (defined('DONE_HEADER') AND !$override)
165 if (constant('DONE_HEADER') AND !$override)
171 $title = sprintf($this->registry
->modules
['localize']->string('%1$s - %2$s - %3$s'), $this->registry
->application
, $this->realm
, $actiontitle);
173 echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
174 echo "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n<head>";
175 echo "\n\t<title>$title</title>";
176 echo "\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=iso-8859-1\" />";
178 echo ($extra ?
"\n$extra" : '');
179 echo "\n</head>\n<body style=\"margin: {$margin}px;\"" . (($pageclass !== ':default:') ?
" class=\"$pageclass\"" : '') . (($onload) ?
" onload=\"$onload\"" : '') . ">\n";
181 if (!defined('HIDE_SETUP') AND function_exists('_printer_page_start'))
183 _printer_page_start();
186 echo "<div style=\"margin: {$pagemargin}px;\">\n<!-- / page head -->\n\n";
188 if (!defined('DONE_HEADER'))
190 define('DONE_HEADER', 1);
194 // ###################################################################
196 * Links CSS to the page from a given relative path
200 * @param string Relative path to the CSS file
202 function css_link($path)
204 $this->css
.= "\n\t<link rel=\"stylesheet\" href=\"$path\" />";
207 // ###################################################################
209 * Imbeds actual CSS information into the page in <style> tags
213 * @param string Path of the CSS file to be imbeded
215 function css_imbed($path)
217 $data = require_once($path);
218 $css = preg_replace('#/\*(.*?)\*/(\r|\n)*#s', '', $css);
220 $this->css
.= "\n\t<style type=\"text/css\">\n\t<!--\n" . $css . "\n\t//-->\n\t</style>";
223 // ###################################################################
225 * Places raw HTML code directly into the documet at the current
230 * @param string HTML code
232 function page_code($code)
234 echo "\n\n$code\n\n";
237 // ###################################################################
239 * A block function that produces a table with a message in it. This
240 * does not print the header and footer.
244 * @param string The title of the message (appears at the top of the block)
245 * @param string Content of the message
247 function page_message($title, $message)
249 $this->table_start(true
, '75%');
250 $this->table_head($title, 1);
251 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
255 // ###################################################################
257 * Produces an entire page layout that asks the user whether or not
258 * they want to perform X action and provides a link to the YES and NO
263 * @param string Message that asks if they want to do X
264 * @param string Location to go for YES
265 * @param string DO action to pass
266 * @param array Hidden parameters to pass to the next page
268 function page_confirm($message, $location, $action, $params)
270 $this->page_start($this->registry
->modules
['localize']->string('Confirm'));
272 $this->form_start($location, $action);
273 foreach ($params AS $key => $value)
275 $this->form_hidden_field($key, $value);
278 $this->table_start(true
, '75%');
279 $this->table_head($this->registry
->modules
['localize']->string('Confirm'), 1);
280 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
281 $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'), '');
289 // ###################################################################
291 * Closes the HTML document structure an adds the copyright; this also
292 * stops execution of the page
298 if ($this->registry
->debug
AND isset($_GET['query']))
303 if (is_array($this->registry
->modules
['db_mysql']->history
))
306 foreach ($this->registry
->modules
['db_mysql']->history
AS $query)
308 echo $query . "\n\n<hr />\n\n";
315 $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>";
317 if (!defined('HIDE_SETUP'))
319 echo "\n<!-- page end -->\n</div>\n$copyright";
323 echo "\n<!-- page end -->\n</div>";
326 if ($this->registry
->debug
)
329 $scinfo = 'Not Under Source Control';
330 $possiblescms = array('cvs', 'svn', 'cvs_information', 'svn_information', 'scm', 'sc_information', 'scm_information');
331 foreach ($possiblescms AS $scm)
333 if (defined(strtoupper($scm)))
335 $scinfo = constant(strtoupper($scm));
339 if (strpos($scinfo, 'RCSfile:') !== false
)
343 else if (strpos($scinfo, ',v ') !== false
)
348 else if (strpos($scinfo, 'URL:') !== false
)
352 else if (strpos($scinfo, 'https://') !== false
OR strpos($scinfo, 'http://') !== false
)
356 // not found so just return it
357 // try a SVN ID tag as we can't really tell if we're using it
360 $test = preg_replace('#\$' . 'Id: (.+?) (.+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', '\\1 - SVN \\2', $scinfo);
361 if ($test == '$' . 'Id: $')
363 $scinfo = 'Not Under Source Control';
374 $scinfo = preg_replace('#\$' . 'RCSfile: (.+?) \$#', '\\1', $scinfo);
375 $scinfo = preg_replace('#\$' . 'Revision: (.+?) \$#', 'CVS \\1', $scinfo);
376 $scinfo = preg_replace('#\$' . 'Id: (.+?) (.+?) [0-9]{4}/[0-9]{2}/[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} (.+?) (.+?) \$#', '\\1 - CVS \\2', $scinfo);
378 else if ($type == 'svn')
380 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
381 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
382 $scinfo = preg_replace('#\$' . 'Id: (.+?) ([0-9].+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', '\\1 - SVN \\2', $scinfo);
386 $scinfo = 'Not Under Source Control';
391 $scinfo = trim($scinfo);
392 $debug = "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
395 if (is_object($this->registry
->modules
['db_mysql']))
397 $debug .= "\n\t<li><strong>Total Queries:</strong> " . sizeof($this->registry
->modules
['db_mysql']->history
) . " (<a href=\"" . $this->registry
->sanitize($_SERVER['REQUEST_URI']) . ((strpos($_SERVER['REQUEST_URI'], '?') !== false
) ?
'&query=1' : '?query=1') . "\">?</a>)</li>";
400 // total execution time
401 if (defined('ISSO_MT_START'))
403 $this->registry
->load('functions', 'functions');
404 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($this->registry
->modules
['functions']->fetch_microtime_diff(ISSO_MT_START
), 10) . "</li>";
408 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($this->registry
->debuginfo
) . ")</option>";
409 foreach ((array)$this->registry
->debuginfo
AS $msg)
411 $debug .= "\n\t\t\t<option>--- $msg</option>";
413 $debug .= "\n\t\t</select>\n\t</li>";
416 $modules = $this->registry
->show_modules(true
);
417 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
418 foreach ($modules AS $mod)
420 $debug .= "\n\t\t\t<option>--- $mod</option>";
422 $debug .= "\n\t\t</select>\n\t</li>";
427 $debug = "\n<hr />\n" . $this->registry
->message('Debug Information', $debug, 1, true
, false
);
428 echo "\n\n<!-- dev debug -->\n<div align=\"center\">\n$debug\n</div>\n<!-- / dev debug -->\n\n";
431 echo "\n\n</body>\n</html>";
436 // -------------------------------------------------------------------
438 // ###################################################################
440 * Opens a <table> tag with styling
444 * @param bool Whether to add a <br /> before the table
445 * @param string Value of the width attribute
447 function table_start($break = true
, $width = '90%')
454 echo "\n<table cellpadding=\"4\" cellspacing=\"0\" border=\"0\" align=\"center\" width=\"$width\" class=\"tborder\">\n";
457 // ###################################################################
459 * Adds a table row that is sued to head the entire table
463 * @param string Title string
464 * @param integer Colspan attribute value
465 * @param bool Whether to bold the title
467 function table_head($title, $colspan = 2, $strong = true
)
469 echo "<tr>\n\t<td class=\"tcat\" align=\"center\" colspan=\"$colspan\">" . (($strong) ?
"<strong>$title</strong>" : $title) . "</td>\n</tr>\n";
472 // ###################################################################
474 * Creates column headings; useful for a grid-style page. This uses a
475 * different styling than table_head() and is usually used directly
476 * after a table header.
480 * @param array Array of titles to print
482 function table_column_head($columnarray)
484 if (is_array($columnarray))
486 $render = "<tr valign=\"top\" align=\"center\">\n";
488 foreach ($columnarray AS $header)
490 $render .= "\t<td class=\"thead\" align=\"center\">$header</td>\n";
493 $render .= "</tr>\n";
499 // ###################################################################
501 * Closes a <table> tag
510 // -------------------------------------------------------------------
512 // ###################################################################
514 * Starts a <form> tag and adds the DO hidden input field
518 * @param string Action/name of the file to action to
519 * @param string Value of the DO parameter; used to do-branch
520 * @param bool Enctype attribute; used for mime/multi-part
521 * @param string Name of the form; this only matters for DOM access
522 * @param string Method to action as; POST or GET (default is POST)
524 function form_start($action, $do, $enctype = false
, $name = 'inputform', $submitmethod = 'post')
526 echo "\n<!-- input form -->\n<form name=\"$name\" action=\"$action\"" . (($enctype) ?
" enctype=\"$enctype\"" : '') . " method=\"$submitmethod\">\n";
527 $this->form_hidden_field('do', $do);
530 // ###################################################################
532 * Adds a hidden field at the current location
536 * @param string Name of the field
537 * @param string Value of the field
539 function form_hidden_field($name, $value)
541 echo "<input type=\"hidden\" name=\"$name\" value=\"$value\" />\n";
544 // ###################################################################
546 * Closes a <form> tag
552 echo "</form>\n<!-- / input form -->\n";
555 // -------------------------------------------------------------------
557 // ###################################################################
559 * Creates a table row that spans an entire row; this is used to divide
564 * @param string Text to place in the row
565 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
566 * @param string Alignment of the text in the row
567 * @param integer Colspan attribute
569 function row_span($text, $class = ':swap:', $align = 'left', $colspan = 2)
571 if ($class === ':swap:')
573 $this->registry
->modules
['functions']->exec_swap_bg();
574 $row_class = $this->registry
->modules
['functions']->bgcolour
;
575 $is_style_element = false
;
579 if (preg_match('#:style:(.*?)#i', $class))
581 $is_style_element = true
;
582 $style = str_replace(':style:', '', $class);
587 $is_style_element = false
;
591 echo "\n<tr>\n\t<td ". (($is_style_element) ?
"style=\"$style\"" : "class=\"$row_class\"") . " colspan=\"$colspan\" align=\"$align\">$text</td>\n</tr>";
594 // ###################################################################
596 * Creates a table row that has more than two columns; this is used in
597 * conjunction with table_column_head() usually; it takes an array of
602 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
604 function row_multi_item($row_array)
606 $this->registry
->modules
['functions']->exec_swap_bg();
608 foreach ($row_array AS $item => $align)
610 $row_data["$align"][] = $item;
613 echo "<tr valign=\"top\">";
615 foreach ($row_data AS $align_key => $item_array)
617 if ($align_key == 'c')
621 else if ($align_key == 'l')
625 else if ($align_key == 'r')
630 foreach ($item_array AS $value)
632 echo "\n\t<td class=\"{$this->registry->modules['functions']->bgcolour}\" align=\"$align\">$value</td>";
639 // ###################################################################
641 * Generic row creation function that has two columns: label and value;
642 * this is used for many other form functions, but can also be used for
643 * non-editable fields
647 * @param string Label text
648 * @param string HTML or text to place in the value column
649 * @param string Vertical align (valign attribute) for the row
650 * @param integer Colspan attribute
651 * @param string Class to style the row with; default is to alternate
653 function row_text($label, $value = ' ', $valign = 'top', $colspan = 2, $class = -1)
661 $this->registry
->modules
['functions']->exec_swap_bg();
662 $row_class = $this->registry
->modules
['functions']->bgcolour
;
674 echo "<tr valign=\"$valign\">";
675 echo "\n\t<td class=\"$row_class\">$label</td>";
676 echo "\n\t<td class=\"$row_class\">$value</td>";
680 echo "\n\t<td class=\"$row_class\" colspan=\"" . $colspan - 2 . "\"> </td>";
686 // ###################################################################
688 * Creates a table row with an <input> text field as the value column
692 * @param string Label text
693 * @param string Name of the <input> field
694 * @param string Value of the field
695 * @param integer Colspan attribute
696 * @param integer Size of the <input> field
697 * @param integer Length attribute; use FALSE for no length to be specified
698 * @param bool Whether to make this a password field
699 * @param string Vertical align (valign attribute)
701 function row_input($label, $name, $value = '', $colspan = 2, $size = 35, $length = false
, $password = false
, $lalign = 'top')
703 $this->row_text($label, "<input type=\"" . (($password) ?
'password' : 'text') . "\" class=\"input\" name=\"$name\" value=\"$value\" size=\"$size\" " . (($length) ?
"maxlength=\"$length\" " : '') . "/>", $lalign, $colspan);
706 // ###################################################################
708 * Creates a table row with a <textarea> as the value column
712 * @param string Label text
713 * @param string Name of the <textarea>
714 * @param string Value of the <textarea>
715 * @param integer Colspan attribute
716 * @param integer Number of rows in the <textarea>
717 * @param integer Number of colums in the <textarea>
718 * @param bool Whether or not to use monospacing font
719 * @param string Extra style attributes to apply to the <textarea>
721 function row_textarea($label, $name, $value = '', $colspan = 2, $rows = 7, $cols = 50, $code = false
, $style = '')
723 $this->row_text($label, "<textarea name=\"$name\" class=\"" . (($code) ?
'code' : 'input') . "\" rows=\"$rows\" cols=\"$cols\"" . (($style) ?
' style="' . $style . '"' : '') . ">$value</textarea>", 'top', $colspan);
726 // ###################################################################
728 * Creates a table row with the tfoot class
732 * @param string Extra text or HTML to insert into the row
733 * @param integer Colspan attribute
735 function row_tfoot($data, $colspan = 2)
737 echo $this->row_span($data, 'tfoot', 'center', $colspan);
740 // ###################################################################
742 * Creates a tfoot table row with submit buttons
746 * @param string Extra HTML to imbed in the row after the buttons
747 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
748 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
749 * @param integer Colspan attribute
751 function row_submit($extra = false
, $submit = ':save:', $reset = ':reset:', $colspan = 2)
753 if ($submit === ':save:')
755 $submit = " " . $this->registry
->modules
['localize']->string('Submit') . " ";
759 $submit = " $submit ";
762 if ($reset === ':reset:')
764 $reset = " " . $this->registry
->modules
['localize']->string('Reset') . " ";
768 $reset = (($reset) ?
" $reset " : '');
771 $output = "\n\t\t<input type=\"submit\" class=\"button\" name=\"__submit__\" value=\"$submit\" accesskey=\"s\" />";
772 $output .= ($reset ?
"\n\t\t<input type=\"reset\" class=\"button\" name=\"__reset__\" value=\"$reset\" accesskey=\"r\" />" : '');
773 $output .= ($extra ?
"\n\t\t$extra" : '');
775 $this->row_tfoot($output, $colspan);
778 // ###################################################################
780 * Creates an upload row; you need to specify some other paramaters in
781 * form_start() for this to work
785 * @param string Label text
786 * @param string Upload name
787 * @param integer Colspan attribute
789 function row_upload($label, $name, $colspan = 2)
791 $this->row_text($label, "<input type=\"file\" class=\"button\" name=\"$name\" size=\"35\" />", 'top', $colspan);
794 // ###################################################################
796 * Adds a name-value pair to an array that is constructed into a
801 * @param string Text displayed for the option
802 * @param string Value of the option
803 * @param bool Whether or not to select this particluar option
805 function list_item($name, $value, $selected = false
)
809 $listitem[] = "\n\t<option value=\"$value\"" . (($selected == true
) ?
' selected="selected"' : '') . ">$name</option>";
812 // ###################################################################
814 * Assembles a <select> table row from list_item() items
818 * @param string Label text
819 * @param string Name of the <select>
820 * @param bool Automatically submit the form on a change?
821 * @param integer Colspan attribute
823 function row_list($label, $name, $is_jump = false
, $colspan = 2)
827 foreach ($listitem AS $option)
829 $optionlist .= $option;
834 $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);
837 // ###################################################################
839 * Creates a row with two radio buttons: yes and now
843 * @param string Label text
844 * @param string Name of the BOOL flag
845 * @param bool TRUE to select the YES by default; FALSE for NO
846 * @param integer Colspan attribute
848 function row_yesno($label, $name, $value, $colspan = 2)
850 $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);
854 /*=====================================================================*\
855 || ###################################################################
858 || ###################################################################
859 \*=====================================================================*/