Documentation

Table extends Border
in package

Border style.

Table of Contents

Constants

DEFAULT_MARGIN  = 1440
LAYOUT_AUTO  = 'autofit'
AutoFit Table Layout.
LAYOUT_FIXED  = 'fixed'
Fixed Width Table Layout.

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.
$cellSpacing  : null|float|int
$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.
$alignment  : string
$bidiVisual  : bool|null
Visually Right to Left Table.
$borderInsideHColor  : string
Border color inside horizontal.
$borderInsideHSize  : int
Border size inside horizontal.
$borderInsideVColor  : string
Border color inside vertical.
$borderInsideVSize  : int
Border size inside vertical.
$cellMarginBottom  : int
Cell margin bottom.
$cellMarginLeft  : int
Cell margin left.
$cellMarginRight  : int
Cell margin right.
$cellMarginTop  : int
Cell margin top.
$columnWidths  : array<string|int, int>
The width of each column, computed based on the max cell width of each column.
$firstRowStyle  : Table
Style for first row.
$indent  : null|TblWidth
$isAuto  : bool
Is this an automatic style? (Used primarily in OpenDocument driver).
$isFirstRow  : bool
Is this a first row style?
$layout  : string
$position  : TablePosition|null
Position.
$shading  : Shading
Shading.
$unit  : string
$width  : float|int

Methods

__construct()  : mixed
Create new table style.
getAlignment()  : string
getBgColor()  : string|null
Get background.
getBorderBottomColor()  : null|string
Get border bottom color.
getBorderBottomSize()  : float|int
Get border bottom size.
getBorderBottomStyle()  : string
Get border bottom style.
getBorderColor()  : array<string|int, string>
Get TLRBHV Border Color.
getBorderInsideHColor()  : string
Get border color inside horizontal.
getBorderInsideHSize()  : int
Get border size inside horizontal.
getBorderInsideVColor()  : string
Get border color inside vertical.
getBorderInsideVSize()  : int
Get border size inside vertical.
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 TLRBHV 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.
getCellMargin()  : array<string|int, int>
Get cell margin.
getCellMarginBottom()  : int
Get cell margin bottom.
getCellMarginLeft()  : int
Get cell margin left.
getCellMarginRight()  : int
Get cell margin right.
getCellMarginTop()  : int
Get cell margin top.
getCellSpacing()  : null|float|int
getChildStyleValue()  : mixed
Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`.
getColumnWidths()  : null|array<string|int, int>
Get the columnWidths.
getFirstRow()  : Table
Set first row.
getIndent()  : TblWidth|null
getIndex()  : null|int
Get index number.
getLayout()  : string
Get layout.
getMarginBottom()  : float|int
Get Margin Bottom.
getMarginLeft()  : float|int
Get Margin Left.
getMarginRight()  : float|int
Get Margin Right.
getMarginTop()  : float|int
Get Margin Top.
getPosition()  : TablePosition|null
Get position.
getShading()  : Shading
Get shading.
getStyleName()  : string|null
Get style name.
getUnit()  : string
Get width unit.
getWidth()  : float|int
Get width.
hasBorder()  : bool
Check if any of the border is not null.
hasMargin()  : bool
Check if any of the margin is not null.
isAuto()  : bool
Get is automatic style flag.
isBidiVisual()  : bool|null
Get bidiVisual.
setAlignment()  : self
setAuto()  : self
Set is automatic style flag.
setBgColor()  : self
Set background.
setBidiVisual()  : self
Set bidiVisual.
setBorderBottomColor()  : self
Set border bottom color.
setBorderBottomSize()  : self
Set border bottom size.
setBorderBottomStyle()  : self
Set border bottom style.
setBorderColor()  : self
Set TLRBHV Border Color.
setBorderInsideHColor()  : self
Set border color inside horizontal.
setBorderInsideHSize()  : self
Set border size inside horizontal.
setBorderInsideVColor()  : self
Set border color inside vertical.
setBorderInsideVSize()  : self
Set border size inside vertical.
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 TLRBHV 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.
setCellMargin()  : self
Set TLRB cell margin.
setCellMarginBottom()  : self
Set cell margin bottom.
setCellMarginLeft()  : self
Set cell margin left.
setCellMarginRight()  : self
Set cell margin right.
setCellMarginTop()  : self
Set cell margin top.
setCellSpacing()  : void
setColumnWidths()  : void
The column widths.
setIndent()  : self
setIndex()  : self
Set index number.
setLayout()  : self
Set layout.
setMarginBottom()  : self
Set Margin Bottom.
setMarginLeft()  : self
Set Margin Left.
setMarginRight()  : self
Set Margin Right.
setMarginTop()  : self
Set Margin Top.
setPosition()  : self
Set position.
setShading()  : self
Set shading.
setStyleByArray()  : self
Set style by using associative array.
setStyleName()  : self
Set style name.
setStyleValue()  : self
Set style value template method.
setUnit()  : self
Set width unit.
setWidth()  : self
Set width.
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.
getTableOnlyProperty()  : null|int|string
Get table style only property by checking if it's a firstRow.
setTableOnlyProperty()  : self
Set table style only property by checking if it's a firstRow.

Constants

DEFAULT_MARGIN

public mixed DEFAULT_MARGIN = 1440

LAYOUT_AUTO

AutoFit Table Layout.

public string LAYOUT_AUTO = 'autofit'

LAYOUT_FIXED

Fixed Width Table Layout.

public string LAYOUT_FIXED = 'fixed'

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

$cellSpacing

protected null|float|int $cellSpacing

cell spacing value

$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

$alignment

private string $alignment = ''

$borderInsideHColor

Border color inside horizontal.

private string $borderInsideHColor

$borderInsideHSize

Border size inside horizontal.

private int $borderInsideHSize

$borderInsideVColor

Border color inside vertical.

private string $borderInsideVColor

$borderInsideVSize

Border size inside vertical.

private int $borderInsideVSize

$cellMarginBottom

Cell margin bottom.

private int $cellMarginBottom

$cellMarginLeft

Cell margin left.

private int $cellMarginLeft

$cellMarginRight

Cell margin right.

private int $cellMarginRight

$cellMarginTop

Cell margin top.

private int $cellMarginTop

$columnWidths

The width of each column, computed based on the max cell width of each column.

private array<string|int, int> $columnWidths

$firstRowStyle

Style for first row.

private Table $firstRowStyle

$isAuto

Is this an automatic style? (Used primarily in OpenDocument driver).

private bool $isAuto = false
Tags
since
0.11.0

$isFirstRow

Is this a first row style?

private bool $isFirstRow = false

$layout

private string $layout = self::LAYOUT_AUTO

Table Layout

$unit

private string $unit = \PhpOffice\PhpWord\SimpleType\TblWidth::AUTO

Width unit

$width

private float|int $width = 0

Width value

Methods

__construct()

Create new table style.

public __construct([mixed $tableStyle = null ][, mixed $firstRowStyle = null ]) : mixed
Parameters
$tableStyle : mixed = null
$firstRowStyle : mixed = null

getAlignment()

public getAlignment() : string
Tags
since
0.13.0
Return values
string

getBgColor()

Get background.

public getBgColor() : string|null
Return values
string|null

getBorderBottomColor()

Get border bottom color.

public getBorderBottomColor() : null|string
Return values
null|string

getBorderBottomSize()

Get border bottom size.

public getBorderBottomSize() : float|int
Return values
float|int

getBorderBottomStyle()

Get border bottom style.

public getBorderBottomStyle() : string
Return values
string

getBorderColor()

Get TLRBHV Border Color.

public getBorderColor() : array<string|int, string>
Return values
array<string|int, string>

getBorderInsideHColor()

Get border color inside horizontal.

public getBorderInsideHColor() : string
Return values
string

getBorderInsideHSize()

Get border size inside horizontal.

public getBorderInsideHSize() : int
Return values
int

getBorderInsideVColor()

Get border color inside vertical.

public getBorderInsideVColor() : string
Return values
string

getBorderInsideVSize()

Get border size inside vertical.

public getBorderInsideVSize() : int
Return values
int

getBorderLeftColor()

Get border left color.

public getBorderLeftColor() : null|string
Return values
null|string

getBorderLeftSize()

Get border left size.

public getBorderLeftSize() : float|int
Return values
float|int

getBorderLeftStyle()

Get border left style.

public getBorderLeftStyle() : string
Return values
string

getBorderRightColor()

Get border right color.

public getBorderRightColor() : null|string
Return values
null|string

getBorderRightSize()

Get border right size.

public getBorderRightSize() : float|int
Return values
float|int

getBorderRightStyle()

Get border right style.

public getBorderRightStyle() : string
Return values
string

getBorderSize()

Get TLRBHV 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|string

getBorderTopSize()

Get border top size.

public getBorderTopSize() : float|int
Return values
float|int

getBorderTopStyle()

Get border top style.

public getBorderTopStyle() : string
Return values
string

getCellMargin()

Get cell margin.

public getCellMargin() : array<string|int, int>
Return values
array<string|int, int>

getCellMarginBottom()

Get cell margin bottom.

public getCellMarginBottom() : int
Return values
int

getCellMarginLeft()

Get cell margin left.

public getCellMarginLeft() : int
Return values
int

getCellMarginRight()

Get cell margin right.

public getCellMarginRight() : int
Return values
int

getCellMarginTop()

Get cell margin top.

public getCellMarginTop() : int
Return values
int

getCellSpacing()

public getCellSpacing() : null|float|int
Return values
null|float|int

getChildStyleValue()

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
since
0.12.0

getColumnWidths()

Get the columnWidths.

public getColumnWidths() : null|array<string|int, int>
Return values
null|array<string|int, int>

getFirstRow()

Set first row.

public getFirstRow() : Table
Return values
Table

getIndex()

Get index number.

public getIndex() : null|int
Return values
null|int

getLayout()

Get layout.

public getLayout() : string
Return values
string

getMarginBottom()

Get Margin Bottom.

public getMarginBottom() : float|int
Return values
float|int

getMarginLeft()

Get Margin Left.

public getMarginLeft() : float|int
Return values
float|int

getMarginRight()

Get Margin Right.

public getMarginRight() : float|int
Return values
float|int

getMarginTop()

Get Margin Top.

public getMarginTop() : float|int
Return values
float|int

getStyleName()

Get style name.

public getStyleName() : string|null
Return values
string|null

getUnit()

Get width unit.

public getUnit() : string
Return values
string

getWidth()

Get width.

public getWidth() : float|int
Return values
float|int

hasBorder()

Check if any of the border is not null.

public hasBorder() : bool
Return values
bool

hasMargin()

Check if any of the margin is not null.

public hasMargin() : bool
Return values
bool

isAuto()

Get is automatic style flag.

public isAuto() : bool
Return values
bool

isBidiVisual()

Get bidiVisual.

public isBidiVisual() : bool|null
Return values
bool|null

setAlignment()

public setAlignment(string $value) : self
Parameters
$value : string
Tags
since
0.13.0
Return values
self

setAuto()

Set is automatic style flag.

public setAuto([bool $value = true ]) : self
Parameters
$value : bool = true
Return values
self

setBgColor()

Set background.

public setBgColor([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setBidiVisual()

Set bidiVisual.

public setBidiVisual(bool|null $bidi) : self
Parameters
$bidi : bool|null

Set to true to visually present table as Right to Left

Return values
self

setBorderBottomColor()

Set border bottom color.

public setBorderBottomColor([null|string $value = null ]) : self
Parameters
$value : null|string = null
Return values
self

setBorderBottomSize()

Set border bottom size.

public setBorderBottomSize([float|int $value = null ]) : self
Parameters
$value : float|int = null
Return values
self

setBorderBottomStyle()

Set border bottom style.

public setBorderBottomStyle([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setBorderColor()

Set TLRBHV Border Color.

public setBorderColor([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setBorderInsideHColor()

Set border color inside horizontal.

public setBorderInsideHColor([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setBorderInsideHSize()

Set border size inside horizontal.

public setBorderInsideHSize([int $value = null ]) : self
Parameters
$value : int = null
Return values
self

setBorderInsideVColor()

Set border color inside vertical.

public setBorderInsideVColor([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setBorderInsideVSize()

Set border size inside vertical.

public setBorderInsideVSize([int $value = null ]) : self
Parameters
$value : int = null
Return values
self

setBorderLeftColor()

Set border left color.

public setBorderLeftColor([null|string $value = null ]) : self
Parameters
$value : null|string = null
Return values
self

setBorderLeftSize()

Set border left size.

public setBorderLeftSize([float|int $value = null ]) : self
Parameters
$value : float|int = null
Return values
self

setBorderLeftStyle()

Set border left style.

public setBorderLeftStyle([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setBorderRightColor()

Set border right color.

public setBorderRightColor([null|string $value = null ]) : self
Parameters
$value : null|string = null
Return values
self

setBorderRightSize()

Set border right size.

public setBorderRightSize([float|int $value = null ]) : self
Parameters
$value : float|int = null
Return values
self

setBorderRightStyle()

Set border right style.

public setBorderRightStyle([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setBorderSize()

Set TLRBHV Border Size.

public setBorderSize([int $value = null ]) : self
Parameters
$value : int = null

Border size in eighths of a point (1/8 point)

Return values
self

setBorderStyle()

Set border style.

public setBorderStyle([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setBorderTopColor()

Set border top color.

public setBorderTopColor([null|string $value = null ]) : self
Parameters
$value : null|string = null
Return values
self

setBorderTopSize()

Set border top size.

public setBorderTopSize([float|int $value = null ]) : self
Parameters
$value : float|int = null
Return values
self

setBorderTopStyle()

Set border top Style.

public setBorderTopStyle([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setCellMargin()

Set TLRB cell margin.

public setCellMargin([int $value = null ]) : self
Parameters
$value : int = null

Margin in twips

Return values
self

setCellMarginBottom()

Set cell margin bottom.

public setCellMarginBottom([int $value = null ]) : self
Parameters
$value : int = null
Return values
self

setCellMarginLeft()

Set cell margin left.

public setCellMarginLeft([int $value = null ]) : self
Parameters
$value : int = null
Return values
self

setCellMarginRight()

Set cell margin right.

public setCellMarginRight([int $value = null ]) : self
Parameters
$value : int = null
Return values
self

setCellMarginTop()

Set cell margin top.

public setCellMarginTop([int $value = null ]) : self
Parameters
$value : int = null
Return values
self

setCellSpacing()

public setCellSpacing([null|float|int $cellSpacing = null ]) : void
Parameters
$cellSpacing : null|float|int = null

setColumnWidths()

The column widths.

public setColumnWidths([array<string|int, int> $value = null ]) : void
Parameters
$value : array<string|int, int> = null

setIndex()

Set index number.

public setIndex([null|int $value = null ]) : self
Parameters
$value : null|int = null
Return values
self

setLayout()

Set layout.

public setLayout([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setMarginBottom()

Set Margin Bottom.

public setMarginBottom([float|int $value = null ]) : self
Parameters
$value : float|int = null
Return values
self

setMarginLeft()

Set Margin Left.

public setMarginLeft([float|int $value = null ]) : self
Parameters
$value : float|int = null
Return values
self

setMarginRight()

Set Margin Right.

public setMarginRight([float|int $value = null ]) : self
Parameters
$value : float|int = null
Return values
self

setMarginTop()

Set Margin Top.

public setMarginTop([float|int $value = null ]) : self
Parameters
$value : float|int = null
Return values
self

setPosition()

Set position.

public setPosition([mixed $value = null ]) : self
Parameters
$value : mixed = null
Return values
self

setShading()

Set shading.

public setShading([mixed $value = null ]) : self
Parameters
$value : mixed = null
Return values
self

setStyleByArray()

Set style by using associative array.

public setStyleByArray([array<string|int, mixed> $values = [] ]) : self
Parameters
$values : array<string|int, mixed> = []
Return values
self

setStyleName()

Set style name.

public setStyleName(string $value) : self
Parameters
$value : string
Return values
self

setStyleValue()

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
self

setUnit()

Set width unit.

public setUnit([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setWidth()

Set width.

public setWidth([float|int $value = null ]) : self
Parameters
$value : float|int = null
Return values
self

setBoolVal()

Set bool value.

protected setBoolVal(bool $value, bool $default) : bool
Parameters
$value : bool
$default : bool
Return values
bool

setEnumVal()

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|float

setIntVal()

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|int

setNonEmptyVal()

Set default for null and empty value.

protected setNonEmptyVal(string|null $value, string $default) : string
Parameters
$value : string|null
$default : string
Return values
string

setNumericVal()

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|int

setObjectVal()

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
Return values
self

getTableOnlyProperty()

Get table style only property by checking if it's a firstRow.

private getTableOnlyProperty(string $property) : null|int|string

This is necessary since firstRow style is cloned from table style but without certain properties activated, e.g. margins

Parameters
$property : string
Return values
null|int|string

setTableOnlyProperty()

Set table style only property by checking if it's a firstRow.

private setTableOnlyProperty(string $property, int|string $value[, bool $isNumeric = true ]) : self

This is necessary since firstRow style is cloned from table style but without certain properties activated, e.g. margins

Parameters
$property : string
$value : int|string
$isNumeric : bool = true
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results