Outline extends AbstractStyle
Outline defines the line/border of the object
Tags
Table of Contents
- ARROW_BLOCK = 'block'
- ARROW_CLASSIC = 'classic'
- ARROW_DIAMOND = 'diamond'
- ARROW_NONE = 'none'
- Arrowhead type constants
- ARROW_OPEN = 'open'
- ARROW_OVAL = 'oval'
- ENDCAP_FLAT = 'flat'
- Line style constants
- ENDCAP_ROUND = 'round'
- ENDCAP_SQUARE = 'square'
- LINE_SINGLE = 'single'
- Line style constants
- LINE_THICK_BETWEEN_THIN = 'thickBetweenThin'
- LINE_THICK_THIN = 'thickThin'
- LINE_THIN_THICK = 'thinThick'
- LINE_THIN_THIN = 'thinThin'
- $aliases : array<string|int, mixed>
- Aliases
- $index : int|null
- Index number in Style collection for named style
- $styleName : string
- Style name
- $color : string
- Outline color
- $dash : string
- Dash type
- $endArrow : string
- End arrow type
- $endCap : string
- End cap
- $isAuto : bool
- Is this an automatic style? (Used primarily in OpenDocument driver)
- $line : string
- Line style
- $startArrow : string
- Start arrow type
- $unit : string
- Unit; No set method for now
- $weight : int|float
- Outline weight
- __construct() : mixed
- Create a new instance
- getChildStyleValue() : mixed
- Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`
- getColor() : string
- Get color
- getDash() : string
- Get dash type
- getEndArrow() : string
- Get endArrow
- getEndCap() : string
- Get endCap style
- getIndex() : int|null
- Get index number
- getLine() : string
- Get line style
- getStartArrow() : string
- Get startArrow
- getStyleName() : string
- Get style name
- getUnit() : string
- Get unit
- getWeight() : int|float
- Get weight
- isAuto() : bool
- Get is automatic style flag
- setArrayStyle() : self
- Set style using associative array
- setAuto() : self
- Set is automatic style flag
- setColor() : self
- Set color
- setDash() : self
- Set dash type
- setEndArrow() : self
- Set pattern
- setEndCap() : self
- Set endCap style
- setIndex() : self
- Set index number
- setLine() : self
- Set line style
- setStartArrow() : self
- Set pattern
- setStyleByArray() : self
- Set style by using associative array
- setStyleName() : self
- Set style name
- setStyleValue() : self
- Set style value template method
- setWeight() : self
- Set weight
- 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
Constants
ARROW_BLOCK
public
mixed
ARROW_BLOCK
= 'block'
ARROW_CLASSIC
public
mixed
ARROW_CLASSIC
= 'classic'
ARROW_DIAMOND
public
mixed
ARROW_DIAMOND
= 'diamond'
ARROW_NONE
Arrowhead type constants
public
mixed
ARROW_NONE
= 'none'
Tags
ARROW_OPEN
public
mixed
ARROW_OPEN
= 'open'
ARROW_OVAL
public
mixed
ARROW_OVAL
= 'oval'
ENDCAP_FLAT
Line style constants
public
mixed
ENDCAP_FLAT
= 'flat'
Tags
ENDCAP_ROUND
public
mixed
ENDCAP_ROUND
= 'round'
ENDCAP_SQUARE
public
mixed
ENDCAP_SQUARE
= 'square'
LINE_SINGLE
Line style constants
public
mixed
LINE_SINGLE
= 'single'
Tags
LINE_THICK_BETWEEN_THIN
public
mixed
LINE_THICK_BETWEEN_THIN
= 'thickBetweenThin'
LINE_THICK_THIN
public
mixed
LINE_THICK_THIN
= 'thickThin'
LINE_THIN_THICK
public
mixed
LINE_THIN_THICK
= 'thinThick'
LINE_THIN_THIN
public
mixed
LINE_THIN_THIN
= 'thinThin'
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
$color
Outline color
private
string
$color
$dash
Dash type
private
string
$dash
$endArrow
End arrow type
private
string
$endArrow
$endCap
End cap
private
string
$endCap
Tags
$isAuto
Is this an automatic style? (Used primarily in OpenDocument driver)
private
bool
$isAuto
= false
Tags
$line
Line style
private
string
$line
$startArrow
Start arrow type
private
string
$startArrow
$unit
Unit; No set method for now
private
string
$unit
= 'pt'
$weight
Outline weight
private
int|float
$weight
Methods
__construct()
Create a new instance
public
__construct([array<string|int, mixed> $style = array() ]) : mixed
Parameters
- $style : array<string|int, mixed> = array()
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 —getColor()
Get color
public
getColor() : string
Return values
string —getDash()
Get dash type
public
getDash() : string
Return values
string —getEndArrow()
Get endArrow
public
getEndArrow() : string
Return values
string —getEndCap()
Get endCap style
public
getEndCap() : string
Return values
string —getIndex()
Get index number
public
getIndex() : int|null
Return values
int|null —getLine()
Get line style
public
getLine() : string
Return values
string —getStartArrow()
Get startArrow
public
getStartArrow() : string
Return values
string —getStyleName()
Get style name
public
getStyleName() : string
Return values
string —getUnit()
Get unit
public
getUnit() : string
Return values
string —getWeight()
Get weight
public
getWeight() : int|float
Return values
int|float —isAuto()
Get is automatic style flag
public
isAuto() : 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 —setColor()
Set color
public
setColor([string $value = null ]) : self
Parameters
- $value : string = null
Return values
self —setDash()
Set dash type
public
setDash([string $value = null ]) : self
Parameters
- $value : string = null
Return values
self —setEndArrow()
Set pattern
public
setEndArrow([string $value = null ]) : self
Parameters
- $value : string = null
Return values
self —setEndCap()
Set endCap style
public
setEndCap([string $value = null ]) : self
Parameters
- $value : string = null
Return values
self —setIndex()
Set index number
public
setIndex([int|null $value = null ]) : self
Parameters
- $value : int|null = null
Return values
self —setLine()
Set line style
public
setLine([string $value = null ]) : self
Parameters
- $value : string = null
Return values
self —setStartArrow()
Set pattern
public
setStartArrow([string $value = null ]) : self
Parameters
- $value : string = 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 —setWeight()
Set weight
public
setWeight([int|float $value = null ]) : self
Parameters
- $value : int|float = 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 = 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