Section
extends Border
in package
Section settings.
Table of Contents
Constants
- DEFAULT_COLUMN_COUNT = 1
- DEFAULT_COLUMN_SPACING = 720
- DEFAULT_FOOTER_HEIGHT = 720
- DEFAULT_GUTTER = 0
- DEFAULT_HEADER_HEIGHT = 720
- DEFAULT_HEIGHT = 16837.79527559
- DEFAULT_MARGIN = 1440
- DEFAULT_WIDTH = 11905.511811024
- Page default constants.
- ORIENTATION_LANDSCAPE = 'landscape'
- ORIENTATION_PORTRAIT = 'portrait'
- Page orientation.
Properties
- $aliases : array<string|int, mixed>
- Aliases.
- $borderBottomColor : null|string
- Border Bottom Color.
- $borderBottomSize : float|int
- Border Bottom Size.
- $borderBottomStyle : string
- Border Bottom Style.
- $borderLeftColor : null|string
- Border Left Color.
- $borderLeftSize : float|int
- Border Left Size.
- $borderLeftStyle : string
- Border Left Style.
- $borderRightColor : null|string
- Border Right Color.
- $borderRightSize : float|int
- Border Right Size.
- $borderRightStyle : string
- Border Right Style.
- $borderTopColor : null|string
- Border Top Color.
- $borderTopSize : float|int
- Border Top Size.
- $borderTopStyle : string
- Border Top Style.
- $index : null|int
- Index number in Style collection for named style.
- $marginBottom : float|int
- Bottom margin spacing.
- $marginLeft : float|int
- Left margin spacing.
- $marginRight : float|int
- Right margin spacing.
- $marginTop : float|int
- Top margin spacing.
- $styleName : string|null
- Style name.
- $breakType : string|null
- Section break type.
- $colsNum : int
- Section columns count.
- $colsSpace : float|int
- Section spacing between columns.
- $footerHeight : float|int
- Footer height.
- $gutter : float|int
- Page gutter spacing.
- $headerHeight : float|int
- Header height.
- $isAuto : bool
- Is this an automatic style? (Used primarily in OpenDocument driver).
- $lineNumbering : LineNumbering
- Line numbering.
- $orientation : string
- Page Orientation.
- $pageNumberingStart : int
- Page Numbering Start.
- $pageSizeH : float|int
- Page Size Height.
- $pageSizeW : float|int
- Page Size Width.
- $paper : Paper
- Paper size.
- $vAlign : string|null
- Vertical Text Alignment on Page One of \PhpOffice\PhpWord\SimpleType\VerticalJc.
Methods
- __construct() : mixed
- Create new instance.
- getBorderBottomColor() : null|string
- Get border bottom color.
- getBorderBottomSize() : float|int
- Get border bottom size.
- getBorderBottomStyle() : string
- Get border bottom style.
- getBorderColor() : array<string|int, null|string>
- Get border color.
- getBorderLeftColor() : null|string
- Get border left color.
- getBorderLeftSize() : float|int
- Get border left size.
- getBorderLeftStyle() : string
- Get border left style.
- getBorderRightColor() : null|string
- Get border right color.
- getBorderRightSize() : float|int
- Get border right size.
- getBorderRightStyle() : string
- Get border right style.
- getBorderSize() : array<string|int, int>
- Get border size.
- getBorderStyle() : array<string|int, string>
- Get border style.
- getBorderTopColor() : null|string
- Get border top color.
- getBorderTopSize() : float|int
- Get border top size.
- getBorderTopStyle() : string
- Get border top style.
- getBreakType() : string|null
- Get Break Type.
- getChildStyleValue() : mixed
- Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`.
- getColsNum() : int
- Get Section Columns Count.
- getColsSpace() : float|int
- Get Section Space Between Columns.
- getFooterHeight() : float|int
- Get Footer Height.
- getGutter() : float|int
- Get gutter.
- getHeaderHeight() : float|int
- Get Header Height.
- getIndex() : null|int
- Get index number.
- getLineNumbering() : LineNumbering
- Get line numbering.
- getMarginBottom() : float|int
- Get Margin Bottom.
- getMarginLeft() : float|int
- Get Margin Left.
- getMarginRight() : float|int
- Get Margin Right.
- getMarginTop() : float|int
- Get Margin Top.
- getOrientation() : string
- Get Page Orientation.
- getPageNumberingStart() : null|int
- Get page numbering start.
- getPageSizeH() : null|float|int
- Get Page Size Height.
- getPageSizeW() : null|float|int
- Get Page Size Width.
- getPaperSize() : string
- Get paper size.
- getStyleName() : string|null
- Get style name.
- getVAlign() : string|null
- Get vertical alignment.
- hasBorder() : bool
- Check if any of the border is not null.
- isAuto() : bool
- Get is automatic style flag.
- setAuto() : self
- Set is automatic style flag.
- setBorderBottomColor() : self
- Set border bottom color.
- setBorderBottomSize() : self
- Set border bottom size.
- setBorderBottomStyle() : self
- Set border bottom style.
- setBorderColor() : self
- Set border color.
- setBorderLeftColor() : self
- Set border left color.
- setBorderLeftSize() : self
- Set border left size.
- setBorderLeftStyle() : self
- Set border left style.
- setBorderRightColor() : self
- Set border right color.
- setBorderRightSize() : self
- Set border right size.
- setBorderRightStyle() : self
- Set border right style.
- setBorderSize() : self
- Set border size.
- setBorderStyle() : self
- Set border style.
- setBorderTopColor() : self
- Set border top color.
- setBorderTopSize() : self
- Set border top size.
- setBorderTopStyle() : self
- Set border top Style.
- setBreakType() : self
- Set Break Type.
- setColsNum() : self
- Set Section Columns Count.
- setColsSpace() : self
- Set Section Space Between Columns.
- setFooterHeight() : self
- Set Footer Height.
- setGutter() : self
- Set gutter.
- setHeaderHeight() : self
- Set Header Height.
- setIndex() : self
- Set index number.
- setLandscape() : self
- Set Landscape Orientation.
- setLineNumbering() : self
- Set line numbering.
- setMarginBottom() : self
- Set Margin Bottom.
- setMarginLeft() : self
- Set Margin Left.
- setMarginRight() : self
- Set Margin Right.
- setMarginTop() : self
- Set Margin Top.
- setOrientation() : self
- Set orientation.
- setPageNumberingStart() : self
- Set page numbering start.
- setPageSizeH() : Section
- setPageSizeW() : Section
- setPaperSize() : self
- Set paper size.
- setPortrait() : self
- Set Portrait Orientation.
- setSettingValue() : self
- Set Setting Value.
- setStyleByArray() : self
- Set style by using associative array.
- setStyleName() : self
- Set style name.
- setStyleValue() : self
- Set style value template method.
- setVAlign() : self
- Set vertical alignment.
- setBoolVal() : bool
- Set bool value.
- setEnumVal() : mixed
- Set enum value.
- setFloatVal() : null|float
- Set float value: Convert string that contains only numeric into float.
- setIntVal() : null|int
- Set integer value: Convert string that contains only numeric into integer.
- setNonEmptyVal() : string
- Set default for null and empty value.
- setNumericVal() : null|float|int
- Set numeric value.
- setObjectVal() : mixed
- Set object value.
- setPairedVal() : self
- Set $property value and set $pairProperty = false when $value = true.
Constants
DEFAULT_COLUMN_COUNT
public
mixed
DEFAULT_COLUMN_COUNT
= 1
DEFAULT_COLUMN_SPACING
public
mixed
DEFAULT_COLUMN_SPACING
= 720
DEFAULT_FOOTER_HEIGHT
public
mixed
DEFAULT_FOOTER_HEIGHT
= 720
DEFAULT_GUTTER
public
mixed
DEFAULT_GUTTER
= 0
DEFAULT_HEADER_HEIGHT
public
mixed
DEFAULT_HEADER_HEIGHT
= 720
DEFAULT_HEIGHT
public
mixed
DEFAULT_HEIGHT
= 16837.79527559
DEFAULT_MARGIN
public
mixed
DEFAULT_MARGIN
= 1440
DEFAULT_WIDTH
Page default constants.
public
mixed
DEFAULT_WIDTH
= 11905.511811024
Tags
ORIENTATION_LANDSCAPE
public
mixed
ORIENTATION_LANDSCAPE
= 'landscape'
ORIENTATION_PORTRAIT
Page orientation.
public
mixed
ORIENTATION_PORTRAIT
= 'portrait'
Tags
Properties
$aliases
Aliases.
protected
array<string|int, mixed>
$aliases
= []
$borderBottomColor
Border Bottom Color.
protected
null|string
$borderBottomColor
$borderBottomSize
Border Bottom Size.
protected
float|int
$borderBottomSize
$borderBottomStyle
Border Bottom Style.
protected
string
$borderBottomStyle
$borderLeftColor
Border Left Color.
protected
null|string
$borderLeftColor
$borderLeftSize
Border Left Size.
protected
float|int
$borderLeftSize
$borderLeftStyle
Border Left Style.
protected
string
$borderLeftStyle
$borderRightColor
Border Right Color.
protected
null|string
$borderRightColor
$borderRightSize
Border Right Size.
protected
float|int
$borderRightSize
$borderRightStyle
Border Right Style.
protected
string
$borderRightStyle
$borderTopColor
Border Top Color.
protected
null|string
$borderTopColor
$borderTopSize
Border Top Size.
protected
float|int
$borderTopSize
$borderTopStyle
Border Top Style.
protected
string
$borderTopStyle
$index
Index number in Style collection for named style.
protected
null|int
$index
This number starts from one and defined in Style::setStyleValues()
$marginBottom
Bottom margin spacing.
protected
float|int
$marginBottom
= self::DEFAULT_MARGIN
$marginLeft
Left margin spacing.
protected
float|int
$marginLeft
= self::DEFAULT_MARGIN
$marginRight
Right margin spacing.
protected
float|int
$marginRight
= self::DEFAULT_MARGIN
$marginTop
Top margin spacing.
protected
float|int
$marginTop
= self::DEFAULT_MARGIN
$styleName
Style name.
protected
string|null
$styleName
$breakType
Section break type.
private
string|null
$breakType
Options:
- nextPage: Next page section break
- nextColumn: Column section break
- continuous: Continuous section break
- evenPage: Even page section break
- oddPage: Odd page section break
$colsNum
Section columns count.
private
int
$colsNum
= self::DEFAULT_COLUMN_COUNT
$colsSpace
Section spacing between columns.
private
float|int
$colsSpace
= self::DEFAULT_COLUMN_SPACING
$footerHeight
Footer height.
private
float|int
$footerHeight
= self::DEFAULT_FOOTER_HEIGHT
$gutter
Page gutter spacing.
private
float|int
$gutter
= self::DEFAULT_GUTTER
Tags
$headerHeight
Header height.
private
float|int
$headerHeight
= self::DEFAULT_HEADER_HEIGHT
$isAuto
Is this an automatic style? (Used primarily in OpenDocument driver).
private
bool
$isAuto
= false
Tags
$lineNumbering
Line numbering.
private
LineNumbering
$lineNumbering
Tags
$orientation
Page Orientation.
private
string
$orientation
= self::ORIENTATION_PORTRAIT
Tags
$pageNumberingStart
Page Numbering Start.
private
int
$pageNumberingStart
$pageSizeH
Page Size Height.
private
float|int
$pageSizeH
= self::DEFAULT_HEIGHT
$pageSizeW
Page Size Width.
private
float|int
$pageSizeW
= self::DEFAULT_WIDTH
$paper
Paper size.
private
Paper
$paper
$vAlign
Vertical Text Alignment on Page One of \PhpOffice\PhpWord\SimpleType\VerticalJc.
private
string|null
$vAlign
Methods
__construct()
Create new instance.
public
__construct() : mixed
getBorderBottomColor()
Get border bottom color.
public
getBorderBottomColor() : null|string
Return values
null|stringgetBorderBottomSize()
Get border bottom size.
public
getBorderBottomSize() : float|int
Return values
float|intgetBorderBottomStyle()
Get border bottom style.
public
getBorderBottomStyle() : string
Return values
stringgetBorderColor()
Get border color.
public
getBorderColor() : array<string|int, null|string>
Return values
array<string|int, null|string>getBorderLeftColor()
Get border left color.
public
getBorderLeftColor() : null|string
Return values
null|stringgetBorderLeftSize()
Get border left size.
public
getBorderLeftSize() : float|int
Return values
float|intgetBorderLeftStyle()
Get border left style.
public
getBorderLeftStyle() : string
Return values
stringgetBorderRightColor()
Get border right color.
public
getBorderRightColor() : null|string
Return values
null|stringgetBorderRightSize()
Get border right size.
public
getBorderRightSize() : float|int
Return values
float|intgetBorderRightStyle()
Get border right style.
public
getBorderRightStyle() : string
Return values
stringgetBorderSize()
Get border size.
public
getBorderSize() : array<string|int, int>
Return values
array<string|int, int>getBorderStyle()
Get border style.
public
getBorderStyle() : array<string|int, string>
Return values
array<string|int, string>getBorderTopColor()
Get border top color.
public
getBorderTopColor() : null|string
Return values
null|stringgetBorderTopSize()
Get border top size.
public
getBorderTopSize() : float|int
Return values
float|intgetBorderTopStyle()
Get border top style.
public
getBorderTopStyle() : string
Return values
stringgetBreakType()
Get Break Type.
public
getBreakType() : string|null
Return values
string|nullgetChildStyleValue()
Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`.
public
getChildStyleValue(AbstractStyle $substyleObject, string $substyleProperty) : mixed
Parameters
- $substyleObject : AbstractStyle
- $substyleProperty : string
Tags
getColsNum()
Get Section Columns Count.
public
getColsNum() : int
Return values
intgetColsSpace()
Get Section Space Between Columns.
public
getColsSpace() : float|int
Return values
float|intgetFooterHeight()
Get Footer Height.
public
getFooterHeight() : float|int
Return values
float|intgetGutter()
Get gutter.
public
getGutter() : float|int
Return values
float|intgetHeaderHeight()
Get Header Height.
public
getHeaderHeight() : float|int
Return values
float|intgetIndex()
Get index number.
public
getIndex() : null|int
Return values
null|intgetLineNumbering()
Get line numbering.
public
getLineNumbering() : LineNumbering
Return values
LineNumberinggetMarginBottom()
Get Margin Bottom.
public
getMarginBottom() : float|int
Return values
float|intgetMarginLeft()
Get Margin Left.
public
getMarginLeft() : float|int
Return values
float|intgetMarginRight()
Get Margin Right.
public
getMarginRight() : float|int
Return values
float|intgetMarginTop()
Get Margin Top.
public
getMarginTop() : float|int
Return values
float|intgetOrientation()
Get Page Orientation.
public
getOrientation() : string
Return values
stringgetPageNumberingStart()
Get page numbering start.
public
getPageNumberingStart() : null|int
Return values
null|intgetPageSizeH()
Get Page Size Height.
public
getPageSizeH() : null|float|int
Tags
Return values
null|float|intgetPageSizeW()
Get Page Size Width.
public
getPageSizeW() : null|float|int
Tags
Return values
null|float|intgetPaperSize()
Get paper size.
public
getPaperSize() : string
Return values
stringgetStyleName()
Get style name.
public
getStyleName() : string|null
Return values
string|nullgetVAlign()
Get vertical alignment.
public
getVAlign() : string|null
Return values
string|nullhasBorder()
Check if any of the border is not null.
public
hasBorder() : bool
Return values
boolisAuto()
Get is automatic style flag.
public
isAuto() : bool
Return values
boolsetAuto()
Set is automatic style flag.
public
setAuto([bool $value = true ]) : self
Parameters
- $value : bool = true
Return values
selfsetBorderBottomColor()
Set border bottom color.
public
setBorderBottomColor([null|string $value = null ]) : self
Parameters
- $value : null|string = null
Return values
selfsetBorderBottomSize()
Set border bottom size.
public
setBorderBottomSize([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetBorderBottomStyle()
Set border bottom style.
public
setBorderBottomStyle([string $value = null ]) : self
Parameters
- $value : string = null
Return values
selfsetBorderColor()
Set border color.
public
setBorderColor([null|string $value = null ]) : self
Parameters
- $value : null|string = null
Return values
selfsetBorderLeftColor()
Set border left color.
public
setBorderLeftColor([null|string $value = null ]) : self
Parameters
- $value : null|string = null
Return values
selfsetBorderLeftSize()
Set border left size.
public
setBorderLeftSize([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetBorderLeftStyle()
Set border left style.
public
setBorderLeftStyle([string $value = null ]) : self
Parameters
- $value : string = null
Return values
selfsetBorderRightColor()
Set border right color.
public
setBorderRightColor([null|string $value = null ]) : self
Parameters
- $value : null|string = null
Return values
selfsetBorderRightSize()
Set border right size.
public
setBorderRightSize([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetBorderRightStyle()
Set border right style.
public
setBorderRightStyle([string $value = null ]) : self
Parameters
- $value : string = null
Return values
selfsetBorderSize()
Set border size.
public
setBorderSize([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetBorderStyle()
Set border style.
public
setBorderStyle([string $value = null ]) : self
Parameters
- $value : string = null
Return values
selfsetBorderTopColor()
Set border top color.
public
setBorderTopColor([null|string $value = null ]) : self
Parameters
- $value : null|string = null
Return values
selfsetBorderTopSize()
Set border top size.
public
setBorderTopSize([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetBorderTopStyle()
Set border top Style.
public
setBorderTopStyle([string $value = null ]) : self
Parameters
- $value : string = null
Return values
selfsetBreakType()
Set Break Type.
public
setBreakType([string $value = null ]) : self
Parameters
- $value : string = null
Return values
selfsetColsNum()
Set Section Columns Count.
public
setColsNum([int $value = null ]) : self
Parameters
- $value : int = null
Return values
selfsetColsSpace()
Set Section Space Between Columns.
public
setColsSpace([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetFooterHeight()
Set Footer Height.
public
setFooterHeight([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetGutter()
Set gutter.
public
setGutter([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetHeaderHeight()
Set Header Height.
public
setHeaderHeight([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetIndex()
Set index number.
public
setIndex([null|int $value = null ]) : self
Parameters
- $value : null|int = null
Return values
selfsetLandscape()
Set Landscape Orientation.
public
setLandscape() : self
Return values
selfsetLineNumbering()
Set line numbering.
public
setLineNumbering([mixed $value = null ]) : self
Parameters
- $value : mixed = null
Return values
selfsetMarginBottom()
Set Margin Bottom.
public
setMarginBottom([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetMarginLeft()
Set Margin Left.
public
setMarginLeft([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetMarginRight()
Set Margin Right.
public
setMarginRight([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetMarginTop()
Set Margin Top.
public
setMarginTop([float|int $value = null ]) : self
Parameters
- $value : float|int = null
Return values
selfsetOrientation()
Set orientation.
public
setOrientation([string $value = null ]) : self
Parameters
- $value : string = null
Return values
selfsetPageNumberingStart()
Set page numbering start.
public
setPageNumberingStart([null|int $pageNumberingStart = null ]) : self
Parameters
- $pageNumberingStart : null|int = null
Return values
selfsetPageSizeH()
public
setPageSizeH([null|float|int $value = null ]) : Section
Parameters
- $value : null|float|int = null
Tags
Return values
SectionsetPageSizeW()
public
setPageSizeW([null|float|int $value = null ]) : Section
Parameters
- $value : null|float|int = null
Tags
Return values
SectionsetPaperSize()
Set paper size.
public
setPaperSize([string $value = '' ]) : self
Parameters
- $value : string = ''
Return values
selfsetPortrait()
Set Portrait Orientation.
public
setPortrait() : self
Return values
selfsetSettingValue()
Set Setting Value.
public
setSettingValue(string $key, array<string|int, mixed>|int|string $value) : self
Parameters
- $key : string
- $value : array<string|int, mixed>|int|string
Return values
selfsetStyleByArray()
Set style by using associative array.
public
setStyleByArray([array<string|int, mixed> $values = [] ]) : self
Parameters
- $values : array<string|int, mixed> = []
Return values
selfsetStyleName()
Set style name.
public
setStyleName(string $value) : self
Parameters
- $value : string
Return values
selfsetStyleValue()
Set style value template method.
public
setStyleValue(string $key, array<string|int, mixed>|int|string $value) : self
Some child classes have their own specific overrides. Backward compability check for versions < 0.10.0 which use underscore prefix for their private properties. Check if the set method is exists. Throws an exception?
Parameters
- $key : string
- $value : array<string|int, mixed>|int|string
Return values
selfsetVAlign()
Set vertical alignment.
public
setVAlign([string $value = null ]) : self
Parameters
- $value : string = null
Return values
selfsetBoolVal()
Set bool value.
protected
setBoolVal(bool $value, bool $default) : bool
Parameters
- $value : bool
- $default : bool
Return values
boolsetEnumVal()
Set enum value.
protected
setEnumVal([mixed $value = null ][, array<string|int, mixed> $enum = [] ][, mixed $default = null ]) : mixed
Parameters
- $value : mixed = null
- $enum : array<string|int, mixed> = []
- $default : mixed = null
setFloatVal()
Set float value: Convert string that contains only numeric into float.
protected
setFloatVal(mixed $value[, null|float $default = null ]) : null|float
Parameters
- $value : mixed
- $default : null|float = null
Return values
null|floatsetIntVal()
Set integer value: Convert string that contains only numeric into integer.
protected
setIntVal(null|float|int|string $value[, null|int $default = null ]) : null|int
Parameters
- $value : null|float|int|string
- $default : null|int = null
Return values
null|intsetNonEmptyVal()
Set default for null and empty value.
protected
setNonEmptyVal(string|null $value, string $default) : string
Parameters
- $value : string|null
- $default : string
Return values
stringsetNumericVal()
Set numeric value.
protected
setNumericVal(mixed $value[, null|float|int $default = null ]) : null|float|int
Parameters
- $value : mixed
- $default : null|float|int = null
Return values
null|float|intsetObjectVal()
Set object value.
protected
setObjectVal(mixed $value, string $styleName, mixed &$style) : mixed
Parameters
- $value : mixed
- $styleName : string
- $style : mixed
setPairedVal()
Set $property value and set $pairProperty = false when $value = true.
protected
setPairedVal(bool &$property, bool &$pairProperty, bool $value) : self
Parameters
- $property : bool
- $pairProperty : bool
- $value : bool