Constants

BORDER_NONE

BORDER_NONE = 'none'

BORDER_DASHDOT

BORDER_DASHDOT = 'dashDot'

BORDER_DASHDOTDOT

BORDER_DASHDOTDOT = 'dashDotDot'

BORDER_DASHED

BORDER_DASHED = 'dashed'

BORDER_DOTTED

BORDER_DOTTED = 'dotted'

BORDER_DOUBLE

BORDER_DOUBLE = 'double'

BORDER_HAIR

BORDER_HAIR = 'hair'

BORDER_MEDIUM

BORDER_MEDIUM = 'medium'

BORDER_MEDIUMDASHDOT

BORDER_MEDIUMDASHDOT = 'mediumDashDot'

BORDER_MEDIUMDASHDOTDOT

BORDER_MEDIUMDASHDOTDOT = 'mediumDashDotDot'

BORDER_MEDIUMDASHED

BORDER_MEDIUMDASHED = 'mediumDashed'

BORDER_SLANTDASHDOT

BORDER_SLANTDASHDOT = 'slantDashDot'

BORDER_THICK

BORDER_THICK = 'thick'

BORDER_THIN

BORDER_THIN = 'thin'

Properties

$colorIndex

$colorIndex : integer

Type

integer

$isSupervisor

$isSupervisor : boolean

Supervisor?

Type

boolean

$parent

$parent : \PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style

Parent. Only used for supervisor.

Type

\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style

$parentPropertyName

$parentPropertyName : null|string

Parent property name.

Type

null|string

$borderStyle

$borderStyle : string

Border style.

Type

string

Methods

__construct()

__construct(boolean  $isSupervisor = false, boolean  $isConditional = false) 

Create a new Border.

Parameters

boolean $isSupervisor

Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are

boolean $isConditional

Flag indicating if this is a conditional style or not Leave this value at default unless you understand exactly what its ramifications are

bindParent()

bindParent(\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style  $parent, null|string  $parentPropertyName = null) : $this

Bind parent. Only used for supervisor.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet|\PhpOffice\PhpSpreadsheet\Style\Style $parent
null|string $parentPropertyName

Returns

$this

getIsSupervisor()

getIsSupervisor() : boolean

Is this a supervisor or a cell style component?

Returns

boolean

getActiveSheet()

getActiveSheet() : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get the currently active sheet. Only used for supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

getSelectedCells()

getSelectedCells() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns

string —

E.g. 'A1'

getActiveCell()

getActiveCell() : string

Get the currently active cell coordinate in currently active sheet.

Only used for supervisor.

Returns

string —

E.g. 'A1'

__clone()

__clone() 

Implement PHP __clone to create a deep clone, not just a shallow copy.

getSharedComponent()

getSharedComponent() : \PhpOffice\PhpSpreadsheet\Style\Border

Get the shared style component for the currently active cell in currently active sheet.

Only used for style supervisor.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Border

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents.

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles) : $this

Apply styles from array.

$spreadsheet->getActiveSheet()->getStyle('B2')->getBorders()->getTop()->applyFromArray( [ 'borderStyle' => Border::BORDER_DASHDOT, 'color' => [ 'rgb' => '808080' ] ] );

Parameters

array $pStyles

Array containing style information

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getBorderStyle()

getBorderStyle() : string

Get Border style.

Returns

string

setBorderStyle()

setBorderStyle(boolean|string  $pValue) : $this

Set Border style.

Parameters

boolean|string $pValue

When passing a boolean, FALSE equates Border::BORDER_NONE and TRUE to Border::BORDER_MEDIUM

Returns

$this

setColor()

setColor(\PhpOffice\PhpSpreadsheet\Style\Color  $pValue) : $this

Set Border Color.

Parameters

\PhpOffice\PhpSpreadsheet\Style\Color $pValue

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code