Documentation

Outline extends AbstractStyle
in package

Outline defines the line/border of the object.

Tags
see
http://www.schemacentral.com/sc/ooxml/t-v_CT_Stroke.html
see
http://www.w3.org/TR/1998/NOTE-VML-19980513#_Toc416858395
since
0.12.0

Table of Contents

Constants

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'

Properties

$aliases  : array<string|int, mixed>
Aliases.
$index  : null|int
Index number in Style collection for named style.
$styleName  : string|null
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  : float|int
Outline weight.

Methods

__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()  : null|int
Get index number.
getLine()  : string
Get line style.
getStartArrow()  : string
Get startArrow.
getStyleName()  : string|null
Get style name.
getUnit()  : string
Get unit.
getWeight()  : float|int
Get weight.
isAuto()  : bool
Get is automatic style flag.
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()  : 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.

Constants

ARROW_BLOCK

public mixed ARROW_BLOCK = 'block'

ARROW_CLASSIC

public mixed ARROW_CLASSIC = 'classic'

ARROW_DIAMOND

public mixed ARROW_DIAMOND = 'diamond'

ARROW_OPEN

public mixed ARROW_OPEN = 'open'

ARROW_OVAL

public mixed ARROW_OVAL = 'oval'

ENDCAP_ROUND

public mixed ENDCAP_ROUND = 'round'

ENDCAP_SQUARE

public mixed ENDCAP_SQUARE = 'square'

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 = []

$index

Index number in Style collection for named style.

protected null|int $index

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

$color

Outline color.

private string $color

$dash

Dash type.

private string $dash

$endArrow

End arrow type.

private string $endArrow

$isAuto

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

private bool $isAuto = false
Tags
since
0.11.0

$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 float|int $weight

Methods

__construct()

Create a new instance.

public __construct([array<string|int, mixed> $style = [] ]) : mixed
Parameters
$style : array<string|int, 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
since
0.12.0

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() : null|int
Return values
null|int

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|null
Return values
string|null

getUnit()

Get unit.

public getUnit() : string
Return values
string

getWeight()

Get weight.

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

isAuto()

Get is automatic style flag.

public isAuto() : bool
Return values
bool

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([null|int $value = null ]) : self
Parameters
$value : null|int = 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 = [] ]) : 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

setWeight()

Set weight.

public setWeight([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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results