Row extends AbstractStyle
Table row style
Tags
Table of Contents
- $aliases : array<string|int, mixed>
- Aliases
- $index : int|null
- Index number in Style collection for named style
- $styleName : string
- Style name
- $cantSplit : bool
- Table row cannot break across pages
- $exactHeight : bool
- Table row exact height
- $isAuto : bool
- Is this an automatic style? (Used primarily in OpenDocument driver)
- $tblHeader : bool
- Repeat table row on every new page
- __construct() : mixed
- Create a new row style
- getCantSplit() : mixed
- Get cantSplit
- getChildStyleValue() : mixed
- Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`
- getExactHeight() : mixed
- Get exactHeight
- getIndex() : int|null
- Get index number
- getStyleName() : string
- Get style name
- getTblHeader() : mixed
- Get tblHeader
- isAuto() : bool
- Get is automatic style flag
- isCantSplit() : bool
- Is cantSplit
- isExactHeight() : bool
- Is exactHeight
- isTblHeader() : bool
- Is tblHeader
- setArrayStyle() : self
- Set style using associative array
- setAuto() : self
- Set is automatic style flag
- setCantSplit() : self
- Is cantSplit
- setExactHeight() : self
- Set exactHeight
- setIndex() : self
- Set index number
- setStyleByArray() : self
- Set style by using associative array
- setStyleName() : self
- Set style name
- setStyleValue() : self
- Set style value template method
- setTblHeader() : self
- Is tblHeader
- setBoolVal() : bool
- Set bool value
- setEnumVal() : mixed
- Set enum value
- setFloatVal() : float|null
- Set float value: Convert string that contains only numeric into float
- setIntVal() : int|null
- Set integer value: Convert string that contains only numeric into integer
- setNonEmptyVal() : string
- Set default for null and empty value
- setNumericVal() : int|float|null
- Set numeric value
- setObjectVal() : mixed
- Set object value
- setPairedVal() : self
- Set $property value and set $pairProperty = false when $value = true
Properties
$aliases
Aliases
protected
array<string|int, mixed>
$aliases
= array()
$index
Index number in Style collection for named style
protected
int|null
$index
This number starts from one and defined in Style::setStyleValues()
$styleName
Style name
protected
string
$styleName
$cantSplit
Table row cannot break across pages
private
bool
$cantSplit
= false
$exactHeight
Table row exact height
private
bool
$exactHeight
= false
$isAuto
Is this an automatic style? (Used primarily in OpenDocument driver)
private
bool
$isAuto
= false
Tags
$tblHeader
Repeat table row on every new page
private
bool
$tblHeader
= false
Methods
__construct()
Create a new row style
public
__construct() : mixed
Return values
mixed —getCantSplit()
Get cantSplit
public
getCantSplit() : mixed
Tags
Return values
mixed —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
Return values
mixed —getExactHeight()
Get exactHeight
public
getExactHeight() : mixed
Tags
Return values
mixed —getIndex()
Get index number
public
getIndex() : int|null
Return values
int|null —getStyleName()
Get style name
public
getStyleName() : string
Return values
string —getTblHeader()
Get tblHeader
public
getTblHeader() : mixed
Tags
Return values
mixed —isAuto()
Get is automatic style flag
public
isAuto() : bool
Return values
bool —isCantSplit()
Is cantSplit
public
isCantSplit() : bool
Return values
bool —isExactHeight()
Is exactHeight
public
isExactHeight() : bool
Return values
bool —isTblHeader()
Is tblHeader
public
isTblHeader() : bool
Return values
bool —setArrayStyle()
Set style using associative array
public
setArrayStyle([array<string|int, mixed> $style = array() ]) : self
Parameters
- $style : array<string|int, mixed> = array()
Tags
Return values
self —setAuto()
Set is automatic style flag
public
setAuto([bool $value = true ]) : self
Parameters
- $value : bool = true
Return values
self —setCantSplit()
Is cantSplit
public
setCantSplit([bool $value = true ]) : self
Parameters
- $value : bool = true
Return values
self —setExactHeight()
Set exactHeight
public
setExactHeight([bool $value = true ]) : self
Parameters
- $value : bool = true
Return values
self —setIndex()
Set index number
public
setIndex([int|null $value = null ]) : self
Parameters
- $value : int|null = null
Return values
self —setStyleByArray()
Set style by using associative array
public
setStyleByArray([array<string|int, mixed> $values = array() ]) : self
Parameters
- $values : array<string|int, mixed> = array()
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, 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 : string
Return values
self —setTblHeader()
Is tblHeader
public
setTblHeader([bool $value = true ]) : self
Parameters
- $value : bool = true
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 = array() ][, mixed $default = null ]) : mixed
Parameters
- $value : mixed = null
- $enum : array<string|int, mixed> = array()
- $default : mixed = null
Tags
Return values
mixed —setFloatVal()
Set float value: Convert string that contains only numeric into float
protected
setFloatVal(mixed $value[, float|null $default = null ]) : float|null
Parameters
- $value : mixed
- $default : float|null = null
Return values
float|null —setIntVal()
Set integer value: Convert string that contains only numeric into integer
protected
setIntVal(int|null $value[, int|null $default = null ]) : int|null
Parameters
- $value : int|null
- $default : int|null = null
Return values
int|null —setNonEmptyVal()
Set default for null and empty value
protected
setNonEmptyVal(string $value, string $default) : string
Parameters
- $value : string
-
(was: mixed)
- $default : string
-
(was: mixed)
Return values
string —(was: mixed)
setNumericVal()
Set numeric value
protected
setNumericVal(mixed $value[, int|float|null $default = null ]) : int|float|null
Parameters
- $value : mixed
- $default : int|float|null = null
Return values
int|float|null —setObjectVal()
Set object value
protected
setObjectVal(mixed $value, string $styleName, mixed &$style) : mixed
Parameters
- $value : mixed
- $styleName : string
- $style : mixed
Return values
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