729 lines
14 KiB
PHP
Executable File
729 lines
14 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* PhpWord
|
|
*
|
|
* Copyright (c) 2014 PhpWord
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*
|
|
* @category PhpWord
|
|
* @package PhpWord
|
|
* @copyright Copyright (c) 2014 PhpWord
|
|
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
|
|
* @version 0.8.0
|
|
*/
|
|
|
|
namespace PhpOffice\PhpWord\Section;
|
|
|
|
class Settings
|
|
{
|
|
/**
|
|
* Default Page Size Width
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_defaultPageSizeW = 11906;
|
|
|
|
/**
|
|
* Default Page Size Height
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_defaultPageSizeH = 16838;
|
|
|
|
/**
|
|
* Page Orientation
|
|
*
|
|
* @var string
|
|
*/
|
|
private $_orientation;
|
|
|
|
/**
|
|
* Page Margin Top
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_marginTop;
|
|
|
|
/**
|
|
* Page Margin Left
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_marginLeft;
|
|
|
|
/**
|
|
* Page Margin Right
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_marginRight;
|
|
|
|
/**
|
|
* Page Margin Bottom
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_marginBottom;
|
|
|
|
/**
|
|
* Page Size Width
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_pageSizeW;
|
|
|
|
/**
|
|
* Page Size Height
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_pageSizeH;
|
|
|
|
/**
|
|
* Page Border Top Size
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_borderTopSize;
|
|
|
|
/**
|
|
* Page Border Top Color
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_borderTopColor;
|
|
|
|
/**
|
|
* Page Border Left Size
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_borderLeftSize;
|
|
|
|
/**
|
|
* Page Border Left Color
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_borderLeftColor;
|
|
|
|
/**
|
|
* Page Border Right Size
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_borderRightSize;
|
|
|
|
/**
|
|
* Page Border Right Color
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_borderRightColor;
|
|
|
|
/**
|
|
* Page Border Bottom Size
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_borderBottomSize;
|
|
|
|
/**
|
|
* Page Border Bottom Color
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_borderBottomColor;
|
|
|
|
/**
|
|
* Page Numbering Start
|
|
*
|
|
* @var int
|
|
*/
|
|
private $pageNumberingStart;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
private $headerHeight;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
private $footerHeight;
|
|
|
|
/**
|
|
* Section columns count
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_colsNum;
|
|
|
|
/**
|
|
* Section spacing between columns
|
|
*
|
|
* @var int
|
|
*/
|
|
private $_colsSpace;
|
|
|
|
/**
|
|
* Section break type
|
|
*
|
|
* Options:
|
|
* - nextPage: Next page section break
|
|
* - nextColumn: Column section break
|
|
* - continuous: Continuous section break
|
|
* - evenPage: Even page section break
|
|
* - oddPage: Odd page section break
|
|
*
|
|
* @var string
|
|
*/
|
|
private $_breakType;
|
|
|
|
/**
|
|
* Create new Section Settings
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->_orientation = null;
|
|
$this->_marginTop = 1418;
|
|
$this->_marginLeft = 1418;
|
|
$this->_marginRight = 1418;
|
|
$this->_marginBottom = 1134;
|
|
$this->_pageSizeW = $this->_defaultPageSizeW;
|
|
$this->_pageSizeH = $this->_defaultPageSizeH;
|
|
$this->_borderTopSize = null;
|
|
$this->_borderTopColor = null;
|
|
$this->_borderLeftSize = null;
|
|
$this->_borderLeftColor = null;
|
|
$this->_borderRightSize = null;
|
|
$this->_borderRightColor = null;
|
|
$this->_borderBottomSize = null;
|
|
$this->_borderBottomColor = null;
|
|
$this->headerHeight = 720; // set default header and footer to 720 twips (.5 inches)
|
|
$this->footerHeight = 720;
|
|
$this->_colsNum = 1;
|
|
$this->_colsSpace = 720;
|
|
$this->_breakType = null;
|
|
}
|
|
|
|
/**
|
|
* Set Setting Value
|
|
*
|
|
* @param string $key
|
|
* @param string $value
|
|
*/
|
|
public function setSettingValue($key, $value)
|
|
{
|
|
if ($key == '_orientation' && $value == 'landscape') {
|
|
$this->setLandscape();
|
|
} elseif ($key == '_orientation' && is_null($value)) {
|
|
$this->setPortrait();
|
|
} elseif ($key == '_borderSize') {
|
|
$this->setBorderSize($value);
|
|
} elseif ($key == '_borderColor') {
|
|
$this->setBorderColor($value);
|
|
} else {
|
|
$this->$key = $value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get Margin Top
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getMarginTop()
|
|
{
|
|
return $this->_marginTop;
|
|
}
|
|
|
|
/**
|
|
* Set Margin Top
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setMarginTop($pValue = '')
|
|
{
|
|
$this->_marginTop = $pValue;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get Margin Left
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getMarginLeft()
|
|
{
|
|
return $this->_marginLeft;
|
|
}
|
|
|
|
/**
|
|
* Set Margin Left
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setMarginLeft($pValue = '')
|
|
{
|
|
$this->_marginLeft = $pValue;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get Margin Right
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getMarginRight()
|
|
{
|
|
return $this->_marginRight;
|
|
}
|
|
|
|
/**
|
|
* Set Margin Right
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setMarginRight($pValue = '')
|
|
{
|
|
$this->_marginRight = $pValue;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get Margin Bottom
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getMarginBottom()
|
|
{
|
|
return $this->_marginBottom;
|
|
}
|
|
|
|
/**
|
|
* Set Margin Bottom
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setMarginBottom($pValue = '')
|
|
{
|
|
$this->_marginBottom = $pValue;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set Landscape Orientation
|
|
*/
|
|
public function setLandscape()
|
|
{
|
|
$this->_orientation = 'landscape';
|
|
$this->_pageSizeW = $this->_defaultPageSizeH;
|
|
$this->_pageSizeH = $this->_defaultPageSizeW;
|
|
}
|
|
|
|
/**
|
|
* Set Portrait Orientation
|
|
*/
|
|
public function setPortrait()
|
|
{
|
|
$this->_orientation = null;
|
|
$this->_pageSizeW = $this->_defaultPageSizeW;
|
|
$this->_pageSizeH = $this->_defaultPageSizeH;
|
|
}
|
|
|
|
/**
|
|
* Get Page Size Width
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getPageSizeW()
|
|
{
|
|
return $this->_pageSizeW;
|
|
}
|
|
|
|
/**
|
|
* Get Page Size Height
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getPageSizeH()
|
|
{
|
|
return $this->_pageSizeH;
|
|
}
|
|
|
|
/**
|
|
* Get Page Orientation
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getOrientation()
|
|
{
|
|
return $this->_orientation;
|
|
}
|
|
|
|
/**
|
|
* Set Border Size
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setBorderSize($pValue = null)
|
|
{
|
|
$this->_borderTopSize = $pValue;
|
|
$this->_borderLeftSize = $pValue;
|
|
$this->_borderRightSize = $pValue;
|
|
$this->_borderBottomSize = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Size
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getBorderSize()
|
|
{
|
|
$t = $this->getBorderTopSize();
|
|
$l = $this->getBorderLeftSize();
|
|
$r = $this->getBorderRightSize();
|
|
$b = $this->getBorderBottomSize();
|
|
|
|
return array($t, $l, $r, $b);
|
|
}
|
|
|
|
/**
|
|
* Set Border Color
|
|
*
|
|
* @param string $pValue
|
|
*/
|
|
public function setBorderColor($pValue = null)
|
|
{
|
|
$this->_borderTopColor = $pValue;
|
|
$this->_borderLeftColor = $pValue;
|
|
$this->_borderRightColor = $pValue;
|
|
$this->_borderBottomColor = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Color
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getBorderColor()
|
|
{
|
|
$t = $this->getBorderTopColor();
|
|
$l = $this->getBorderLeftColor();
|
|
$r = $this->getBorderRightColor();
|
|
$b = $this->getBorderBottomColor();
|
|
|
|
return array($t, $l, $r, $b);
|
|
}
|
|
|
|
/**
|
|
* Set Border Top Size
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setBorderTopSize($pValue = null)
|
|
{
|
|
$this->_borderTopSize = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Top Size
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getBorderTopSize()
|
|
{
|
|
return $this->_borderTopSize;
|
|
}
|
|
|
|
/**
|
|
* Set Border Top Color
|
|
*
|
|
* @param string $pValue
|
|
*/
|
|
public function setBorderTopColor($pValue = null)
|
|
{
|
|
$this->_borderTopColor = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Top Color
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getBorderTopColor()
|
|
{
|
|
return $this->_borderTopColor;
|
|
}
|
|
|
|
/**
|
|
* Set Border Left Size
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setBorderLeftSize($pValue = null)
|
|
{
|
|
$this->_borderLeftSize = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Left Size
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getBorderLeftSize()
|
|
{
|
|
return $this->_borderLeftSize;
|
|
}
|
|
|
|
/**
|
|
* Set Border Left Color
|
|
*
|
|
* @param string $pValue
|
|
*/
|
|
public function setBorderLeftColor($pValue = null)
|
|
{
|
|
$this->_borderLeftColor = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Left Color
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getBorderLeftColor()
|
|
{
|
|
return $this->_borderLeftColor;
|
|
}
|
|
|
|
/**
|
|
* Set Border Right Size
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setBorderRightSize($pValue = null)
|
|
{
|
|
$this->_borderRightSize = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Right Size
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getBorderRightSize()
|
|
{
|
|
return $this->_borderRightSize;
|
|
}
|
|
|
|
/**
|
|
* Set Border Right Color
|
|
*
|
|
* @param string $pValue
|
|
*/
|
|
public function setBorderRightColor($pValue = null)
|
|
{
|
|
$this->_borderRightColor = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Right Color
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getBorderRightColor()
|
|
{
|
|
return $this->_borderRightColor;
|
|
}
|
|
|
|
/**
|
|
* Set Border Bottom Size
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setBorderBottomSize($pValue = null)
|
|
{
|
|
$this->_borderBottomSize = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Bottom Size
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getBorderBottomSize()
|
|
{
|
|
return $this->_borderBottomSize;
|
|
}
|
|
|
|
/**
|
|
* Set Border Bottom Color
|
|
*
|
|
* @param string $pValue
|
|
*/
|
|
public function setBorderBottomColor($pValue = null)
|
|
{
|
|
$this->_borderBottomColor = $pValue;
|
|
}
|
|
|
|
/**
|
|
* Get Border Bottom Color
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getBorderBottomColor()
|
|
{
|
|
return $this->_borderBottomColor;
|
|
}
|
|
|
|
/**
|
|
* @param null|int $pageNumberingStart
|
|
* @return $this
|
|
*/
|
|
public function setPageNumberingStart($pageNumberingStart = null)
|
|
{
|
|
$this->pageNumberingStart = $pageNumberingStart;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return null|int
|
|
*/
|
|
public function getPageNumberingStart()
|
|
{
|
|
return $this->pageNumberingStart;
|
|
}
|
|
|
|
/**
|
|
* Get Header Height
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getHeaderHeight()
|
|
{
|
|
return $this->headerHeight;
|
|
}
|
|
|
|
/**
|
|
* Set Header Height
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setHeaderHeight($pValue = '')
|
|
{
|
|
if (!is_numeric($pValue)) {
|
|
$pValue = 720;
|
|
}
|
|
$this->headerHeight = $pValue;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get Footer Height
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getFooterHeight()
|
|
{
|
|
return $this->footerHeight;
|
|
}
|
|
|
|
/**
|
|
* Set Footer Height
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setFooterHeight($pValue = '')
|
|
{
|
|
if (!is_numeric($pValue)) {
|
|
$pValue = 720;
|
|
}
|
|
$this->footerHeight = $pValue;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set Section Columns Count
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setColsNum($pValue = '')
|
|
{
|
|
if (!is_numeric($pValue)) {
|
|
$pValue = 1;
|
|
}
|
|
$this->_colsNum = $pValue;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get Section Columns Count
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getColsNum()
|
|
{
|
|
return $this->_colsNum;
|
|
}
|
|
|
|
/**
|
|
* Set Section Space Between Columns
|
|
*
|
|
* @param int $pValue
|
|
*/
|
|
public function setColsSpace($pValue = '')
|
|
{
|
|
if (!is_numeric($pValue)) {
|
|
$pValue = 720;
|
|
}
|
|
$this->_colsSpace = $pValue;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get Section Space Between Columns
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getColsSpace()
|
|
{
|
|
return $this->_colsSpace;
|
|
}
|
|
|
|
/**
|
|
* Set Break Type
|
|
*
|
|
* @param string $pValue
|
|
*/
|
|
public function setBreakType($pValue = null)
|
|
{
|
|
$this->_breakType = $pValue;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get Break Type
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getBreakType()
|
|
{
|
|
return $this->_breakType;
|
|
}
|
|
}
|