]>
src.bluestatic.org Git - isso.git/blob - printer.php
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)
82 * @param string Location to redirect to
83 * @param integer Time to wait before the redirect
85 function redirect ( $location , $timeout = 10 )
87 $timeout = $timeout * 200 ;
91 <script type="text/javascript">
93 var timeout = $timeout ;
97 setTimeout("redirect()", $timeout );
106 window.location = " $location" ;
112 $this- > page_start ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Redirect' ), ':default:' , 15 , $js );
114 $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 ));
120 * Throws a fatal error; constructs the header and footer
124 * @param string Error messsage text
126 function error ( $message )
128 $this- > page_start ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Error' ));
129 $this- > page_message ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Error' ), $message );
135 // ###################################################################
137 * Outputs the header of the page: doctype, <html>, <head>, <title>, <body>
138 * and imbeds the style information
142 * @param string Title of the page
143 * @param string Class of the page to be applied to the body
144 * @param integer Margin of the <div> that all content is placed in
145 * @param string Extra HTML to imbed in the <head> tag
146 * @param string <body> onLoad action to imbed
147 * @param integer Margin of the actual <body > tag
148 * @param string Relative path where the CSS data is stored
149 * @param bool Will force re-print the header if it has already been printed
151 function page_start ( $actiontitle , $pageclass = ':default:' , $pagemargin = 15 , $extra = '' , $onload = false , $margin = 0 , $dotpath = '.' , $override = false )
153 if ( $this- > registry
-> debug
AND isset ( $_GET [ 'query' ]))
158 if ( defined ( 'DONE_HEADER' ) AND ! $override )
160 if ( constant ( 'DONE_HEADER' ) AND ! $override )
166 $title = sprintf ( $this- > registry
-> modules
[ 'localize' ]-> string ( '%1 $s - %2 $s - %3 $s' ), $this- >registry->application, $this- >realm, $actiontitle );
168 echo "<!DOCTYPE html PUBLIC \" -//W3C//DTD XHTML 1.0 Transitional//EN \" \" http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd \" > \n ";
169 echo "<html xmlns= \" http://www.w3.org/1999/xhtml \" > \n <head>";
170 echo " \n\t <title> $title </title>";
171 echo " \n\t <meta http-equiv= \" Content-Type \" content= \" text/html; charset=iso-8859-1 \" />";
173 echo ( $extra ? " \n $extra" : ' ');
174 echo " \n </head> \n <body style= \" margin: {$margin} px; \" " . (( $pageclass !== ' : default : ') ? " class= \" $pageclass\" " : ' ') . (( $onload ) ? " onload= \" $onload\" " : ' ') . "> \n ";
176 if (!defined(' HIDE_SETUP
') AND function_exists(' _printer_page_start
'))
178 _printer_page_start();
181 echo "<div style= \" margin: {$pagemargin} px; \" > \n <!-- / page head --> \n\n ";
183 if (!defined(' DONE_HEADER
'))
185 define(' DONE_HEADER
', 1);
190 * Links CSS to the page from a given relative path
194 * @param string Relative path to the CSS file
196 function css_link( $path )
198 $this- >css .= " \n\t <link rel= \" stylesheet \" href= \" $path\" />";
202 * Imbeds actual CSS information into the page in <style> tags
206 * @param string Path of the CSS file to be imbeded
208 function css_imbed( $path )
210 $data = require_once( $path );
211 $css = preg_replace(' #/\*(.*?)\*/(\r|\n)*#s', '', $css);
213 $this- > css
.= " \n\t <style type= \" text/css \" > \n\t <!-- \n " . $css . " \n\t //--> \n\t </style>" ;
217 * Places raw HTML code directly into the documet at the current position
221 * @param string HTML code
223 function page_code ( $code )
225 echo " \n\n $code\n\n " ;
229 * A block function that produces a table with a message in it. This does not print the header and footer
233 * @param string The title of the message (appears at the top of the block)
234 * @param string Content of the message
236 function page_message ( $title , $message )
238 $this- > table_start ( true , '75%' );
239 $this- > table_head ( $title , 1 );
240 $this- > row_span ( "<blockquote> $message </blockquote>" , ':swap:' , 'left' , 1 );
245 * Produces an entire page layout that asks the user whether or not they want to perform X action and provides
246 * a link to the YES and NO action
250 * @param string Message that asks if they want to do X
251 * @param string Location to go for YES
252 * @param string DO action to pass
253 * @param array Hidden parameters to pass to the next page
255 function page_confirm ( $message , $location , $action , $params )
257 $this- > page_start ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Confirm' ));
259 $this- > form_start ( $location , $action );
260 foreach ( $params AS $key => $value )
262 $this- > form_hidden_field ( $key , $value );
265 $this- > table_start ( true , '75%' );
266 $this- > table_head ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Confirm' ), 1 );
267 $this- > row_span ( "<blockquote> $message </blockquote>" , ':swap:' , 'left' , 1 );
268 $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' ), '' );
277 * Closes the HTML document structure an adds the copyright; this also stops execution of the page
283 if ( $this- > registry
-> debug
AND isset ( $_GET [ 'query' ]))
288 if ( is_array ( $this- > registry
-> modules
[ 'db_mysql' ]-> history
))
291 foreach ( $this- > registry
-> modules
[ 'db_mysql' ]-> history
AS $query )
293 echo $query . " \n\n <hr /> \n\n " ;
300 $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>" ;
302 if (! defined ( 'HIDE_SETUP' ))
304 echo " \n <!-- page end --> \n </div> \n $copyright" ;
308 echo " \n
<!-- page end
-->\n</ div
> ";
311 if ( $this- >registry->debug)
314 $scinfo = 'Not Under Source Control';
315 $possiblescms = array('cvs', 'svn', 'cvs_information', 'svn_information', 'scm', 'sc_information', 'scm_information');
316 foreach ( $possiblescms AS $scm )
318 if (defined(strtoupper( $scm )))
320 $scinfo = constant(strtoupper( $scm ));
324 if (strpos( $scinfo , 'RCSfile:') !== false)
328 else if (strpos( $scinfo , ',v ') !== false)
333 else if (strpos( $scinfo , 'URL:') !== false)
337 else if (strpos( $scinfo , 'https://') !== false OR strpos( $scinfo , 'http://') !== false)
341 // not found so just return it
342 // try a SVN ID tag as we can't really tell if we're using it
345 $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 );
346 if ( $test == ' $' . 'Id: $' )
348 $scinfo = 'Not Under Source Control';
359 $scinfo = preg_replace('# \$ ' . 'RCSfile: (.+?) \$ #', ' \\ 1', $scinfo );
360 $scinfo = preg_replace('# \$ ' . 'Revision: (.+?) \$ #', 'CVS \\ 1', $scinfo );
361 $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 );
363 else if ( $type == 'svn')
365 $scinfo = preg_replace('# \$ ' . '(Head)?URL: (.+?) \$ #e', " end ( explode ( '/' , ' \\ 2' )) ", $scinfo );
366 $scinfo = preg_replace('# \$ ' . '(LastModified)?Revision: (.+?) \$ #', 'SVN \\ 2', $scinfo );
367 $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 );
371 $scinfo = 'Not Under Source Control';
376 $scinfo = trim( $scinfo );
377 $debug = " \n\t
< li
>< strong
> Source Control
:</ strong
> $scinfo </ li
> ";
380 if (is_object( $this- >registry->modules['db_mysql']))
382 $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
> ";
385 // total execution time
386 if (defined('ISSO_MT_START'))
388 $this- >registry->load('functions', 'functions');
389 $debug .= " \n\t
< li
>< strong
> Total Execution Time
:</ strong
> " . round( $this- >registry->modules['functions']->fetch_microtime_diff(ISSO_MT_START), 10) . " </ li
> ";
393 $debug .= " \n\t
< li
>\n\t\t< select
>\n\t\t\t< option
> Debug
Notices ( " . sizeof( $this- >registry->debuginfo) . " )</ option
> ";
394 foreach ((array) $this- >registry->debuginfo AS $msg )
396 $debug .= " \n\t\t\t
< option
>--- $msg </ option
> ";
398 $debug .= " \n\t\t
</ select
>\n\t</ li
> ";
401 $modules = $this- >registry->show_modules(true);
402 $debug .= " \n\t
< li
>\n\t\t< select
>\n\t\t\t< option
> Loaded
Modules ( " . sizeof( $modules ) . " )</ option
> ";
403 foreach ( $modules AS $mod )
405 $debug .= " \n\t\t\t
< option
>--- $mod </ option
> ";
407 $debug .= " \n\t\t
</ select
>\n\t</ li
> ";
412 $debug = " \n
< hr
/>\n " . $this- >registry->message('Debug Information', $debug , 1, true, false);
413 echo " \n\n
<!-- dev debug
-->\n< div align
=\" center\"
>\n $debug\n </ div
>\n<!-- / dev debug
-->\n\n ";
416 echo " \n\n
</ body
>\n</ html
> ";
421 // ###################################################################
423 * Opens a <table> tag with styling
427 * @param bool Whether to add a <br /> before the table
428 * @param string Value of the width attribute
430 function table_start( $break = true, $width = '90%')
437 echo " \n
< table cellpadding
=\" 4\" cellspacing
=\" 0\" border
=\" 0\" align
=\" center\" width
=\" $width\" class =\" tborder\"
>\n ";
441 * Adds a table row that is sued to head the entire table
445 * @param string Title string
446 * @param integer Colspan attribute value
447 * @param bool Whether to bold the title
449 function table_head( $title , $colspan = 2, $strong = true)
451 echo " < tr
>\n\t< td
class =\" tcat\" align
=\" center\" colspan
=\" $colspan\" > " . (( $strong ) ? " < strong
> $title </ strong
> " : $title ) . " </ td
>\n</ tr
>\n ";
455 * Creates column headings; useful for a grid-style page. This uses a different styling than table_head()
456 * and is usually used directly after a table header
460 * @param array Array of titles to print
462 function table_column_head( $columnarray )
464 if (is_array( $columnarray ))
466 $render = " < tr valign
=\" top\" align
=\" center\"
>\n ";
468 foreach ( $columnarray AS $header )
470 $render .= " \t
< td
class =\" thead\" align
=\" center\"
> $header </ td
>\n ";
473 $render .= " </ tr
>\n ";
480 * Closes a <table> tag
489 // ###################################################################
491 * Starts a <form> tag and adds the DO hidden input field
495 * @param string Action/name of the file to action to
496 * @param string Value of the DO parameter; used to do-branch
497 * @param bool Enctype attribute; used for mime/multi-part
498 * @param string Name of the form; this only matters for DOM access
499 * @param string Method to action as; POST or GET (default is POST)
501 function form_start( $action , $do , $enctype = false, $name = 'inputform', $submitmethod = 'post')
503 echo " \n
<!-- input form
-->\n< form name
=\" $name\" action
=\" $action\" " . (( $enctype ) ? " enctype
=\" $enctype\" " : '') . " method
=\" $submitmethod\" >\n ";
504 $this- >form_hidden_field('do', $do );
508 * Adds a hidden field at the current location
512 * @param string Name of the field
513 * @param string Value of the field
515 function form_hidden_field( $name , $value )
517 echo " < input type
=\" hidden\" name
=\" $name\" value
=\" $value\" />\n ";
521 * Closes a <form> tag
527 echo " </ form
>\n<!-- / input form
-->\n ";
530 // ###################################################################
532 * Creates a table row that spans an entire row; this is used to divide sections, usually
536 * @param string Text to place in the row
537 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
538 * @param string Alignment of the text in the row
539 * @param integer Colspan attribute
541 function row_span( $text , $class = ':swap:', $align = 'left', $colspan = 2)
543 if ( $class === ':swap:')
545 $this- >registry->modules['functions']->exec_swap_bg();
546 $row_class = $this- >registry->modules['functions']->bgcolour;
547 $is_style_element = false;
551 if (preg_match('#:style:(.*?)#i', $class ))
553 $is_style_element = true;
554 $style = str_replace(':style:', '', $class );
559 $is_style_element = false;
563 echo " \n
< tr
>\n\t< td
". (( $is_style_element ) ? " style
=\" $style\" " : " class =\" $row_class\" ") . " colspan
=\" $colspan\" align
=\" $align\" > $text </ td
>\n</ tr
> ";
567 * Creates a table row that has more than two columns; this is used in conjunction with table_column_head()
568 * usually; it takes an array of values
572 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
574 function row_multi_item( $row_array )
576 $this- >registry->modules['functions']->exec_swap_bg();
578 foreach ( $row_array AS $item => $align )
580 $row_data [" $align" ][] = $item ;
583 echo "<tr valign= \" top \" >" ;
585 foreach ( $row_data AS $align_key => $item_array )
587 if ( $align_key == 'c' )
591 else if ( $align_key == 'l' )
595 else if ( $align_key == 'r' )
600 foreach ( $item_array AS $value )
602 echo " \n\t <td class= \"{ $this->registry->modules['functions']->bgcolour} \" align= \" $align\" > $value </td>" ;
610 * Generic row creation function that has two columns: label and value; this is used for many
611 * other form functions, but can also be used for non-editable fields
615 * @param string Label text
616 * @param string HTML or text to place in the value column
617 * @param string Vertical align (valign attribute) for the row
618 * @param integer Colspan attribute
619 * @param string Class to style the row with; default is to alternate
621 function row_text ( $label , $value = ' ' , $valign = 'top' , $colspan = 2 , $class = - 1 )
629 $this- > registry
-> modules
[ 'functions' ]-> exec_swap_bg ();
630 $row_class = $this- > registry
-> modules
[ 'functions' ]-> bgcolour
;
642 echo "<tr valign= \" $valign\" >" ;
643 echo " \n\t <td class= \" $row_class\" > $label </td>" ;
644 echo " \n\t <td class= \" $row_class\" > $value </td>" ;
648 echo " \n\t <td class= \" $row_class\" colspan= \" " . $colspan - 2 . " \" > </td>" ;
655 * Creates a table row with an <input> text field as the value column
659 * @param string Label text
660 * @param string Name of the <input> field
661 * @param string Value of the field
662 * @param integer Colspan attribute
663 * @param integer Size of the <input> field
664 * @param integer Length attribute; use FALSE for no length to be specified
665 * @param bool Whether to make this a password field
666 * @param string Vertical align (valign attribute)
668 function row_input ( $label , $name , $value = '' , $colspan = 2 , $size = 35 , $length = false , $password = false , $lalign = 'top' )
670 $this- > row_text ( $label , "<input type= \" " . (( $password ) ? 'password' : 'text' ) . " \" class= \" input \" name= \" $name\" value= \" $value\" size= \" $size\" " . (( $length ) ? "maxlength= \" $length\" " : '' ) . "/>" , $lalign , $colspan );
674 * Creates a table row with a <textarea> as the value column
678 * @param string Label text
679 * @param string Name of the <textarea>
680 * @param string Value of the <textarea>
681 * @param integer Colspan attribute
682 * @param integer Number of rows in the <textarea>
683 * @param integer Number of colums in the <textarea>
684 * @param bool Whether or not to use monospacing font
685 * @param string Extra style attributes to apply to the <textarea>
687 function row_textarea ( $label , $name , $value = '' , $colspan = 2 , $rows = 7 , $cols = 50 , $code = false , $style = '' )
689 $this- > row_text ( $label , "<textarea name= \" $name\" class= \" " . (( $code ) ? 'code' : 'input' ) . " \" rows= \" $rows\" cols= \" $cols\" " . (( $style ) ? ' style="' . $style . '"' : '' ) . "> $value </textarea>" , 'top' , $colspan );
693 * Creates a table row with the tfoot class
697 * @param string Extra text or HTML to insert into the row
698 * @param integer Colspan attribute
700 function row_tfoot ( $data , $colspan = 2 )
702 echo $this- > row_span ( $data , 'tfoot' , 'center' , $colspan );
706 * Creates a tfoot table row with submit buttons
710 * @param string Extra HTML to imbed in the row after the buttons
711 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
712 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
713 * @param integer Colspan attribute
715 function row_submit ( $extra = false , $submit = ':save:' , $reset = ':reset:' , $colspan = 2 )
717 if ( $submit === ':save:' )
719 $submit = " " . $this- > registry
-> modules
[ 'localize' ]-> string ( 'Submit' ) . " " ;
723 $submit = " $submit " ;
726 if ( $reset === ':reset:' )
728 $reset = " " . $this- > registry
-> modules
[ 'localize' ]-> string ( 'Reset' ) . " " ;
732 $reset = (( $reset ) ? " $reset " : '' );
735 $output = " \n\t\t <input type= \" submit \" class= \" button \" name= \" __submit__ \" value= \" $submit\" accesskey= \" s \" />" ;
736 $output .= ( $reset ? " \n\t\t <input type= \" reset \" class= \" button \" name= \" __reset__ \" value= \" $reset\" accesskey= \" r \" />" : '' );
737 $output .= ( $extra ? " \n\t\t $extra" : '');
739 $this- >row_tfoot( $output , $colspan );
743 * Creates an upload row; you need to specify some other paramaters in form_start() for this to work
747 * @param string Label text
748 * @param string Upload name
749 * @param integer Colspan attribute
751 function row_upload( $label , $name , $colspan = 2)
753 $this- >row_text( $label , " < input type
=\" file\"
class =\" button\" name
=\" $name\" size
=\" 35\" /> ", 'top', $colspan );
757 * Adds a name-value pair to an array that is constructed into a <select> list
761 * @param string Text displayed for the option
762 * @param string Value of the option
763 * @param bool Whether or not to select this particluar option
765 function list_item( $name , $value , $selected = false)
769 $listitem [] = " \n\t
< option value
=\" $value\" " . (( $selected == true) ? ' selected=" selected
"' : '') . " > $name </ option
> ";
773 * Assembles a <select> table row from list_item() items
777 * @param string Label text
778 * @param string Name of the <select>
779 * @param bool Automatically submit the form on a change?
780 * @param integer Colspan attribute
782 function row_list( $label , $name , $is_jump = false, $colspan = 2)
786 foreach ( $listitem AS $option )
788 $optionlist .= $option ;
793 $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 );
797 * Creates a row with two radio buttons: yes and now
801 * @param string Label text
802 * @param string Name of the BOOL flag
803 * @param bool TRUE to select the YES by default; FALSE for NO
804 * @param integer Colspan attribute
806 function row_yesno( $label , $name , $value , $colspan = 2)
808 $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 );
812 /*=====================================================================*\
813 || ###################################################################
816 || ###################################################################
817 \*=====================================================================*/