]>
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.
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
42 * _printer_page_start() - Define function to echo() data after the page header
45 * @author Iris Studios, Inc.
46 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
54 * Framework registry object
60 * Realm that we are operating in (displayed in the <title>)
63 var $realm = '[UNDEFINED REALM]' ;
66 * CSS to place in the page
71 // ###################################################################
75 function __construct (& $registry )
77 $this- > registry
=& $registry ;
80 // ###################################################################
84 function Printer (& $registry )
86 $this- > __construct ( $registry );
89 // ###################################################################
91 * Creates a redirect to another page; constructs the header and footer
92 * (therefore execution stops)
96 * @param string Location to redirect to
97 * @param integer Time to wait before the redirect
98 * @param array An aray of POST variables to send through on the redirect
100 function redirect ( $location , $timeout = 10 , $postvars = array ())
102 $timeout = $timeout * 200 ;
107 <script type="text/javascript">
109 var timeout = $timeout ;
113 setTimeout("redirect()", $timeout );
122 document.forms.postvars.submit();
132 <script type="text/javascript">
134 var timeout = $timeout ;
138 setTimeout("redirect()", $timeout );
147 window.location = " $location" ;
154 $this- > page_start ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Redirect' ));
158 $this- > form_start ( $location , null , false , 'postvars' );
160 foreach ( $postvars AS $key => $value )
162 $this- > form_hidden_field ( $key , $value );
168 $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 ));
170 $this- > page_code ( $js );
175 // ###################################################################
177 * Throws a fatal error; constructs the header and footer
181 * @param string Error messsage text
183 function error ( $message )
185 $this- > page_start ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Error' ));
186 $this- > page_message ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Error' ), $message );
192 // ###################################################################
194 * Outputs the header of the page: doctype, <html>, <head>, <title>,
195 * <body> and imbeds the style information
199 * @param string Title of the page
200 * @param string Class of the page to be applied to the body
201 * @param integer Margin of the <div> that all content is placed in
202 * @param string Extra HTML to imbed in the <head> tag
203 * @param string <body> onLoad action to imbed
204 * @param integer Margin of the actual <body > tag
205 * @param string Relative path where the CSS data is stored
206 * @param bool Will force re-print the header if it has already been printed
208 function page_start ( $actiontitle , $pageclass = ':default:' , $pagemargin = 15 , $extra = '' , $onload = false , $margin = 0 , $dotpath = '.' , $override = false )
210 if ( $this- > registry
-> debug
AND isset ( $_GET [ 'query' ]))
215 if ( defined ( 'ISSO_PRINTER_DONE_HEADER' ) AND ! $override )
217 if ( constant ( 'ISSO_PRINTER_DONE_HEADER' ) AND ! $override )
223 $title = sprintf ( $this- > registry
-> modules
[ 'localize' ]-> string ( '%1 $s - %2 $s - %3 $s' ), $this- >registry->application, $this- >realm, $actiontitle );
225 echo "<!DOCTYPE html PUBLIC \" -//W3C//DTD XHTML 1.0 Transitional//EN \" \" http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd \" > \n ";
226 echo "<html xmlns= \" http://www.w3.org/1999/xhtml \" > \n <head>";
227 echo " \n\t <title> $title </title>";
228 echo " \n\t <meta http-equiv= \" Content-Type \" content= \" text/html; charset=utf-8 \" />";
230 echo ( $extra ? " \n $extra" : ' ');
231 echo " \n </head> \n <body style= \" margin: {$margin} px; \" " . (( $pageclass !== ' : default : ') ? " class= \" $pageclass\" " : ' ') . (( $onload ) ? " onload= \" $onload\" " : ' ') . "> \n ";
233 if (!defined(' ISSO_PRINTER_HIDE_SETUP
') AND function_exists(' _printer_page_start
'))
235 _printer_page_start();
238 echo "<div style= \" margin: {$pagemargin} px; \" > \n <!-- / page head --> \n\n ";
240 if (!defined(' ISSO_PRINTER_DONE_HEADER
'))
242 define(' ISSO_PRINTER_DONE_HEADER
', 1);
246 // ###################################################################
248 * Links CSS to the page from a given relative path
252 * @param string Relative path to the CSS file
254 function css_link( $path )
256 $this- >css .= " \n\t <link rel= \" stylesheet \" href= \" $path\" />";
259 // ###################################################################
261 * Imbeds actual CSS information into the page in <style> tags
265 * @param string Path of the CSS file to be imbeded
267 function css_imbed( $path )
269 $data = require_once( $path );
270 $css = preg_replace(' #/\*(.*?)\*/(\r|\n)*#s', '', $css);
272 $this- > css
.= " \n\t <style type= \" text/css \" > \n\t <!-- \n " . $css . " \n\t //--> \n\t </style>" ;
275 // ###################################################################
277 * Places raw HTML code directly into the documet at the current
282 * @param string HTML code
284 function page_code ( $code )
286 echo " \n\n $code\n\n " ;
289 // ###################################################################
291 * A block function that produces a table with a message in it. This
292 * does not print the header and footer.
296 * @param string The title of the message (appears at the top of the block)
297 * @param string Content of the message
299 function page_message ( $title , $message )
301 $this- > table_start ( true , '75%' );
302 $this- > table_head ( $title , 1 );
303 $this- > row_span ( "<blockquote> $message </blockquote>" , ':swap:' , 'left' , 1 );
307 // ###################################################################
309 * Produces an entire page layout that asks the user whether or not
310 * they want to perform X action and provides a link to the YES and NO
315 * @param string Message that asks if they want to do X
316 * @param string Location to go for YES
317 * @param string DO action to pass
318 * @param array Hidden parameters to pass to the next page
320 function page_confirm ( $message , $location , $action , $params )
322 $this- > page_start ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Confirm' ));
324 $this- > form_start ( $location , $action );
325 foreach ( $params AS $key => $value )
327 $this- > form_hidden_field ( $key , $value );
330 $this- > table_start ( true , '75%' );
331 $this- > table_head ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Confirm' ), 1 );
332 $this- > row_span ( "<blockquote> $message </blockquote>" , ':swap:' , 'left' , 1 );
333 $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' ), '' );
341 // ###################################################################
343 * Closes the HTML document structure an adds the copyright; this also
344 * stops execution of the page
350 if ( $this- > registry
-> debug
AND isset ( $_GET [ 'query' ]))
355 if ( is_array ( $this- > registry
-> modules
[ ISSO_DB_LAYER
]-> history
))
358 foreach ( $this- > registry
-> modules
[ ISSO_DB_LAYER
]-> history
AS $query )
360 echo $query . " \n\n <hr /> \n\n " ;
367 $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>" ;
369 if (! defined ( 'ISSO_PRINTER_HIDE_SETUP' ))
371 echo " \n <!-- page end --> \n </div> \n $copyright" ;
372 echo $this- >registry->construct_debug_block(false);
376 echo " \n
<!-- page end
-->\n</ div
> ";
379 echo " \n\n
</ body
>\n</ html
> ";
384 // -------------------------------------------------------------------
386 // ###################################################################
388 * Opens a <table> tag with styling
392 * @param bool Whether to add a <br /> before the table
393 * @param string Value of the width attribute
395 function table_start( $break = true, $width = '90%')
402 echo " \n
< table cellpadding
=\" 4\" cellspacing
=\" 0\" border
=\" 0\" align
=\" center\" width
=\" $width\" class =\" tborder\"
>\n ";
405 // ###################################################################
407 * Adds a table row that is sued to head the entire table
411 * @param string Title string
412 * @param integer Colspan attribute value
413 * @param bool Whether to bold the title
415 function table_head( $title , $colspan = 2, $strong = true)
417 echo " < tr
>\n\t< td
class =\" tcat\" align
=\" center\" colspan
=\" $colspan\" > " . (( $strong ) ? " < strong
> $title </ strong
> " : $title ) . " </ td
>\n</ tr
>\n ";
420 // ###################################################################
422 * Creates column headings; useful for a grid-style page. This uses a
423 * different styling than table_head() and is usually used directly
424 * after a table header.
428 * @param array Array of titles to print
430 function table_column_head( $columnarray )
432 if (is_array( $columnarray ))
434 $render = " < tr valign
=\" top\" align
=\" center\"
>\n ";
436 foreach ( $columnarray AS $header )
438 $render .= " \t
< td
class =\" thead\" align
=\" center\"
> $header </ td
>\n ";
441 $render .= " </ tr
>\n ";
447 // ###################################################################
449 * Closes a <table> tag
458 // -------------------------------------------------------------------
460 // ###################################################################
462 * Starts a <form> tag and adds the DO hidden input field
466 * @param string Action/name of the file to action to
467 * @param string Value of the DO parameter; used to do-branch
468 * @param bool Enctype attribute; used for mime/multi-part
469 * @param string Name of the form; this only matters for DOM access
470 * @param string Method to action as; POST or GET (default is POST)
472 function form_start( $action , $do , $enctype = false, $name = 'inputform', $submitmethod = 'post')
474 echo " \n
<!-- input form
-->\n< form name
=\" $name\" action
=\" $action\" " . (( $enctype ) ? " enctype
=\" $enctype\" " : '') . " method
=\" $submitmethod\" >\n ";
478 $this- >form_hidden_field('do', $do );
482 // ###################################################################
484 * Adds a hidden field at the current location
488 * @param string Name of the field
489 * @param string Value of the field
491 function form_hidden_field( $name , $value )
493 echo " < input type
=\" hidden\" name
=\" $name\" value
=\" $value\" />\n ";
496 // ###################################################################
498 * Closes a <form> tag
504 echo " </ form
>\n<!-- / input form
-->\n ";
507 // -------------------------------------------------------------------
509 // ###################################################################
511 * Creates a table row that spans an entire row; this is used to divide
516 * @param string Text to place in the row
517 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
518 * @param string Alignment of the text in the row
519 * @param integer Colspan attribute
521 function row_span( $text , $class = ':swap:', $align = 'left', $colspan = 2)
523 if ( $class === ':swap:')
525 $this- >registry->modules['functions']->exec_swap_bg();
526 $row_class = $this- >registry->modules['functions']->bgcolour;
527 $is_style_element = false;
531 if (preg_match('#:style:(.*?)#i', $class ))
533 $is_style_element = true;
534 $style = str_replace(':style:', '', $class );
539 $is_style_element = false;
543 echo " \n
< tr
>\n\t< td
". (( $is_style_element ) ? " style
=\" $style\" " : " class =\" $row_class\" ") . " colspan
=\" $colspan\" align
=\" $align\" > $text </ td
>\n</ tr
> ";
546 // ###################################################################
548 * Creates a table row that has more than two columns; this is used in
549 * conjunction with table_column_head() usually; it takes an array of
554 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
556 function row_multi_item( $row_array )
558 $this- >registry->modules['functions']->exec_swap_bg();
560 foreach ( $row_array AS $item => $align )
562 $row_data [" $align" ][] = $item ;
565 echo "<tr valign= \" top \" >" ;
567 foreach ( $row_data AS $align_key => $item_array )
569 if ( $align_key == 'c' )
573 else if ( $align_key == 'l' )
577 else if ( $align_key == 'r' )
582 foreach ( $item_array AS $value )
584 echo " \n\t <td class= \"{ $this->registry->modules['functions']->bgcolour} \" align= \" $align\" > $value </td>" ;
591 // ###################################################################
593 * Generic row creation function that has two columns: label and value;
594 * this is used for many other form functions, but can also be used for
595 * non-editable fields
599 * @param string Label text
600 * @param string HTML or text to place in the value column
601 * @param string Vertical align (valign attribute) for the row
602 * @param integer Colspan attribute
603 * @param string Class to style the row with; default is to alternate
605 function row_text ( $label , $value = ' ' , $valign = 'top' , $colspan = 2 , $class = - 1 )
613 $this- > registry
-> modules
[ 'functions' ]-> exec_swap_bg ();
614 $row_class = $this- > registry
-> modules
[ 'functions' ]-> bgcolour
;
626 echo "<tr valign= \" $valign\" >" ;
627 echo " \n\t <td class= \" $row_class\" > $label </td>" ;
628 echo " \n\t <td class= \" $row_class\" > $value </td>" ;
632 echo " \n\t <td class= \" $row_class\" colspan= \" " . $colspan - 2 . " \" > </td>" ;
638 // ###################################################################
640 * Creates a table row with an <input> text field as the value column
644 * @param string Label text
645 * @param string Name of the <input> field
646 * @param string Value of the field
647 * @param integer Colspan attribute
648 * @param integer Size of the <input> field
649 * @param integer Length attribute; use FALSE for no length to be specified
650 * @param bool Whether to make this a password field
651 * @param string Vertical align (valign attribute)
653 function row_input ( $label , $name , $value = '' , $colspan = 2 , $size = 35 , $length = false , $password = false , $lalign = 'top' )
655 $this- > row_text ( $label , "<input type= \" " . (( $password ) ? 'password' : 'text' ) . " \" class= \" input \" name= \" $name\" value= \" $value\" size= \" $size\" " . (( $length ) ? "maxlength= \" $length\" " : '' ) . "/>" , $lalign , $colspan );
658 // ###################################################################
660 * Creates a table row with a <textarea> as the value column
664 * @param string Label text
665 * @param string Name of the <textarea>
666 * @param string Value of the <textarea>
667 * @param integer Colspan attribute
668 * @param integer Number of rows in the <textarea>
669 * @param integer Number of colums in the <textarea>
670 * @param bool Whether or not to use monospacing font
671 * @param string Extra style attributes to apply to the <textarea>
673 function row_textarea ( $label , $name , $value = '' , $colspan = 2 , $rows = 7 , $cols = 50 , $code = false , $style = '' )
675 $this- > row_text ( $label , "<textarea name= \" $name\" class= \" " . (( $code ) ? 'code' : 'input' ) . " \" rows= \" $rows\" cols= \" $cols\" " . (( $style ) ? ' style="' . $style . '"' : '' ) . "> $value </textarea>" , 'top' , $colspan );
678 // ###################################################################
680 * Creates a table row with the tfoot class
684 * @param string Extra text or HTML to insert into the row
685 * @param integer Colspan attribute
687 function row_tfoot ( $data , $colspan = 2 )
689 echo $this- > row_span ( $data , 'tfoot' , 'center' , $colspan );
692 // ###################################################################
694 * Creates a tfoot table row with submit buttons
698 * @param string Extra HTML to imbed in the row after the buttons
699 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
700 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
701 * @param integer Colspan attribute
703 function row_submit ( $extra = false , $submit = ':save:' , $reset = ':reset:' , $colspan = 2 )
705 if ( $submit === ':save:' )
707 $submit = " " . $this- > registry
-> modules
[ 'localize' ]-> string ( 'Submit' ) . " " ;
711 $submit = " $submit " ;
714 if ( $reset === ':reset:' )
716 $reset = " " . $this- > registry
-> modules
[ 'localize' ]-> string ( 'Reset' ) . " " ;
720 $reset = (( $reset ) ? " $reset " : '' );
723 $output = " \n\t\t <input type= \" submit \" class= \" button \" name= \" __submit__ \" value= \" $submit\" accesskey= \" s \" />" ;
724 $output .= ( $reset ? " \n\t\t <input type= \" reset \" class= \" button \" name= \" __reset__ \" value= \" $reset\" accesskey= \" r \" />" : '' );
725 $output .= ( $extra ? " \n\t\t $extra" : '');
727 $this- >row_tfoot( $output , $colspan );
730 // ###################################################################
732 * Creates an upload row; you need to specify some other paramaters in
733 * form_start() for this to work
737 * @param string Label text
738 * @param string Upload name
739 * @param integer Colspan attribute
741 function row_upload( $label , $name , $colspan = 2)
743 $this- >row_text( $label , " < input type
=\" file\"
class =\" button\" name
=\" $name\" size
=\" 35\" /> ", 'top', $colspan );
746 // ###################################################################
748 * Adds a name-value pair to an array that is constructed into a
753 * @param string Text displayed for the option
754 * @param string Value of the option
755 * @param bool Whether or not to select this particluar option
757 function list_item( $name , $value , $selected = false)
761 $listitem [] = " \n\t
< option value
=\" $value\" " . (( $selected == true) ? ' selected=" selected
"' : '') . " > $name </ option
> ";
764 // ###################################################################
766 * Assembles a <select> table row from list_item() items
770 * @param string Label text
771 * @param string Name of the <select>
772 * @param bool Automatically submit the form on a change?
773 * @param integer Colspan attribute
775 function row_list( $label , $name , $is_jump = false, $colspan = 2)
779 foreach ( $listitem AS $option )
781 $optionlist .= $option ;
786 $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 );
789 // ###################################################################
791 * Creates a row with two radio buttons: yes and now
795 * @param string Label text
796 * @param string Name of the BOOL flag
797 * @param bool TRUE to select the YES by default; FALSE for NO
798 * @param integer Colspan attribute
800 function row_yesno( $label , $name , $value , $colspan = 2)
802 $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 );
806 /*=====================================================================*\
807 || ###################################################################
810 || ###################################################################
811 \*=====================================================================*/