PrinterTableElement.php

   1 <?php
   2 /*=====================================================================*
   3 || ###################################################################
   4 || # Blue Static ISSO Framework
   5 || # Copyright ©2002-[#]year[#] 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 [#]gpl[#] 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 Table Element (PrinterTableElement.php)
  24 *
  25 * @package      ISSO
  26 */
  27
  28 require_once('ISSO/PrinterRootElementTable.php');
  29 require_once('ISSO/PrinterBaseElement.php');
  30
  31 /**
  32 * Printer Table Element
  33 *
  34 * This represents a table row that holds elements.
  35 *
  36 * @author               Blue Static
  37 * @copyright    Copyright (c)2002 - [#]year[#], Blue Static
  38 * @version              $Revision$
  39 * @package              ISSO
  40 *
  41 */
  42 class BSPrinterTableElement extends BSPrinterElement
  43 {
  44         /**
  45         * Array of child nodes
  46         * @var array
  47         */
  48         private $children = array();
  49
  50         /**
  51         * Number of columns to span
  52         * @var integer
  53         */
  54         private $colspan = 0;
  55
  56         // ###################################################################
  57         /**
  58         * Creates a table element; takes a variable number of arguments which
  59         * are added as children in the order passed
  60         *
  61         * @param        BSPrinterTableElement...        Variable number (or no) children
  62         */
  63         public function __construct()
  64         {
  65                 $childs = func_get_args();
  66                 if (is_array($childs))
  67                 {
  68                         $this->children = $childs;
  69                 }
  70         }
  71
  72         // ###################################################################
  73         /**
  74         * Prints a simple row of text and text
  75         *
  76         * @param        string  Label (left side)
  77         * @param        string  Value (right side)
  78         *
  79         * @return       BSPrinterTableElement   Table row element
  80         */
  81         public static function RowLabel($label, $value)
  82         {
  83                 $tr = new BSPrinterTableElement();
  84
  85                 $tr->addChild(new BSPrinterLabelElement($label));
  86                 $tr->addChild(new BSPrinterLabelElement($value));
  87
  88                 return $tr;
  89         }
  90
  91         // ###################################################################
  92         /**
  93         * Creates an input[text/password] field row
  94         *
  95         * @param        string  Label
  96         * @param        string  Field name
  97         * @param        mixed   Default value
  98         * @param        bool    A password field?
  99         *
 100         * @return       BPrinterTableElement    Table row element
 101         */
 102         public static function RowText($label, $name, $value = null, $password = false)
 103         {
 104                 $tr = new BSPrinterTableElement();
 105
 106                 $tr->addChild(new BSPrinterLabelElement($label));
 107                 $tr->addChild(new BSPrinterBaseElement(($password ? 'password' : 'text'), $name, $value));
 108
 109                 return $tr;
 110         }
 111
 112         // ###################################################################
 113         /**
 114         * Creates a submit row
 115         *
 116         * @param        array   Child elements to add before the buttons
 117         * @param        string  Save button text
 118         * @param        string  Reset button text
 119         *
 120         * @return       BSPrinterTableElement   Table row element
 121         */
 122         public static function RowSubmit(Array $children = null, $save = ':submit:', $reset = ':reset:')
 123         {
 124                 $build = '';
 125                 if (sizeof($children) > 0)
 126                 {
 127                         foreach ($children AS $child)
 128                         {
 129                                 $build .= "\n\t\t\t" . $child->paint();
 130                         }
 131                 }
 132
 133                 $save = ($save == ':submit:' ? _('Submit') : $save);
 134                 $reset = ($reset == ':reset:' ? _('Reset') : $reset);
 135
 136                 $elm = new BSPrinterBaseElement('submit', '__submit__', "  $save  ");
 137                 $build .= "\n\t\t\t" . $elm->paint();
 138
 139                 $elm = new BSPrinterBaseElement('reset', '__reset__', "  $reset  ");
 140                 $build .= "\n\t\t\t" . $elm->paint() . "\n\t\t";
 141
 142                 $tr = new BSPrinterTableElement();
 143                 $tr->addChild(new BSPrinterLabelElement($build));
 144                 $tr->setCssClass('tfoot');
 145
 146                 return $tr;
 147         }
 148
 149         // ###################################################################
 150         /**
 151         * Constructs a <select> row from an array of BSPrinterBaseElement's
 152         *
 153         * @param        string  Label
 154         * @param        string  Name
 155         * @param        array   Array of BSPrinterBaseElement[option]'s
 156         *
 157         * @return       BSPrinterTableElement   Table row
 158         */
 159         public static function RowList($label, $name, Array $options)
 160         {
 161                 $build = '';
 162                 foreach ($options AS $option)
 163                 {
 164                         if ($option->getType() == 'option')
 165                         {
 166                                 $build .= $option->paint();
 167                         }
 168                         else
 169                         {
 170                                 trigger_error('Only BSPrinterBaseElement\'s of type "option" are allowed in BSPrinterTableElement::RowList()');
 171                         }
 172                 }
 173
 174                 $tr = new BSPrinterTableElement();
 175
 176                 $tr->addChild(new BSPrinterLabelElement($label));
 177                 $tr->addChild(new BSPrinterBaseElement('select', $name, $build));
 178
 179                 return $tr;
 180         }
 181
 182         // ###################################################################
 183         /**
 184         * Constructs a row from an array of BSPrinterBaseElement's of checkboxes
 185         *
 186         * @param        string  Label
 187         * @param        string  Name
 188         * @param        array   Array of BSPrinterBaseElement[checkbox]'s that follow array(box label => BSPrinterBaseElement)
 189         *
 190         * @return       BSPrinterTableElement   Table row
 191         */
 192         public static function RowCheckbox($label, $name, Array $boxes)
 193         {
 194                 $build = '';
 195                 foreach ($boxes AS $boxLabel => $box)
 196                 {
 197                         if ($box->getType() == 'checkbox')
 198                         {
 199                                 if ($box->getName() == null)
 200                                 {
 201                                         $box->setName($name . '[]');
 202                                 }
 203                                 $build .= '<div>' . $box->paint() . ' ' . $boxLabel . '</div>';
 204                         }
 205                         else
 206                         {
 207                                 trigger_error('Only BSPrinterBaseElement\'s of type "checkbox" are allowed in BSPrinterTableElement::RowCheckbox()');
 208                         }
 209                 }
 210
 211                 $tr = new BSPrinterTableElement();
 212
 213                 $tr->addChild(new BSPrinterLabelElement($label));
 214                 $tr->addChild(new BSPrinterLabelElement($build));
 215
 216                 return $tr;
 217         }
 218
 219         // ###################################################################
 220         /**
 221         * Factory method to create an upload form element; requires that the
 222         * form this is attached to have the upload flag set
 223         *
 224         * @param        string  Label for the element
 225         * @param        string  Name of the <input>
 226         *
 227         * @return       BSPrinterTableElement   Upload form
 228         */
 229         public static function RowUpload($label, $name)
 230         {
 231                 $tr = new BSPrinterTableElement();
 232
 233                 $tr->addChild(new BSPrinterLabelElement($label));
 234                 $tr->addChild(new BSPrinterBaseElement('upload', $name));
 235
 236                 return $tr;
 237         }
 238
 239         // ###################################################################
 240         /**
 241         * Creates a row with a radio select option for yes/no
 242         *
 243         * @param        string  Row label
 244         * @param        string  Name of the radio buttons
 245         * @param        bool    Yes is selected? (if false, No is selected)
 246         *
 247         * @return       BSPrinterTableElement   Yes-No row
 248         */
 249         public static function RowYesNo($label, $name, $yes)
 250         {
 251                 $elm = new BSPrinterBaseElement('radio', $name, 1);
 252                 $elm->setActive($yes);
 253
 254                 $build = $elm->paint() . ' ' . _('Yes') . ' ';
 255
 256                 $elm = new BSPrinterBaseElement('radio', $name, 0);
 257                 $elm->setActive(!$yes);
 258
 259                 $build .= $elm->paint() . ' ' . _('No');
 260
 261                 $tr = new BSPrinterTableElement();
 262                 $tr->addChild(new BSPrinterLabelElement($label));
 263                 $tr->addChild(new BSPrinterLabelElement($build));
 264                 return $tr;
 265         }
 266
 267         // ###################################################################
 268         /**
 269         * Returns the number of columns in this element
 270         *
 271         * @return       integer Column count
 272         */
 273         public function numberOfColumns()
 274         {
 275                 return sizeof($this->children);
 276         }
 277
 278         // ###################################################################
 279         /**
 280         * Adds a child node to the element
 281         *
 282         * @param        BSPrinterElement        A child element
 283         */
 284         public function addChild(BSPrinterElement $child)
 285         {
 286                 $this->children[] = $child;
 287         }
 288
 289         // ###################################################################
 290         /**
 291         * Sets the number of columns this row should have and pads the <td>
 292         * elements accordingly
 293         *
 294         * @param        integer Column count
 295         */
 296         public function setColumnNumber($cols)
 297         {
 298                 if ($cols < $this->numberOfColumns())
 299                 {
 300                         trigger_error('You need to have at least ' . $this->numberOfColumns() . ' columns');
 301                 }
 302                 $this->colspan = $cols;
 303         }
 304
 305         // ###################################################################
 306         /**
 307         * Returns the HTML for all printed children elements
 308         *
 309         * @return       string  Printed HTML
 310         */
 311         protected function _paintChildren()
 312         {
 313                 $builder = '';
 314
 315                 $numCols = $this->numberOfColumns();
 316                 $even = true;
 317
 318                 if ($this->colspan % $numCols == 0)
 319                 {
 320                         $cols = $this->colspan / $numCols;
 321                         $even = true;
 322                 }
 323                 else
 324                 {
 325                         $cols = intval($this->colspan / $numCols);
 326                         $even = false;
 327                 }
 328
 329                 $i = 0;
 330                 foreach ($this->children AS $child)
 331                 {
 332                         $i++;
 333                         $colspan = (($i == $numCols AND !$even) ? $cols + 1 : $cols);
 334                         $builder .= "\n\t\t<td" . ($colspan > 1 ? ' colspan="' . $colspan . '"' : '') . ">" . $child->paint() . "</td>";
 335                 }
 336
 337                 return $builder;
 338         }
 339
 340         // ###################################################################
 341         /**
 342         * Paints the entire table row
 343         *
 344         * @return       string  Table row HTML
 345         */
 346         public function paint()
 347         {
 348                 return "\t<tr" . $this->_prepareStyle() . ">" . $this->_paintChildren() . "\n\t</tr>";
 349         }
 350 }
 351
 352 /*=====================================================================*
 353 || ###################################################################
 354 || # $HeadURL$
 355 || # $Id$
 356 || ###################################################################
 357 \*=====================================================================*/
 358 ?>