Constants

DIAGONAL_NONE

DIAGONAL_NONE = 0

DIAGONAL_UP

DIAGONAL_UP = 1

DIAGONAL_DOWN

DIAGONAL_DOWN = 2

DIAGONAL_BOTH

DIAGONAL_BOTH = 3

Properties

$isSupervisor

$isSupervisor : bool

Supervisor?

Type

bool

$parent

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

Parent. Only used for supervisor.

Type

Style

$parentPropertyName

$parentPropertyName : null|string

Parent property name.

Type

null|string

$left

$left : \PhpOffice\PhpSpreadsheet\Style\Border

Left.

Type

Border

$right

$right : \PhpOffice\PhpSpreadsheet\Style\Border

Right.

Type

Border

$top

$top : \PhpOffice\PhpSpreadsheet\Style\Border

Top.

Type

Border

$bottom

$bottom : \PhpOffice\PhpSpreadsheet\Style\Border

Bottom.

Type

Border

$diagonal

$diagonal : \PhpOffice\PhpSpreadsheet\Style\Border

Diagonal.

Type

Border

$diagonalDirection

$diagonalDirection : int

DiagonalDirection.

Type

int

$allBorders

$allBorders : \PhpOffice\PhpSpreadsheet\Style\Border

All borders pseudo-border. Only applies to supervisor.

Type

Border

$outline

$outline : \PhpOffice\PhpSpreadsheet\Style\Border

Outline pseudo-border. Only applies to supervisor.

Type

Border

$inside

$inside : \PhpOffice\PhpSpreadsheet\Style\Border

Inside pseudo-border. Only applies to supervisor.

Type

Border

$vertical

$vertical : \PhpOffice\PhpSpreadsheet\Style\Border

Vertical pseudo-border. Only applies to supervisor.

Type

Border

$horizontal

$horizontal : \PhpOffice\PhpSpreadsheet\Style\Border

Horizontal pseudo-border. Only applies to supervisor.

Type

Border

Methods

__construct()

__construct(bool  $isSupervisor = false, bool  $isConditional = false) : mixed

Create a new Borders.

Parameters

bool $isSupervisor

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

bool $isConditional

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

Returns

mixed —

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

Is this a supervisor or a cell style component?

Returns

bool —

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

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

Returns

mixed —

exportArray()

exportArray() : array

Export style as array.

Available to anything which extends this class: Alignment, Border, Borders, Color, Fill, Font, NumberFormat, Protection, and Style.

Returns

array —

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) : $this

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

Returns

$this —

getLeft()

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

Get Left.

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getRight()

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

Get Right.

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getTop()

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

Get Top.

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getBottom()

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

Get Bottom.

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getDiagonal()

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

Get Diagonal.

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getAllBorders()

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

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

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getOutline()

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

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

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getInside()

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

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

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getVertical()

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

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

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getHorizontal()

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

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

Returns

\PhpOffice\PhpSpreadsheet\Style\Border —

getDiagonalDirection()

getDiagonalDirection() : int

Get DiagonalDirection.

Returns

int —

setDiagonalDirection()

setDiagonalDirection(int  $pValue) : $this

Set DiagonalDirection.

Parameters

int $pValue

see self::DIAGONAL_*

Returns

$this —

getHashCode()

getHashCode() : string

Get hash code.

Returns

string —

Hash code

exportArray1()

exportArray1() : array

Abstract method to be implemented in anything which extends this class.

This method invokes exportArray2 with the names and values of all properties to be included in output array, returning that array to exportArray, then to caller.

Returns

array —

exportArray2()

exportArray2(array  $exportedArray, string  $index, mixed  $objOrValue) : void

Populate array from exportArray1.

This method is available to anything which extends this class. The parameter index is the key to be added to the array. The parameter objOrValue is either a primitive type, which is the value added to the array, or a Style object to be recursively added via exportArray.

Parameters

array $exportedArray
string $index
mixed $objOrValue