\PhpOffice\PhpWord\StyleTable

getBorderSize()

getBorderSize() : array<mixed,integer>

Get TLRBHV Border Size

Returns

setBorderSize()

setBorderSize(integer  $value = null) : self

Set TLRBHV Border Size

Parameters

Returns

getBorderColor()

getBorderColor() : array<mixed,string>

Get TLRBHV Border Color

Returns

setBorderColor()

setBorderColor(string  $value = null) : self

Set TLRBHV Border Color

Parameters

Returns

getBorderStyle()

getBorderStyle() : array<mixed,string>

Get border style

Returns

setBorderStyle()

setBorderStyle(string  $value = null) : self

Set border style

Parameters

Returns

getBorderTopSize()

getBorderTopSize() : integer|float

Get border top size

Returns

setBorderTopSize()

setBorderTopSize(integer|float  $value = null) : self

Set border top size

Parameters

Returns

getBorderTopColor()

getBorderTopColor() : string

Get border top color

Returns

setBorderTopColor()

setBorderTopColor(string  $value = null) : self

Set border top color

Parameters

Returns

getBorderTopStyle()

getBorderTopStyle() : string

Get border top style

Returns

setBorderTopStyle()

setBorderTopStyle(string  $value = null) : self

Set border top Style

Parameters

Returns

getBorderLeftSize()

getBorderLeftSize() : integer|float

Get border left size

Returns

setBorderLeftSize()

setBorderLeftSize(integer|float  $value = null) : self

Set border left size

Parameters

Returns

getBorderLeftColor()

getBorderLeftColor() : string

Get border left color

Returns

setBorderLeftColor()

setBorderLeftColor(string  $value = null) : self

Set border left color

Parameters

Returns

getBorderLeftStyle()

getBorderLeftStyle() : string

Get border left style

Returns

setBorderLeftStyle()

setBorderLeftStyle(string  $value = null) : self

Set border left style

Parameters

Returns

getBorderRightSize()

getBorderRightSize() : integer|float

Get border right size

Returns

setBorderRightSize()

setBorderRightSize(integer|float  $value = null) : self

Set border right size

Parameters

Returns

getBorderRightColor()

getBorderRightColor() : string

Get border right color

Returns

setBorderRightColor()

setBorderRightColor(string  $value = null) : self

Set border right color

Parameters

Returns

getBorderRightStyle()

getBorderRightStyle() : string

Get border right style

Returns

setBorderRightStyle()

setBorderRightStyle(string  $value = null) : self

Set border right style

Parameters

Returns

getBorderBottomSize()

getBorderBottomSize() : integer|float

Get border bottom size

Returns

setBorderBottomSize()

setBorderBottomSize(integer|float  $value = null) : self

Set border bottom size

Parameters

Returns

getBorderBottomColor()

getBorderBottomColor() : string

Get border bottom color

Returns

setBorderBottomColor()

setBorderBottomColor(string  $value = null) : self

Set border bottom color

Parameters

Returns

getBorderBottomStyle()

getBorderBottomStyle() : string

Get border bottom style

Returns

setBorderBottomStyle()

setBorderBottomStyle(string  $value = null) : self

Set border bottom style

Parameters

Returns

hasBorder()

hasBorder() : boolean

Check if any of the border is not null

Returns

getStyleName()

getStyleName() : string

Get style name

Returns

setStyleName()

setStyleName(string  $value) : self

Set style name

Parameters

Returns

getIndex()

getIndex() : integer|null

Get index number

Returns

setIndex()

setIndex(integer|null  $value = null) : self

Set index number

Parameters

Returns

isAuto()

isAuto() : boolean

Get is automatic style flag

Returns

setAuto()

setAuto(boolean  $value = true) : self

Set is automatic style flag

Parameters

Returns

getChildStyleValue()

getChildStyleValue(\PhpOffice\PhpWord\Style\AbstractStyle  $substyleObject, string  $substyleProperty) : mixed

Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`

Parameters

Returns

setStyleValue()

setStyleValue(string  $key, string  $value) : self

Set style value template method

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

Returns

setStyleByArray()

setStyleByArray(array  $values = array()) : self

Set style by using associative array

Parameters

Returns

setArrayStyle()

setArrayStyle(array  $style = array()) : self

Set style using associative array

Parameters

Returns

__construct()

__construct(mixed  $tableStyle = null, mixed  $firstRowStyle = null) 

Create new table style

Parameters

setCellSpacing()

setCellSpacing(float|integer  $cellSpacing = null) 

Parameters

getCellSpacing()

getCellSpacing() : float|integer

Returns

getFirstRow()

getFirstRow() : \PhpOffice\PhpWord\Style\Table

Set first row

Returns

getBgColor()

getBgColor() : string

Get background

Returns

setBgColor()

setBgColor(string  $value = null) : self

Set background

Parameters

Returns

getBorderInsideHSize()

getBorderInsideHSize() : integer

Get border size inside horizontal

Returns

setBorderInsideHSize()

setBorderInsideHSize(integer  $value = null) : self

Set border size inside horizontal

Parameters

Returns

getBorderInsideHColor()

getBorderInsideHColor() : string

Get border color inside horizontal

Returns

setBorderInsideHColor()

setBorderInsideHColor(string  $value = null) : self

Set border color inside horizontal

Parameters

Returns

getBorderInsideVSize()

getBorderInsideVSize() : integer

Get border size inside vertical

Returns

setBorderInsideVSize()

setBorderInsideVSize(integer  $value = null) : self

Set border size inside vertical

Parameters

Returns

getBorderInsideVColor()

getBorderInsideVColor() : string

Get border color inside vertical

Returns

setBorderInsideVColor()

setBorderInsideVColor(string  $value = null) : self

Set border color inside vertical

Parameters

Returns

getCellMarginTop()

getCellMarginTop() : integer

Get cell margin top

Returns

setCellMarginTop()

setCellMarginTop(integer  $value = null) : self

Set cell margin top

Parameters

Returns

getCellMarginLeft()

getCellMarginLeft() : integer

Get cell margin left

Returns

setCellMarginLeft()

setCellMarginLeft(integer  $value = null) : self

Set cell margin left

Parameters

Returns

getCellMarginRight()

getCellMarginRight() : integer

Get cell margin right

Returns

setCellMarginRight()

setCellMarginRight(integer  $value = null) : self

Set cell margin right

Parameters

Returns

getCellMarginBottom()

getCellMarginBottom() : integer

Get cell margin bottom

Returns

setCellMarginBottom()

setCellMarginBottom(integer  $value = null) : self

Set cell margin bottom

Parameters

Returns

getCellMargin()

getCellMargin() : array<mixed,integer>

Get cell margin

Returns

setCellMargin()

setCellMargin(integer  $value = null) : self

Set TLRB cell margin

Parameters

Returns

hasMargin()

hasMargin() : boolean

Check if any of the margin is not null

Returns

getShading()

getShading() : \PhpOffice\PhpWord\Style\Shading

Get shading

Returns

setShading()

setShading(mixed  $value = null) : self

Set shading

Parameters

Returns

getAlignment()

getAlignment() : string

Returns

setAlignment()

setAlignment(string  $value) : self

Parameters

Returns

getAlign()

getAlign() : string

Returns

setAlign()

setAlign(string  $value = null) : self

Parameters

Returns

getWidth()

getWidth() : integer|float

Get width

Returns

setWidth()

setWidth(integer|float  $value = null) : self

Set width

Parameters

Returns

getUnit()

getUnit() : string

Get width unit

Returns

setUnit()

setUnit(string  $value = null) : self

Set width unit

Parameters

Returns

getLayout()

getLayout() : string

Get layout

Returns

setLayout()

setLayout(string  $value = null) : self

Set layout

Parameters

Returns

getPosition()

getPosition() : \PhpOffice\PhpWord\Style\TablePosition

Get position

Returns

setPosition()

setPosition(mixed  $value = null) : self

Set position

Parameters

Returns

getIndent()

getIndent() : \PhpOffice\PhpWord\ComplexType\TblWidth

Returns

setIndent()

setIndent(\PhpOffice\PhpWord\ComplexType\TblWidth  $indent) : self

Parameters

Returns

getColumnWidths()

getColumnWidths() : array<mixed,\PhpOffice\PhpWord\Style\number>

Get the columnWidths

Returns

setColumnWidths()

setColumnWidths(array<mixed,integer>  $value = null) 

The column widths

Parameters

setNonEmptyVal()

setNonEmptyVal(string  $value, string  $default) : string

Set default for null and empty value

Parameters

Returns

(was: mixed)

setBoolVal()

setBoolVal(boolean  $value, boolean  $default) : boolean

Set bool value

Parameters

Returns

setNumericVal()

setNumericVal(mixed  $value, integer|float|null  $default = null) : integer|float|null

Set numeric value

Parameters

Returns

setIntVal()

setIntVal(integer|null  $value, integer|null  $default = null) : integer|null

Set integer value: Convert string that contains only numeric into integer

Parameters

Returns

setFloatVal()

setFloatVal(mixed  $value, float|null  $default = null) : float|null

Set float value: Convert string that contains only numeric into float

Parameters

Returns

setEnumVal()

setEnumVal(mixed  $value = null, array  $enum = array(), mixed  $default = null) : mixed

Set enum value

Parameters

Throws

\InvalidArgumentException

Returns

setObjectVal()

setObjectVal(mixed  $value, string  $styleName,   $style) : mixed

Set object value

Parameters

Returns

setPairedVal()

setPairedVal(  $property,   $pairProperty, boolean  $value) : self

Set $property value and set $pairProperty = false when $value = true

Parameters

Returns

getTableOnlyProperty()

getTableOnlyProperty(string  $property) : integer|string|null

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

Parameters

Returns

setTableOnlyProperty()

setTableOnlyProperty(string  $property, integer|string  $value, boolean  $isNumeric = true) : self

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

Parameters

Returns