__construct()
bindParent()
getIsSupervisor()
getActiveSheet()
getSelectedCells()
getActiveCell()
__clone()
exportArray()
getSharedComponent()
getStyleArray()
applyFromArray()
getBorderStyle()
setBorderStyle()
getColor()
setColor()
getHashCode()

$colorIndex

BORDER_NONE
BORDER_DASHDOT
BORDER_DASHDOTDOT
BORDER_DASHED
BORDER_DOTTED
BORDER_DOUBLE
BORDER_HAIR
BORDER_MEDIUM
BORDER_MEDIUMDASHDOT
BORDER_MEDIUMDASHDOTDOT
BORDER_MEDIUMDASHED
BORDER_SLANTDASHDOT
BORDER_THICK
BORDER_THIN

exportArray1()
exportArray2()

$isSupervisor
$parent
$parentPropertyName
$borderStyle
$color

N/A

No private methods found

No private properties found

N/A

File: serve/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Style/Border.php
Package: Application
Class hierarchy: Supervisor

\PhpOffice\PhpSpreadsheet\Style\Border
Uses

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 : int

Type

int —

$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 —

$borderStyle

$borderStyle : string

Border style.

Type

string —

$color

$color : \PhpOffice\PhpSpreadsheet\Style\Color

Border color.

Type

Color —

Methods

__construct()

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

Create a new Border.

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

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

Only used for style supervisor.

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

Returns

$this —

getBorderStyle()

getBorderStyle() : string

Get Border style.

Returns

string —

setBorderStyle()

setBorderStyle(bool|string  $pValue) : $this

Set Border style.

Parameters

bool|string

$pValue

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

Returns

$this —

getColor()

getColor() : \PhpOffice\PhpSpreadsheet\Style\Color

Get Border Color.

Returns

\PhpOffice\PhpSpreadsheet\Style\Color —

setColor()

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

Set Border Color.

Parameters

\PhpOffice\PhpSpreadsheet\Style\Color

$pValue

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