123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810 |
- <?php
- /**
- * This file is part of PHPWord - A pure PHP library for reading and writing
- * word processing documents.
- *
- * PHPWord is free software distributed under the terms of the GNU Lesser
- * General Public License version 3 as published by the Free Software Foundation.
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code. For the full list of
- * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
- *
- * @see https://github.com/PHPOffice/PHPWord
- * @copyright 2010-2018 PHPWord contributors
- * @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
- */
- namespace PhpOffice\PhpWord\Style;
- use PhpOffice\PhpWord\ComplexType\TblWidth as TblWidthComplexType;
- use PhpOffice\PhpWord\SimpleType\Jc;
- use PhpOffice\PhpWord\SimpleType\JcTable;
- use PhpOffice\PhpWord\SimpleType\TblWidth;
- class Table extends Border
- {
- /**
- * @deprecated Use \PhpOffice\PhpWord\SimpleType\TblWidth::AUTO instead
- */
- const WIDTH_AUTO = 'auto'; // Automatically determined width
- /**
- * @deprecated Use \PhpOffice\PhpWord\SimpleType\TblWidth::PERCENT instead
- */
- const WIDTH_PERCENT = 'pct'; // Width in fiftieths (1/50) of a percent (1% = 50 unit)
- /**
- * @deprecated Use \PhpOffice\PhpWord\SimpleType\TblWidth::TWIP instead
- */
- const WIDTH_TWIP = 'dxa'; // Width in twentieths (1/20) of a point (twip)
- //values for http://www.datypic.com/sc/ooxml/t-w_ST_TblLayoutType.html
- /**
- * AutoFit Table Layout
- *
- * @var string
- */
- const LAYOUT_AUTO = 'autofit';
- /**
- * Fixed Width Table Layout
- *
- * @var string
- */
- const LAYOUT_FIXED = 'fixed';
- /**
- * Is this a first row style?
- *
- * @var bool
- */
- private $isFirstRow = false;
- /**
- * Style for first row
- *
- * @var \PhpOffice\PhpWord\Style\Table
- */
- private $firstRowStyle;
- /**
- * Cell margin top
- *
- * @var int
- */
- private $cellMarginTop;
- /**
- * Cell margin left
- *
- * @var int
- */
- private $cellMarginLeft;
- /**
- * Cell margin right
- *
- * @var int
- */
- private $cellMarginRight;
- /**
- * Cell margin bottom
- *
- * @var int
- */
- private $cellMarginBottom;
- /**
- * Border size inside horizontal
- *
- * @var int
- */
- private $borderInsideHSize;
- /**
- * Border color inside horizontal
- *
- * @var string
- */
- private $borderInsideHColor;
- /**
- * Border size inside vertical
- *
- * @var int
- */
- private $borderInsideVSize;
- /**
- * Border color inside vertical
- *
- * @var string
- */
- private $borderInsideVColor;
- /**
- * Shading
- *
- * @var \PhpOffice\PhpWord\Style\Shading
- */
- private $shading;
- /**
- * @var string
- */
- private $alignment = '';
- /**
- * @var int|float Width value
- */
- private $width = 0;
- /**
- * @var string Width unit
- */
- private $unit = TblWidth::AUTO;
- /**
- * @var int|float cell spacing value
- */
- protected $cellSpacing = null;
- /**
- * @var string Table Layout
- */
- private $layout = self::LAYOUT_AUTO;
- /**
- * Position
- *
- * @var \PhpOffice\PhpWord\Style\TablePosition
- */
- private $position;
- /** @var TblWidthComplexType|null */
- private $indent;
- /**
- * The width of each column, computed based on the max cell width of each column
- *
- * @var int[]
- */
- private $columnWidths;
- /**
- * Visually Right to Left Table
- *
- * @see http://www.datypic.com/sc/ooxml/e-w_bidiVisual-1.html
- * @var bool
- */
- private $bidiVisual = false;
- /**
- * Create new table style
- *
- * @param mixed $tableStyle
- * @param mixed $firstRowStyle
- */
- public function __construct($tableStyle = null, $firstRowStyle = null)
- {
- // Clone first row from table style, but with certain properties disabled
- if ($firstRowStyle !== null && is_array($firstRowStyle)) {
- $this->firstRowStyle = clone $this;
- $this->firstRowStyle->isFirstRow = true;
- unset($this->firstRowStyle->firstRowStyle, $this->firstRowStyle->borderInsideHSize, $this->firstRowStyle->borderInsideHColor, $this->firstRowStyle->borderInsideVSize, $this->firstRowStyle->borderInsideVColor, $this->firstRowStyle->cellMarginTop, $this->firstRowStyle->cellMarginLeft, $this->firstRowStyle->cellMarginRight, $this->firstRowStyle->cellMarginBottom, $this->firstRowStyle->cellSpacing);
- $this->firstRowStyle->setStyleByArray($firstRowStyle);
- }
- if ($tableStyle !== null && is_array($tableStyle)) {
- $this->setStyleByArray($tableStyle);
- }
- }
- /**
- * @param float|int $cellSpacing
- */
- public function setCellSpacing($cellSpacing = null)
- {
- $this->cellSpacing = $cellSpacing;
- }
- /**
- * @return float|int
- */
- public function getCellSpacing()
- {
- return $this->cellSpacing;
- }
- /**
- * Set first row
- *
- * @return \PhpOffice\PhpWord\Style\Table
- */
- public function getFirstRow()
- {
- return $this->firstRowStyle;
- }
- /**
- * Get background
- *
- * @return string
- */
- public function getBgColor()
- {
- if ($this->shading !== null) {
- return $this->shading->getFill();
- }
- return null;
- }
- /**
- * Set background
- *
- * @param string $value
- * @return self
- */
- public function setBgColor($value = null)
- {
- $this->setShading(array('fill' => $value));
- return $this;
- }
- /**
- * Get TLRBHV Border Size
- *
- * @return int[]
- */
- public function getBorderSize()
- {
- return array(
- $this->getBorderTopSize(),
- $this->getBorderLeftSize(),
- $this->getBorderRightSize(),
- $this->getBorderBottomSize(),
- $this->getBorderInsideHSize(),
- $this->getBorderInsideVSize(),
- );
- }
- /**
- * Set TLRBHV Border Size
- *
- * @param int $value Border size in eighths of a point (1/8 point)
- * @return self
- */
- public function setBorderSize($value = null)
- {
- $this->setBorderTopSize($value);
- $this->setBorderLeftSize($value);
- $this->setBorderRightSize($value);
- $this->setBorderBottomSize($value);
- $this->setBorderInsideHSize($value);
- $this->setBorderInsideVSize($value);
- return $this;
- }
- /**
- * Get TLRBHV Border Color
- *
- * @return string[]
- */
- public function getBorderColor()
- {
- return array(
- $this->getBorderTopColor(),
- $this->getBorderLeftColor(),
- $this->getBorderRightColor(),
- $this->getBorderBottomColor(),
- $this->getBorderInsideHColor(),
- $this->getBorderInsideVColor(),
- );
- }
- /**
- * Set TLRBHV Border Color
- *
- * @param string $value
- * @return self
- */
- public function setBorderColor($value = null)
- {
- $this->setBorderTopColor($value);
- $this->setBorderLeftColor($value);
- $this->setBorderRightColor($value);
- $this->setBorderBottomColor($value);
- $this->setBorderInsideHColor($value);
- $this->setBorderInsideVColor($value);
- return $this;
- }
- /**
- * Get border size inside horizontal
- *
- * @return int
- */
- public function getBorderInsideHSize()
- {
- return $this->getTableOnlyProperty('borderInsideHSize');
- }
- /**
- * Set border size inside horizontal
- *
- * @param int $value
- * @return self
- */
- public function setBorderInsideHSize($value = null)
- {
- return $this->setTableOnlyProperty('borderInsideHSize', $value);
- }
- /**
- * Get border color inside horizontal
- *
- * @return string
- */
- public function getBorderInsideHColor()
- {
- return $this->getTableOnlyProperty('borderInsideHColor');
- }
- /**
- * Set border color inside horizontal
- *
- * @param string $value
- * @return self
- */
- public function setBorderInsideHColor($value = null)
- {
- return $this->setTableOnlyProperty('borderInsideHColor', $value, false);
- }
- /**
- * Get border size inside vertical
- *
- * @return int
- */
- public function getBorderInsideVSize()
- {
- return $this->getTableOnlyProperty('borderInsideVSize');
- }
- /**
- * Set border size inside vertical
- *
- * @param int $value
- * @return self
- */
- public function setBorderInsideVSize($value = null)
- {
- return $this->setTableOnlyProperty('borderInsideVSize', $value);
- }
- /**
- * Get border color inside vertical
- *
- * @return string
- */
- public function getBorderInsideVColor()
- {
- return $this->getTableOnlyProperty('borderInsideVColor');
- }
- /**
- * Set border color inside vertical
- *
- * @param string $value
- * @return self
- */
- public function setBorderInsideVColor($value = null)
- {
- return $this->setTableOnlyProperty('borderInsideVColor', $value, false);
- }
- /**
- * Get cell margin top
- *
- * @return int
- */
- public function getCellMarginTop()
- {
- return $this->getTableOnlyProperty('cellMarginTop');
- }
- /**
- * Set cell margin top
- *
- * @param int $value
- * @return self
- */
- public function setCellMarginTop($value = null)
- {
- return $this->setTableOnlyProperty('cellMarginTop', $value);
- }
- /**
- * Get cell margin left
- *
- * @return int
- */
- public function getCellMarginLeft()
- {
- return $this->getTableOnlyProperty('cellMarginLeft');
- }
- /**
- * Set cell margin left
- *
- * @param int $value
- * @return self
- */
- public function setCellMarginLeft($value = null)
- {
- return $this->setTableOnlyProperty('cellMarginLeft', $value);
- }
- /**
- * Get cell margin right
- *
- * @return int
- */
- public function getCellMarginRight()
- {
- return $this->getTableOnlyProperty('cellMarginRight');
- }
- /**
- * Set cell margin right
- *
- * @param int $value
- * @return self
- */
- public function setCellMarginRight($value = null)
- {
- return $this->setTableOnlyProperty('cellMarginRight', $value);
- }
- /**
- * Get cell margin bottom
- *
- * @return int
- */
- public function getCellMarginBottom()
- {
- return $this->getTableOnlyProperty('cellMarginBottom');
- }
- /**
- * Set cell margin bottom
- *
- * @param int $value
- * @return self
- */
- public function setCellMarginBottom($value = null)
- {
- return $this->setTableOnlyProperty('cellMarginBottom', $value);
- }
- /**
- * Get cell margin
- *
- * @return int[]
- */
- public function getCellMargin()
- {
- return array(
- $this->cellMarginTop,
- $this->cellMarginLeft,
- $this->cellMarginRight,
- $this->cellMarginBottom,
- );
- }
- /**
- * Set TLRB cell margin
- *
- * @param int $value Margin in twips
- * @return self
- */
- public function setCellMargin($value = null)
- {
- $this->setCellMarginTop($value);
- $this->setCellMarginLeft($value);
- $this->setCellMarginRight($value);
- $this->setCellMarginBottom($value);
- return $this;
- }
- /**
- * Check if any of the margin is not null
- *
- * @return bool
- */
- public function hasMargin()
- {
- $margins = $this->getCellMargin();
- return $margins !== array_filter($margins, 'is_null');
- }
- /**
- * Get shading
- *
- * @return \PhpOffice\PhpWord\Style\Shading
- */
- public function getShading()
- {
- return $this->shading;
- }
- /**
- * Set shading
- *
- * @param mixed $value
- * @return self
- */
- public function setShading($value = null)
- {
- $this->setObjectVal($value, 'Shading', $this->shading);
- return $this;
- }
- /**
- * @since 0.13.0
- *
- * @return string
- */
- public function getAlignment()
- {
- return $this->alignment;
- }
- /**
- * @since 0.13.0
- *
- * @param string $value
- *
- * @return self
- */
- public function setAlignment($value)
- {
- if (JcTable::isValid($value) || Jc::isValid($value)) {
- $this->alignment = $value;
- }
- return $this;
- }
- /**
- * @deprecated 0.13.0 Use the `getAlignment` method instead.
- *
- * @return string
- *
- * @codeCoverageIgnore
- */
- public function getAlign()
- {
- return $this->getAlignment();
- }
- /**
- * @deprecated 0.13.0 Use the `setAlignment` method instead.
- *
- * @param string $value
- *
- * @return self
- *
- * @codeCoverageIgnore
- */
- public function setAlign($value = null)
- {
- return $this->setAlignment($value);
- }
- /**
- * Get width
- *
- * @return int|float
- */
- public function getWidth()
- {
- return $this->width;
- }
- /**
- * Set width
- *
- * @param int|float $value
- * @return self
- */
- public function setWidth($value = null)
- {
- $this->width = $this->setNumericVal($value, $this->width);
- return $this;
- }
- /**
- * Get width unit
- *
- * @return string
- */
- public function getUnit()
- {
- return $this->unit;
- }
- /**
- * Set width unit
- *
- * @param string $value
- * @return self
- */
- public function setUnit($value = null)
- {
- TblWidth::validate($value);
- $this->unit = $value;
- return $this;
- }
- /**
- * Get layout
- *
- * @return string
- */
- public function getLayout()
- {
- return $this->layout;
- }
- /**
- * Set layout
- *
- * @param string $value
- * @return self
- */
- public function setLayout($value = null)
- {
- $enum = array(self::LAYOUT_AUTO, self::LAYOUT_FIXED);
- $this->layout = $this->setEnumVal($value, $enum, $this->layout);
- return $this;
- }
- /**
- * Get table style only property by checking if it's a firstRow
- *
- * This is necessary since firstRow style is cloned from table style but
- * without certain properties activated, e.g. margins
- *
- * @param string $property
- * @return int|string|null
- */
- private function getTableOnlyProperty($property)
- {
- if (false === $this->isFirstRow) {
- return $this->$property;
- }
- return null;
- }
- /**
- * Set table style only property by checking if it's a firstRow
- *
- * This is necessary since firstRow style is cloned from table style but
- * without certain properties activated, e.g. margins
- *
- * @param string $property
- * @param int|string $value
- * @param bool $isNumeric
- * @return self
- */
- private function setTableOnlyProperty($property, $value, $isNumeric = true)
- {
- if (false === $this->isFirstRow) {
- if (true === $isNumeric) {
- $this->$property = $this->setNumericVal($value, $this->$property);
- } else {
- $this->$property = $value;
- }
- }
- return $this;
- }
- /**
- * Get position
- *
- * @return \PhpOffice\PhpWord\Style\TablePosition
- */
- public function getPosition()
- {
- return $this->position;
- }
- /**
- * Set position
- *
- * @param mixed $value
- * @return self
- */
- public function setPosition($value = null)
- {
- $this->setObjectVal($value, 'TablePosition', $this->position);
- return $this;
- }
- /**
- * @return TblWidthComplexType
- */
- public function getIndent()
- {
- return $this->indent;
- }
- /**
- * @param TblWidthComplexType $indent
- * @return self
- * @see http://www.datypic.com/sc/ooxml/e-w_tblInd-1.html
- */
- public function setIndent(TblWidthComplexType $indent)
- {
- $this->indent = $indent;
- return $this;
- }
- /**
- * Get the columnWidths
- *
- * @return null|int[]
- */
- public function getColumnWidths()
- {
- return $this->columnWidths;
- }
- /**
- * The column widths
- *
- * @param int[] $value
- */
- public function setColumnWidths(array $value = null)
- {
- $this->columnWidths = $value;
- }
- /**
- * Get bidiVisual
- *
- * @return bool
- */
- public function isBidiVisual()
- {
- return $this->bidiVisual;
- }
- /**
- * Set bidiVisual
- *
- * @param bool $bidi
- * Set to true to visually present table as Right to Left
- * @return self
- */
- public function setBidiVisual($bidi)
- {
- $this->bidiVisual = $bidi;
- return $this;
- }
- }
|