]>
src.bluestatic.org Git - isso.git/blob - printer.php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]issoversion[#]
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
61 * Realm that we are operating in (displayed in the <title>)
65 var $realm = '[UNDEFINED REALM]' ;
68 * CSS to place in the page
82 * Fields array that is used in this module
87 'realm' => array ( REQ_YES
, null , false )
90 // ###################################################################
94 function __construct (& $registry )
96 $this- > registry
=& $registry ;
99 // ###################################################################
101 * (PHP 4) Constructor
103 function Printer (& $registry )
105 $this- > __construct ( $registry );
108 // ###################################################################
114 * @param string Field name
115 * @param mixed Value of the field
117 function set ( $name , $value )
119 $this- > registry
-> do_set ( $name , $value , 'printer' );
122 // ###################################################################
128 * @param string Field name
130 * @return mixed Value of the field
132 function get ( $fieldname )
134 return $this- > registry
-> do_get ( $fieldname , 'printer' );
137 // ###################################################################
139 * Creates a redirect to another page; constructs the header and footer
140 * (therefore execution stops)
144 * @param string Location to redirect to
145 * @param string Redirect message to be shown
146 * @param array An aray of POST variables to send through on the redirect
148 function redirect ( $location , $message = null , $postvars = array ())
155 <script type="text/javascript">
157 var timeout = $timeout ;
161 setTimeout("redirect()", $timeout );
170 document.forms.postvars.submit();
180 <script type="text/javascript">
182 var timeout = $timeout ;
186 setTimeout("redirect()", $timeout );
195 window.location = " $location" ;
202 $this- > page_start ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Redirect' ));
206 $this- > form_start ( $location , null , false , 'postvars' );
208 foreach ( $postvars AS $key => $value )
210 $this- > form_hidden_field ( $key , $value );
216 $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 );
218 if ( $message == null )
220 $showmessage = $redir ;
224 $showmessage = '<blockquote>' . $message . '</blockquote>' ;
225 $showmessage .= " \n <p>" . $redir . "</p>" ;
229 $this- > page_message ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Redirect' ), $showmessage , $override );
231 $this- > page_code ( $js );
236 // ###################################################################
238 * Throws a fatal error; constructs the header and footer
242 * @param string Error messsage text
244 function error ( $message )
246 $this- > page_start ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Error' ));
247 $this- > page_message ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Error' ), $message );
253 // ###################################################################
255 * Outputs the header of the page: doctype, <html>, <head>, <title>,
256 * <body> and imbeds the style information
260 * @param string Title of the page
261 * @param string Class of the page to be applied to the body
262 * @param integer Margin of the <div> that all content is placed in
263 * @param string Extra HTML to imbed in the <head> tag
264 * @param string <body> onLoad action to imbed
265 * @param integer Margin of the actual <body > tag
266 * @param string Relative path where the CSS data is stored
267 * @param bool Will force re-print the header if it has already been printed
269 function page_start ( $actiontitle , $pageclass = ':default:' , $pagemargin = 15 , $extra = '' , $onload = false , $margin = 0 , $dotpath = '.' , $override = false )
271 $this- > registry
-> check_isso_fields ( get_class ( $this ));
273 if ( $this- > registry
-> debug
AND isset ( $_GET [ 'query' ]))
278 if ( defined ( 'ISSO_PRINTER_DONE_HEADER' ) AND ! $override )
280 if ( constant ( 'ISSO_PRINTER_DONE_HEADER' ) AND ! $override )
286 $title = sprintf ( $this- > registry
-> modules
[ 'localize' ]-> string ( '%1 $s - %2 $s - %3 $s' ), $this- >registry->application, $this- >realm, $actiontitle );
288 echo "<!DOCTYPE html PUBLIC \" -//W3C//DTD XHTML 1.0 Transitional//EN \" \" http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd \" > \n ";
289 echo "<html xmlns= \" http://www.w3.org/1999/xhtml \" > \n <head>";
290 echo " \n\t <title> $title </title>";
291 echo " \n\t <meta http-equiv= \" Content-Type \" content= \" text/html; charset=utf-8 \" />";
294 echo ( $extra ? " \n $extra" : ' ');
295 echo " \n </head> \n <body style= \" margin: {$margin} px; \" " . (( $pageclass !== ' : default : ') ? " class= \" $pageclass\" " : ' ') . (( $onload ) ? " onload= \" $onload\" " : ' ') . "> \n ";
297 if (!defined(' ISSO_PRINTER_HIDE_SETUP
') AND function_exists(' _printer_page_start
'))
299 _printer_page_start();
302 echo "<div style= \" margin: {$pagemargin} px; \" > \n <!-- / page head --> \n\n ";
304 if (!defined(' ISSO_PRINTER_DONE_HEADER
'))
306 define(' ISSO_PRINTER_DONE_HEADER
', 1);
310 // ###################################################################
312 * Links CSS to the page from a given relative path
316 * @param string Relative path to the CSS file
318 function css_link( $path )
320 $this- >css .= " \n\t <link rel= \" stylesheet \" href= \" $path\" />";
323 // ###################################################################
325 * Imbeds actual CSS information into the page in <style> tags
329 * @param string Path of the CSS file to be imbeded
331 function css_imbed( $path )
333 $data = require_once( $path );
334 $css = preg_replace(' #/\*(.*?)\*/(\r|\n)*#s', '', $css);
336 $this- > css
.= " \n\t <style type= \" text/css \" > \n\t <!-- \n " . $css . " \n\t //--> \n\t </style>" ;
339 // ###################################################################
341 * Places raw HTML code directly into the documet at the current
346 * @param string HTML code
348 function page_code ( $code )
350 if ( defined ( 'ISSO_PRINTER_DONE_HEADER' ))
352 echo " \n\n $code\n\n " ;
356 $this- > code
.= " \n\n $code\n\n " ;
360 // ###################################################################
362 * A block function that produces a table with a message in it. This
363 * 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 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
387 * @param string Message that asks if they want to do X
388 * @param string Location to go for YES
389 * @param string DO action to pass
390 * @param array Hidden parameters to pass to the next page
392 function page_confirm ( $message , $location , $action , $params )
394 $this- > page_start ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Confirm' ));
396 $this- > form_start ( $location , $action );
397 foreach ( $params AS $key => $value )
399 $this- > form_hidden_field ( $key , $value );
402 $this- > table_start ( true , '75%' );
403 $this- > table_head ( $this- > registry
-> modules
[ 'localize' ]-> string ( 'Confirm' ), 1 );
404 $this- > row_span ( "<blockquote> $message </blockquote>" , ':swap:' , 'left' , 1 );
405 $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' ), '' );
413 // ###################################################################
415 * Closes the HTML document structure an adds the copyright; this also
416 * stops execution of the page
422 if ( $this- > registry
-> debug
AND isset ( $_GET [ 'query' ]))
427 if ( is_array ( $this- > registry
-> modules
[ ISSO_DB_LAYER
]-> history
))
429 foreach ( $this- > registry
-> modules
[ ISSO_DB_LAYER
]-> history
AS $query )
431 echo $this- > registry
-> modules
[ ISSO_DB_LAYER
]-> construct_query_debug ( $query );
437 $copyright = " \n <br /> \n <p align= \" center \" class= \" copyright \" > \n\t <a href= \" http://www.iris-studios.com \" target= \" _blank \" >" . $this- > registry
-> get ( 'application' ) . ' ' . $this- > registry
-> get ( 'appversion' ) . ", ©2002 - " . date ( 'Y' ) . " Iris Studios, Inc.</a> \n </p>" ;
439 if (! defined ( 'ISSO_PRINTER_HIDE_SETUP' ))
441 echo " \n <!-- page end --> \n </div> \n $copyright" ;
442 echo $this- >registry->construct_debug_block(false);
446 echo " \n
<!-- page end
-->\n</ div
> ";
449 echo " \n\n
</ body
>\n</ html
> ";
454 // -------------------------------------------------------------------
456 // ###################################################################
458 * 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 function table_start( $break = true, $width = '90%')
472 echo " \n
< table cellpadding
=\" 4\" cellspacing
=\" 0\" border
=\" 0\" align
=\" center\" width
=\" $width\" class =\" tborder\"
>\n ";
475 // ###################################################################
477 * Adds a table row that is sued to head the entire table
481 * @param string Title string
482 * @param integer Colspan attribute value
483 * @param bool Whether to bold the title
485 function table_head( $title , $colspan = 2, $strong = true)
487 echo " < tr
>\n\t< td
class =\" tcat\" align
=\" center\" colspan
=\" $colspan\" > " . (( $strong ) ? " < strong
> $title </ strong
> " : $title ) . " </ td
>\n</ tr
>\n ";
490 // ###################################################################
492 * Creates column headings; useful for a grid-style page. This uses a
493 * different styling than table_head() and is usually used directly
494 * after a table header.
498 * @param array Array of titles to print
500 function table_column_head( $columnarray )
502 if (is_array( $columnarray ))
504 $render = " < tr valign
=\" top\" align
=\" center\"
>\n ";
506 foreach ( $columnarray AS $header )
508 $render .= " \t
< td
class =\" thead\" align
=\" center\"
> $header </ td
>\n ";
511 $render .= " </ tr
>\n ";
517 // ###################################################################
519 * Closes a <table> tag
528 // -------------------------------------------------------------------
530 // ###################################################################
532 * Starts a <form> tag and adds the DO hidden input field
536 * @param string Action/name of the file to action to
537 * @param string Value of the DO parameter; used to do-branch
538 * @param bool Enctype attribute; used for mime/multi-part
539 * @param string Name of the form; this only matters for DOM access
540 * @param string Method to action as; POST or GET (default is POST)
542 function form_start( $action , $do , $enctype = false, $name = 'inputform', $submitmethod = 'post')
544 echo " \n
<!-- input form
-->\n< form name
=\" $name\" action
=\" $action\" " . (( $enctype ) ? " enctype
=\" $enctype\" " : '') . " method
=\" $submitmethod\" >\n ";
548 $this- >form_hidden_field('do', $do );
552 // ###################################################################
554 * Adds a hidden field at the current location
558 * @param string Name of the field
559 * @param string Value of the field
561 function form_hidden_field( $name , $value )
563 echo " < input type
=\" hidden\" name
=\" $name\" value
=\" $value\" />\n ";
566 // ###################################################################
568 * Closes a <form> tag
574 echo " </ form
>\n<!-- / input form
-->\n ";
577 // -------------------------------------------------------------------
579 // ###################################################################
581 * Creates a table row that spans an entire row; this is used to divide
586 * @param string Text to place in the row
587 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
588 * @param string Alignment of the text in the row
589 * @param integer Colspan attribute
591 function row_span( $text , $class = ':swap:', $align = 'left', $colspan = 2)
593 if ( $class === ':swap:')
595 $this- >registry->modules['functions']->exec_swap_bg();
596 $row_class = $this- >registry->modules['functions']->bgcolour;
597 $is_style_element = false;
601 if (preg_match('#:style:(.*?)#i', $class ))
603 $is_style_element = true;
604 $style = str_replace(':style:', '', $class );
609 $is_style_element = false;
613 echo " \n
< tr
>\n\t< td
". (( $is_style_element ) ? " style
=\" $style\" " : " class =\" $row_class\" ") . " colspan
=\" $colspan\" align
=\" $align\" > $text </ td
>\n</ tr
> ";
616 // ###################################################################
618 * Creates a table row that has more than two columns; this is used in
619 * conjunction with table_column_head() usually; it takes an array of
624 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
626 function row_multi_item( $row_array )
628 $this- >registry->modules['functions']->exec_swap_bg();
630 foreach ( $row_array AS $item => $align )
632 $row_data [" $align" ][] = $item ;
635 echo "<tr valign= \" top \" >" ;
637 foreach ( $row_data AS $align_key => $item_array )
639 if ( $align_key == 'c' )
643 else if ( $align_key == 'l' )
647 else if ( $align_key == 'r' )
652 foreach ( $item_array AS $value )
654 echo " \n\t <td class= \"{ $this->registry->modules['functions']->bgcolour} \" align= \" $align\" > $value </td>" ;
661 // ###################################################################
663 * Generic row creation function that has two columns: label and value;
664 * this is used for many other form functions, but can also be used for
665 * non-editable fields
669 * @param string Label text
670 * @param string HTML or text to place in the value column
671 * @param string Vertical align (valign attribute) for the row
672 * @param integer Colspan attribute
673 * @param string Class to style the row with; default is to alternate
675 function row_text ( $label , $value = ' ' , $valign = 'top' , $colspan = 2 , $class = - 1 )
683 $this- > registry
-> modules
[ 'functions' ]-> exec_swap_bg ();
684 $row_class = $this- > registry
-> modules
[ 'functions' ]-> bgcolour
;
696 echo "<tr valign= \" $valign\" >" ;
697 echo " \n\t <td class= \" $row_class\" > $label </td>" ;
698 echo " \n\t <td class= \" $row_class\" > $value </td>" ;
702 echo " \n\t <td class= \" $row_class\" colspan= \" " . $colspan - 2 . " \" > </td>" ;
708 // ###################################################################
710 * Creates a table row with an <input> text field as the value column
714 * @param string Label text
715 * @param string Name of the <input> field
716 * @param string Value of the field
717 * @param integer Colspan attribute
718 * @param integer Size of the <input> field
719 * @param integer Length attribute; use FALSE for no length to be specified
720 * @param bool Whether to make this a password field
721 * @param string Vertical align (valign attribute)
723 function row_input ( $label , $name , $value = '' , $colspan = 2 , $size = 35 , $length = false , $password = false , $lalign = 'top' )
725 $this- > row_text ( $label , "<input type= \" " . (( $password ) ? 'password' : 'text' ) . " \" class= \" input \" name= \" $name\" value= \" $value\" size= \" $size\" " . (( $length ) ? "maxlength= \" $length\" " : '' ) . "/>" , $lalign , $colspan );
728 // ###################################################################
730 * Creates a table row with a <textarea> as the value column
734 * @param string Label text
735 * @param string Name of the <textarea>
736 * @param string Value of the <textarea>
737 * @param integer Colspan attribute
738 * @param integer Number of rows in the <textarea>
739 * @param integer Number of colums in the <textarea>
740 * @param bool Whether or not to use monospacing font
741 * @param string Extra style attributes to apply to the <textarea>
743 function row_textarea ( $label , $name , $value = '' , $colspan = 2 , $rows = 7 , $cols = 50 , $code = false , $style = '' )
745 $this- > row_text ( $label , "<textarea name= \" $name\" class= \" " . (( $code ) ? 'code' : 'input' ) . " \" rows= \" $rows\" cols= \" $cols\" " . (( $style ) ? ' style="' . $style . '"' : '' ) . "> $value </textarea>" , 'top' , $colspan );
748 // ###################################################################
750 * Creates a table row with the tfoot class
754 * @param string Extra text or HTML to insert into the row
755 * @param integer Colspan attribute
757 function row_tfoot ( $data , $colspan = 2 )
759 echo $this- > row_span ( $data , 'tfoot' , 'center' , $colspan );
762 // ###################################################################
764 * Creates a tfoot table row with submit buttons
768 * @param string Extra HTML to imbed in the row after the buttons
769 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
770 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
771 * @param integer Colspan attribute
773 function row_submit ( $extra = false , $submit = ':save:' , $reset = ':reset:' , $colspan = 2 )
775 if ( $submit === ':save:' )
777 $submit = " " . $this- > registry
-> modules
[ 'localize' ]-> string ( 'Submit' ) . " " ;
781 $submit = " $submit " ;
784 if ( $reset === ':reset:' )
786 $reset = " " . $this- > registry
-> modules
[ 'localize' ]-> string ( 'Reset' ) . " " ;
790 $reset = (( $reset ) ? " $reset " : '' );
793 $output = " \n\t\t <input type= \" submit \" class= \" button \" name= \" __submit__ \" value= \" $submit\" accesskey= \" s \" />" ;
794 $output .= ( $reset ? " \n\t\t <input type= \" reset \" class= \" button \" name= \" __reset__ \" value= \" $reset\" accesskey= \" r \" />" : '' );
795 $output .= ( $extra ? " \n\t\t $extra" : '');
797 $this- >row_tfoot( $output , $colspan );
800 // ###################################################################
802 * Creates an upload row; you need to specify some other paramaters in
803 * form_start() for this to work
807 * @param string Label text
808 * @param string Upload name
809 * @param integer Colspan attribute
811 function row_upload( $label , $name , $colspan = 2)
813 $this- >row_text( $label , " < input type
=\" file\"
class =\" button\" name
=\" $name\" size
=\" 35\" /> ", 'top', $colspan );
816 // ###################################################################
818 * Adds a name-value pair to an array that is constructed into a
823 * @param string Text displayed for the option
824 * @param string Value of the option
825 * @param bool Whether or not to select this particluar option
827 function list_item( $name , $value , $selected = false)
831 $listitem [" $value" ] = array ( 'name' => $name , 'selected' => $selected );
834 // ###################################################################
836 * Assembles a <select> table row from list_item() items
840 * @param string Label text
841 * @param string Name of the <select>
842 * @param bool Automatically submit the form on a change?
843 * @param integer Colspan attribute
845 function row_list ( $label , $name , $is_jump = false , $colspan = 2 )
849 foreach ( $listitem AS $value => $option )
851 $optionlist .= " \n\t <option value= \" $value\" " . ( $option [ 'selected' ] == true ? ' selected="selected"' : '' ) . "> $option [name]</option>" ;
856 $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 );
859 // ###################################################################
861 * Assembles a list of checkboxes from list_item() items
865 * @param string Label text
866 * @param string Name of the <input>s
867 * @param integer Colspan attribute
869 function row_checkbox ( $label , $name , $colspan = 2 )
873 foreach ( $listitem AS $value => $box )
875 $optionlist [] = " \n\t <input type= \" checkbox \" class= \" button \" name= \"{ $name}[] \" value= \" $value\" " . ( $box [ 'selected' ] == true ? ' checked="checked"' : '' ) . " /> $box [name]" ;
880 $this- > row_text ( $label , " \n " . implode ( '<br />' , $optionlist ) . " \n " , $colspan );
883 // ###################################################################
885 * Creates a row with two radio buttons: yes and now
889 * @param string Label text
890 * @param string Name of the BOOL flag
891 * @param bool TRUE to select the YES by default; FALSE for NO
892 * @param integer Colspan attribute
894 function row_yesno ( $label , $name , $value , $colspan = 2 )
896 $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 );
900 /*=====================================================================*\
901 || ###################################################################
904 || ###################################################################
905 \*=====================================================================*/