PrinterRootPage.php

   1 <?php
   2 /*=====================================================================*
   3 || ###################################################################
   4 || # Blue Static ISSO Framework
   5 || # Copyright (c)2005-2008 Blue Static
   6 || #
   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 2 of the License.
  10 || #
  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
  14 || # more details.
  15 || #
  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 \*=====================================================================*/
  21
  22 /**
  23 * Printer Root Element: Page (PrinterRootPage.php)
  24 *
  25 * @package      ISSO
  26 */
  27
  28 require_once(ISSO . '/PrinterRootAbstract.php');
  29
  30 /**
  31 * Printer Root Element: Page
  32 *
  33 * This root element represents the entire page and is usually used for all
  34 * printer applications
  35 *
  36 * @author               Blue Static
  37 * @copyright    Copyright (c)2005 - 2008, Blue Static
  38 * @package              ISSO
  39 *
  40 */
  41 class BSPrinterRootPage extends BSPrinterRootAbstract
  42 {
  43         /**
  44         * The page title
  45         * @var string
  46         */
  47         private $title;
  48
  49         /**
  50          * Navigation object
  51          * @var BSPrinterNavigation
  52          */
  53         private $navigator;
  54
  55         // ###################################################################
  56         /**
  57         * Constructor
  58         *
  59         * @param        string  Page title
  60         */
  61         function __construct($title)
  62         {
  63                 $this->title = $title;
  64         }
  65
  66         /**
  67          * Makes a new instance of the object in a static fashion
  68          *
  69          * @return      object
  70          */
  71         public static function make()
  72         {
  73                 $obj = new ReflectionClass(__CLASS__);
  74                 $args = func_get_args();
  75                 return $obj->newInstanceArgs($args);
  76         }
  77
  78         /**
  79          * Sets the navigation object
  80          *
  81          * @param       BSPrinterNavigation Navigator
  82          *
  83          * @return      fluent interface
  84          */
  85         public function setNavigator(BSPrinterNavigation $nav)
  86         {
  87                 $this->navigator = $nav;
  88                 return $this;
  89         }
  90
  91         /**
  92          * Returns the printer navigation object
  93          *
  94          * @return      BSPrinterNavigation     Navigation object
  95          */
  96         public function getNavigatior()
  97         {
  98                 return $this->navigatior;
  99         }
 100
 101         // ###################################################################
 102         /**
 103         * Creates a redirect to another page; constructs the header and footer
 104         * (therefore execution stops)
 105         *
 106         * @param        string  Location
 107         * @param        string  Redirect message to be shown
 108         * @param        array   An aray of POST variables to send through on the redirect
 109         */
 110         public static function redirect($location, $message = null, $postvars = array())
 111         {
 112                 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
 113                 {
 114                         define('ISSO_PRINTER_NO_NAVIGATION', 1);
 115                 }
 116
 117                 $page = new BSPrinterRootPage(_('Redirect'));
 118
 119                 $page->addChild(new BSPrinterElementLabel('
 120         <script type="text/javascript">
 121         <!--
 122                 var timeout = 2000;
 123
 124                 if (timeout > 0)
 125                 {
 126                         setTimeout("redirect()", timeout);
 127                 }
 128                 else
 129                 {
 130                         redirect();
 131                 }
 132
 133                 function redirect()
 134                 {
 135                         ' . ($postvars ? 'document.forms.postvars.submit();' : 'window.location = "' . $location  . '";')  . '
 136                 }
 137
 138         //-->
 139         </script>'));
 140
 141                 if ($postvars)
 142                 {
 143                         $vars = new BSPrinterRootForm($location, $postvars['do'], 'postvars');
 144                         unset($postvars['do']);
 145
 146                         foreach ($postvars as $key => $value)
 147                         {
 148                                 $vars->addChild(new BSPrinterElement('hidden', $key, $value));
 149                         }
 150
 151                         $page->addChild($vars);
 152                 }
 153
 154                 $redir = _('Please wait to be redirected. This page will load in a few seconds.');
 155                 if ($message == null)
 156                 {
 157                         $showmessage = $redir;
 158                 }
 159                 else
 160                 {
 161                         $showmessage = '<blockquote>' . $message . '</blockquote>';
 162                         $showmessage .= "\n<p>" . $redir . "</p>";
 163                 }
 164
 165                 $page->addChild(BSPrinterRootPage::message(_('Redirect'), $showmessage));
 166
 167                 $page->paint();
 168                 exit;
 169         }
 170
 171         // ###################################################################
 172         /**
 173         * Prints a complete table message
 174         *
 175         * @param        string  Message title
 176         * @param        string  Message text
 177         *
 178         * @return       BSPrinterRootTable      A table
 179         */
 180         public static function message($title, $message)
 181         {
 182                 $table = new BSPrinterRootTable();
 183
 184                 $head = new BSPrinterElementTable();
 185                 $head->setCssClass('tcat');
 186                 $head->addChild(new BSPrinterElementLabel($title));
 187                 $table->addHeadingChild($head);
 188
 189                 $msg = new BSPrinterElementTable();
 190                 $msg->addChild(new BSPrinterElementLabel((strpos($message, '<blockquote') === false ? "<blockquote>$message</blockquote>" : $message)));
 191                 $table->addChild($msg);
 192
 193                 return $table;
 194         }
 195
 196         // ###################################################################
 197         /**
 198         * Produces an entire page layout that asks the user whether or not
 199         * they want to perform X action and provides a link to the YES and NO
 200         * action
 201         *
 202         * @param        string  Message that asks if they want to do X
 203         * @param        string  Location to go to if the user confirms
 204         * @param        string  Form 'do' value
 205         * @param        array   Hidden parameters to pass to the next page
 206         */
 207         public static function confirm($message, $action, $do, $params)
 208         {
 209                 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
 210                 {
 211                         define('ISSO_PRINTER_NO_NAVIGATION', 1);
 212                 }
 213
 214                 $page = new BSPrinterRootPage(_('Confirm'));
 215
 216                 $form = new BSPrinterRootForm($action, $do);
 217                 foreach ($params as $key => $value)
 218                 {
 219                         $form->addChild(new BSPrinterElement('hidden', $key, $value));
 220                 }
 221                 $page->addChild($form);
 222
 223                 $table = new BSPrinterRootTable();
 224                 $table->setWidth('75%');
 225
 226                 $head = new BSPrinterElementTable();
 227                 $head->addChild(new BSPrinterElementLabel(_('Confirm')));
 228                 $head->setCssClass('tcat');
 229                 $table->addChild($head);
 230
 231                 $table->addChild(new BSPrinterElementTable(new BSPrinterElementLabel("<blockquote>$message</blockquote>")));
 232                 $no = new BSPrinterElement('button', '__no__', _('No'));
 233                 $no->setOnClick('history.back(1); return false;');
 234                 $table->addChild(BSPrinterElementTable::row_submit(array($no), _('Yes'), null));
 235
 236                 $form->addChild($table);
 237
 238                 $page->paint();
 239                 exit;
 240         }
 241
 242         // ###################################################################
 243         /**
 244         * Throws a fatal error message
 245         *
 246         * @param        string  Error string
 247         */
 248         public static function error($message)
 249         {
 250                 if (!defined('ISSO_PRINTER_NO_NAVIGATION'))
 251                 {
 252                         define('ISSO_PRINTER_NO_NAVIGATION', 1);
 253                 }
 254
 255                 $page = new BSPrinterRootPage(_('Error'));
 256                 $page->addChild(BSPrinterRootPage::message(_('Error'), $message));
 257                 $page->paint();
 258
 259                 exit;
 260         }
 261
 262         // ###################################################################
 263         /**
 264         * Returns the HTML for all printed children elements
 265         *
 266         * @return       string  Printed HTML
 267         */
 268         protected function _paintChildren()
 269         {
 270                 $builder = '';
 271
 272                 foreach ($this->children as $child)
 273                 {
 274                         $builder .= "\n" . $child->paint() . "\n";
 275                 }
 276
 277                 return $builder;
 278         }
 279
 280         // ###################################################################
 281         /**
 282         * Tells the element to paint itself (and any children)
 283         */
 284         public function paint()
 285         {
 286                 $language = BSPrinter::get_language_information();
 287
 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 xml:lang=\"" . $language['langcode'] . "\" lang=\"" . $language['langcode'] . "\" dir=\"" . $language['direction'] . "\">\n<head>";
 290                 echo "\n\t<title>" . BSPrinter::get_realm() . " - " . $this->title . "</title>";
 291                 echo "\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=" . $language['charset'] . "\" />";
 292                 echo "\n\t<link rel=\"stylesheet\" href=\"" . BSPrinter::get_stylesheet() . "\" />";
 293                 echo "\n</head>\n<body>\n";
 294
 295                 if ($this->navigator && (!defined('ISSO_PRINTER_NO_NAVIGATION') || !constant('ISSO_PRINTER_NO_NAVIGATION')))
 296                 {
 297                         echo $this->navigator->constructHeaderHtml();
 298                 }
 299
 300                 echo $this->_paintChildren();
 301
 302                 if ($this->navigator && (!defined('ISSO_PRINTER_NO_NAVIGATION') || !constant('ISSO_PRINTER_NO_NAVIGATION')))
 303                 {
 304                         echo $this->navigator->constructFooterHtml();
 305                 }
 306
 307                 $copyright = "\n<br />\n<p align=\"center\" class=\"copyright\">\n\t" . BSPrinter::get_copyright() . "\n</p>";
 308
 309                 if (!defined('ISSO_PRINTER_HIDE_SETUP'))
 310                 {
 311                         echo "\n$copyright";
 312
 313                         echo "\n\n\n";
 314
 315                         if (BSApp::get_debug())
 316                         {
 317                                 if (defined('SVN') && preg_match('#^\$Id:?#', constant('SVN')))
 318                                 {
 319                                         echo preg_replace('#\$' . 'Id: (.+?) ([0-9].+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', "\n<br />\n" . '<div align="center"><strong>\1</strong> &mdash; r\2</div>', constant('SVN'));
 320                                 }
 321
 322                                 if (defined('ISSO_MT_START'))
 323                                 {
 324                                         echo "\n<div align=\"center\">Executed in " . round(BSFunctions::fetch_microtime_diff(ISSO_MT_START), 10) . ' seconds</div>';
 325                                 }
 326
 327                                 echo "\n<br /><div align=\"center\">" . BSApp::get_debug_list() . "</div>\n";
 328
 329                                 if (BSApp::$db)
 330                                 {
 331                                         $queries = BSApp::$db->getHistory();
 332
 333                                         $table = new BSPrinterRootTable();
 334                                         $head = new BSPrinterElementTable();
 335                                         $head->addChild(new BSPrinterElementLabel('Query Debug'));
 336                                         $head->setCssClass('thead');
 337                                         $table->addHeadingChild($head);
 338
 339                                         foreach ($queries as $query)
 340                                         {
 341                                                 $tr = new BSPrinterElementTable();
 342                                                 $tr->addChild(new BSPrinterElementLabel("\n\t\t\t" . $query['query'] . "\n\n\t\t\t<div class=\"smallfont\">(" . $query['time'] . ")</div>\n<!--\n" . $query['trace'] . "\n-->\n\t\t"));
 343                                                 $table->addChild($tr);
 344                                         }
 345
 346                                         $table->setWidth('30%');
 347
 348                                         echo $table->paint();
 349                                 }
 350                         }
 351                 }
 352
 353                 echo "\n\n</body>\n</html>";
 354         }
 355 }
 356
 357 ?>