vendor/zendframework/zend-text/src/Table/Column.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-text for the canonical source repository
   4  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-text/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Text\Table;
   9
  10 use Zend\Stdlib\StringUtils;
  11
  12 /**
  13  * Column class for Zend\Text\Table\Row
  14  */
  15 class Column
  16 {
  17     /**
  18      * Aligns for columns
  19      */
  20     const ALIGN_LEFT   = 'left';
  21     const ALIGN_CENTER = 'center';
  22     const ALIGN_RIGHT  = 'right';
  23
  24     /**
  25      * Content of the column
  26      *
  27      * @var string
  28      */
  29     protected $content = '';
  30
  31     /**
  32      * Align of the column
  33      *
  34      * @var string
  35      */
  36     protected $align = self::ALIGN_LEFT;
  37
  38     /**
  39      * Colspan of the column
  40      *
  41      * @var int
  42      */
  43     protected $colSpan = 1;
  44
  45     /**
  46      * Allowed align parameters
  47      *
  48      * @var array
  49      */
  50     protected $allowedAligns = [self::ALIGN_LEFT, self::ALIGN_CENTER, self::ALIGN_RIGHT];
  51
  52     /**
  53      * Create a column for a Zend\Text\Table\Row object.
  54      *
  55      * @param string  $content  The content of the column
  56      * @param string  $align    The align of the content
  57      * @param int $colSpan  The colspan of the column
  58      * @param string  $charset  The encoding of the content
  59      */
  60     public function __construct($content = null, $align = null, $colSpan = null, $charset = null)
  61     {
  62         if ($content !== null) {
  63             $this->setContent($content, $charset);
  64         }
  65
  66         if ($align !== null) {
  67             $this->setAlign($align);
  68         }
  69
  70         if ($colSpan !== null) {
  71             $this->setColSpan($colSpan);
  72         }
  73     }
  74
  75     /**
  76      * Set the content.
  77      *
  78      * If $charset is not defined, it is assumed that $content is encoded in
  79      * the charset defined via Zend\Text\Table::setInputCharset() (defaults
  80      * to utf-8).
  81      *
  82      * @param  string $content  Content of the column
  83      * @param  string $charset  The charset of the content
  84      * @throws Exception\InvalidArgumentException When $content is not a string
  85      * @return Column
  86      */
  87     public function setContent($content, $charset = null)
  88     {
  89         if (is_string($content) === false) {
  90             throw new Exception\InvalidArgumentException('$content must be a string');
  91         }
  92
  93         if ($charset === null) {
  94             $inputCharset = Table::getInputCharset();
  95         } else {
  96             $inputCharset = strtolower($charset);
  97         }
  98
  99         $outputCharset = Table::getOutputCharset();
 100
 101         if ($inputCharset !== $outputCharset) {
 102             if (PHP_OS !== 'AIX') {
 103                 // AIX does not understand these character sets
 104                 $strWrapper = StringUtils::getWrapper($inputCharset, $outputCharset);
 105                 $content = $strWrapper->convert($content);
 106             }
 107         }
 108
 109         $this->content = $content;
 110
 111         return $this;
 112     }
 113
 114     /**
 115      * Set the align
 116      *
 117      * @param  string $align Align of the column
 118      * @throws Exception\OutOfBoundsException When supplied align is invalid
 119      * @return Column
 120      */
 121     public function setAlign($align)
 122     {
 123         if (in_array($align, $this->allowedAligns) === false) {
 124             throw new Exception\OutOfBoundsException('Invalid align supplied');
 125         }
 126
 127         $this->align = $align;
 128
 129         return $this;
 130     }
 131
 132     /**
 133      * Set the colspan
 134      *
 135      * @param  int $colSpan
 136      * @throws Exception\InvalidArgumentException When $colSpan is smaller than 1
 137      * @return Column
 138      */
 139     public function setColSpan($colSpan)
 140     {
 141         if (is_int($colSpan) === false or $colSpan < 1) {
 142             throw new Exception\InvalidArgumentException('$colSpan must be an integer and greater than 0');
 143         }
 144
 145         $this->colSpan = $colSpan;
 146
 147         return $this;
 148     }
 149
 150     /**
 151      * Get the colspan
 152      *
 153      * @return int
 154      */
 155     public function getColSpan()
 156     {
 157         return $this->colSpan;
 158     }
 159
 160     /**
 161      * Render the column width the given column width
 162      *
 163      * @param  int $columnWidth The width of the column
 164      * @param  int $padding     The padding for the column
 165      * @throws Exception\InvalidArgumentException When $columnWidth is lower than 1
 166      * @throws Exception\OutOfBoundsException When padding is greater than columnWidth
 167      * @return string
 168      */
 169     public function render($columnWidth, $padding = 0)
 170     {
 171         if (is_int($columnWidth) === false or $columnWidth < 1) {
 172             throw new Exception\InvalidArgumentException('$columnWidth must be an integer and greater than 0');
 173         }
 174
 175         $columnWidth -= ($padding * 2);
 176
 177         if ($columnWidth < 1) {
 178             throw new Exception\OutOfBoundsException('Padding (' . $padding . ') is greater than column width');
 179         }
 180
 181         switch ($this->align) {
 182             case self::ALIGN_LEFT:
 183                 $padMode = STR_PAD_RIGHT;
 184                 break;
 185
 186             case self::ALIGN_CENTER:
 187                 $padMode = STR_PAD_BOTH;
 188                 break;
 189
 190             case self::ALIGN_RIGHT:
 191                 $padMode = STR_PAD_LEFT;
 192                 break;
 193
 194             default:
 195                 // This can never happen, but the CS tells I have to have it ...
 196                 break;
 197         }
 198
 199         $outputCharset = Table::getOutputCharset();
 200         $strWrapper    = StringUtils::getWrapper($outputCharset);
 201         $lines         = explode("\n", $strWrapper->wordWrap($this->content, $columnWidth, "\n", true));
 202         $paddedLines   = [];
 203
 204         foreach ($lines as $line) {
 205             $paddedLines[] = str_repeat(' ', $padding)
 206                            . $strWrapper->strPad($line, $columnWidth, ' ', $padMode)
 207                            . str_repeat(' ', $padding);
 208         }
 209
 210         $result = implode("\n", $paddedLines);
 211
 212         return $result;
 213     }
 214 }