PrinterRootElementTable.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: Table (PrinterRootElementTable.php)
  24 *
  25 * @package      ISSO
  26 */
  27
  28 require_once(ISSO . '/PrinterRootElement.php');
  29
  30 /**
  31 * Printer Root Element: Table
  32 *
  33 * Represents a <table> object. This can have a parent or not: if it does,
  34 * then it will be painted as a child, otherwise it will act as a root.
  35 *
  36 * @author               Blue Static
  37 * @copyright    Copyright (c)2005 - 2008, Blue Static
  38 * @package              ISSO
  39 *
  40 */
  41 class BSPrinterRootElementTable extends BSPrinterRootElement
  42 {
  43         /**
  44         * Maximum number of columns
  45         * @var integer
  46         */
  47         private $colspan = 0;
  48
  49         /**
  50         * Heading child elements
  51         * @var array
  52         */
  53         private $headers = array();
  54
  55         /**
  56         * Width of the table
  57         * @var string
  58         */
  59         private $width = '90%';
  60
  61         // ###################################################################
  62         /**
  63         * Constructor
  64         */
  65         public function __construct()
  66         {
  67                 $this->setCssClass('tborder');
  68         }
  69
  70         // ###################################################################
  71         /**
  72         * Adds a table row into the child list
  73         *
  74         * @param        BSPrinterTableElement   Table element
  75         */
  76         public function addChild(BSPrinterElement $tr)
  77         {
  78                 if (!$tr instanceof BSPrinterTableElement)
  79                 {
  80                         throw new Exception('BSPrinterRootElementTable::addChild() only accepts BSPrinterTableElement objects as children');
  81                 }
  82                 $this->children[] = $tr;
  83         }
  84
  85         // ###################################################################
  86         /**
  87         * Adds a table element to be a heading of the table. This is still
  88         * considered a child, but it goes before all other child elemends
  89         *
  90         * @param        BSPrinterTableElement   Child element
  91         */
  92         public function addHeadingChild(BSPrinterTableElement $tr)
  93         {
  94                 $this->headers[] = $tr;
  95         }
  96
  97         // ###################################################################
  98         /**
  99         * Sets the width of the table
 100         *
 101         * @param        string  Width value
 102         */
 103         public function setWidth($width)
 104         {
 105                 $this->width = $width;
 106         }
 107
 108         // ###################################################################
 109         /**
 110         * Calculates the number of columns to display based on the colspan
 111         * of children elements
 112         */
 113         private function _calculateColumnCount()
 114         {
 115                 foreach ($this->children AS $child)
 116                 {
 117                         if ($child->numberOfColumns() > $this->colspan)
 118                         {
 119                                 $this->colspan = $child->numberOfColumns();
 120                         }
 121                 }
 122         }
 123
 124         // ###################################################################
 125         /**
 126         * Returns the HTML for all printed children elements
 127         *
 128         * @return       string  Printed HTML
 129         */
 130         protected function _paintChildren()
 131         {
 132                 $builder = '';
 133
 134                 $this->children = array_merge($this->headers, $this->children);
 135                 $this->headers = array();
 136
 137                 $this->_calculateColumnCount();
 138
 139                 foreach ($this->children AS $child)
 140                 {
 141                         $child->setColumnNumber($this->colspan);
 142                         $builder .= "\n" . $child->paint();
 143                 }
 144
 145                 return $builder;
 146         }
 147
 148         // ###################################################################
 149         /**
 150         * Paints the <table>
 151         *
 152         * @return       string  Table HTML code
 153         */
 154         public function paint()
 155         {
 156                 return "<br />\n<table cellpadding=\"4\" cellspacing=\"1\" border=\"0\" align=\"center\" width=\"" . $this->width . "\"" . $this->_prepareStyle() . ">" . $this->_paintChildren() . "\n</table>";
 157         }
 158 }
 159
 160 ?>