Docs For Class PHPExcel

static mixed extractSheetTitle(
string
$pRange, [bool
$returnRange = false])

Extract worksheet title from range.

Extract worksheet title from range. Example: extractSheetTitle('test!A1') ==> 'test' Example: extractSheetTitle('test!A1', true) ==> array('test', 'A1');

Tags:

access:

public

Parameters:

string	$pRange	Range to extract title from
bool	$returnRange	Return range? (see example)

[ Top ]

PHPExcel_Worksheet __construct(
[
$pParent = null], [string
$pTitle = 'Worksheet'])

Create a new worksheet

Tags:

access:

public

Parameters:

PHPExcel	$pParent
string	$pTitle

[ Top ]

void calculateColumnWidths(
[boolean
$calculateMergeCells = false])

Calculate widths for auto-size columns

Tags:

access:

public

Parameters:

boolean

$calculateMergeCells

Calculate merge cell width

[ Top ]

string calculateWorksheetDimension(
)

Calculate worksheet dimension

Tags:

return:	String containing the dimension of this worksheet
access:	public

[ Top ]

boolean cellExists(
[string
$pCoordinate = 'A1'])

Cell at a specific coordinate exists?

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCoordinate

Coordinate of the cell

[ Top ]

boolean cellExistsByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 0])

Cell at a specific coordinate by using numeric cell coordinates exists?

Tags:

access:

public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell

[ Top ]

PHPExcel_Worksheet copy(
)

Copy worksheet (!= clone!)

Tags:

access:

public

[ Top ]

void duplicateStyle(
[
$pCellStyle = null], [string
$pRange = ''])

Duplicate cell style to a range of cells

Duplicate cell style to a range of cells Please note that this will overwrite existing cell styles for cells in range!

Tags:

throws:	Exception
access:	public

Parameters:

PHPExcel_Style	$pCellStyle	Cell style to duplicate
string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")

[ Top ]

void duplicateStyleArray(
[array
$pStyles = null], [string
$pRange = ''])

Duplicate cell style array to a range of cells Please note that this will overwrite existing cell styles for cells in range, if they are in the styles array. cells to font bold, only include font bold in the styles array.

Duplicate cell style array to a range of cells Please note that this will overwrite existing cell styles for cells in range, if they are in the styles array. For example, if you decide to set a range of cells to font bold, only include font bold in the styles array.

Tags:

throws:	Exception
access:	public

Parameters:

array	$pStyles	Array containing style information
string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")

[ Top ]

void freezePane(
[string
$pCell = ''])

Freeze Pane

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCell

Cell (i.e. A1)

[ Top ]

void freezePaneByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0])

Freeze Pane by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

[ Top ]

void fromArray(
[array
$source = null], [mixed
$nullValue = null])

Fill worksheet from values in array

Tags:

throws:	Exception
access:	public

Parameters:

array	$source	Source array
mixed	$nullValue	Value treated as "null"

[ Top ]

void garbageCollect(
)

Run PHPExcel garabage collector.

Tags:

access:

public

[ Top ]

string getAutoFilter(
)

Get Autofilter Range

Tags:

access:

public

[ Top ]

array[] getBreaks(
)

Get breaks

Tags:

access:

public

[ Top ]

PHPExcel_Cell getCell(
[string
$pCoordinate = 'A1'])

Get cell at a specific coordinate

Tags:

return:	Cell that was found
throws:	Exception
access:	public

Parameters:

string

$pCoordinate

Coordinate of the cell

[ Top ]

PHPExcel_Cell getCellByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 0])

Get cell at a specific coordinate by using numeric cell coordinates

Tags:

return:	Cell that was found
access:	public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell

[ Top ]

PHPExcel_Cell[] getCellCollection(
)

Get collection of cells

Tags:

access:

public

[ Top ]

PHPExcel_Worksheet_ColumnDimension getColumnDimension(
[string
$pColumn = 'A'])

Get column dimension at a specific column

Tags:

access:

public

Parameters:

string

$pColumn

String index of the column

[ Top ]

PHPExcel_Worksheet_ColumnDimension getColumnDimensionByColumn(
[string
$pColumn = 0], string
$pRow)

Get column dimension at a specific column by using numeric cell coordinates

Tags:

access:

public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell

[ Top ]

PHPExcel_Worksheet_ColumnDimension[] getColumnDimensions(
)

Get collection of column dimensions

Tags:

access:

public

[ Top ]

PHPExcel_Comment getComment(
[string
$pCellCoordinate = 'A1'])

Get comment for cell

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCellCoordinate

Cell coordinate to get comment for

[ Top ]

PHPExcel_Comment getCommentByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0])

Get comment for cell by using numeric cell coordinates

Tags:

access:

public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

[ Top ]

PHPExcel_Comment[] getComments(
)

Get comments

Tags:

access:

public

[ Top ]

PHPExcel_Worksheet_ColumnDimension getDefaultColumnDimension(
)

Get default column dimension

Tags:

access:

public

[ Top ]

PHPExcel_Worksheet_RowDimension getDefaultRowDimension(
)

Get default row dimension

Tags:

access:

public

[ Top ]

PHPExcel_Style getDefaultStyle(
)

Get default style

Tags:

throws:	Exception
access:	public

[ Top ]

PHPExcel_Worksheet_BaseDrawing[] getDrawingCollection(
)

Get collection of drawings

Tags:

access:

public

[ Top ]

string getFreezePane(
)

Get Freeze Pane

Tags:

access:

public

[ Top ]

string getHashCode(
)

Get hash code

Tags:

return:	Hash code
access:	public

[ Top ]

string getHashIndex(
)

Get hash index Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Tags:

return:	Hash index
access:	public

[ Top ]

PHPExcel_Worksheet_HeaderFooter getHeaderFooter(
)

Get page header/footer

Tags:

access:

public

[ Top ]

string getHighestColumn(
)

Get highest worksheet column

Tags:

return:	Highest column name
access:	public

[ Top ]

int getHighestRow(
)

Get highest worksheet row

Tags:

return:	Highest row number
access:	public

[ Top ]

array[] getMergeCells(
)

Get merge cells

Tags:

access:

public

[ Top ]

PHPExcel_Worksheet_PageMargins getPageMargins(
)

Get page margins

Tags:

access:

public

[ Top ]

PHPExcel_Worksheet_PageSetup getPageSetup(
)

Get page setup

Tags:

access:

public

[ Top ]

PHPExcel getParent(
)

Get parent

Tags:

access:

public

[ Top ]

boolean getPrintGridlines(
)

Print gridlines?

Tags:

access:

public

[ Top ]

array[] getProtectedCells(
)

Get protected cells

Tags:

access:

public

[ Top ]

PHPExcel_Worksheet_Protection getProtection(
)

Get Protection

Tags:

access:

public

[ Top ]

PHPExcel_Worksheet_RowDimension getRowDimension(
[int
$pRow = 0])

Get row dimension at a specific row

Tags:

access:

public

Parameters:

int

$pRow

Numeric index of the row

[ Top ]

PHPExcel_Worksheet_RowDimension[] getRowDimensions(
)

Get collection of row dimensions

Tags:

access:

public

[ Top ]

string getSelectedCell(
)

Get selected cell

Tags:

access:

public

[ Top ]

PHPExcel_Worksheet_HeaderFooter getSheetView(
)

Get sheet view

Tags:

access:

public

[ Top ]

boolean getShowGridlines(
)

Show gridlines?

Tags:

access:

public

[ Top ]

boolean getShowSummaryBelow(
)

Show summary below? (Row/Column outlining)

Tags:

access:

public

[ Top ]

boolean getShowSummaryRight(
)

Show summary right? (Row/Column outlining)

Tags:

access:

public

[ Top ]

PHPExcel_Style getStyle(
[string
$pCellCoordinate = 'A1'])

Get style for cell

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCellCoordinate

Cell coordinate to get style for

[ Top ]

PHPExcel_Style getStyleByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0])

Get style for cell by using numeric cell coordinates

Tags:

access:

public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

[ Top ]

PHPExcel_Style[] getStyles(
)

Get styles

Tags:

access:

public

[ Top ]

string getTitle(
)

Get title

Tags:

access:

public

[ Top ]

void insertNewColumnBefore(
[int
$pBefore = 'A'], [int
$pNumCols = 1])

Insert a new column, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pBefore	Insert before this one
int	$pNumCols	Number of columns to insert

[ Top ]

void insertNewColumnBeforeByIndex(
[int
$pBefore = 0], [int
$pNumCols = 1])

Insert a new column, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pBefore	Insert before this one (numeric column coordinate of the cell)
int	$pNumCols	Number of columns to insert

[ Top ]

void insertNewRowBefore(
[int
$pBefore = 1], [int
$pNumRows = 1])

Insert a new row, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pBefore	Insert before this one
int	$pNumRows	Number of rows to insert

[ Top ]

void mergeCells(
[string
$pRange = 'A1:A1'])

Set merge on a cell range

Tags:

throws:	Exception
access:	public

Parameters:

string

$pRange

Cell range (e.g. A1:E1)

[ Top ]

void mergeCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0])

Set merge on a cell range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell

[ Top ]

void protectCells(
[string
$pRange = 'A1'], [string
$pPassword = ''], [boolean
$pAlreadyHashed = false])

Set protection on a cell range

Tags:

throws:	Exception
access:	public

Parameters:

string	$pRange	Cell (e.g. A1) or cell range (e.g. A1:E1)
string	$pPassword	Password to unlock the protection
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

[ Top ]

void protectCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0], [string
$pPassword = ''], [boolean
$pAlreadyHashed = false])

Set protection on a cell range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell
string	$pPassword	Password to unlock the protection
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

[ Top ]

void rebindParent(

$parent)

Re-bind parent

Tags:

access:

public

Parameters:

PHPExcel

$parent

[ Top ]

void refreshColumnDimensions(
)

Refresh column dimensions

Tags:

access:

public

[ Top ]

void refreshRowDimensions(
)

Refresh row dimensions

Tags:

access:

public

[ Top ]

void removeColumn(
[int
$pColumn = 'A'], [int
$pNumCols = 1])

Remove a column, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Remove starting with this one
int	$pNumCols	Number of columns to remove

[ Top ]

void removeColumnByIndex(
[int
$pColumn = 0], [int
$pNumCols = 1])

Remove a column, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Remove starting with this one (numeric column coordinate of the cell)
int	$pNumCols	Number of columns to remove

[ Top ]

void removeRow(
[int
$pRow = 1], [int
$pNumRows = 1])

Delete a row, updating all possible related data

Tags:

throws:	Exception
access:	public

Parameters:

int	$pRow	Remove starting with this one
int	$pNumRows	Number of rows to remove

[ Top ]

void setAutoFilter(
[string
$pRange = ''])

Set Autofilter Range

Tags:

throws:	Exception
access:	public

Parameters:

string

$pRange

Cell range (i.e. A1:E10)

[ Top ]

void setAutoFilterByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0])

Set Autofilter Range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the second cell
int	$pRow2	Numeric row coordinate of the second cell

[ Top ]

void setBreak(
[string
$pCell = 'A1'], [int
$pBreak = PHPExcel_Worksheet::BREAK_NONE])

Set break on a cell

Tags:

throws:	Exception
access:	public

Parameters:

string	$pCell	Cell coordinate (e.g. A1)
int	$pBreak	Break type (type of PHPExcel_Worksheet::BREAK_*)

[ Top ]

void setBreakByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0], [int
$pBreak = PHPExcel_Worksheet::BREAK_NONE])

Set break on a cell by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell
int	$pBreak	Break type (type of PHPExcel_Worksheet::BREAK_*)

[ Top ]

void setCellValue(
[string
$pCoordinate = 'A1'], [mixed
$pValue = null])

Set a cell value

Tags:

access:

public

Parameters:

string	$pCoordinate	Coordinate of the cell
mixed	$pValue	Value of the cell

[ Top ]

void setCellValueByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 0], [mixed
$pValue = null])

Set a cell value by using numeric cell coordinates

Tags:

access:

public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell
mixed	$pValue	Value of the cell

[ Top ]

void setCellValueExplicit(
[string
$pCoordinate = 'A1'], [mixed
$pValue = null], [string
$pDataType = PHPExcel_Cell_DataType::TYPE_STRING])

Set a cell value

Tags:

access:

public

Parameters:

string	$pCoordinate	Coordinate of the cell
mixed	$pValue	Value of the cell
string	$pDataType	Explicit data type

[ Top ]

void setCellValueExplicitByColumnAndRow(
[string
$pColumn = 0], [string
$pRow = 0], [mixed
$pValue = null], [string
$pDataType = PHPExcel_Cell_DataType::TYPE_STRING])

Set a cell value by using numeric cell coordinates

Tags:

access:

public

Parameters:

string	$pColumn	Numeric column coordinate of the cell
string	$pRow	Numeric row coordinate of the cell
mixed	$pValue	Value of the cell
string	$pDataType	Explicit data type

[ Top ]

void setDefaultStyle(

$value)

Set default style - should only be used by PHPExcel_IReader implementations!

Tags:

throws:	Exception
access:	public

Parameters:

PHPExcel_Style

$value

[ Top ]

void setHashIndex(
string
$value)

Set hash index Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Tags:

access:

public

Parameters:

string

$value

Hash index

[ Top ]

void setHeaderFooter(
PHPExcel_Worksheet_HeaderFooter
$pValue)

Set page header/footer

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_HeaderFooter

$pValue

[ Top ]

void setPageMargins(
PHPExcel_Worksheet_PageMargins
$pValue)

Set page margins

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_PageMargins

$pValue

[ Top ]

void setPageSetup(
PHPExcel_Worksheet_PageSetup
$pValue)

Set page setup

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_PageSetup

$pValue

[ Top ]

void setPrintGridlines(
[boolean
$pValue = false])

Set print gridlines

Tags:

access:

public

Parameters:

boolean

$pValue

Print gridlines (true/false)

[ Top ]

void setProtection(
PHPExcel_Worksheet_Protection
$pValue)

Set Protection

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_Protection

$pValue

[ Top ]

void setSelectedCell(
[string
$pCell = ''])

Selected cell

Tags:

throws:	Exception
access:	public

Parameters:

string

$pCell

Cell (i.e. A1)

[ Top ]

void setSelectedCellByColumnAndRow(
[int
$pColumn = 0], [int
$pRow = 0])

Selected cell by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn	Numeric column coordinate of the cell
int	$pRow	Numeric row coordinate of the cell

[ Top ]

void setSharedStyle(
[
$pSharedCellStyle = null], [string
$pRange = ''])

Set shared cell style to a range of cells

Set shared cell style to a range of cells Please note that this will overwrite existing cell styles for cells in range!

Tags:

throws:	Exception
access:	public

Parameters:

PHPExcel_Style	$pSharedCellStyle	Cell style to share
string	$pRange	Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")

[ Top ]

void setSheetView(
PHPExcel_Worksheet_SheetView
$pValue)

Set sheet view

Tags:

access:

public

Parameters:

PHPExcel_Worksheet_SheetView

$pValue

[ Top ]

void setShowGridlines(
[boolean
$pValue = false])

Set show gridlines

Tags:

access:

public

Parameters:

boolean

$pValue

Show gridlines (true/false)

[ Top ]

void setShowSummaryBelow(
[boolean
$pValue = true])

Set show summary below

Tags:

access:

public

Parameters:

boolean

$pValue

Show summary below (true/false)

[ Top ]

void setShowSummaryRight(
[boolean
$pValue = true])

Set show summary right

Tags:

access:

public

Parameters:

boolean

$pValue

Show summary right (true/false)

[ Top ]

void setTitle(
[string
$pValue = 'Worksheet'])

Set title

Tags:

access:

public

Parameters:

string

$pValue

String containing the dimension of this worksheet

[ Top ]

void sortCellCollection(
)

Sort collection of cells

Tags:

access:

public

[ Top ]

array toArray(
[mixed
$nullValue = null], [boolean
$calculateFormulas = true])

Create array from worksheet

Tags:

access:

public

Parameters:

mixed	$nullValue	Value treated as "null"
boolean	$calculateFormulas	Should formulas be calculated?

[ Top ]

string unfreezePane(
)

Unfreeze Pane

Tags:

access:

public

[ Top ]

void unmergeCells(
[string
$pRange = 'A1:A1'])

Remove merge on a cell range

Tags:

throws:	Exception
access:	public

Parameters:

string

$pRange

Cell range (e.g. A1:E1)

[ Top ]

void unmergeCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0])

Remove merge on a cell range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell

[ Top ]

void unprotectCells(
[string
$pRange = 'A1'])

Remove protection on a cell range

Tags:

throws:	Exception
access:	public

Parameters:

string

$pRange

Cell (e.g. A1) or cell range (e.g. A1:E1)

[ Top ]

void unprotectCellsByColumnAndRow(
[int
$pColumn1 = 0], [int
$pRow1 = 0], [int
$pColumn2 = 0], [int
$pRow2 = 0], [string
$pPassword = ''], [boolean
$pAlreadyHashed = false])

Remove protection on a cell range by using numeric cell coordinates

Tags:

throws:	Exception
access:	public

Parameters:

int	$pColumn1	Numeric column coordinate of the first cell
int	$pRow1	Numeric row coordinate of the first cell
int	$pColumn2	Numeric column coordinate of the last cell
int	$pRow2	Numeric row coordinate of the last cell
string	$pPassword	Password to unlock the protection
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

[ Top ]

void __clone(
)

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

Tags:

access:

public

[ Top ]

Class: PHPExcel_Worksheet

Class Overview

Author(s):

Copyright:

Variables

Constants

Methods

Class Details

Tags:

Class Variables

$_autoFilter = ''

Tags:

$_breaks = array()

Tags:

$_cellCollection = array()

Tags:

$_cellCollectionIsSorted = false

Tags:

$_columnDimensions = array()

Tags:

$_comments = array()

Tags:

$_defaultColumnDimension = null

Tags:

$_defaultRowDimension = null

Tags:

$_drawingCollection = null

Tags:

$_freezePane = ''

Tags:

$_hashIndex =

Tags:

$_headerFooter =

Tags:

$_mergeCells = array()

Tags:

$_pageMargins =

Tags:

$_pageSetup =

Tags:

$_parent =

Tags:

$_printGridlines = false

Tags:

$_protectedCells = array()

Tags:

$_protection =

Tags:

$_rowDimensions = array()

Tags:

$_selectedCell = 'A1'

Tags:

$_sheetView =

Tags:

$_showGridlines = true

Tags:

$_showSummaryBelow = true

Tags:

$_showSummaryRight = true

Tags:

$_styles = array()

Tags:

$_title =

Tags:

Class Methods

static method extractSheetTitle [line 1975]

Tags:

Parameters:

constructor __construct [line 298]

Tags:

Parameters:

method calculateColumnWidths [line 488]

Tags:

Parameters:

method calculateWorksheetDimension [line 477]

Tags:

method cellExists [line 868]

Tags:

Parameters:

method cellExistsByColumnAndRow [line 912]