Constants

VANCHOR_TEXT

VANCHOR_TEXT = 'text'

Vertical anchor constants

VANCHOR_MARGIN

VANCHOR_MARGIN = 'margin'

VANCHOR_PAGE

VANCHOR_PAGE = 'page'

HANCHOR_TEXT

HANCHOR_TEXT = 'text'

Horizontal anchor constants

HANCHOR_MARGIN

HANCHOR_MARGIN = 'margin'

HANCHOR_PAGE

HANCHOR_PAGE = 'page'

XALIGN_LEFT

XALIGN_LEFT = 'left'

Horizontal alignment constants

XALIGN_CENTER

XALIGN_CENTER = 'center'

XALIGN_RIGHT

XALIGN_RIGHT = 'right'

XALIGN_INSIDE

XALIGN_INSIDE = 'inside'

XALIGN_OUTSIDE

XALIGN_OUTSIDE = 'outside'

YALIGN_INLINE

YALIGN_INLINE = 'inline'

Vertical alignment constants

YALIGN_TOP

YALIGN_TOP = 'top'

YALIGN_CENTER

YALIGN_CENTER = 'center'

YALIGN_BOTTOM

YALIGN_BOTTOM = 'bottom'

YALIGN_INSIDE

YALIGN_INSIDE = 'inside'

YALIGN_OUTSIDE

YALIGN_OUTSIDE = 'outside'

Properties

$styleName

$styleName : string

Style name

Type

string

$index

$index : integer|null

Index number in Style collection for named style

This number starts from one and defined in Style::setStyleValues()

Type

integer|null

$aliases

$aliases : array

Aliases

Type

array

$isAuto

$isAuto : boolean

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

Type

boolean

$leftFromText

$leftFromText : integer

Distance from left of table to text

Type

integer

$rightFromText

$rightFromText : integer

Distance from right of table to text

Type

integer

$topFromText

$topFromText : integer

Distance from top of table to text

Type

integer

$bottomFromText

$bottomFromText : integer

Distance from bottom of table to text

Type

integer

$vertAnchor

$vertAnchor : string

Table vertical anchor

Type

string

$horzAnchor

$horzAnchor : string

Table horizontal anchor

Type

string

$tblpXSpec

$tblpXSpec : string

Relative horizontal alignment from anchor

Type

string

$tblpX

$tblpX : integer

Absolute horizontal distance from anchor

Type

integer

$tblpYSpec

$tblpYSpec : string

Relative vertical alignment from anchor

Type

string

$tblpY

$tblpY : integer

Absolute vertical distance from anchor

Type

integer

Methods

getStyleName()

getStyleName() : string

Get style name

Returns

string

setStyleName()

setStyleName(string  $value) : self

Set style name

Parameters

string $value

Returns

self

getIndex()

getIndex() : integer|null

Get index number

Returns

integer|null

setIndex()

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

Set index number

Parameters

integer|null $value

Returns

self

isAuto()

isAuto() : boolean

Get is automatic style flag

Returns

boolean

setAuto()

setAuto(boolean  $value = true) : self

Set is automatic style flag

Parameters

boolean $value

Returns

self

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

\PhpOffice\PhpWord\Style\AbstractStyle $substyleObject
string $substyleProperty

Returns

mixed

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

string $key
string $value

Returns

self

setStyleByArray()

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

Set style by using associative array

Parameters

array $values

Returns

self

setArrayStyle()

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

Set style using associative array

Parameters

array $style

Returns

self

__construct()

__construct(array  $style = array()) 

Create a new instance

Parameters

array $style

getLeftFromText()

getLeftFromText() : integer

Get distance from left of table to text

Returns

integer

setLeftFromText()

setLeftFromText(integer  $value = null) : self

Set distance from left of table to text

Parameters

integer $value

Returns

self

getRightFromText()

getRightFromText() : integer

Get distance from right of table to text

Returns

integer

setRightFromText()

setRightFromText(integer  $value = null) : self

Set distance from right of table to text

Parameters

integer $value

Returns

self

getTopFromText()

getTopFromText() : integer

Get distance from top of table to text

Returns

integer

setTopFromText()

setTopFromText(integer  $value = null) : self

Set distance from top of table to text

Parameters

integer $value

Returns

self

getBottomFromText()

getBottomFromText() : integer

Get distance from bottom of table to text

Returns

integer

setBottomFromText()

setBottomFromText(integer  $value = null) : self

Set distance from bottom of table to text

Parameters

integer $value

Returns

self

getVertAnchor()

getVertAnchor() : string

Get table vertical anchor

Returns

string

setVertAnchor()

setVertAnchor(string  $value = null) : self

Set table vertical anchor

Parameters

string $value

Returns

self

getHorzAnchor()

getHorzAnchor() : string

Get table horizontal anchor

Returns

string

setHorzAnchor()

setHorzAnchor(string  $value = null) : self

Set table horizontal anchor

Parameters

string $value

Returns

self

getTblpXSpec()

getTblpXSpec() : string

Get relative horizontal alignment from anchor

Returns

string

setTblpXSpec()

setTblpXSpec(string  $value = null) : self

Set relative horizontal alignment from anchor

Parameters

string $value

Returns

self

getTblpX()

getTblpX() : integer

Get absolute horizontal distance from anchor

Returns

integer

setTblpX()

setTblpX(integer  $value = null) : self

Set absolute horizontal distance from anchor

Parameters

integer $value

Returns

self

getTblpYSpec()

getTblpYSpec() : string

Get relative vertical alignment from anchor

Returns

string

setTblpYSpec()

setTblpYSpec(string  $value = null) : self

Set relative vertical alignment from anchor

Parameters

string $value

Returns

self

getTblpY()

getTblpY() : integer

Get absolute vertical distance from anchor

Returns

integer

setTblpY()

setTblpY(integer  $value = null) : self

Set absolute vertical distance from anchor

Parameters

integer $value

Returns

self

setNonEmptyVal()

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

Set default for null and empty value

Parameters

string $value

(was: mixed)

string $default

(was: mixed)

Returns

string —

(was: mixed)

setBoolVal()

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

Set bool value

Parameters

boolean $value
boolean $default

Returns

boolean

setNumericVal()

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

Set numeric value

Parameters

mixed $value
integer|float|null $default

Returns

integer|float|null

setIntVal()

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

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

Parameters

integer|null $value
integer|null $default

Returns

integer|null

setFloatVal()

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

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

Parameters

mixed $value
float|null $default

Returns

float|null

setEnumVal()

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

Set enum value

Parameters

mixed $value
array $enum
mixed $default

Throws

\InvalidArgumentException

Returns

mixed

setObjectVal()

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

Set object value

Parameters

mixed $value
string $styleName
$style

Returns

mixed

setPairedVal()

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

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

Parameters

$property
$pairProperty
boolean $value

Returns

self