\PHPExcel_Style_Border

PHPExcel_Style_Border

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
__construct()
bindParent()
getIsSupervisor()
getActiveSheet()
getSelectedCells()
getActiveCell()
__clone()
getSharedComponent()
getStyleArray()
applyFromArray()
getBorderStyle()
setBorderStyle()
getColor()
setColor()
getHashCode()
No public properties found
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
No protected methods found
$isSupervisor
$parent
$borderStyle
$color
$parentPropertyName
N/A
No private methods found
No private properties found
N/A

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

$isSupervisor

$isSupervisor : boolean

Supervisor?

Type

boolean

$parent

$parent : \PHPExcel_Style

Parent. Only used for supervisor

Type

\PHPExcel_Style

$borderStyle

$borderStyle : string

Border style

Type

string

$parentPropertyName

$parentPropertyName : string

Parent property name

Type

string

Methods

__construct()

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

Create a new PHPExcel_Style_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(\PHPExcel_Style_Borders  $parent, string  $parentPropertyName = null) : \PHPExcel_Style_Border

Bind parent. Only used for supervisor

Parameters

\PHPExcel_Style_Borders $parent
string $parentPropertyName

Returns

\PHPExcel_Style_Border

getIsSupervisor()

getIsSupervisor() : boolean

Is this a supervisor or a cell style component?

Returns

boolean

getActiveSheet()

getActiveSheet() : \PHPExcel_Worksheet

Get the currently active sheet. Only used for supervisor

Returns

\PHPExcel_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() : \PHPExcel_Style_Border

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

Only used for style supervisor

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Border

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles = null) : \PHPExcel_Style_Border

Apply styles from array

$objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->getTop()->applyFromArray( array( 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, 'color' => array( 'rgb' => '808080' ) ) );

Parameters

array $pStyles

Array containing style information

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Border

getBorderStyle()

getBorderStyle() : string

Get Border style

Returns

string

setBorderStyle()

setBorderStyle(string|boolean  $pValue = \PHPExcel_Style_Border::BORDER_NONE) : \PHPExcel_Style_Border

Set Border style

Parameters

string|boolean $pValue

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

Returns

\PHPExcel_Style_Border

getHashCode()

getHashCode() : string

Get hash code

Returns

string —

Hash code