interface/modules/zend_modules/library/Zend/Text/Table/Row.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Text\Table;
  11
  12 use Zend\Text\Table\Decorator\DecoratorInterface as Decorator;
  13
  14 /**
  15  * Row class for Zend\Text\Table
  16  */
  17 class Row
  18 {
  19     /**
  20      * List of all columns
  21      *
  22      * @var array
  23      */
  24     protected $columns = array();
  25
  26     /**
  27      * Temporary stored column widths
  28      *
  29      * @var array
  30      */
  31     protected $columnWidths = null;
  32
  33     /**
  34      * Create a new column and append it to the row
  35      *
  36      * @param  string $content
  37      * @param  array  $options
  38      * @return Row
  39      */
  40     public function createColumn($content, array $options = null)
  41     {
  42         $align    = null;
  43         $colSpan  = null;
  44         $encoding = null;
  45
  46         if ($options !== null) {
  47             extract($options, EXTR_IF_EXISTS);
  48         }
  49
  50         $column = new Column($content, $align, $colSpan, $encoding);
  51
  52         $this->appendColumn($column);
  53
  54         return $this;
  55     }
  56
  57     /**
  58      * Append a column to the row
  59      *
  60      * @param  \Zend\Text\Table\Column $column The column to append to the row
  61      * @return Row
  62      */
  63     public function appendColumn(Column $column)
  64     {
  65         $this->columns[] = $column;
  66
  67         return $this;
  68     }
  69
  70     /**
  71      * Get a column by it's index
  72      *
  73      * Returns null, when the index is out of range
  74      *
  75      * @param  int $index
  76      * @return Column|null
  77      */
  78     public function getColumn($index)
  79     {
  80         if (!isset($this->columns[$index])) {
  81             return null;
  82         }
  83
  84         return $this->columns[$index];
  85     }
  86
  87     /**
  88      * Get all columns of the row
  89      *
  90      * @return array
  91      */
  92     public function getColumns()
  93     {
  94         return $this->columns;
  95     }
  96
  97     /**
  98      * Get the widths of all columns, which were rendered last
  99      *
 100      * @throws Exception\UnexpectedValueException When no columns were rendered yet
 101      * @return int
 102      */
 103     public function getColumnWidths()
 104     {
 105         if ($this->columnWidths === null) {
 106             throw new Exception\UnexpectedValueException('render() must be called before columnWidths can be populated');
 107         }
 108
 109         return $this->columnWidths;
 110     }
 111
 112     /**
 113      * Render the row
 114      *
 115      * @param  array                               $columnWidths Width of all columns
 116      * @param  Decorator $decorator    Decorator for the row borders
 117      * @param  int                             $padding      Padding for the columns
 118      * @throws Exception\OverflowException When there are too many columns
 119      * @return string
 120      */
 121     public function render(array $columnWidths, Decorator $decorator, $padding = 0)
 122     {
 123         // Prepare an array to store all column widths
 124         $this->columnWidths = array();
 125
 126         // If there is no single column, create a column which spans over the
 127         // entire row
 128         if (count($this->columns) === 0) {
 129             $this->appendColumn(new Column(null, null, count($columnWidths)));
 130         }
 131
 132         // First we have to render all columns, to get the maximum height
 133         $renderedColumns = array();
 134         $maxHeight       = 0;
 135         $colNum          = 0;
 136         foreach ($this->columns as $column) {
 137             // Get the colspan of the column
 138             $colSpan = $column->getColSpan();
 139
 140             // Verify if there are enough column widths defined
 141             if (($colNum + $colSpan) > count($columnWidths)) {
 142                 throw new Exception\OverflowException('Too many columns');
 143             }
 144
 145             // Calculate the column width
 146             $columnWidth = ($colSpan - 1 + array_sum(array_slice($columnWidths,
 147                                                                  $colNum,
 148                                                                  $colSpan)));
 149
 150             // Render the column and split it's lines into an array
 151             $result = explode("\n", $column->render($columnWidth, $padding));
 152
 153             // Store the width of the rendered column
 154             $this->columnWidths[] = $columnWidth;
 155
 156             // Store the rendered column and calculate the new max height
 157             $renderedColumns[] = $result;
 158             $maxHeight         = max($maxHeight, count($result));
 159
 160             // Set up the internal column number
 161             $colNum += $colSpan;
 162         }
 163
 164         // If the row doesnt contain enough columns to fill the entire row, fill
 165         // it with an empty column
 166         if ($colNum < count($columnWidths)) {
 167             $remainingWidth = (count($columnWidths) - $colNum - 1) +
 168                                array_sum(array_slice($columnWidths,
 169                                                      $colNum));
 170             $renderedColumns[] = array(str_repeat(' ', $remainingWidth));
 171
 172             $this->columnWidths[] = $remainingWidth;
 173         }
 174
 175         // Add each single column line to the result
 176         $result = '';
 177         for ($line = 0; $line < $maxHeight; $line++) {
 178             $result .= $decorator->getVertical();
 179
 180             foreach ($renderedColumns as $index => $renderedColumn) {
 181                 if (isset($renderedColumn[$line]) === true) {
 182                     $result .= $renderedColumn[$line];
 183                 } else {
 184                     $result .= str_repeat(' ', $this->columnWidths[$index]);
 185                 }
 186
 187                 $result .= $decorator->getVertical();
 188             }
 189
 190             $result .= "\n";
 191         }
 192
 193         return $result;
 194     }
 195 }