\PHPExcel_Style_Borders

PHPExcel_Style_Borders

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()
getLeft()
getRight()
getTop()
getBottom()
getDiagonal()
getAllBorders()
getOutline()
getInside()
getVertical()
getHorizontal()
getDiagonalDirection()
setDiagonalDirection()
getHashCode()
No public properties found
DIAGONAL_NONE
DIAGONAL_UP
DIAGONAL_DOWN
DIAGONAL_BOTH
No protected methods found
$isSupervisor
$parent
$left
$right
$top
$bottom
$diagonal
$diagonalDirection
$allBorders
$outline
$inside
$vertical
$horizontal
N/A
No private methods found
No private properties found
N/A

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

$parent

$parent : \PHPExcel_Style

Parent. Only used for supervisor

Type

\PHPExcel_Style

$diagonalDirection

$diagonalDirection : integer

DiagonalDirection

Type

integer

$allBorders

$allBorders : \PHPExcel_Style_Border

All borders psedo-border. Only applies to supervisor.

Type

\PHPExcel_Style_Border

$outline

$outline : \PHPExcel_Style_Border

Outline psedo-border. Only applies to supervisor.

Type

\PHPExcel_Style_Border

$inside

$inside : \PHPExcel_Style_Border

Inside psedo-border. Only applies to supervisor.

Type

\PHPExcel_Style_Border

$vertical

$vertical : \PHPExcel_Style_Border

Vertical pseudo-border. Only applies to supervisor.

Type

\PHPExcel_Style_Border

$horizontal

$horizontal : \PHPExcel_Style_Border

Horizontal pseudo-border. Only applies to supervisor.

Type

\PHPExcel_Style_Border

Methods

__construct()

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

Create a new PHPExcel_Style_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

bindParent()

bindParent(\PHPExcel  $parent,   $parentPropertyName = null) : \PHPExcel_Style_Supervisor

Bind parent. Only used for supervisor

Parameters

\PHPExcel $parent
$parentPropertyName

Returns

\PHPExcel_Style_Supervisor

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_Borders

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

Only used for style supervisor

Returns

\PHPExcel_Style_Borders

getStyleArray()

getStyleArray(array  $array) : array

Build style array from subcomponents

Parameters

array $array

Returns

array

applyFromArray()

applyFromArray(array  $pStyles = null) : \PHPExcel_Style_Borders

Apply styles from array

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

Parameters

array $pStyles

Array containing style information

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Borders

getAllBorders()

getAllBorders() : \PHPExcel_Style_Border

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

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Border

getOutline()

getOutline() : boolean

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

Throws

\PHPExcel_Exception

Returns

boolean

getInside()

getInside() : boolean

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

Throws

\PHPExcel_Exception

Returns

boolean

getVertical()

getVertical() : \PHPExcel_Style_Border

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

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Border

getHorizontal()

getHorizontal() : \PHPExcel_Style_Border

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

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Style_Border

getDiagonalDirection()

getDiagonalDirection() : integer

Get DiagonalDirection

Returns

integer

setDiagonalDirection()

setDiagonalDirection(integer  $pValue = \PHPExcel_Style_Borders::DIAGONAL_NONE) : \PHPExcel_Style_Borders

Set DiagonalDirection

Parameters

integer $pValue

Returns

\PHPExcel_Style_Borders

getHashCode()

getHashCode() : string

Get hash code

Returns

string —

Hash code