Documentation

Line extends Image

Line style

Table of Contents

ARROW_STYLE_BLOCK  = 'block'
Arrow styles
ARROW_STYLE_CLASSIC  = 'classic'
ARROW_STYLE_DIAMOND  = 'diamond'
ARROW_STYLE_OPEN  = 'open'
ARROW_STYLE_OVAL  = 'oval'
CONNECTOR_TYPE_STRAIGHT  = 'straight'
Connector types
DASH_STYLE_DASH  = 'dash'
Dash styles
DASH_STYLE_DASH_DOT  = 'dashdot'
DASH_STYLE_LONG_DASH  = 'longdash'
DASH_STYLE_LONG_DASH_DOT  = 'longdashdot'
DASH_STYLE_LONG_DASH_DOT_DOT  = 'longdashdotdot'
DASH_STYLE_ROUND_DOT  = 'rounddot'
DASH_STYLE_SQUARE_DOT  = 'squaredot'
POS_ABSOLUTE  = 'absolute'
General positioning options.
POS_BOTTOM  = 'bottom'
POS_CENTER  = 'center'
Horizontal/vertical value
POS_INSIDE  = 'inside'
POS_LEFT  = 'left'
POS_OUTSIDE  = 'outside'
POS_RELATIVE  = 'relative'
POS_RELTO_BMARGIN  = 'bottom-margin-area'
POS_RELTO_CHAR  = 'char'
POS_RELTO_COLUMN  = 'column'
POS_RELTO_IMARGIN  = 'inner-margin-area'
POS_RELTO_LINE  = 'line'
POS_RELTO_LMARGIN  = 'left-margin-area'
POS_RELTO_MARGIN  = 'margin'
Position relative to
POS_RELTO_OMARGIN  = 'outer-margin-area'
POS_RELTO_PAGE  = 'page'
POS_RELTO_RMARGIN  = 'right-margin-area'
POS_RELTO_TEXT  = 'text'
POS_RELTO_TMARGIN  = 'top-margin-area'
POS_RIGHT  = 'right'
POS_TOP  = 'top'
POSITION_ABSOLUTE  = self::POS_ABSOLUTE
POSITION_HORIZONTAL_CENTER  = self::POS_CENTER
POSITION_HORIZONTAL_LEFT  = self::POS_LEFT
POSITION_HORIZONTAL_RIGHT  = self::POS_RIGHT
POSITION_RELATIVE  = self::POS_RELATIVE
POSITION_RELATIVE_TO_BMARGIN  = self::POS_RELTO_BMARGIN
POSITION_RELATIVE_TO_CHAR  = self::POS_RELTO_CHAR
POSITION_RELATIVE_TO_COLUMN  = self::POS_RELTO_COLUMN
POSITION_RELATIVE_TO_IMARGIN  = self::POS_RELTO_IMARGIN
POSITION_RELATIVE_TO_LINE  = self::POS_RELTO_LINE
POSITION_RELATIVE_TO_LMARGIN  = self::POS_RELTO_LMARGIN
POSITION_RELATIVE_TO_MARGIN  = self::POS_RELTO_MARGIN
POSITION_RELATIVE_TO_OMARGIN  = self::POS_RELTO_OMARGIN
POSITION_RELATIVE_TO_PAGE  = self::POS_RELTO_PAGE
POSITION_RELATIVE_TO_RMARGIN  = self::POS_RELTO_RMARGIN
POSITION_RELATIVE_TO_TEXT  = self::POS_RELTO_TEXT
POSITION_RELATIVE_TO_TMARGIN  = self::POS_RELTO_TMARGIN
POSITION_VERTICAL_BOTTOM  = self::POS_BOTTOM
POSITION_VERTICAL_CENTER  = self::POS_CENTER
POSITION_VERTICAL_INSIDE  = self::POS_INSIDE
POSITION_VERTICAL_OUTSIDE  = self::POS_OUTSIDE
POSITION_VERTICAL_TOP  = self::POS_TOP
UNIT_PT  = 'pt'
Length unit
UNIT_PX  = 'px'
WRAP_BEHIND  = 'behind'
WRAP_INFRONT  = 'infront'
WRAP_INLINE  = 'inline'
Wrap type
WRAP_SQUARE  = 'square'
WRAP_THROUGH  = 'through'
WRAP_TIGHT  = 'tight'
WRAP_TOPBOTTOM  = 'topAndBottom'
WRAPPING_STYLE_BEHIND  = self::WRAP_BEHIND
WRAPPING_STYLE_INFRONT  = self::WRAP_INFRONT
WRAPPING_STYLE_INLINE  = self::WRAP_INLINE
Backward compatibility constants
WRAPPING_STYLE_SQUARE  = self::WRAP_SQUARE
WRAPPING_STYLE_TIGHT  = self::WRAP_TIGHT
$aliases  : array<string|int, mixed>
Aliases
$index  : int|null
Index number in Style collection for named style
$styleName  : string
Style name
$alignment  : string
$beginArrow  : string
Begin arrow
$color  : string
Line color
$connectorType  : string
connectorType
$dash  : string
Dash style
$endArrow  : string
End arrow
$flip  : bool
flip Line
$height  : int|float
Height
$hPos  : string
Horizontal position
$hPosRelTo  : string
Horizontal position relative to
$isAuto  : bool
Is this an automatic style? (Used primarily in OpenDocument driver)
$left  : int|float
Leftmost (horizontal) position
$pos  : string
Position type: absolute|relative
$position  : int
Vertically raised or lowered text
$top  : int|float
Topmost (vertical) position
$unit  : string
Unit
$vPos  : string
Vertical position
$vPosRelTo  : string
Vertical position relative to
$weight  : int
Line Weight
$width  : int|float
Width
$wrap  : string
Wrap type
$wrapDistanceBottom  : float
Bottom wrap distance
$wrapDistanceLeft  : float
Left wrap distance
$wrapDistanceRight  : float
Right wrap distance
$wrapDistanceTop  : float
Top wrap distance
__construct()  : mixed
Create a new instance
getAlign()  : string
getAlignment()  : string
getBeginArrow()  : string
Get beginArrow
getChildStyleValue()  : mixed
Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`
getColor()  : string
Get color
getConnectorType()  : string
Get connectorType
getDash()  : string
Get Dash
getEndArrow()  : string
Get endArrow
getHeight()  : int|float
Get height
getHPos()  : string
Get horizontal position
getHPosRelTo()  : string
Get horizontal position relative to
getIndex()  : int|null
Get index number
getLeft()  : int|float
Get left
getMarginLeft()  : int|float
Get margin left
getMarginTop()  : int|float
Get margin top
getPos()  : string
Get position type
getPosHorizontal()  : string
Get horizontal alignment
getPosHorizontalRel()  : string
Get horizontal relation
getPosition()  : int
Get position
getPositioning()  : string
Get positioning type
getPosVertical()  : string
Get vertical alignment
getPosVerticalRel()  : string
Get vertical relation
getStyleName()  : string
Get style name
getTop()  : int|float
Get topmost position
getUnit()  : string
Get unit
getVPos()  : string
Get vertical position
getVPosRelTo()  : string
Get vertical position relative to
getWeight()  : int
Get weight
getWidth()  : int|float
Get width
getWrap()  : string
Get wrap type
getWrapDistanceBottom()  : float
Get bottom distance from text wrap
getWrapDistanceLeft()  : float
Get left distance from text wrap
getWrapDistanceRight()  : float
Get right distance from text wrap
getWrapDistanceTop()  : float
Get top distance from text wrap
getWrappingStyle()  : string
Get wrapping style
isAuto()  : bool
Get is automatic style flag
isFlip()  : bool
Get flip
setAlign()  : self
setAlignment()  : self
setArrayStyle()  : self
Set style using associative array
setAuto()  : self
Set is automatic style flag
setBeginArrow()  : self
Set beginArrow
setColor()  : self
Set color
setConnectorType()  : self
Set connectorType
setDash()  : self
Set Dash
setEndArrow()  : self
Set endArrow
setFlip()  : self
Set flip
setHeight()  : self
Set height
setHPos()  : self
Set horizontal position
setHPosRelTo()  : self
Set horizontal position relative to
setIndex()  : self
Set index number
setLeft()  : self
Set left
setMarginLeft()  : self
Set margin left
setMarginTop()  : self
Set margin top
setPos()  : self
Set position type
setPosHorizontal()  : self
Set horizontal alignment
setPosHorizontalRel()  : self
Set horizontal relation
setPosition()  : self
Set position
setPositioning()  : self
Set positioning type
setPosVertical()  : self
Set vertical alignment
setPosVerticalRel()  : self
Set vertical relation
setStyleByArray()  : self
Set style by using associative array
setStyleName()  : self
Set style name
setStyleValue()  : self
Set style value template method
setTop()  : self
Set topmost position
setUnit()  : self
Set unit
setVPos()  : self
Set vertical position
setVPosRelTo()  : self
Set vertical position relative to
setWeight()  : self
Set weight
setWidth()  : self
Set width
setWrap()  : self
Set wrap type
setWrapDistanceBottom()  : self
Set bottom distance from text wrap
setWrapDistanceLeft()  : self
Set left distance from text wrap
setWrapDistanceRight()  : self
Set right distance from text wrap
setWrapDistanceTop()  : self
Set top distance from text wrap
setWrappingStyle()  : self
Set wrapping style
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_STYLE_BLOCK

Arrow styles

public mixed ARROW_STYLE_BLOCK = 'block'
Tags
const

string

ARROW_STYLE_CLASSIC

public mixed ARROW_STYLE_CLASSIC = 'classic'

ARROW_STYLE_DIAMOND

public mixed ARROW_STYLE_DIAMOND = 'diamond'

ARROW_STYLE_OPEN

public mixed ARROW_STYLE_OPEN = 'open'

ARROW_STYLE_OVAL

public mixed ARROW_STYLE_OVAL = 'oval'

CONNECTOR_TYPE_STRAIGHT

Connector types

public mixed CONNECTOR_TYPE_STRAIGHT = 'straight'
Tags
const

string

DASH_STYLE_DASH

Dash styles

public mixed DASH_STYLE_DASH = 'dash'
Tags
const

string

DASH_STYLE_DASH_DOT

public mixed DASH_STYLE_DASH_DOT = 'dashdot'

DASH_STYLE_LONG_DASH

public mixed DASH_STYLE_LONG_DASH = 'longdash'

DASH_STYLE_LONG_DASH_DOT

public mixed DASH_STYLE_LONG_DASH_DOT = 'longdashdot'

DASH_STYLE_LONG_DASH_DOT_DOT

public mixed DASH_STYLE_LONG_DASH_DOT_DOT = 'longdashdotdot'

DASH_STYLE_ROUND_DOT

public mixed DASH_STYLE_ROUND_DOT = 'rounddot'

DASH_STYLE_SQUARE_DOT

public mixed DASH_STYLE_SQUARE_DOT = 'squaredot'

POS_ABSOLUTE

General positioning options.

public mixed POS_ABSOLUTE = 'absolute'
Tags
const

string

POS_BOTTOM

public mixed POS_BOTTOM = 'bottom'

POS_CENTER

Horizontal/vertical value

public mixed POS_CENTER = 'center'
Tags
const

string

POS_INSIDE

public mixed POS_INSIDE = 'inside'

POS_LEFT

public mixed POS_LEFT = 'left'

POS_OUTSIDE

public mixed POS_OUTSIDE = 'outside'

POS_RELATIVE

public mixed POS_RELATIVE = 'relative'

POS_RELTO_BMARGIN

public mixed POS_RELTO_BMARGIN = 'bottom-margin-area'

POS_RELTO_CHAR

public mixed POS_RELTO_CHAR = 'char'

POS_RELTO_COLUMN

public mixed POS_RELTO_COLUMN = 'column'

POS_RELTO_IMARGIN

public mixed POS_RELTO_IMARGIN = 'inner-margin-area'

POS_RELTO_LINE

public mixed POS_RELTO_LINE = 'line'

POS_RELTO_LMARGIN

public mixed POS_RELTO_LMARGIN = 'left-margin-area'

POS_RELTO_MARGIN

Position relative to

public mixed POS_RELTO_MARGIN = 'margin'
Tags
const

string

POS_RELTO_OMARGIN

public mixed POS_RELTO_OMARGIN = 'outer-margin-area'

POS_RELTO_PAGE

public mixed POS_RELTO_PAGE = 'page'

POS_RELTO_RMARGIN

public mixed POS_RELTO_RMARGIN = 'right-margin-area'

POS_RELTO_TEXT

public mixed POS_RELTO_TEXT = 'text'

POS_RELTO_TMARGIN

public mixed POS_RELTO_TMARGIN = 'top-margin-area'

POS_RIGHT

public mixed POS_RIGHT = 'right'

POS_TOP

public mixed POS_TOP = 'top'

POSITION_ABSOLUTE

public mixed POSITION_ABSOLUTE = self::POS_ABSOLUTE

POSITION_HORIZONTAL_CENTER

public mixed POSITION_HORIZONTAL_CENTER = self::POS_CENTER

POSITION_HORIZONTAL_LEFT

public mixed POSITION_HORIZONTAL_LEFT = self::POS_LEFT

POSITION_HORIZONTAL_RIGHT

public mixed POSITION_HORIZONTAL_RIGHT = self::POS_RIGHT

POSITION_RELATIVE

public mixed POSITION_RELATIVE = self::POS_RELATIVE

POSITION_RELATIVE_TO_BMARGIN

public mixed POSITION_RELATIVE_TO_BMARGIN = self::POS_RELTO_BMARGIN

POSITION_RELATIVE_TO_CHAR

public mixed POSITION_RELATIVE_TO_CHAR = self::POS_RELTO_CHAR

POSITION_RELATIVE_TO_COLUMN

public mixed POSITION_RELATIVE_TO_COLUMN = self::POS_RELTO_COLUMN

POSITION_RELATIVE_TO_IMARGIN

public mixed POSITION_RELATIVE_TO_IMARGIN = self::POS_RELTO_IMARGIN

POSITION_RELATIVE_TO_LINE

public mixed POSITION_RELATIVE_TO_LINE = self::POS_RELTO_LINE

POSITION_RELATIVE_TO_LMARGIN

public mixed POSITION_RELATIVE_TO_LMARGIN = self::POS_RELTO_LMARGIN

POSITION_RELATIVE_TO_MARGIN

public mixed POSITION_RELATIVE_TO_MARGIN = self::POS_RELTO_MARGIN

POSITION_RELATIVE_TO_OMARGIN

public mixed POSITION_RELATIVE_TO_OMARGIN = self::POS_RELTO_OMARGIN

POSITION_RELATIVE_TO_PAGE

public mixed POSITION_RELATIVE_TO_PAGE = self::POS_RELTO_PAGE

POSITION_RELATIVE_TO_RMARGIN

public mixed POSITION_RELATIVE_TO_RMARGIN = self::POS_RELTO_RMARGIN

POSITION_RELATIVE_TO_TEXT

public mixed POSITION_RELATIVE_TO_TEXT = self::POS_RELTO_TEXT

POSITION_RELATIVE_TO_TMARGIN

public mixed POSITION_RELATIVE_TO_TMARGIN = self::POS_RELTO_TMARGIN

POSITION_VERTICAL_BOTTOM

public mixed POSITION_VERTICAL_BOTTOM = self::POS_BOTTOM

POSITION_VERTICAL_CENTER

public mixed POSITION_VERTICAL_CENTER = self::POS_CENTER

POSITION_VERTICAL_INSIDE

public mixed POSITION_VERTICAL_INSIDE = self::POS_INSIDE

POSITION_VERTICAL_OUTSIDE

public mixed POSITION_VERTICAL_OUTSIDE = self::POS_OUTSIDE

POSITION_VERTICAL_TOP

public mixed POSITION_VERTICAL_TOP = self::POS_TOP

UNIT_PT

Length unit

public mixed UNIT_PT = 'pt'
Tags
const

string

UNIT_PX

public mixed UNIT_PX = 'px'

WRAP_BEHIND

public mixed WRAP_BEHIND = 'behind'

WRAP_INFRONT

public mixed WRAP_INFRONT = 'infront'

WRAP_INLINE

Wrap type

public mixed WRAP_INLINE = 'inline'
Tags
const

string

WRAP_SQUARE

public mixed WRAP_SQUARE = 'square'

WRAP_THROUGH

public mixed WRAP_THROUGH = 'through'

WRAP_TIGHT

public mixed WRAP_TIGHT = 'tight'

WRAP_TOPBOTTOM

public mixed WRAP_TOPBOTTOM = 'topAndBottom'

WRAPPING_STYLE_BEHIND

public mixed WRAPPING_STYLE_BEHIND = self::WRAP_BEHIND

WRAPPING_STYLE_INFRONT

public mixed WRAPPING_STYLE_INFRONT = self::WRAP_INFRONT

WRAPPING_STYLE_INLINE

Backward compatibility constants

public mixed WRAPPING_STYLE_INLINE = self::WRAP_INLINE
Tags
const

string

WRAPPING_STYLE_SQUARE

public mixed WRAPPING_STYLE_SQUARE = self::WRAP_SQUARE

WRAPPING_STYLE_TIGHT

public mixed WRAPPING_STYLE_TIGHT = self::WRAP_TIGHT

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()

$alignment

private string $alignment = ''

$beginArrow

Begin arrow

private string $beginArrow

$color

Line color

private string $color

$connectorType

connectorType

private string $connectorType = self::CONNECTOR_TYPE_STRAIGHT

$dash

Dash style

private string $dash

$endArrow

End arrow

private string $endArrow

$flip

flip Line

private bool $flip = false

$height

Height

private int|float $height

$hPos

Horizontal position

private string $hPos

$hPosRelTo

Horizontal position relative to

private string $hPosRelTo

$isAuto

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

private bool $isAuto = false
Tags
since
0.11.0

$left

Leftmost (horizontal) position

private int|float $left = 0

$pos

Position type: absolute|relative

private string $pos

$top

Topmost (vertical) position

private int|float $top = 0

$unit

Unit

private string $unit = 'pt'

$vPos

Vertical position

private string $vPos

$vPosRelTo

Vertical position relative to

private string $vPosRelTo

$weight

Line Weight

private int $weight

$width

Width

private int|float $width

$wrap

Wrap type

private string $wrap

$wrapDistanceBottom

Bottom wrap distance

private float $wrapDistanceBottom

$wrapDistanceLeft

Left wrap distance

private float $wrapDistanceLeft

$wrapDistanceRight

Right wrap distance

private float $wrapDistanceRight

$wrapDistanceTop

Top wrap distance

private float $wrapDistanceTop

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 —

getAlign()

public getAlign() : string
Tags
deprecated
0.13.0

Use the getAlignment method instead.

codeCoverageIgnore
Return values
string —

getAlignment()

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

getBeginArrow()

Get beginArrow

public getBeginArrow() : string
Return values
string —

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
Return values
mixed —

getColor()

Get color

public getColor() : string
Return values
string —

getConnectorType()

Get connectorType

public getConnectorType() : string
Return values
string —

getDash()

Get Dash

public getDash() : string
Return values
string —

getEndArrow()

Get endArrow

public getEndArrow() : string
Return values
string —

getHeight()

Get height

public getHeight() : int|float
Return values
int|float —

getHPos()

Get horizontal position

public getHPos() : string
Return values
string —

getHPosRelTo()

Get horizontal position relative to

public getHPosRelTo() : string
Return values
string —

getIndex()

Get index number

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

getLeft()

Get left

public getLeft() : int|float
Return values
int|float —

getMarginLeft()

Get margin left

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

getMarginTop()

Get margin top

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

getPos()

Get position type

public getPos() : string
Return values
string —

getPosHorizontal()

Get horizontal alignment

public getPosHorizontal() : string
Return values
string —

getPosHorizontalRel()

Get horizontal relation

public getPosHorizontalRel() : string
Return values
string —

getPosition()

Get position

public getPosition() : int
Return values
int —

getPositioning()

Get positioning type

public getPositioning() : string
Return values
string —

getPosVertical()

Get vertical alignment

public getPosVertical() : string
Return values
string —

getPosVerticalRel()

Get vertical relation

public getPosVerticalRel() : string
Return values
string —

getStyleName()

Get style name

public getStyleName() : string
Return values
string —

getTop()

Get topmost position

public getTop() : int|float
Return values
int|float —

getUnit()

Get unit

public getUnit() : string
Return values
string —

getVPos()

Get vertical position

public getVPos() : string
Return values
string —

getVPosRelTo()

Get vertical position relative to

public getVPosRelTo() : string
Return values
string —

getWeight()

Get weight

public getWeight() : int
Return values
int —

getWidth()

Get width

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

getWrap()

Get wrap type

public getWrap() : string
Return values
string —

getWrapDistanceBottom()

Get bottom distance from text wrap

public getWrapDistanceBottom() : float
Return values
float —

getWrapDistanceLeft()

Get left distance from text wrap

public getWrapDistanceLeft() : float
Return values
float —

getWrapDistanceRight()

Get right distance from text wrap

public getWrapDistanceRight() : float
Return values
float —

getWrapDistanceTop()

Get top distance from text wrap

public getWrapDistanceTop() : float
Return values
float —

getWrappingStyle()

Get wrapping style

public getWrappingStyle() : string
Return values
string —

isAuto()

Get is automatic style flag

public isAuto() : bool
Return values
bool —

isFlip()

Get flip

public isFlip() : bool
Return values
bool —

setAlign()

public setAlign([string $value = null ]) : self
Parameters
$value : string = null
Tags
deprecated
0.13.0

Use the setAlignment method instead.

codeCoverageIgnore
Return values
self —

setAlignment()

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

setArrayStyle()

Set style using associative array

public setArrayStyle([array<string|int, mixed> $style = array() ]) : self
Parameters
$style : array<string|int, mixed> = array()
Tags
deprecated
0.11.0
codeCoverageIgnore
Return values
self —

setAuto()

Set is automatic style flag

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

setBeginArrow()

Set beginArrow

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

setColor()

Set color

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

setConnectorType()

Set connectorType

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

setDash()

Set Dash

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

setEndArrow()

Set endArrow

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

setFlip()

Set flip

public setFlip([bool $value = false ]) : self
Parameters
$value : bool = false
Return values
self —

setHeight()

Set height

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

setHPos()

Set horizontal position

public setHPos(string $value) : self
Parameters
$value : string
Tags
since
0.12.0

"absolute" option is available.

Return values
self —

setHPosRelTo()

Set horizontal position relative to

public setHPosRelTo(string $value) : self
Parameters
$value : string
Return values
self —

setIndex()

Set index number

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

setLeft()

Set left

public setLeft(int|float $value) : self
Parameters
$value : int|float
Return values
self —

setMarginLeft()

Set margin left

public setMarginLeft(int|float $value) : self
Parameters
$value : int|float
Tags
ignoreScrutinizerPatch
Return values
self —

setMarginTop()

Set margin top

public setMarginTop(int|float $value) : self
Parameters
$value : int|float
Tags
ignoreScrutinizerPatch
Return values
self —

setPos()

Set position type

public setPos(string $value) : self
Parameters
$value : string
Return values
self —

setPosHorizontal()

Set horizontal alignment

public setPosHorizontal(string $alignment) : self
Parameters
$alignment : string
Tags
throws
InvalidArgumentException
Return values
self —

setPosHorizontalRel()

Set horizontal relation

public setPosHorizontalRel(string $relto) : self
Parameters
$relto : string
Tags
throws
InvalidArgumentException
Return values
self —

setPosition()

Set position

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

setPositioning()

Set positioning type

public setPositioning(string $positioning) : self
Parameters
$positioning : string
Tags
throws
InvalidArgumentException
Return values
self —

setPosVertical()

Set vertical alignment

public setPosVertical(string $alignment) : self
Parameters
$alignment : string
Tags
throws
InvalidArgumentException
Return values
self —

setPosVerticalRel()

Set vertical relation

public setPosVerticalRel(string $relto) : self
Parameters
$relto : string
Tags
throws
InvalidArgumentException
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 —

setTop()

Set topmost position

public setTop(int|float $value) : self
Parameters
$value : int|float
Return values
self —

setUnit()

Set unit

public setUnit(string $value) : self
Parameters
$value : string
Return values
self —

setVPos()

Set vertical position

public setVPos(string $value) : self
Parameters
$value : string
Tags
since
0.12.0

"absolute" option is available.

Return values
self —

setVPosRelTo()

Set vertical position relative to

public setVPosRelTo(string $value) : self
Parameters
$value : string
Return values
self —

setWeight()

Set weight

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

Weight in points

Return values
self —

setWidth()

Set width

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

setWrap()

Set wrap type

public setWrap(string $value) : self
Parameters
$value : string
Return values
self —

setWrapDistanceBottom()

Set bottom distance from text wrap

public setWrapDistanceBottom([float $value = null ]) : self
Parameters
$value : float = null
Return values
self —

setWrapDistanceLeft()

Set left distance from text wrap

public setWrapDistanceLeft([float $value = null ]) : self
Parameters
$value : float = null
Return values
self —

setWrapDistanceRight()

Set right distance from text wrap

public setWrapDistanceRight([float $value = null ]) : self
Parameters
$value : float = null
Return values
self —

setWrapDistanceTop()

Set top distance from text wrap

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

setWrappingStyle()

Set wrapping style

public setWrappingStyle(string $wrappingStyle) : self
Parameters
$wrappingStyle : string
Tags
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
Return values
self —

Search results