Constants

DIAGONAL_NONE

DIAGONAL_NONE = 0

DIAGONAL_UP

DIAGONAL_UP = 1

DIAGONAL_DOWN

DIAGONAL_DOWN = 2

DIAGONAL_BOTH

DIAGONAL_BOTH = 3

Properties

$isSupervisor

$isSupervisor : boolean

Supervisor?

Type

boolean

$parentPropertyName

$parentPropertyName : null|string

Parent property name.

Type

null|string

$diagonalDirection

$diagonalDirection : integer

DiagonalDirection.

Type

integer

Methods

__construct()

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

Create a new Borders.

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

getIsSupervisor()

getIsSupervisor() : boolean

Is this a supervisor or a cell style component?

Returns

boolean

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\Borders

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

Only used for style supervisor.

Returns

\PhpOffice\PhpSpreadsheet\Style\Borders

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents.

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles) : \PhpOffice\PhpSpreadsheet\Style\Borders

Apply styles from array.

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

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

Parameters

array $pStyles

Array containing style information

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Borders

getAllBorders()

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

Get AllBorders (pseudo-border). Only applies to supervisor.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Border

getOutline()

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

Get Outline (pseudo-border). Only applies to supervisor.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Border

getInside()

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

Get Inside (pseudo-border). Only applies to supervisor.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Border

getVertical()

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

Get Vertical (pseudo-border). Only applies to supervisor.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Border

getHorizontal()

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

Get Horizontal (pseudo-border). Only applies to supervisor.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

\PhpOffice\PhpSpreadsheet\Style\Border

getDiagonalDirection()

getDiagonalDirection() : integer

Get DiagonalDirection.

Returns

integer

setDiagonalDirection()

setDiagonalDirection(integer  $pValue) : \PhpOffice\PhpSpreadsheet\Style\Borders

Set DiagonalDirection.

Parameters

integer $pValue

see self::DIAGONAL_*

Returns

\PhpOffice\PhpSpreadsheet\Style\Borders

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code