PHPXRef 0.7.1 : Unnamed Project : Detail view of Worksheet.php

Class: PHPExcel_Worksheet - X-Ref

PHPExcel_Worksheet

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

__construct(PHPExcel $pParent = null, $pTitle = 'Worksheet') X-Ref

Create a new worksheet

param: PHPExcel $pParent
param: string $pTitle

disconnectCells() X-Ref

Disconnect all cells from this PHPExcel_Worksheet object,
typically so that the worksheet object can be unset

__destruct() X-Ref

Code to execute when this worksheet is unset()

getCellCacheController() X-Ref

Return the cache controller for the cell collection

return: PHPExcel_CachedObjectStorage_xxx

getInvalidCharacters() X-Ref

Get array of invalid characters for sheet title

return: array

checkSheetCodeName($pValue) X-Ref

Check sheet code name for valid Excel syntax

param: string $pValue The string to check
return: string The valid string

checkSheetTitle($pValue) X-Ref

Check sheet title for valid Excel syntax

param: string $pValue The string to check
return: string The valid string

getCellCollection($pSorted = true) X-Ref

Get collection of cells

param: boolean $pSorted Also sort the cell collection?
return: PHPExcel_Cell[]

sortCellCollection() X-Ref

Sort collection of cells

return: PHPExcel_Worksheet

getRowDimensions() X-Ref

Get collection of row dimensions

return: PHPExcel_Worksheet_RowDimension[]

getDefaultRowDimension() X-Ref

Get default row dimension

return: PHPExcel_Worksheet_RowDimension

getColumnDimensions() X-Ref

Get collection of column dimensions

return: PHPExcel_Worksheet_ColumnDimension[]

getDefaultColumnDimension() X-Ref

Get default column dimension

return: PHPExcel_Worksheet_ColumnDimension

getDrawingCollection() X-Ref

Get collection of drawings

return: PHPExcel_Worksheet_BaseDrawing[]

getChartCollection() X-Ref

Get collection of charts

return: PHPExcel_Chart[]

addChart(PHPExcel_Chart $pChart = null, $iChartIndex = null) X-Ref

Add chart

param: PHPExcel_Chart $pChart
param: int|null $iChartIndex Index where chart should go (0,1,..., or null for last)
return: PHPExcel_Chart

getChartCount() X-Ref

Return the count of charts on this worksheet

return: int The number of charts

getChartByIndex($index = null) X-Ref

Get a chart by its index position

param: string $index Chart index position
return: false|PHPExcel_Chart

getChartNames() X-Ref

Return an array of the names of charts on this worksheet

return: string[] The names of charts

getChartByName($chartName = '') X-Ref

Get a chart by name

param: string $chartName Chart name
return: false|PHPExcel_Chart

refreshColumnDimensions() X-Ref

Refresh column dimensions

return: PHPExcel_Worksheet

refreshRowDimensions() X-Ref

Refresh row dimensions

return: PHPExcel_Worksheet

calculateWorksheetDimension() X-Ref

Calculate worksheet dimension

return: string String containing the dimension of this worksheet

calculateWorksheetDataDimension() X-Ref

Calculate worksheet data dimension

return: string String containing the dimension of this worksheet that actually contain data

calculateColumnWidths($calculateMergeCells = false) X-Ref

Calculate widths for auto-size columns

param: boolean $calculateMergeCells Calculate merge cell width
return: PHPExcel_Worksheet;

getParent() X-Ref

Get parent

return: PHPExcel

rebindParent(PHPExcel $parent) X-Ref

Re-bind parent

param: PHPExcel $parent
return: PHPExcel_Worksheet

getTitle() X-Ref

Get title

return: string

setTitle($pValue = 'Worksheet', $updateFormulaCellReferences = true) X-Ref

Set title

param: string $pValue String containing the dimension of this worksheet
param: string $updateFormulaCellReferences boolean Flag indicating whether cell references in formulae should
return: PHPExcel_Worksheet

getSheetState() X-Ref

Get sheet state

return: string Sheet state (visible, hidden, veryHidden)

setSheetState($value = PHPExcel_Worksheet::SHEETSTATE_VISIBLE) X-Ref

Set sheet state

param: string $value Sheet state (visible, hidden, veryHidden)
return: PHPExcel_Worksheet

getPageSetup() X-Ref

Get page setup

return: PHPExcel_Worksheet_PageSetup

setPageSetup(PHPExcel_Worksheet_PageSetup $pValue) X-Ref

Set page setup

param: PHPExcel_Worksheet_PageSetup $pValue
return: PHPExcel_Worksheet

getPageMargins() X-Ref

Get page margins

return: PHPExcel_Worksheet_PageMargins

setPageMargins(PHPExcel_Worksheet_PageMargins $pValue) X-Ref

Set page margins

param: PHPExcel_Worksheet_PageMargins $pValue
return: PHPExcel_Worksheet

getHeaderFooter() X-Ref

Get page header/footer

return: PHPExcel_Worksheet_HeaderFooter

setHeaderFooter(PHPExcel_Worksheet_HeaderFooter $pValue) X-Ref

Set page header/footer

param: PHPExcel_Worksheet_HeaderFooter $pValue
return: PHPExcel_Worksheet

getSheetView() X-Ref

Get sheet view

return: PHPExcel_Worksheet_SheetView

setSheetView(PHPExcel_Worksheet_SheetView $pValue) X-Ref

Set sheet view

param: PHPExcel_Worksheet_SheetView $pValue
return: PHPExcel_Worksheet

getProtection() X-Ref

Get Protection

return: PHPExcel_Worksheet_Protection

setProtection(PHPExcel_Worksheet_Protection $pValue) X-Ref

Set Protection

param: PHPExcel_Worksheet_Protection $pValue
return: PHPExcel_Worksheet

getHighestColumn($row = null) X-Ref

Get highest worksheet column

param: string $row Return the data highest column for the specified row,
return: string Highest column name

getHighestDataColumn($row = null) X-Ref

Get highest worksheet column that contains data

param: string $row Return the highest data column for the specified row,
return: string Highest column name that contains data

getHighestRow($column = null) X-Ref

Get highest worksheet row

param: string $column Return the highest data row for the specified column,
return: int Highest row number

getHighestDataRow($column = null) X-Ref

Get highest worksheet row that contains data

param: string $column Return the highest data row for the specified column,
return: string Highest row number that contains data

getHighestRowAndColumn() X-Ref

Get highest worksheet column and highest row that have cell records

return: array Highest column name and highest row number

setCellValue($pCoordinate = 'A1', $pValue = null, $returnCell = false) X-Ref

Set a cell value

param: string $pCoordinate Coordinate of the cell
param: mixed $pValue Value of the cell
param: bool $returnCell Return the worksheet (false, default) or the cell (true)
return: PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

setCellValueByColumnAndRow($pColumn = 0, $pRow = 1, $pValue = null, $returnCell = false) X-Ref

Set a cell value by using numeric cell coordinates

param: string $pColumn Numeric column coordinate of the cell (A = 0)
param: string $pRow Numeric row coordinate of the cell
param: mixed $pValue Value of the cell
param: bool $returnCell Return the worksheet (false, default) or the cell (true)
return: PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

setCellValueExplicit($pCoordinate = 'A1', $pValue = null, $pDataType = PHPExcel_Cell_DataType::TYPE_STRING, $returnCell = false) X-Ref

Set a cell value

param: string $pCoordinate Coordinate of the cell
param: mixed $pValue Value of the cell
param: string $pDataType Explicit data type
param: bool $returnCell Return the worksheet (false, default) or the cell (true)
return: PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

setCellValueExplicitByColumnAndRow($pColumn = 0, $pRow = 1, $pValue = null, $pDataType = PHPExcel_Cell_DataType::TYPE_STRING, $returnCell = false) X-Ref

Set a cell value by using numeric cell coordinates

param: string $pColumn Numeric column coordinate of the cell
param: string $pRow Numeric row coordinate of the cell
param: mixed $pValue Value of the cell
param: string $pDataType Explicit data type
param: bool $returnCell Return the worksheet (false, default) or the cell (true)
return: PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

getCell($pCoordinate = 'A1') X-Ref

Get cell at a specific coordinate

param: string $pCoordinate Coordinate of the cell
return: PHPExcel_Cell Cell that was found

getCellByColumnAndRow($pColumn = 0, $pRow = 1) X-Ref

Get cell at a specific coordinate by using numeric cell coordinates

param: string $pColumn Numeric column coordinate of the cell
param: string $pRow Numeric row coordinate of the cell
return: PHPExcel_Cell Cell that was found

createNewCell($pCoordinate) X-Ref

Create a new cell at the specified coordinate

param: string $pCoordinate Coordinate of the cell
return: PHPExcel_Cell Cell that was created

cellExists($pCoordinate = 'A1') X-Ref

Does the cell at a specific coordinate exist?

param: string $pCoordinate Coordinate of the cell
return: boolean

cellExistsByColumnAndRow($pColumn = 0, $pRow = 1) X-Ref

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

param: string $pColumn Numeric column coordinate of the cell
param: string $pRow Numeric row coordinate of the cell
return: boolean

getRowDimension($pRow = 1, $create = true) X-Ref

Get row dimension at a specific row

param: int $pRow Numeric index of the row
return: PHPExcel_Worksheet_RowDimension

getColumnDimension($pColumn = 'A', $create = true) X-Ref

Get column dimension at a specific column

param: string $pColumn String index of the column
return: PHPExcel_Worksheet_ColumnDimension

getColumnDimensionByColumn($pColumn = 0) X-Ref

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

param: string $pColumn Numeric column coordinate of the cell
return: PHPExcel_Worksheet_ColumnDimension

getStyles() X-Ref

Get styles

return: PHPExcel_Style[]

getDefaultStyle() X-Ref

Get default style of workbook.

return: PHPExcel_Style

setDefaultStyle(PHPExcel_Style $pValue) X-Ref

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

param: PHPExcel_Style $pValue
return: PHPExcel_Worksheet

getStyle($pCellCoordinate = 'A1') X-Ref

Get style for cell

param: string $pCellCoordinate Cell coordinate (or range) to get style for
return: PHPExcel_Style

getConditionalStyles($pCoordinate = 'A1') X-Ref

Get conditional styles for a cell

param: string $pCoordinate
return: PHPExcel_Style_Conditional[]

conditionalStylesExists($pCoordinate = 'A1') X-Ref

Do conditional styles exist for this cell?

param: string $pCoordinate
return: boolean

removeConditionalStyles($pCoordinate = 'A1') X-Ref

Removes conditional styles for a cell

param: string $pCoordinate
return: PHPExcel_Worksheet

getConditionalStylesCollection() X-Ref

Get collection of conditional styles

return: array

setConditionalStyles($pCoordinate = 'A1', $pValue) X-Ref

Set conditional styles

param: $pCoordinate string E.g. 'A1'
param: $pValue PHPExcel_Style_Conditional[]
return: PHPExcel_Worksheet

getStyleByColumnAndRow($pColumn = 0, $pRow = 1, $pColumn2 = null, $pRow2 = null) X-Ref

Get style for cell by using numeric cell coordinates

param: int $pColumn Numeric column coordinate of the cell
param: int $pRow Numeric row coordinate of the cell
param: int pColumn2 Numeric column coordinate of the range cell
param: int pRow2 Numeric row coordinate of the range cell
return: PHPExcel_Style

setSharedStyle(PHPExcel_Style $pSharedCellStyle = null, $pRange = '') X-Ref

Set shared cell style to a range of cells

Please note that this will overwrite existing cell styles for cells in range!

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

duplicateStyle(PHPExcel_Style $pCellStyle = null, $pRange = '') X-Ref

Duplicate cell style to a range of cells

Please note that this will overwrite existing cell styles for cells in range!

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

duplicateConditionalStyle(array $pCellStyle = null, $pRange = '') X-Ref

Duplicate conditional style to a range of cells

Please note that this will overwrite existing cell styles for cells in range!

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

duplicateStyleArray($pStyles = null, $pRange = '', $pAdvanced = true) X-Ref

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.

param: array $pStyles Array containing style information
param: string $pRange Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
param: boolean $pAdvanced Advanced mode for setting borders.
return: PHPExcel_Worksheet

setBreak($pCell = 'A1', $pBreak = PHPExcel_Worksheet::BREAK_NONE) X-Ref

Set break on a cell

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

setBreakByColumnAndRow($pColumn = 0, $pRow = 1, $pBreak = PHPExcel_Worksheet::BREAK_NONE) X-Ref

Set break on a cell by using numeric cell coordinates

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

getBreaks() X-Ref

Get breaks

return: array[]

mergeCells($pRange = 'A1:A1') X-Ref

Set merge on a cell range

param: string $pRange Cell range (e.g. A1:E1)
return: PHPExcel_Worksheet

mergeCellsByColumnAndRow($pColumn1 = 0, $pRow1 = 1, $pColumn2 = 0, $pRow2 = 1) X-Ref

Set merge on a cell range by using numeric cell coordinates

param: int $pColumn1    Numeric column coordinate of the first cell
param: int $pRow1        Numeric row coordinate of the first cell
param: int $pColumn2    Numeric column coordinate of the last cell
param: int $pRow2        Numeric row coordinate of the last cell
return: PHPExcel_Worksheet

unmergeCells($pRange = 'A1:A1') X-Ref

Remove merge on a cell range

param: string $pRange Cell range (e.g. A1:E1)
return: PHPExcel_Worksheet

unmergeCellsByColumnAndRow($pColumn1 = 0, $pRow1 = 1, $pColumn2 = 0, $pRow2 = 1) X-Ref

Remove merge on a cell range by using numeric cell coordinates

param: int $pColumn1    Numeric column coordinate of the first cell
param: int $pRow1        Numeric row coordinate of the first cell
param: int $pColumn2    Numeric column coordinate of the last cell
param: int $pRow2        Numeric row coordinate of the last cell
return: PHPExcel_Worksheet

getMergeCells() X-Ref

Get merge cells array.

return: array[]

setMergeCells($pValue = array() X-Ref

Set merge cells array for the entire sheet. Use instead mergeCells() to merge
a single cell range.

param: array

protectCells($pRange = 'A1', $pPassword = '', $pAlreadyHashed = false) X-Ref

Set protection on a cell range

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

protectCellsByColumnAndRow($pColumn1 = 0, $pRow1 = 1, $pColumn2 = 0, $pRow2 = 1, $pPassword = '', $pAlreadyHashed = false) X-Ref

Set protection on a cell range by using numeric cell coordinates

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

unprotectCells($pRange = 'A1') X-Ref

Remove protection on a cell range

param: string $pRange Cell (e.g. A1) or cell range (e.g. A1:E1)
return: PHPExcel_Worksheet

unprotectCellsByColumnAndRow($pColumn1 = 0, $pRow1 = 1, $pColumn2 = 0, $pRow2 = 1, $pPassword = '', $pAlreadyHashed = false) X-Ref

Remove protection on a cell range by using numeric cell coordinates

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

getProtectedCells() X-Ref

Get protected cells

return: array[]

getAutoFilter() X-Ref

Get Autofilter

return: PHPExcel_Worksheet_AutoFilter

setAutoFilter($pValue) X-Ref

Set AutoFilter

param: PHPExcel_Worksheet_AutoFilter|string $pValue
return: PHPExcel_Worksheet

setAutoFilterByColumnAndRow($pColumn1 = 0, $pRow1 = 1, $pColumn2 = 0, $pRow2 = 1) X-Ref

Set Autofilter Range by using numeric cell coordinates

param: integer  $pColumn1    Numeric column coordinate of the first cell
param: integer  $pRow1       Numeric row coordinate of the first cell
param: integer  $pColumn2    Numeric column coordinate of the second cell
param: integer  $pRow2       Numeric row coordinate of the second cell
return: PHPExcel_Worksheet

removeAutoFilter() X-Ref

Remove autofilter

return: PHPExcel_Worksheet

getFreezePane() X-Ref

Get Freeze Pane

return: string

freezePane($pCell = '') X-Ref

Freeze Pane

param: string $pCell Cell (i.e. A2)
return: PHPExcel_Worksheet

freezePaneByColumnAndRow($pColumn = 0, $pRow = 1) X-Ref

Freeze Pane by using numeric cell coordinates

param: int $pColumn Numeric column coordinate of the cell
param: int $pRow Numeric row coordinate of the cell
return: PHPExcel_Worksheet

unfreezePane() X-Ref

Unfreeze Pane

return: PHPExcel_Worksheet

insertNewRowBefore($pBefore = 1, $pNumRows = 1) X-Ref

Insert a new row, updating all possible related data

param: int $pBefore Insert before this one
param: int $pNumRows Number of rows to insert
return: PHPExcel_Worksheet

insertNewColumnBefore($pBefore = 'A', $pNumCols = 1) X-Ref

Insert a new column, updating all possible related data

param: int $pBefore Insert before this one
param: int $pNumCols Number of columns to insert
return: PHPExcel_Worksheet

insertNewColumnBeforeByIndex($pBefore = 0, $pNumCols = 1) X-Ref

Insert a new column, updating all possible related data

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

removeRow($pRow = 1, $pNumRows = 1) X-Ref

Delete a row, updating all possible related data

param: int $pRow Remove starting with this one
param: int $pNumRows Number of rows to remove
return: PHPExcel_Worksheet

removeColumn($pColumn = 'A', $pNumCols = 1) X-Ref

Remove a column, updating all possible related data

param: string $pColumn Remove starting with this one
param: int $pNumCols Number of columns to remove
return: PHPExcel_Worksheet

removeColumnByIndex($pColumn = 0, $pNumCols = 1) X-Ref

Remove a column, updating all possible related data

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

getShowGridlines() X-Ref

Show gridlines?

return: boolean

setShowGridlines($pValue = false) X-Ref

Set show gridlines

param: boolean $pValue Show gridlines (true/false)
return: PHPExcel_Worksheet

getPrintGridlines() X-Ref

Print gridlines?

return: boolean

setPrintGridlines($pValue = false) X-Ref

Set print gridlines

param: boolean $pValue Print gridlines (true/false)
return: PHPExcel_Worksheet

getShowRowColHeaders() X-Ref

Show row and column headers?

return: boolean

setShowRowColHeaders($pValue = false) X-Ref

Set show row and column headers

param: boolean $pValue Show row and column headers (true/false)
return: PHPExcel_Worksheet

getShowSummaryBelow() X-Ref

Show summary below? (Row/Column outlining)

return: boolean

setShowSummaryBelow($pValue = true) X-Ref

Set show summary below

param: boolean $pValue Show summary below (true/false)
return: PHPExcel_Worksheet

getShowSummaryRight() X-Ref

Show summary right? (Row/Column outlining)

return: boolean

setShowSummaryRight($pValue = true) X-Ref

Set show summary right

param: boolean $pValue Show summary right (true/false)
return: PHPExcel_Worksheet

getComments() X-Ref

Get comments

return: PHPExcel_Comment[]

setComments($pValue = array() X-Ref

Set comments array for the entire sheet.

param: array of PHPExcel_Comment
return: PHPExcel_Worksheet

getComment($pCellCoordinate = 'A1') X-Ref

Get comment for cell

param: string $pCellCoordinate Cell coordinate to get comment for
return: PHPExcel_Comment

getCommentByColumnAndRow($pColumn = 0, $pRow = 1) X-Ref

Get comment for cell by using numeric cell coordinates

param: int $pColumn Numeric column coordinate of the cell
param: int $pRow Numeric row coordinate of the cell
return: PHPExcel_Comment

getSelectedCell() X-Ref

Get selected cell

return: string

getActiveCell() X-Ref

Get active cell

return: string Example: 'A1'

getSelectedCells() X-Ref

Get selected cells

return: string

setSelectedCell($pCoordinate = 'A1') X-Ref

Selected cell

param: string $pCoordinate Cell (i.e. A1)
return: PHPExcel_Worksheet

setSelectedCells($pCoordinate = 'A1') X-Ref

Select a range of cells.

param: string $pCoordinate Cell range, examples: 'A1', 'B2:G5', 'A:C', '3:6'
return: PHPExcel_Worksheet

setSelectedCellByColumnAndRow($pColumn = 0, $pRow = 1) X-Ref

Selected cell by using numeric cell coordinates

param: int $pColumn Numeric column coordinate of the cell
param: int $pRow Numeric row coordinate of the cell
return: PHPExcel_Worksheet

getRightToLeft() X-Ref

Get right-to-left

return: boolean

setRightToLeft($value = false) X-Ref

Set right-to-left

param: boolean $value Right-to-left true/false
return: PHPExcel_Worksheet

fromArray($source = null, $nullValue = null, $startCell = 'A1', $strictNullComparison = false) X-Ref

Fill worksheet from values in array

param: array $source Source array
param: mixed $nullValue Value in source array that stands for blank cell
param: string $startCell Insert array starting from this cell address as the top left coordinate
param: boolean $strictNullComparison Apply strict comparison when testing for null values in the array
return: PHPExcel_Worksheet

rangeToArray($pRange = 'A1', $nullValue = null, $calculateFormulas = true, $formatData = true, $returnCellRef = false) X-Ref

Create array from a range of cells

param: string $pRange Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
param: mixed $nullValue Value returned in the array entry if a cell doesn't exist
param: boolean $calculateFormulas Should formulas be calculated?
param: boolean $formatData Should formatting be applied to cell values?
param: boolean $returnCellRef False - Return a simple array of rows and columns indexed by number counting from zero
return: array

namedRangeToArray($pNamedRange = '', $nullValue = null, $calculateFormulas = true, $formatData = true, $returnCellRef = false) X-Ref

Create array from a range of cells

param: string $pNamedRange Name of the Named Range
param: mixed  $nullValue Value returned in the array entry if a cell doesn't exist
param: boolean $calculateFormulas  Should formulas be calculated?
param: boolean $formatData  Should formatting be applied to cell values?
param: boolean $returnCellRef False - Return a simple array of rows and columns indexed by number counting from zero
return: array

toArray($nullValue = null, $calculateFormulas = true, $formatData = true, $returnCellRef = false) X-Ref

Create array from worksheet

param: mixed $nullValue Value returned in the array entry if a cell doesn't exist
param: boolean $calculateFormulas Should formulas be calculated?
param: boolean $formatData Should formatting be applied to cell values?
param: boolean $returnCellRef False - Return a simple array of rows and columns indexed by number counting from zero
return: array

getRowIterator($startRow = 1, $endRow = null) X-Ref

Get row iterator

param: integer $startRow The row number at which to start iterating
param: integer $endRow The row number at which to stop iterating
return: PHPExcel_Worksheet_RowIterator

getColumnIterator($startColumn = 'A', $endColumn = null) X-Ref

Get column iterator

param: string $startColumn The column address at which to start iterating
param: string $endColumn The column address at which to stop iterating
return: PHPExcel_Worksheet_ColumnIterator

garbageCollect() X-Ref

Run PHPExcel garabage collector.

return: PHPExcel_Worksheet

getHashCode() X-Ref

Get hash code

return: string Hash code

extractSheetTitle($pRange, $returnRange = false) X-Ref

Extract worksheet title from range.

Example: extractSheetTitle("testSheet!A1") ==> 'A1'
Example: extractSheetTitle("'testSheet 1'!A1", true) ==> array('testSheet 1', 'A1');

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

getHyperlink($pCellCoordinate = 'A1') X-Ref

Get hyperlink

param: string $pCellCoordinate Cell coordinate to get hyperlink for

setHyperlink($pCellCoordinate = 'A1', PHPExcel_Cell_Hyperlink $pHyperlink = null) X-Ref

Set hyperlnk

param: string $pCellCoordinate Cell coordinate to insert hyperlink
param: PHPExcel_Cell_Hyperlink $pHyperlink
return: PHPExcel_Worksheet

hyperlinkExists($pCoordinate = 'A1') X-Ref

Hyperlink at a specific coordinate exists?

param: string $pCoordinate
return: boolean

getHyperlinkCollection() X-Ref

Get collection of hyperlinks

return: PHPExcel_Cell_Hyperlink[]

getDataValidation($pCellCoordinate = 'A1') X-Ref

Get data validation

param: string $pCellCoordinate Cell coordinate to get data validation for

setDataValidation($pCellCoordinate = 'A1', PHPExcel_Cell_DataValidation $pDataValidation = null) X-Ref

Set data validation

param: string $pCellCoordinate Cell coordinate to insert data validation
param: PHPExcel_Cell_DataValidation $pDataValidation
return: PHPExcel_Worksheet

dataValidationExists($pCoordinate = 'A1') X-Ref

Data validation at a specific coordinate exists?

param: string $pCoordinate
return: boolean

getDataValidationCollection() X-Ref

Get collection of data validations

return: PHPExcel_Cell_DataValidation[]

shrinkRangeToFit($range) X-Ref

Accepts a range, returning it as a range that falls within the current highest row and column of the worksheet

param: string $range
return: string Adjusted range value

getTabColor() X-Ref

Get tab color

return: PHPExcel_Style_Color

resetTabColor() X-Ref

Reset tab color

return: PHPExcel_Worksheet

isTabColorSet() X-Ref

Tab color set?

return: boolean

copy() X-Ref

Copy worksheet (!= clone!)

return: PHPExcel_Worksheet

__clone() X-Ref

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

setCodeName($pValue = null) X-Ref

Define the code name of the sheet

param: null|string Same rule as Title minus space not allowed (but, like Excel, change silently space to underscore)
return: objWorksheet

getCodeName() X-Ref

Return the code name of the sheet

return: null|string

hasCodeName() X-Ref

Sheet has a code name ?

return: boolean

File Size:	2961 lines (94 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Unnamed Project

/lib/phpexcel/PHPExcel/ -> Worksheet.php (summary)

Defines 1 class