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
64 function __construct(&$registry)
66 $this->registry
=& $registry;
72 function Printer(&$registry)
74 $this->__construct($registry);
78 * Creates a redirect to another page; constructs the header and footer (therefore execution stops)
80 * @param string Location to redirect to
81 * @param integer Time to wait before the redirect
83 function redirect($location, $timeout = 10)
85 $timeout = $timeout * 200;
89 <script type
="text/javascript">
91 var timeout
= $timeout;
95 setTimeout("redirect()", $timeout);
104 window
.location
= "$location";
110 $this->page_start($this->registry
->modules
['localize']->string('Redirect'), ':default:', 15, $js);
112 $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));
118 * Throws a fatal error; constructs the header and footer
120 * @param string Error messsage text
122 function error($message)
124 $this->page_start($this->registry
->modules
['localize']->string('Error'));
125 $this->page_message($this->registry
->modules
['localize']->string('Error'), $message);
131 // ###################################################################
133 * Outputs the header of the page: doctype, <html>, <head>, <title>, <body>
134 * and imbeds the style information
136 * @param string Title of the page
137 * @param string Class of the page to be applied to the body
138 * @param integer Margin of the <div> that all content is placed in
139 * @param string Extra HTML to imbed in the <head> tag
140 * @param string <body> onLoad action to imbed
141 * @param integer Margin of the actual <body > tag
142 * @param string Relative path where the CSS data is stored
143 * @param bool Will force re-print the header if it has already been printed
145 function page_start($actiontitle, $pageclass = ':default:', $pagemargin = 15, $extra = '', $onload = false
, $margin = 0, $dotpath = '.', $override = false
)
147 if ($this->registry
->debug
AND isset($_GET['query']))
152 if (defined('DONE_HEADER') AND !$override)
154 if (constant('DONE_HEADER') AND !$override)
160 $title = sprintf($this->registry
->modules
['localize']->string('%1$s - %2$s - %3$s'), $this->registry
->application
, $this->realm
, $actiontitle);
162 echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
163 echo "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n<head>";
164 echo "\n\t<title>$title</title>";
165 echo "\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=iso-8859-1\" />";
167 echo ($extra ?
"\n$extra" : '');
168 echo "\n</head>\n<body style=\"margin: {$margin}px;\"" . (($pageclass !== ':default:') ?
" class=\"$pageclass\"" : '') . (($onload) ?
" onload=\"$onload\"" : '') . ">\n";
170 if (!defined('HIDE_SETUP') AND function_exists('_printer_page_start'))
172 _printer_page_start();
175 echo "<div style=\"margin: {$pagemargin}px;\">\n<!-- / page head -->\n\n";
177 if (!defined('DONE_HEADER'))
179 define('DONE_HEADER', 1);
184 * Links CSS to the page from a given relative path
186 * @param string Relative path to the CSS file
188 function css_link($path)
190 $this->css
.= "\n\t<link rel=\"stylesheet\" href=\"$path\" />";
194 * Imbeds actual CSS information into the page in <style> tags
196 * @param string Path of the CSS file to be imbeded
198 function css_imbed($path)
200 $data = require_once($path);
201 $css = preg_replace('#/\*(.*?)\*/(\r|\n)*#s', '', $css);
203 $this->css
.= "\n\t<style type=\"text/css\">\n\t<!--\n" . $css . "\n\t//-->\n\t</style>";
207 * Places raw HTML code directly into the documet at the current position
209 * @param string HTML code
211 function page_code($code)
213 echo "\n\n$code\n\n";
217 * A block function that produces a table with a message in it. This does not print the header and footer
219 * @param string The title of the message (appears at the top of the block)
220 * @param string Content of the message
222 function page_message($title, $message)
224 $this->table_start(true
, '75%');
225 $this->table_head($title, 1);
226 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
231 * Produces an entire page layout that asks the user whether or not they want to perform X action and provides
232 * a link to the YES and NO action
234 * @param string Message that asks if they want to do X
235 * @param string Location to go for YES
236 * @param string DO action to pass
237 * @param array Hidden parameters to pass to the next page
239 function page_confirm($message, $location, $action, $params)
241 $this->page_start($this->registry
->modules
['localize']->string('Confirm'));
243 $this->form_start($location, $action);
244 foreach ($params AS $key => $value)
246 $this->form_hidden_field($key, $value);
249 $this->table_start(true
, '75%');
250 $this->table_head($this->registry
->modules
['localize']->string('Confirm'), 1);
251 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
252 $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'), '');
261 * Closes the HTML document structure an adds the copyright; this also stops execution of the page
265 if ($this->registry
->debug
AND isset($_GET['query']))
270 if (is_array($this->registry
->modules
['db_mysql']->history
))
273 foreach ($this->registry
->modules
['db_mysql']->history
AS $query)
275 echo $query . "\n\n<hr />\n\n";
282 $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>";
284 if (!defined('HIDE_SETUP'))
286 echo "\n<!-- page end -->\n</div>\n$copyright";
290 echo "\n<!-- page end -->\n</div>";
293 if ($this->registry
->debug
)
296 $scinfo = 'Not Under Source Control';
297 $possiblescms = array('cvs', 'svn', 'cvs_information', 'svn_information', 'scm', 'sc_information', 'scm_information');
298 foreach ($possiblescms AS $scm)
300 if (defined(strtoupper($scm)))
302 $scinfo = constant(strtoupper($scm));
306 if (strpos($scinfo, 'RCSfile:') !== false
)
310 else if (strpos($scinfo, ',v ') !== false
)
315 else if (strpos($scinfo, 'URL:') !== false
)
319 else if (strpos($scinfo, 'https://') !== false
OR strpos($scinfo, 'http://') !== false
)
323 // not found so just return it
324 // try a SVN ID tag as we can't really tell if we're using it
327 $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);
328 if ($test == '$' . 'Id: $')
330 $scinfo = 'Not Under Source Control';
341 $scinfo = preg_replace('#\$' . 'RCSfile: (.+?) \$#', '\\1', $scinfo);
342 $scinfo = preg_replace('#\$' . 'Revision: (.+?) \$#', 'CVS \\1', $scinfo);
343 $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);
345 else if ($type == 'svn')
347 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
348 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
349 $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);
353 $scinfo = 'Not Under Source Control';
358 $scinfo = trim($scinfo);
359 $debug = "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
362 if (is_object($this->registry
->modules
['db_mysql']))
364 $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>";
367 // total execution time
368 if (defined('ISSO_MT_START'))
370 $this->registry
->load('functions', 'functions');
371 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($this->registry
->modules
['functions']->fetch_microtime_diff(ISSO_MT_START
), 10) . "</li>";
375 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($this->registry
->debuginfo
) . ")</option>";
376 foreach ((array)$this->registry
->debuginfo
AS $msg)
378 $debug .= "\n\t\t\t<option>--- $msg</option>";
380 $debug .= "\n\t\t</select>\n\t</li>";
383 $modules = $this->registry
->show_modules(true
);
384 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
385 foreach ($modules AS $mod)
387 $debug .= "\n\t\t\t<option>--- $mod</option>";
389 $debug .= "\n\t\t</select>\n\t</li>";
394 $debug = "\n<hr />\n" . $this->registry
->message('Debug Information', $debug, 1, true
, false
);
395 echo "\n\n<!-- dev debug -->\n<div align=\"center\">\n$debug\n</div>\n<!-- / dev debug -->\n\n";
398 echo "\n\n</body>\n</html>";
403 // ###################################################################
405 * Opens a <table> tag with styling
407 * @param bool Whether to add a <br /> before the table
408 * @param string Value of the width attribute
410 function table_start($break = true
, $width = '90%')
417 echo "\n<table cellpadding=\"4\" cellspacing=\"0\" border=\"0\" align=\"center\" width=\"$width\" class=\"tborder\">\n";
421 * Adds a table row that is sued to head the entire table
423 * @param string Title string
424 * @param integer Colspan attribute value
425 * @param bool Whether to bold the title
427 function table_head($title, $colspan = 2, $strong = true
)
429 echo "<tr>\n\t<td class=\"tcat\" align=\"center\" colspan=\"$colspan\">" . (($strong) ?
"<strong>$title</strong>" : $title) . "</td>\n</tr>\n";
433 * Creates column headings; useful for a grid-style page. This uses a different styling than table_head()
434 * and is usually used directly after a table header
436 * @param array Array of titles to print
438 function table_column_head($columnarray)
440 if (is_array($columnarray))
442 $render = "<tr valign=\"top\" align=\"center\">\n";
444 foreach ($columnarray AS $header)
446 $render .= "\t<td class=\"thead\" align=\"center\">$header</td>\n";
449 $render .= "</tr>\n";
456 * Closes a <table> tag
463 // ###################################################################
465 * Starts a <form> tag and adds the DO hidden input field
467 * @param string Action/name of the file to action to
468 * @param string Value of the DO parameter; used to do-branch
469 * @param bool Enctype attribute; used for mime/multi-part
470 * @param string Name of the form; this only matters for DOM access
471 * @param string Method to action as; POST or GET (default is POST)
473 function form_start($action, $do, $enctype = false
, $name = 'inputform', $submitmethod = 'post')
475 echo "\n<!-- input form -->\n<form name=\"$name\" action=\"$action\"" . (($enctype) ?
" enctype=\"$enctype\"" : '') . " method=\"$submitmethod\">\n";
476 $this->form_hidden_field('do', $do);
480 * Adds a hidden field at the current location
482 * @param string Name of the field
483 * @param string Value of the field
485 function form_hidden_field($name, $value)
487 echo "<input type=\"hidden\" name=\"$name\" value=\"$value\" />\n";
491 * Closes a <form> tag
495 echo "</form>\n<!-- / input form -->\n";
498 // ###################################################################
500 * Creates a table row that spans an entire row; this is used to divide sections, usually
502 * @param string Text to place in the row
503 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
504 * @param string Alignment of the text in the row
505 * @param integer Colspan attribute
507 function row_span($text, $class = ':swap:', $align = 'left', $colspan = 2)
509 if ($class === ':swap:')
511 $this->registry
->modules
['functions']->exec_swap_bg();
512 $row_class = $this->registry
->modules
['functions']->bgcolour
;
513 $is_style_element = false
;
517 if (preg_match('#:style:(.*?)#i', $class))
519 $is_style_element = true
;
520 $style = str_replace(':style:', '', $class);
525 $is_style_element = false
;
529 echo "\n<tr>\n\t<td ". (($is_style_element) ?
"style=\"$style\"" : "class=\"$row_class\"") . " colspan=\"$colspan\" align=\"$align\">$text</td>\n</tr>";
533 * Creates a table row that has more than two columns; this is used in conjunction with table_column_head()
534 * usually; it takes an array of values
536 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
538 function row_multi_item($row_array)
540 $this->registry
->modules
['functions']->exec_swap_bg();
542 foreach ($row_array AS $item => $align)
544 $row_data["$align"][] = $item;
547 echo "<tr valign=\"top\">";
549 foreach ($row_data AS $align_key => $item_array)
551 if ($align_key == 'c')
555 else if ($align_key == 'l')
559 else if ($align_key == 'r')
564 foreach ($item_array AS $value)
566 echo "\n\t<td class=\"{$this->registry->modules['functions']->bgcolour}\" align=\"$align\">$value</td>";
574 * Generic row creation function that has two columns: label and value; this is used for many
575 * other form functions, but can also be used for non-editable fields
577 * @param string Label text
578 * @param string HTML or text to place in the value column
579 * @param string Vertical align (valign attribute) for the row
580 * @param integer Colspan attribute
581 * @param string Class to style the row with; default is to alternate
583 function row_text($label, $value = ' ', $valign = 'top', $colspan = 2, $class = -1)
591 $this->registry
->modules
['functions']->exec_swap_bg();
592 $row_class = $this->registry
->modules
['functions']->bgcolour
;
604 echo "<tr valign=\"$valign\">";
605 echo "\n\t<td class=\"$row_class\">$label</td>";
606 echo "\n\t<td class=\"$row_class\">$value</td>";
610 echo "\n\t<td class=\"$row_class\" colspan=\"" . $colspan - 2 . "\"> </td>";
617 * Creates a table row with an <input> text field as the value column
619 * @param string Label text
620 * @param string Name of the <input> field
621 * @param string Value of the field
622 * @param integer Colspan attribute
623 * @param integer Size of the <input> field
624 * @param integer Length attribute; use FALSE for no length to be specified
625 * @param bool Whether to make this a password field
626 * @param string Vertical align (valign attribute)
628 function row_input($label, $name, $value = '', $colspan = 2, $size = 35, $length = false
, $password = false
, $lalign = 'top')
630 $this->row_text($label, "<input type=\"" . (($password) ?
'password' : 'text') . "\" class=\"input\" name=\"$name\" value=\"$value\" size=\"$size\" " . (($length) ?
"maxlength=\"$length\" " : '') . "/>", $lalign, $colspan);
634 * Creates a table row with a <textarea> as the value column
636 * @param string Label text
637 * @param string Name of the <textarea>
638 * @param string Value of the <textarea>
639 * @param integer Colspan attribute
640 * @param integer Number of rows in the <textarea>
641 * @param integer Number of colums in the <textarea>
642 * @param bool Whether or not to use monospacing font
643 * @param string Extra style attributes to apply to the <textarea>
645 function row_textarea($label, $name, $value = '', $colspan = 2, $rows = 7, $cols = 50, $code = false
, $style = '')
647 $this->row_text($label, "<textarea name=\"$name\" class=\"" . (($code) ?
'code' : 'input') . "\" rows=\"$rows\" cols=\"$cols\"" . (($style) ?
' style="' . $style . '"' : '') . ">$value</textarea>", 'top', $colspan);
651 * Creates a table row with the tfoot class
653 * @param string Extra text or HTML to insert into the row
654 * @param integer Colspan attribute
656 function row_tfoot($data, $colspan = 2)
658 echo $this->row_span($data, 'tfoot', 'center', $colspan);
662 * Creates a tfoot table row with submit buttons
664 * @param string Extra HTML to imbed in the row after the buttons
665 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
666 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
667 * @param integer Colspan attribute
669 function row_submit($extra = false
, $submit = ':save:', $reset = ':reset:', $colspan = 2)
671 if ($submit === ':save:')
673 $submit = " " . $this->registry
->modules
['localize']->string('Submit') . " ";
677 $submit = " $submit ";
680 if ($reset === ':reset:')
682 $reset = " " . $this->registry
->modules
['localize']->string('Reset') . " ";
686 $reset = (($reset) ?
" $reset " : '');
689 $output = "\n\t\t<input type=\"submit\" class=\"button\" value=\"$submit\" accesskey=\"s\" />";
690 $output .= ($reset ?
"\n\t\t<input type=\"reset\" class=\"button\" value=\"$reset\" accesskey=\"r\" />" : '');
691 $output .= ($extra ?
"\n\t\t$extra" : '');
693 $this->row_tfoot($output, $colspan);
697 * Creates an upload row; you need to specify some other paramaters in form_start() for this to work
699 * @param string Label text
700 * @param string Upload name
701 * @param integer Colspan attribute
703 function row_upload($label, $name, $colspan = 2)
705 $this->row_text($label, "<input type=\"file\" class=\"button\" name=\"$name\" size=\"35\" />", 'top', $colspan);
709 * Adds a name-value pair to an array that is constructed into a <select> list
711 * @param string Text displayed for the option
712 * @param string Value of the option
713 * @param bool Whether or not to select this particluar option
715 function list_item($name, $value, $selected = false
)
719 $listitem[] = "\n\t<option value=\"$value\"" . (($selected == true
) ?
' selected="selected"' : '') . ">$name</option>";
723 * Assembles a <select> table row from list_item() items
725 * @param string Label text
726 * @param string Name of the <select>
727 * @param bool Automatically submit the form on a change?
728 * @param integer Colspan attribute
730 function row_list($label, $name, $is_jump = false
, $colspan = 2)
734 foreach ($listitem AS $option)
736 $optionlist .= $option;
741 $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);
745 * Creates a row with two radio buttons: yes and now
747 * @param string Label text
748 * @param string Name of the BOOL flag
749 * @param bool TRUE to select the YES by default; FALSE for NO
750 * @param integer Colspan attribute
752 function row_yesno($label, $name, $value, $colspan = 2)
754 $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);
758 /*=====================================================================*\
759 || ###################################################################
762 || ###################################################################
763 \*=====================================================================*/