ILIAS  eassessment Revision 61809
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Data Fields | Static Private Member Functions | Private Attributes | Static Private Attributes
PHPExcel_Worksheet Class Reference
+ Inheritance diagram for PHPExcel_Worksheet:
+ Collaboration diagram for PHPExcel_Worksheet:

Public Member Functions

 __construct (PHPExcel $pParent=null, $pTitle= 'Worksheet')
 Create a new worksheet.
 disconnectCells ()
 getCellCacheController ()
 Return the cache controller for the cell collection.
 getCellCollection ($pSorted=true)
 Get collection of cells.
 sortCellCollection ()
 Sort collection of cells.
 getRowDimensions ()
 Get collection of row dimensions.
 getDefaultRowDimension ()
 Get default row dimension.
 getColumnDimensions ()
 Get collection of column dimensions.
 getDefaultColumnDimension ()
 Get default column dimension.
 getDrawingCollection ()
 Get collection of drawings.
 refreshColumnDimensions ()
 Refresh column dimensions.
 refreshRowDimensions ()
 Refresh row dimensions.
 calculateWorksheetDimension ()
 Calculate worksheet dimension.
 calculateColumnWidths ($calculateMergeCells=false)
 Calculate widths for auto-size columns.
 getParent ()
 Get parent.
 rebindParent (PHPExcel $parent)
 Re-bind parent.
 getTitle ()
 Get title.
 setTitle ($pValue= 'Worksheet')
 Set title.
 getSheetState ()
 Get sheet state.
 setSheetState ($value=PHPExcel_Worksheet::SHEETSTATE_VISIBLE)
 Set sheet state.
 getPageSetup ()
 Get page setup.
 setPageSetup (PHPExcel_Worksheet_PageSetup $pValue)
 Set page setup.
 getPageMargins ()
 Get page margins.
 setPageMargins (PHPExcel_Worksheet_PageMargins $pValue)
 Set page margins.
 getHeaderFooter ()
 Get page header/footer.
 setHeaderFooter (PHPExcel_Worksheet_HeaderFooter $pValue)
 Set page header/footer.
 getSheetView ()
 Get sheet view.
 setSheetView (PHPExcel_Worksheet_SheetView $pValue)
 Set sheet view.
 getProtection ()
 Get Protection.
 setProtection (PHPExcel_Worksheet_Protection $pValue)
 Set Protection.
 getHighestColumn ()
 Get highest worksheet column.
 getHighestRow ()
 Get highest worksheet row.
 setCellValue ($pCoordinate= 'A1', $pValue=null, $returnCell=false)
 Set a cell value.
 setCellValueByColumnAndRow ($pColumn=0, $pRow=1, $pValue=null, $returnCell=false)
 Set a cell value by using numeric cell coordinates.
 setCellValueExplicit ($pCoordinate= 'A1', $pValue=null, $pDataType=PHPExcel_Cell_DataType::TYPE_STRING)
 Set a cell value.
 setCellValueExplicitByColumnAndRow ($pColumn=0, $pRow=1, $pValue=null, $pDataType=PHPExcel_Cell_DataType::TYPE_STRING)
 Set a cell value by using numeric cell coordinates.
 getCell ($pCoordinate= 'A1')
 Get cell at a specific coordinate.
 getCellByColumnAndRow ($pColumn=0, $pRow=1)
 Get cell at a specific coordinate by using numeric cell coordinates.
 cellExists ($pCoordinate= 'A1')
 Cell at a specific coordinate exists?
 cellExistsByColumnAndRow ($pColumn=0, $pRow=1)
 Cell at a specific coordinate by using numeric cell coordinates exists?
 getRowDimension ($pRow=1)
 Get row dimension at a specific row.
 getColumnDimension ($pColumn= 'A')
 Get column dimension at a specific column.
 getColumnDimensionByColumn ($pColumn=0)
 Get column dimension at a specific column by using numeric cell coordinates.
 getStyles ()
 Get styles.
 getDefaultStyle ()
 Get default style of workbork.
 setDefaultStyle (PHPExcel_Style $pValue)
 Set default style - should only be used by PHPExcel_IReader implementations!
 getStyle ($pCellCoordinate= 'A1')
 Get style for cell.
 getConditionalStyles ($pCoordinate= 'A1')
 Get conditional styles for a cell.
 conditionalStylesExists ($pCoordinate= 'A1')
 Do conditional styles exist for this cell?
 removeConditionalStyles ($pCoordinate= 'A1')
 Removes conditional styles for a cell.
 getConditionalStylesCollection ()
 Get collection of conditional styles.
 setConditionalStyles ($pCoordinate= 'A1', $pValue)
 Set conditional styles.
 getStyleByColumnAndRow ($pColumn=0, $pRow=1)
 Get style for cell by using numeric cell coordinates.
 setSharedStyle (PHPExcel_Style $pSharedCellStyle=null, $pRange= '')
 Set shared cell style to a range of cells.
 duplicateStyle (PHPExcel_Style $pCellStyle=null, $pRange= '')
 Duplicate cell style to a range of cells.
 duplicateStyleArray ($pStyles=null, $pRange= '', $pAdvanced=true)
 Duplicate cell style array to a range of cells.
 setBreak ($pCell= 'A1', $pBreak=PHPExcel_Worksheet::BREAK_NONE)
 Set break on a cell.
 setBreakByColumnAndRow ($pColumn=0, $pRow=1, $pBreak=PHPExcel_Worksheet::BREAK_NONE)
 Set break on a cell by using numeric cell coordinates.
 getBreaks ()
 Get breaks.
 mergeCells ($pRange= 'A1:A1')
 Set merge on a cell range.
 mergeCellsByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1)
 Set merge on a cell range by using numeric cell coordinates.
 unmergeCells ($pRange= 'A1:A1')
 Remove merge on a cell range.
 unmergeCellsByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1)
 Remove merge on a cell range by using numeric cell coordinates.
 getMergeCells ()
 Get merge cells array.
 setMergeCells ($pValue=array())
 Set merge cells array for the entire sheet.
 protectCells ($pRange= 'A1', $pPassword= '', $pAlreadyHashed=false)
 Set protection on a cell range.
 protectCellsByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1, $pPassword= '', $pAlreadyHashed=false)
 Set protection on a cell range by using numeric cell coordinates.
 unprotectCells ($pRange= 'A1')
 Remove protection on a cell range.
 unprotectCellsByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1, $pPassword= '', $pAlreadyHashed=false)
 Remove protection on a cell range by using numeric cell coordinates.
 getProtectedCells ()
 Get protected cells.
 getAutoFilter ()
 Get Autofilter Range.
 setAutoFilter ($pRange= '')
 Set Autofilter Range.
 setAutoFilterByColumnAndRow ($pColumn1=0, $pRow1=1, $pColumn2=0, $pRow2=1)
 Set Autofilter Range by using numeric cell coordinates.
 removeAutoFilter ()
 Remove autofilter.
 getFreezePane ()
 Get Freeze Pane.
 freezePane ($pCell= '')
 Freeze Pane.
 freezePaneByColumnAndRow ($pColumn=0, $pRow=1)
 Freeze Pane by using numeric cell coordinates.
 unfreezePane ()
 Unfreeze Pane.
 insertNewRowBefore ($pBefore=1, $pNumRows=1)
 Insert a new row, updating all possible related data.
 insertNewColumnBefore ($pBefore= 'A', $pNumCols=1)
 Insert a new column, updating all possible related data.
 insertNewColumnBeforeByIndex ($pBefore=0, $pNumCols=1)
 Insert a new column, updating all possible related data.
 removeRow ($pRow=1, $pNumRows=1)
 Delete a row, updating all possible related data.
 removeColumn ($pColumn= 'A', $pNumCols=1)
 Remove a column, updating all possible related data.
 removeColumnByIndex ($pColumn=0, $pNumCols=1)
 Remove a column, updating all possible related data.
 getShowGridlines ()
 Show gridlines?
 setShowGridlines ($pValue=false)
 Set show gridlines.
 getPrintGridlines ()
 Print gridlines?
 setPrintGridlines ($pValue=false)
 Set print gridlines.
 getShowRowColHeaders ()
 Show row and column headers?
 setShowRowColHeaders ($pValue=false)
 Set show row and column headers.
 getShowSummaryBelow ()
 Show summary below? (Row/Column outlining)
 setShowSummaryBelow ($pValue=true)
 Set show summary below.
 getShowSummaryRight ()
 Show summary right? (Row/Column outlining)
 setShowSummaryRight ($pValue=true)
 Set show summary right.
 getComments ()
 Get comments.
 setComments ($pValue=array())
 Set comments array for the entire sheet.
 getComment ($pCellCoordinate= 'A1')
 Get comment for cell.
 getCommentByColumnAndRow ($pColumn=0, $pRow=1)
 Get comment for cell by using numeric cell coordinates.
 getSelectedCell ()
 Get selected cell.
 getActiveCell ()
 Get active cell.
 getSelectedCells ()
 Get selected cells.
 setSelectedCell ($pCoordinate= 'A1')
 Selected cell.
 setSelectedCells ($pCoordinate= 'A1')
 Select a range of cells.
 setSelectedCellByColumnAndRow ($pColumn=0, $pRow=1)
 Selected cell by using numeric cell coordinates.
 getRightToLeft ()
 Get right-to-left.
 setRightToLeft ($value=false)
 Set right-to-left.
 fromArray ($source=null, $nullValue=null, $startCell= 'A1', $strictNullComparison=false)
 Fill worksheet from values in array.
 rangeToArray ($pRange= 'A1', $nullValue=null, $calculateFormulas=true, $formatData=true, $returnCellRef=false)
 Create array from a range of cells.
 namedRangeToArray ($pNamedRange= '', $nullValue=null, $calculateFormulas=true, $formatData=true, $returnCellRef=false)
 Create array from a range of cells.
 toArray ($nullValue=null, $calculateFormulas=true, $formatData=true, $returnCellRef=false)
 Create array from worksheet.
 getRowIterator ()
 Get row iterator.
 garbageCollect ()
 Run PHPExcel garabage collector.
 getHashCode ()
 Get hash code.
 getHyperlink ($pCellCoordinate= 'A1')
 Get hyperlink.
 setHyperlink ($pCellCoordinate= 'A1', PHPExcel_Cell_Hyperlink $pHyperlink=null)
 Set hyperlnk.
 hyperlinkExists ($pCoordinate= 'A1')
 Hyperlink at a specific coordinate exists?
 getHyperlinkCollection ()
 Get collection of hyperlinks.
 getDataValidation ($pCellCoordinate= 'A1')
 Get data validation.
 setDataValidation ($pCellCoordinate= 'A1', PHPExcel_Cell_DataValidation $pDataValidation=null)
 Set data validation.
 dataValidationExists ($pCoordinate= 'A1')
 Data validation at a specific coordinate exists?
 getDataValidationCollection ()
 Get collection of data validations.
 shrinkRangeToFit ($range)
 Accepts a range, returning it as a range that falls within the current highest row and column of the worksheet.
 getTabColor ()
 Get tab color.
 resetTabColor ()
 Reset tab color.
 isTabColorSet ()
 Tab color set?
 copy ()
 Copy worksheet (!= clone!)
 __clone ()
 Implement PHP __clone to create a deep clone, not just a shallow copy.

Static Public Member Functions

static getInvalidCharacters ()
 Get array of invalid characters for sheet title.
static extractSheetTitle ($pRange, $returnRange=false)
 Extract worksheet title from range.

Data Fields

const BREAK_NONE = 0
const BREAK_ROW = 1
const BREAK_COLUMN = 2
const SHEETSTATE_VISIBLE = 'visible'
const SHEETSTATE_HIDDEN = 'hidden'
const SHEETSTATE_VERYHIDDEN = 'veryHidden'

Static Private Member Functions

static _checkSheetTitle ($pValue)
 Check sheet title for valid Excel syntax.

Private Attributes

 $_parent
 $_cellCollection = null
 $_rowDimensions = array()
 $_defaultRowDimension = null
 $_columnDimensions = array()
 $_defaultColumnDimension = null
 $_drawingCollection = null
 $_title
 $_sheetState
 $_pageSetup
 $_pageMargins
 $_headerFooter
 $_sheetView
 $_protection
 $_styles = array()
 $_conditionalStylesCollection = array()
 $_cellCollectionIsSorted = false
 $_breaks = array()
 $_mergeCells = array()
 $_protectedCells = array()
 $_autoFilter = ''
 $_freezePane = ''
 $_showGridlines = true
 $_printGridlines = false
 $_showRowColHeaders = true
 $_showSummaryBelow = true
 $_showSummaryRight = true
 $_comments = array()
 $_activeCell = 'A1'
 $_selectedCells = 'A1'
 $_cachedHighestColumn = 'A'
 $_cachedHighestRow = 1
 $_rightToLeft = false
 $_hyperlinkCollection = array()
 $_dataValidationCollection = array()
 $_tabColor
 $_dirty = true
 $_hash = null

Static Private Attributes

static $_invalidCharacters = array('*', ':', '/', '\\', '?', '[', ']')

Detailed Description

Definition at line 36 of file Worksheet.php.

Constructor & Destructor Documentation

PHPExcel_Worksheet::__construct ( PHPExcel  $pParent = null,
  $pTitle = 'Worksheet' 
)

Create a new worksheet.

Parameters
PHPExcel$pParent
string$pTitle

Definition at line 327 of file Worksheet.php.

References PHPExcel_CachedObjectStorageFactory\getInstance(), setSheetState(), setTitle(), and SHEETSTATE_VISIBLE.

{
// Set parent and title
$this->_parent = $pParent;
$this->setTitle($pTitle);
$this->setSheetState(PHPExcel_Worksheet::SHEETSTATE_VISIBLE);
$this->_cellCollection = PHPExcel_CachedObjectStorageFactory::getInstance($this);
// Set page setup
$this->_pageSetup = new PHPExcel_Worksheet_PageSetup();
// Set page margins
$this->_pageMargins = new PHPExcel_Worksheet_PageMargins();
// Set page header/footer
$this->_headerFooter = new PHPExcel_Worksheet_HeaderFooter();
// Set sheet view
$this->_sheetView = new PHPExcel_Worksheet_SheetView();
// Drawing collection
$this->_drawingCollection = new ArrayObject();
// Protection
$this->_protection = new PHPExcel_Worksheet_Protection();
// Default row dimension
$this->_defaultRowDimension = new PHPExcel_Worksheet_RowDimension(null);
// Default column dimension
$this->_defaultColumnDimension = new PHPExcel_Worksheet_ColumnDimension(null);
}

+ Here is the call graph for this function:

Member Function Documentation

PHPExcel_Worksheet::__clone ( )

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

Definition at line 2563 of file Worksheet.php.

References $_cellCollection, and $_drawingCollection.

{
foreach ($this as $key => $val) {
if ($key == '_parent') {
continue;
}
if (is_object($val) || (is_array($val))) {
if ($key == '_cellCollection') {
$newCollection = clone $this->_cellCollection;
$newCollection->copyCellCollection($this);
$this->_cellCollection = $newCollection;
} elseif ($key == '_drawingCollection') {
$newCollection = clone $this->_drawingCollection;
$this->_drawingCollection = $newCollection;
} else {
$this->{$key} = unserialize(serialize($val));
}
}
}
}
static PHPExcel_Worksheet::_checkSheetTitle (   $pValue)
staticprivate

Check sheet title for valid Excel syntax.

Parameters
string$pValueThe string to check
Returns
string The valid string
Exceptions
Exception

Definition at line 397 of file Worksheet.php.

References PHPExcel_Shared_String\CountCharacters().

Referenced by setTitle().

{
// Some of the printable ASCII characters are invalid: * : / \ ? [ ]
if (str_replace(self::$_invalidCharacters, '', $pValue) !== $pValue) {
throw new Exception('Invalid character found in sheet title');
}
// Maximum 31 characters allowed for sheet title
if (PHPExcel_Shared_String::CountCharacters($pValue) > 31) {
throw new Exception('Maximum 31 characters allowed in sheet title.');
}
return $pValue;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::calculateColumnWidths (   $calculateMergeCells = false)

Calculate widths for auto-size columns.

Parameters
boolean$calculateMergeCellsCalculate merge cell width
Returns
PHPExcel_Worksheet;

Definition at line 548 of file Worksheet.php.

References PHPExcel_Shared_Font\calculateColumnWidth(), PHPExcel_Cell\extractAllCellReferencesInRange(), getCell(), getCellCollection(), getColumnDimension(), getColumnDimensions(), getDefaultColumnDimension(), getDefaultStyle(), getMergeCells(), getParent(), and PHPExcel_Style_NumberFormat\toFormattedString().

{
// initialize $autoSizes array
$autoSizes = array();
foreach ($this->getColumnDimensions() as $colDimension) {
if ($colDimension->getAutoSize()) {
$autoSizes[$colDimension->getColumnIndex()] = -1;
}
}
// There is only something to do if there are some auto-size columns
if (!empty($autoSizes)) {
// build list of cells references that participate in a merge
$isMergeCell = array();
foreach ($this->getMergeCells() as $cells) {
foreach (PHPExcel_Cell::extractAllCellReferencesInRange($cells) as $cellReference) {
$isMergeCell[$cellReference] = true;
}
}
// loop through all cells in the worksheet
foreach ($this->getCellCollection(false) as $cellID) {
$cell = $this->getCell($cellID);
if (isset($autoSizes[$cell->getColumn()])) {
// Determine width if cell does not participate in a merge
if (!isset($isMergeCell[$cell->getCoordinate()])) {
// Calculated value
$cellValue = $cell->getCalculatedValue();
// To formatted string
$cellValue = PHPExcel_Style_NumberFormat::toFormattedString($cellValue, $this->getParent()->getCellXfByIndex($cell->getXfIndex())->getNumberFormat()->getFormatCode());
$autoSizes[$cell->getColumn()] = max(
(float)$autoSizes[$cell->getColumn()],
(float)PHPExcel_Shared_Font::calculateColumnWidth(
$this->getParent()->getCellXfByIndex($cell->getXfIndex())->getFont(),
$cellValue,
$this->getParent()->getCellXfByIndex($cell->getXfIndex())->getAlignment()->getTextRotation(),
$this->getDefaultStyle()->getFont()
)
);
}
}
}
// adjust column widths
foreach ($autoSizes as $columnIndex => $width) {
if ($width == -1) $width = $this->getDefaultColumnDimension()->getWidth();
$this->getColumnDimension($columnIndex)->setWidth($width);
}
}
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::calculateWorksheetDimension ( )

Calculate worksheet dimension.

Returns
string String containing the dimension of this worksheet

Definition at line 536 of file Worksheet.php.

References getHighestColumn(), and getHighestRow().

{
// Return
return 'A1' . ':' . $this->getHighestColumn() . $this->getHighestRow();
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::cellExists (   $pCoordinate = 'A1')

Cell at a specific coordinate exists?

Parameters
string$pCoordinateCoordinate of the cell
Exceptions
Exception
Returns
boolean

Definition at line 1022 of file Worksheet.php.

References PHPExcel_Calculation\CALCULATION_REGEXP_CELLREF, PHPExcel_Calculation\CALCULATION_REGEXP_NAMEDRANGE, PHPExcel_Cell\coordinateFromString(), extractSheetTitle(), getHashCode(), getParent(), getTitle(), and PHPExcel_NamedRange\resolveRange().

Referenced by cellExistsByColumnAndRow(), and mergeCells().

{
// Worksheet reference?
if (strpos($pCoordinate, '!') !== false) {
$worksheetReference = PHPExcel_Worksheet::extractSheetTitle($pCoordinate, true);
return $this->getParent()->getSheetByName($worksheetReference[0])->cellExists($worksheetReference[1]);
}
// Named range?
if ((!preg_match('/^'.PHPExcel_Calculation::CALCULATION_REGEXP_CELLREF.'$/i', $pCoordinate, $matches)) &&
(preg_match('/^'.PHPExcel_Calculation::CALCULATION_REGEXP_NAMEDRANGE.'$/i', $pCoordinate, $matches))) {
$namedRange = PHPExcel_NamedRange::resolveRange($pCoordinate, $this);
if (!is_null($namedRange)) {
$pCoordinate = $namedRange->getRange();
if ($this->getHashCode() != $namedRange->getWorksheet()->getHashCode()) {
if (!$namedRange->getLocalOnly()) {
return $namedRange->getWorksheet()->cellExists($pCoordinate);
} else {
throw new Exception('Named range ' . $namedRange->getName() . ' is not accessible from within sheet ' . $this->getTitle());
}
}
}
}
// Uppercase coordinate
$pCoordinate = strtoupper($pCoordinate);
if (strpos($pCoordinate,':') !== false || strpos($pCoordinate,',') !== false) {
throw new Exception('Cell coordinate can not be a range of cells.');
} elseif (strpos($pCoordinate,'$') !== false) {
throw new Exception('Cell coordinate must not be absolute.');
} else {
// Coordinates
$aCoordinates = PHPExcel_Cell::coordinateFromString($pCoordinate);
// Cell exists?
return $this->_cellCollection->isDataSet($pCoordinate);
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::cellExistsByColumnAndRow (   $pColumn = 0,
  $pRow = 1 
)

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

Parameters
string$pColumnNumeric column coordinate of the cell
string$pRowNumeric row coordinate of the cell
Returns
boolean

Definition at line 1069 of file Worksheet.php.

References cellExists(), and PHPExcel_Cell\stringFromColumnIndex().

{
return $this->cellExists(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::conditionalStylesExists (   $pCoordinate = 'A1')

Do conditional styles exist for this cell?

Parameters
string$pCoordinate
Returns
boolean

Definition at line 1206 of file Worksheet.php.

{
if (isset($this->_conditionalStylesCollection[$pCoordinate])) {
return true;
}
return false;
}
PHPExcel_Worksheet::copy ( )

Copy worksheet (!= clone!)

Returns
PHPExcel_Worksheet

Definition at line 2554 of file Worksheet.php.

{
$copied = clone $this;
return $copied;
}
PHPExcel_Worksheet::dataValidationExists (   $pCoordinate = 'A1')

Data validation at a specific coordinate exists?

Parameters
string$pCellCoordinate
Returns
boolean

Definition at line 2470 of file Worksheet.php.

{
return isset($this->_dataValidationCollection[$pCoordinate]);
}
PHPExcel_Worksheet::disconnectCells ( )

Definition at line 362 of file Worksheet.php.

{
$this->_cellCollection->unsetWorksheetCells();
$this->_cellCollection = null;
// detach ourself from the workbook, so that it can then delete this worksheet successfully
$this->_parent = null;
}
PHPExcel_Worksheet::duplicateStyle ( PHPExcel_Style  $pCellStyle = null,
  $pRange = '' 
)

Duplicate cell style to a range of cells.

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

Parameters
PHPExcel_Style$pCellStyleCell style to duplicate
string$pRangeRange of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1288 of file Worksheet.php.

References $_parent, $row, PHPExcel_Cell\columnIndexFromString(), PHPExcel_Cell\coordinateFromString(), getCell(), and PHPExcel_Cell\stringFromColumnIndex().

Referenced by setSharedStyle().

{
// make sure we have a real style and not supervisor
$style = $pCellStyle->getIsSupervisor() ? $pCellStyle->getSharedComponent() : $pCellStyle;
// Add the style to the workbook if necessary
$workbook = $this->_parent;
if ($existingStyle = $this->_parent->getCellXfByHashCode($pCellStyle->getHashCode())) {
// there is already such cell Xf in our collection
$xfIndex = $existingStyle->getIndex();
} else {
// we don't have such a cell Xf, need to add
$workbook->addCellXf($pCellStyle);
$xfIndex = $pCellStyle->getIndex();
}
// Uppercase coordinate
$pRange = strtoupper($pRange);
// Is it a cell range or a single cell?
$rangeA = '';
$rangeB = '';
if (strpos($pRange, ':') === false) {
$rangeA = $pRange;
$rangeB = $pRange;
} else {
list($rangeA, $rangeB) = explode(':', $pRange);
}
// Calculate range outer borders
$rangeStart = PHPExcel_Cell::coordinateFromString($rangeA);
$rangeEnd = PHPExcel_Cell::coordinateFromString($rangeB);
// Translate column into index
$rangeStart[0] = PHPExcel_Cell::columnIndexFromString($rangeStart[0]) - 1;
$rangeEnd[0] = PHPExcel_Cell::columnIndexFromString($rangeEnd[0]) - 1;
// Make sure we can loop upwards on rows and columns
if ($rangeStart[0] > $rangeEnd[0] && $rangeStart[1] > $rangeEnd[1]) {
$tmp = $rangeStart;
$rangeStart = $rangeEnd;
$rangeEnd = $tmp;
}
// Loop through cells and apply styles
for ($col = $rangeStart[0]; $col <= $rangeEnd[0]; ++$col) {
for ($row = $rangeStart[1]; $row <= $rangeEnd[1]; ++$row) {
$this->getCell(PHPExcel_Cell::stringFromColumnIndex($col) . $row)->setXfIndex($xfIndex);
}
}
return $this;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::duplicateStyleArray (   $pStyles = null,
  $pRange = '',
  $pAdvanced = true 
)

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.

Deprecated:
Parameters
array$pStylesArray containing style information
string$pRangeRange of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
boolean$pAdvancedAdvanced mode for setting borders.
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1356 of file Worksheet.php.

References getStyle().

{
$this->getStyle($pRange)->applyFromArray($pStyles, $pAdvanced);
return $this;
}

+ Here is the call graph for this function:

static PHPExcel_Worksheet::extractSheetTitle (   $pRange,
  $returnRange = false 
)
static

Extract worksheet title from range.

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

Parameters
string$pRangeRange to extract title from
bool$returnRangeReturn range? (see example)
Returns
mixed

Definition at line 2360 of file Worksheet.php.

Referenced by cellExists(), PHPExcel_Calculation\extractCellRange(), PHPExcel_Calculation\extractNamedRange(), getCell(), and PHPExcel_Reader_Excel2007\load().

{
// Sheet title included?
if (($sep = strpos($pRange, '!')) === false) {
return '';
}
if ($returnRange) {
return array( trim(substr($pRange, 0, $sep),"'"),
substr($pRange, $sep + 1)
);
}
return substr($pRange, $sep + 1);
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::freezePane (   $pCell = '')

Freeze Pane.

Parameters
string$pCellCell (i.e. A1)
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1693 of file Worksheet.php.

Referenced by freezePaneByColumnAndRow(), and unfreezePane().

{
// Uppercase coordinate
$pCell = strtoupper($pCell);
if (strpos($pCell,':') === false && strpos($pCell,',') === false) {
$this->_freezePane = $pCell;
} else {
throw new Exception('Freeze pane can not be set on a range of cells.');
}
return $this;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::freezePaneByColumnAndRow (   $pColumn = 0,
  $pRow = 1 
)

Freeze Pane by using numeric cell coordinates.

Parameters
int$pColumnNumeric column coordinate of the cell
int$pRowNumeric row coordinate of the cell
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1714 of file Worksheet.php.

References freezePane(), and PHPExcel_Cell\stringFromColumnIndex().

{
return $this->freezePane(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::fromArray (   $source = null,
  $nullValue = null,
  $startCell = 'A1',
  $strictNullComparison = false 
)

Fill worksheet from values in array.

Parameters
array$sourceSource array
mixed$nullValueValue in source array that stands for blank cell
string$startCellInsert array starting from this cell address as the top left coordinate
boolean$strictNullComparisonApply strict comparison when testing for null values in the array
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 2119 of file Worksheet.php.

References PHPExcel_Cell\coordinateFromString(), and getCell().

{
if (is_array($source)) {
// Convert a 1-D array to 2-D (for ease of looping)
if (!is_array(end($source))) {
$source = array($source);
}
// start coordinate
list ($startColumn, $startRow) = PHPExcel_Cell::coordinateFromString($startCell);
// Loop through $source
foreach ($source as $rowData) {
$currentColumn = $startColumn;
foreach($rowData as $cellValue) {
if ($strictNullComparison) {
if ($cellValue !== $nullValue) {
// Set cell value
$this->getCell($currentColumn . $startRow)->setValue($cellValue);
}
} else {
if ($cellValue != $nullValue) {
// Set cell value
$this->getCell($currentColumn . $startRow)->setValue($cellValue);
}
}
++$currentColumn;
}
++$startRow;
}
} else {
throw new Exception("Parameter \$source should be an array.");
}
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::garbageCollect ( )

Run PHPExcel garabage collector.

Returns
PHPExcel_Worksheet

Definition at line 2284 of file Worksheet.php.

References $row, PHPExcel_Cell\columnIndexFromString(), and PHPExcel_Cell\stringFromColumnIndex().

Referenced by toArray().

{
// Build a reference table from images
// $imageCoordinates = array();
// $iterator = $this->getDrawingCollection()->getIterator();
// while ($iterator->valid()) {
// $imageCoordinates[$iterator->current()->getCoordinates()] = true;
//
// $iterator->next();
// }
//
// Lookup highest column and highest row if cells are cleaned
$highestColumn = -1;
$highestRow = 1;
// Find cells that can be cleaned
$col = $row = array();
foreach ($this->_cellCollection->getCellList() as $coord) {
list($c,$r) = sscanf($coord,'%[A-Z]%d');
$row[$r] = $r;
$col[$c] = strlen($c).$c;
}
if (count($row) > 0) {
// Determine highest column and row
$highestRow = max($row);
$highestColumn = PHPExcel_Cell::columnIndexFromString(substr(max($col),1));
}
// Loop through column dimensions
foreach ($this->_columnDimensions as $dimension) {
$highestColumn = max($highestColumn,PHPExcel_Cell::columnIndexFromString($dimension->getColumnIndex()));
}
// Loop through row dimensions
foreach ($this->_rowDimensions as $dimension) {
$highestRow = max($highestRow,$dimension->getRowIndex());
}
// Cache values
if ($highestColumn < 0) {
$this->_cachedHighestColumn = 'A';
} else {
$this->_cachedHighestColumn = PHPExcel_Cell::stringFromColumnIndex(--$highestColumn);
}
$this->_cachedHighestRow = $highestRow;
// Return
return $this;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getActiveCell ( )

Get active cell.

Returns
string Example: 'A1'

Definition at line 2016 of file Worksheet.php.

References $_activeCell.

{
return $this->_activeCell;
}
PHPExcel_Worksheet::getAutoFilter ( )

Get Autofilter Range.

Returns
string

Definition at line 1620 of file Worksheet.php.

References $_autoFilter.

{
return $this->_autoFilter;
}
PHPExcel_Worksheet::getBreaks ( )

Get breaks.

Returns
array[]

Definition at line 1403 of file Worksheet.php.

References $_breaks.

Referenced by PHPExcel_Writer_HTML\_generateRow().

{
return $this->_breaks;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getCell (   $pCoordinate = 'A1')

Get cell at a specific coordinate.

Parameters
string$pCoordinateCoordinate of the cell
Exceptions
Exception
Returns
PHPExcel_Cell Cell that was found

Definition at line 925 of file Worksheet.php.

References PHPExcel_Calculation\CALCULATION_REGEXP_CELLREF, PHPExcel_Calculation\CALCULATION_REGEXP_NAMEDRANGE, PHPExcel_Cell\columnIndexFromString(), PHPExcel_Cell\coordinateFromString(), extractSheetTitle(), getColumnDimensions(), getParent(), getRowDimensions(), PHPExcel_NamedRange\resolveRange(), and PHPExcel_Cell_DataType\TYPE_NULL.

Referenced by PHPExcel\addExternalSheet(), calculateColumnWidths(), duplicateStyle(), fromArray(), mergeCells(), setCellValue(), setCellValueByColumnAndRow(), setCellValueExplicit(), and setCellValueExplicitByColumnAndRow().

{
// Check cell collection
if ($this->_cellCollection->isDataSet($pCoordinate)) {
return $this->_cellCollection->getCacheData($pCoordinate);
}
// Worksheet reference?
if (strpos($pCoordinate, '!') !== false) {
$worksheetReference = PHPExcel_Worksheet::extractSheetTitle($pCoordinate, true);
return $this->getParent()->getSheetByName($worksheetReference[0])->getCell($worksheetReference[1]);
}
// Named range?
if ((!preg_match('/^'.PHPExcel_Calculation::CALCULATION_REGEXP_CELLREF.'$/i', $pCoordinate, $matches)) &&
(preg_match('/^'.PHPExcel_Calculation::CALCULATION_REGEXP_NAMEDRANGE.'$/i', $pCoordinate, $matches))) {
$namedRange = PHPExcel_NamedRange::resolveRange($pCoordinate, $this);
if (!is_null($namedRange)) {
$pCoordinate = $namedRange->getRange();
return $namedRange->getWorksheet()->getCell($pCoordinate);
}
}
// Uppercase coordinate
$pCoordinate = strtoupper($pCoordinate);
if (strpos($pCoordinate,':') !== false || strpos($pCoordinate,',') !== false) {
throw new Exception('Cell coordinate can not be a range of cells.');
} elseif (strpos($pCoordinate,'$') !== false) {
throw new Exception('Cell coordinate must not be absolute.');
} else {
// Create new cell object
// Coordinates
$aCoordinates = PHPExcel_Cell::coordinateFromString($pCoordinate);
$cell = $this->_cellCollection->addCacheData($pCoordinate,new PHPExcel_Cell($aCoordinates[0], $aCoordinates[1], null, PHPExcel_Cell_DataType::TYPE_NULL, $this));
$this->_cellCollectionIsSorted = false;
if (PHPExcel_Cell::columnIndexFromString($this->_cachedHighestColumn) < PHPExcel_Cell::columnIndexFromString($aCoordinates[0]))
$this->_cachedHighestColumn = $aCoordinates[0];
$this->_cachedHighestRow = max($this->_cachedHighestRow,$aCoordinates[1]);
// Cell needs appropriate xfIndex
$rowDimensions = $this->getRowDimensions();
$columnDimensions = $this->getColumnDimensions();
if ( isset($rowDimensions[$aCoordinates[1]]) && $rowDimensions[$aCoordinates[1]]->getXfIndex() !== null ) {
// then there is a row dimension with explicit style, assign it to the cell
$cell->setXfIndex($rowDimensions[$aCoordinates[1]]->getXfIndex());
} else if ( isset($columnDimensions[$aCoordinates[0]]) ) {
// then there is a column dimension, assign it to the cell
$cell->setXfIndex($columnDimensions[$aCoordinates[0]]->getXfIndex());
} else {
// set to default index
$cell->setXfIndex(0);
}
return $cell;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getCellByColumnAndRow (   $pColumn = 0,
  $pRow = 1 
)

Get cell at a specific coordinate by using numeric cell coordinates.

Parameters
string$pColumnNumeric column coordinate of the cell
string$pRowNumeric row coordinate of the cell
Returns
PHPExcel_Cell Cell that was found

Definition at line 995 of file Worksheet.php.

References PHPExcel_Cell\columnIndexFromString(), PHPExcel_Cell\stringFromColumnIndex(), and PHPExcel_Cell_DataType\TYPE_NULL.

{
$columnLetter = PHPExcel_Cell::stringFromColumnIndex($pColumn);
$coordinate = $columnLetter . $pRow;
if (!$this->_cellCollection->isDataSet($coordinate)) {
$cell = $this->_cellCollection->addCacheData($coordinate, new PHPExcel_Cell($columnLetter, $pRow, null, PHPExcel_Cell_DataType::TYPE_NULL, $this));
$this->_cellCollectionIsSorted = false;
if (PHPExcel_Cell::columnIndexFromString($this->_cachedHighestColumn) < $pColumn)
$this->_cachedHighestColumn = $columnLetter;
$this->_cachedHighestRow = max($this->_cachedHighestRow,$pRow);
return $cell;
}
return $this->_cellCollection->getCacheData($coordinate);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::getCellCacheController ( )

Return the cache controller for the cell collection.

Returns
PHPExcel_CachedObjectStorage_xxx

Definition at line 375 of file Worksheet.php.

References $_cellCollection.

{
return $this->_cellCollection;
} // function getCellCacheController()
PHPExcel_Worksheet::getCellCollection (   $pSorted = true)

Get collection of cells.

Parameters
boolean$pSortedAlso sort the cell collection?
Returns
PHPExcel_Cell[]

Definition at line 418 of file Worksheet.php.

References sortCellCollection().

Referenced by PHPExcel\addExternalSheet(), and calculateColumnWidths().

{
if ($pSorted) {
// Re-order cell collection
return $this->sortCellCollection();
}
if (!is_null($this->_cellCollection)) {
return $this->_cellCollection->getCellList();
}
return array();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getColumnDimension (   $pColumn = 'A')

Get column dimension at a specific column.

Parameters
string$pColumnString index of the column
Returns
PHPExcel_Worksheet_ColumnDimension

Definition at line 1100 of file Worksheet.php.

References PHPExcel_Cell\columnIndexFromString().

Referenced by calculateColumnWidths(), and getColumnDimensionByColumn().

{
// Uppercase coordinate
$pColumn = strtoupper($pColumn);
// Fetch dimensions
if (!isset($this->_columnDimensions[$pColumn])) {
$this->_columnDimensions[$pColumn] = new PHPExcel_Worksheet_ColumnDimension($pColumn);
if (PHPExcel_Cell::columnIndexFromString($this->_cachedHighestColumn) < PHPExcel_Cell::columnIndexFromString($pColumn))
$this->_cachedHighestColumn = $pColumn;
}
return $this->_columnDimensions[$pColumn];
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getColumnDimensionByColumn (   $pColumn = 0)

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

Parameters
string$pColumnNumeric column coordinate of the cell
string$pRowNumeric row coordinate of the cell
Returns
PHPExcel_Worksheet_ColumnDimension

Definition at line 1122 of file Worksheet.php.

References getColumnDimension(), and PHPExcel_Cell\stringFromColumnIndex().

{
return $this->getColumnDimension(PHPExcel_Cell::stringFromColumnIndex($pColumn));
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::getColumnDimensions ( )

Get collection of column dimensions.

Returns
PHPExcel_Worksheet_ColumnDimension[]

Definition at line 468 of file Worksheet.php.

References $_columnDimensions.

Referenced by calculateColumnWidths(), getCell(), and refreshColumnDimensions().

{
return $this->_columnDimensions;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getComment (   $pCellCoordinate = 'A1')

Get comment for cell.

Parameters
string$pCellCoordinateCell coordinate to get comment for
Returns
PHPExcel_Comment
Exceptions
Exception

Definition at line 1964 of file Worksheet.php.

Referenced by getCommentByColumnAndRow().

{
// Uppercase coordinate
$pCellCoordinate = strtoupper($pCellCoordinate);
if (strpos($pCellCoordinate,':') !== false || strpos($pCellCoordinate,',') !== false) {
throw new Exception('Cell coordinate string can not be a range of cells.');
} else if (strpos($pCellCoordinate,'$') !== false) {
throw new Exception('Cell coordinate string must not be absolute.');
} else if ($pCellCoordinate == '') {
throw new Exception('Cell coordinate can not be zero-length string.');
} else {
// Check if we already have a comment for this cell.
// If not, create a new comment.
if (isset($this->_comments[$pCellCoordinate])) {
return $this->_comments[$pCellCoordinate];
} else {
$newComment = new PHPExcel_Comment();
$this->_comments[$pCellCoordinate] = $newComment;
return $newComment;
}
}
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getCommentByColumnAndRow (   $pColumn = 0,
  $pRow = 1 
)

Get comment for cell by using numeric cell coordinates.

Parameters
int$pColumnNumeric column coordinate of the cell
int$pRowNumeric row coordinate of the cell
Returns
PHPExcel_Comment

Definition at line 1995 of file Worksheet.php.

References getComment(), and PHPExcel_Cell\stringFromColumnIndex().

{
return $this->getComment(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::getComments ( )

Get comments.

Returns
PHPExcel_Comment[]

Definition at line 1939 of file Worksheet.php.

References $_comments.

{
return $this->_comments;
}
PHPExcel_Worksheet::getConditionalStyles (   $pCoordinate = 'A1')

Get conditional styles for a cell.

Parameters
string$pCoordinate
Returns
PHPExcel_Style_Conditional[]

Definition at line 1192 of file Worksheet.php.

{
if (!isset($this->_conditionalStylesCollection[$pCoordinate])) {
$this->_conditionalStylesCollection[$pCoordinate] = array();
}
return $this->_conditionalStylesCollection[$pCoordinate];
}
PHPExcel_Worksheet::getConditionalStylesCollection ( )

Get collection of conditional styles.

Returns
array

Definition at line 1231 of file Worksheet.php.

References $_conditionalStylesCollection.

{
return $this->_conditionalStylesCollection;
}
PHPExcel_Worksheet::getDataValidation (   $pCellCoordinate = 'A1')

Get data validation.

Parameters
string$pCellCoordinateCell coordinate to get data validation for

Definition at line 2435 of file Worksheet.php.

{
// return data validation if we already have one
if (isset($this->_dataValidationCollection[$pCellCoordinate])) {
return $this->_dataValidationCollection[$pCellCoordinate];
}
// else create data validation
$this->_dataValidationCollection[$pCellCoordinate] = new PHPExcel_Cell_DataValidation();
return $this->_dataValidationCollection[$pCellCoordinate];
}
PHPExcel_Worksheet::getDataValidationCollection ( )

Get collection of data validations.

Returns
PHPExcel_Cell_DataValidation[]

Definition at line 2480 of file Worksheet.php.

References $_dataValidationCollection.

{
return $this->_dataValidationCollection;
}
PHPExcel_Worksheet::getDefaultColumnDimension ( )

Get default column dimension.

Returns
PHPExcel_Worksheet_ColumnDimension

Definition at line 478 of file Worksheet.php.

References $_defaultColumnDimension.

Referenced by calculateColumnWidths().

{
return $this->_defaultColumnDimension;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getDefaultRowDimension ( )

Get default row dimension.

Returns
PHPExcel_Worksheet_RowDimension

Definition at line 458 of file Worksheet.php.

References $_defaultRowDimension.

{
return $this->_defaultRowDimension;
}
PHPExcel_Worksheet::getDefaultStyle ( )

Get default style of workbork.

Deprecated:
Returns
PHPExcel_Style
Exceptions
Exception

Definition at line 1144 of file Worksheet.php.

Referenced by calculateColumnWidths().

{
return $this->_parent->getDefaultStyle();
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getDrawingCollection ( )

Get collection of drawings.

Returns
PHPExcel_Worksheet_BaseDrawing[]

Definition at line 488 of file Worksheet.php.

References $_drawingCollection.

Referenced by PHPExcel_Writer_HTML\_writeImageTagInCell().

{
return $this->_drawingCollection;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getFreezePane ( )

Get Freeze Pane.

Returns
string

Definition at line 1681 of file Worksheet.php.

References $_freezePane.

{
return $this->_freezePane;
}
PHPExcel_Worksheet::getHashCode ( )

Get hash code.

Returns
string Hash code

Implements PHPExcel_IComparable.

Definition at line 2338 of file Worksheet.php.

References $_hash.

Referenced by cellExists(), and PHPExcel\getIndex().

{
if ($this->_dirty) {
$this->_hash = md5( $this->_title .
$this->_autoFilter .
($this->_protection->isProtectionEnabled() ? 't' : 'f') .
__CLASS__
);
$this->_dirty = false;
}
return $this->_hash;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getHeaderFooter ( )

Get page header/footer.

Returns
PHPExcel_Worksheet_HeaderFooter

Definition at line 767 of file Worksheet.php.

References $_headerFooter.

{
return $this->_headerFooter;
}
PHPExcel_Worksheet::getHighestColumn ( )

Get highest worksheet column.

Returns
string Highest column name

Definition at line 835 of file Worksheet.php.

References $_cachedHighestColumn.

Referenced by calculateWorksheetDimension(), shrinkRangeToFit(), and toArray().

{
return $this->_cachedHighestColumn;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getHighestRow ( )

Get highest worksheet row.

Returns
int Highest row number

Definition at line 845 of file Worksheet.php.

References $_cachedHighestRow.

Referenced by calculateWorksheetDimension(), shrinkRangeToFit(), and toArray().

{
return $this->_cachedHighestRow;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getHyperlink (   $pCellCoordinate = 'A1')

Get hyperlink.

Parameters
string$pCellCoordinateCell coordinate to get hyperlink for

Definition at line 2380 of file Worksheet.php.

Referenced by PHPExcel_Writer_HTML\_generateRow().

{
// return hyperlink if we already have one
if (isset($this->_hyperlinkCollection[$pCellCoordinate])) {
return $this->_hyperlinkCollection[$pCellCoordinate];
}
// else create hyperlink
$this->_hyperlinkCollection[$pCellCoordinate] = new PHPExcel_Cell_Hyperlink();
return $this->_hyperlinkCollection[$pCellCoordinate];
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getHyperlinkCollection ( )

Get collection of hyperlinks.

Returns
PHPExcel_Cell_Hyperlink[]

Definition at line 2425 of file Worksheet.php.

References $_hyperlinkCollection.

{
return $this->_hyperlinkCollection;
}
static PHPExcel_Worksheet::getInvalidCharacters ( )
static

Get array of invalid characters for sheet title.

Returns
array

Definition at line 385 of file Worksheet.php.

References $_invalidCharacters.

{
return self::$_invalidCharacters;
}
PHPExcel_Worksheet::getMergeCells ( )

Get merge cells array.

Returns
array[]

Definition at line 1509 of file Worksheet.php.

References $_mergeCells.

Referenced by calculateColumnWidths().

{
return $this->_mergeCells;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getPageMargins ( )

Get page margins.

Returns
PHPExcel_Worksheet_PageMargins

Definition at line 745 of file Worksheet.php.

References $_pageMargins.

{
return $this->_pageMargins;
}
PHPExcel_Worksheet::getPageSetup ( )

Get page setup.

Returns
PHPExcel_Worksheet_PageSetup

Definition at line 723 of file Worksheet.php.

References $_pageSetup.

{
return $this->_pageSetup;
}
PHPExcel_Worksheet::getParent ( )

Get parent.

Returns
PHPExcel

Definition at line 609 of file Worksheet.php.

References $_parent.

Referenced by PHPExcel_Writer_HTML\_generateRow(), PHPExcel\addExternalSheet(), calculateColumnWidths(), cellExists(), getCell(), PHPExcel_NamedRange\resolveRange(), and setTitle().

{
return $this->_parent;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getPrintGridlines ( )

Print gridlines?

Returns
boolean

Definition at line 1859 of file Worksheet.php.

References $_printGridlines.

{
return $this->_printGridlines;
}
PHPExcel_Worksheet::getProtectedCells ( )

Get protected cells.

Returns
array[]

Definition at line 1610 of file Worksheet.php.

References $_protectedCells.

{
return $this->_protectedCells;
}
PHPExcel_Worksheet::getProtection ( )

Get Protection.

Returns
PHPExcel_Worksheet_Protection

Definition at line 811 of file Worksheet.php.

References $_protection.

{
return $this->_protection;
}
PHPExcel_Worksheet::getRightToLeft ( )

Get right-to-left.

Returns
boolean

Definition at line 2094 of file Worksheet.php.

References $_rightToLeft.

{
return $this->_rightToLeft;
}
PHPExcel_Worksheet::getRowDimension (   $pRow = 1)

Get row dimension at a specific row.

Parameters
int$pRowNumeric index of the row
Returns
PHPExcel_Worksheet_RowDimension

Definition at line 1080 of file Worksheet.php.

{
// Found
$found = null;
// Get row dimension
if (!isset($this->_rowDimensions[$pRow])) {
$this->_rowDimensions[$pRow] = new PHPExcel_Worksheet_RowDimension($pRow);
$this->_cachedHighestRow = max($this->_cachedHighestRow,$pRow);
}
return $this->_rowDimensions[$pRow];
}
PHPExcel_Worksheet::getRowDimensions ( )

Get collection of row dimensions.

Returns
PHPExcel_Worksheet_RowDimension[]

Definition at line 448 of file Worksheet.php.

References $_rowDimensions.

Referenced by getCell(), and refreshRowDimensions().

{
return $this->_rowDimensions;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getRowIterator ( )

Get row iterator.

Returns
PHPExcel_Worksheet_RowIterator

Definition at line 2275 of file Worksheet.php.

{
return new PHPExcel_Worksheet_RowIterator($this);
}
PHPExcel_Worksheet::getSelectedCell ( )

Get selected cell.

Deprecated:
Returns
string

Definition at line 2006 of file Worksheet.php.

References getSelectedCells().

{
return $this->getSelectedCells();
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::getSelectedCells ( )

Get selected cells.

Returns
string

Definition at line 2026 of file Worksheet.php.

References $_selectedCells.

Referenced by getSelectedCell().

{
return $this->_selectedCells;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getSheetState ( )

Get sheet state.

Returns
string Sheet state (visible, hidden, veryHidden)

Definition at line 703 of file Worksheet.php.

References $_sheetState.

{
return $this->_sheetState;
}
PHPExcel_Worksheet::getSheetView ( )

Get sheet view.

Returns
PHPExcel_Worksheet_HeaderFooter

Definition at line 789 of file Worksheet.php.

References $_sheetView.

{
return $this->_sheetView;
}
PHPExcel_Worksheet::getShowGridlines ( )

Show gridlines?

Returns
boolean

Definition at line 1839 of file Worksheet.php.

References $_showGridlines.

{
return $this->_showGridlines;
}
PHPExcel_Worksheet::getShowRowColHeaders ( )

Show row and column headers?

Returns
boolean

Definition at line 1879 of file Worksheet.php.

References $_showRowColHeaders.

{
return $this->_showRowColHeaders;
}
PHPExcel_Worksheet::getShowSummaryBelow ( )

Show summary below? (Row/Column outlining)

Returns
boolean

Definition at line 1899 of file Worksheet.php.

References $_showSummaryBelow.

{
return $this->_showSummaryBelow;
}
PHPExcel_Worksheet::getShowSummaryRight ( )

Show summary right? (Row/Column outlining)

Returns
boolean

Definition at line 1919 of file Worksheet.php.

References $_showSummaryRight.

{
return $this->_showSummaryRight;
}
PHPExcel_Worksheet::getStyle (   $pCellCoordinate = 'A1')

Get style for cell.

Parameters
string$pCellCoordinateCell coordinate to get style for
Returns
PHPExcel_Style
Exceptions
Exception

Definition at line 1175 of file Worksheet.php.

References setSelectedCells().

Referenced by duplicateStyleArray(), and getStyleByColumnAndRow().

{
// set this sheet as active
$this->_parent->setActiveSheetIndex($this->_parent->getIndex($this));
// set cell coordinate as active
$this->setSelectedCells($pCellCoordinate);
return $this->_parent->getCellXfSupervisor();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::getStyleByColumnAndRow (   $pColumn = 0,
  $pRow = 1 
)

Get style for cell by using numeric cell coordinates.

Parameters
int$pColumnNumeric column coordinate of the cell
int$pRowNumeric row coordinate of the cell
Returns
PHPExcel_Style

Definition at line 1256 of file Worksheet.php.

References getStyle(), and PHPExcel_Cell\stringFromColumnIndex().

{
return $this->getStyle(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::getStyles ( )

Get styles.

Returns
PHPExcel_Style[]

Definition at line 1132 of file Worksheet.php.

References $_styles.

{
return $this->_styles;
}
PHPExcel_Worksheet::getTabColor ( )

Get tab color.

Returns
PHPExcel_Style_Color

Definition at line 2518 of file Worksheet.php.

References $_tabColor.

{
if (is_null($this->_tabColor))
$this->_tabColor = new PHPExcel_Style_Color();
return $this->_tabColor;
}
PHPExcel_Worksheet::getTitle ( )

Get title.

Returns
string

Definition at line 638 of file Worksheet.php.

References $_title.

Referenced by PHPExcel\addExternalSheet(), cellExists(), and setTitle().

{
return $this->_title;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::hyperlinkExists (   $pCoordinate = 'A1')

Hyperlink at a specific coordinate exists?

Parameters
string$pCellCoordinate
Returns
boolean

Definition at line 2415 of file Worksheet.php.

Referenced by PHPExcel_Writer_HTML\_generateRow().

{
return isset($this->_hyperlinkCollection[$pCoordinate]);
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::insertNewColumnBefore (   $pBefore = 'A',
  $pNumCols = 1 
)

Insert a new column, updating all possible related data.

Parameters
int$pBeforeInsert before this one
int$pNumColsNumber of columns to insert
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1755 of file Worksheet.php.

References PHPExcel_ReferenceHelper\getInstance().

Referenced by insertNewColumnBeforeByIndex().

{
if (!is_numeric($pBefore)) {
$objReferenceHelper = PHPExcel_ReferenceHelper::getInstance();
$objReferenceHelper->insertNewBefore($pBefore . '1', $pNumCols, 0, $this);
} else {
throw new Exception("Column references should not be numeric.");
}
return $this;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::insertNewColumnBeforeByIndex (   $pBefore = 0,
  $pNumCols = 1 
)

Insert a new column, updating all possible related data.

Parameters
int$pBeforeInsert before this one (numeric column coordinate of the cell)
int$pNumColsNumber of columns to insert
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1773 of file Worksheet.php.

References insertNewColumnBefore(), and PHPExcel_Cell\stringFromColumnIndex().

{
if ($pBefore >= 0) {
return $this->insertNewColumnBefore(PHPExcel_Cell::stringFromColumnIndex($pBefore), $pNumCols);
} else {
throw new Exception("Columns can only be inserted before at least column A (0).");
}
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::insertNewRowBefore (   $pBefore = 1,
  $pNumRows = 1 
)

Insert a new row, updating all possible related data.

Parameters
int$pBeforeInsert before this one
int$pNumRowsNumber of rows to insert
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1737 of file Worksheet.php.

References PHPExcel_ReferenceHelper\getInstance().

{
if ($pBefore >= 1) {
$objReferenceHelper = PHPExcel_ReferenceHelper::getInstance();
$objReferenceHelper->insertNewBefore('A' . $pBefore, 0, $pNumRows, $this);
} else {
throw new Exception("Rows can only be inserted before at least row 1.");
}
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::isTabColorSet ( )

Tab color set?

Returns
boolean

Definition at line 2544 of file Worksheet.php.

{
return !is_null($this->_tabColor);
}
PHPExcel_Worksheet::mergeCells (   $pRange = 'A1:A1')

Set merge on a cell range.

Parameters
string$pRangeCell range (e.g. A1:E1)
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1415 of file Worksheet.php.

References cellExists(), PHPExcel_Cell\extractAllCellReferencesInRange(), getCell(), and PHPExcel_Cell_DataType\TYPE_NULL.

Referenced by mergeCellsByColumnAndRow().

:A1')
{
// Uppercase coordinate
$pRange = strtoupper($pRange);
if (strpos($pRange,':') !== false) {
$this->_mergeCells[$pRange] = $pRange;
// make sure cells are created
// get the cells in the range
$aReferences = PHPExcel_Cell::extractAllCellReferencesInRange($pRange);
// create upper left cell if it does not already exist
$upperLeft = $aReferences[0];
if (!$this->cellExists($upperLeft)) {
$this->getCell($upperLeft)->setValueExplicit(null, PHPExcel_Cell_DataType::TYPE_NULL);
}
// create or blank out the rest of the cells in the range
$count = count($aReferences);
for ($i = 1; $i < $count; $i++) {
$this->getCell($aReferences[$i])->setValueExplicit(null, PHPExcel_Cell_DataType::TYPE_NULL);
}
} else {
throw new Exception('Merge must be set on a range of cells.');
}
return $this;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::mergeCellsByColumnAndRow (   $pColumn1 = 0,
  $pRow1 = 1,
  $pColumn2 = 0,
  $pRow2 = 1 
)

Set merge on a cell range by using numeric cell coordinates.

Parameters
int$pColumn1Numeric column coordinate of the first cell
int$pRow1Numeric row coordinate of the first cell
int$pColumn2Numeric column coordinate of the last cell
int$pRow2Numeric row coordinate of the last cell
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1457 of file Worksheet.php.

References mergeCells(), and PHPExcel_Cell\stringFromColumnIndex().

{
$cellRange = PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1 . ':' . PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2;
return $this->mergeCells($cellRange);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::namedRangeToArray (   $pNamedRange = '',
  $nullValue = null,
  $calculateFormulas = true,
  $formatData = true,
  $returnCellRef = false 
)

Create array from a range of cells.

Parameters
string$pNamedRangeName of the Named Range
mixed$nullValueValue returned in the array entry if a cell doesn't exist
boolean$calculateFormulasShould formulas be calculated?
boolean$formatDataShould formatting be applied to cell values?
boolean$returnCellRefFalse - Return a simple array of rows and columns indexed by number counting from zero True - Return rows and columns indexed by their actual row and column IDs
Returns
array
Exceptions
Exception

Definition at line 2233 of file Worksheet.php.

References PHPExcel_NamedRange\resolveRange().

{
$namedRange = PHPExcel_NamedRange::resolveRange($pNamedRange, $this);
if (!is_null($namedRange)) {
$pWorkSheet = $namedRange->getWorksheet();
$pCellRange = $namedRange->getRange();
return $pWorkSheet->rangeToArray( $pCellRange,
$nullValue, $calculateFormulas, $formatData, $returnCellRef);
}
throw new Exception('Named Range '.$pNamedRange.' does not exist.');
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::protectCells (   $pRange = 'A1',
  $pPassword = '',
  $pAlreadyHashed = false 
)

Set protection on a cell range.

Parameters
string$pRangeCell (e.g. A1) or cell range (e.g. A1:E1)
string$pPasswordPassword to unlock the protection
boolean$pAlreadyHashedIf the password has already been hashed, set this to true
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1536 of file Worksheet.php.

References PHPExcel_Shared_PasswordHasher\hashPassword().

Referenced by protectCellsByColumnAndRow().

{
// Uppercase coordinate
$pRange = strtoupper($pRange);
if (!$pAlreadyHashed) {
$pPassword = PHPExcel_Shared_PasswordHasher::hashPassword($pPassword);
}
$this->_protectedCells[$pRange] = $pPassword;
return $this;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::protectCellsByColumnAndRow (   $pColumn1 = 0,
  $pRow1 = 1,
  $pColumn2 = 0,
  $pRow2 = 1,
  $pPassword = '',
  $pAlreadyHashed = false 
)

Set protection on a cell range by using numeric cell coordinates.

Parameters
int$pColumn1Numeric column coordinate of the first cell
int$pRow1Numeric row coordinate of the first cell
int$pColumn2Numeric column coordinate of the last cell
int$pRow2Numeric row coordinate of the last cell
string$pPasswordPassword to unlock the protection
boolean$pAlreadyHashedIf the password has already been hashed, set this to true
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1561 of file Worksheet.php.

References protectCells(), and PHPExcel_Cell\stringFromColumnIndex().

{
$cellRange = PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1 . ':' . PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2;
return $this->protectCells($cellRange, $pPassword, $pAlreadyHashed);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::rangeToArray (   $pRange = 'A1',
  $nullValue = null,
  $calculateFormulas = true,
  $formatData = true,
  $returnCellRef = false 
)

Create array from a range of cells.

Parameters
string$pRangeRange of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
mixed$nullValueValue returned in the array entry if a cell doesn't exist
boolean$calculateFormulasShould formulas be calculated?
boolean$formatDataShould formatting be applied to cell values?
boolean$returnCellRefFalse - Return a simple array of rows and columns indexed by number counting from zero True - Return rows and columns indexed by their actual row and column IDs
Returns
array

Definition at line 2165 of file Worksheet.php.

References $row, PHPExcel_Cell\rangeBoundaries(), PHPExcel_Cell\stringFromColumnIndex(), and PHPExcel_Style_NumberFormat\toFormattedString().

Referenced by toArray().

{
// Returnvalue
$returnValue = array();
// Identify the range that we need to extract from the worksheet
list($rangeStart, $rangeEnd) = PHPExcel_Cell::rangeBoundaries($pRange);
$minCol = PHPExcel_Cell::stringFromColumnIndex($rangeStart[0] -1);
$minRow = $rangeStart[1];
$maxCol = PHPExcel_Cell::stringFromColumnIndex($rangeEnd[0] -1);
$maxRow = $rangeEnd[1];
$maxCol++;
// Loop through rows
for ($row = $minRow; $row <= $maxRow; ++$row) {
$c = -1;
// Loop through columns in the current row
for ($col = $minCol; $col != $maxCol; ++$col) {
$rRef = ($returnCellRef) ? $row : $row-1;
$cRef = ($returnCellRef) ? $col : ++$c;
// Using getCell() will create a new cell if it doesn't already exist. We don't want that to happen
// so we test and retrieve directly against _cellCollection
if ($this->_cellCollection->isDataSet($col.$row)) {
// Cell exists
$cell = $this->_cellCollection->getCacheData($col.$row);
if ($cell->getValue() !== null) {
if ($cell->getValue() instanceof PHPExcel_RichText) {
$returnValue[$rRef][$cRef] = $cell->getValue()->getPlainText();
} else {
if ($calculateFormulas) {
$returnValue[$rRef][$cRef] = $cell->getCalculatedValue();
} else {
$returnValue[$rRef][$cRef] = $cell->getValue();
}
}
if ($formatData) {
$style = $this->_parent->getCellXfByIndex($cell->getXfIndex());
$returnValue[$rRef][$cRef] = PHPExcel_Style_NumberFormat::toFormattedString($returnValue[$rRef][$cRef], $style->getNumberFormat()->getFormatCode());
}
} else {
// Cell holds a NULL
$returnValue[$rRef][$cRef] = $nullValue;
}
} else {
// Cell doesn't exist
$returnValue[$rRef][$cRef] = $nullValue;
}
}
}
// Return
return $returnValue;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::rebindParent ( PHPExcel  $parent)

Re-bind parent.

Parameters
PHPExcel$parent
Returns
PHPExcel_Worksheet

Definition at line 619 of file Worksheet.php.

References PHPExcel\addNamedRange().

Referenced by PHPExcel\addExternalSheet().

{
$namedRanges = $this->_parent->getNamedRanges();
foreach ($namedRanges as $namedRange) {
$parent->addNamedRange($namedRange);
}
$this->_parent->removeSheetByIndex(
$this->_parent->getIndex($this)
);
$this->_parent = $parent;
return $this;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::refreshColumnDimensions ( )

Refresh column dimensions.

Returns
PHPExcel_Worksheet

Definition at line 498 of file Worksheet.php.

References getColumnDimensions().

{
$currentColumnDimensions = $this->getColumnDimensions();
$newColumnDimensions = array();
foreach ($currentColumnDimensions as $objColumnDimension) {
$newColumnDimensions[$objColumnDimension->getColumnIndex()] = $objColumnDimension;
}
$this->_columnDimensions = $newColumnDimensions;
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::refreshRowDimensions ( )

Refresh row dimensions.

Returns
PHPExcel_Worksheet

Definition at line 517 of file Worksheet.php.

References getRowDimensions().

{
$currentRowDimensions = $this->getRowDimensions();
$newRowDimensions = array();
foreach ($currentRowDimensions as $objRowDimension) {
$newRowDimensions[$objRowDimension->getRowIndex()] = $objRowDimension;
}
$this->_rowDimensions = $newRowDimensions;
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::removeAutoFilter ( )

Remove autofilter.

Returns
PHPExcel_Worksheet

Definition at line 1670 of file Worksheet.php.

{
$this->_autoFilter = '';
return $this;
}
PHPExcel_Worksheet::removeColumn (   $pColumn = 'A',
  $pNumCols = 1 
)

Remove a column, updating all possible related data.

Parameters
int$pColumnRemove starting with this one
int$pNumColsNumber of columns to remove
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1807 of file Worksheet.php.

References PHPExcel_Cell\columnIndexFromString(), PHPExcel_ReferenceHelper\getInstance(), and PHPExcel_Cell\stringFromColumnIndex().

Referenced by removeColumnByIndex().

{
if (!is_numeric($pColumn)) {
$pColumn = PHPExcel_Cell::stringFromColumnIndex(PHPExcel_Cell::columnIndexFromString($pColumn) - 1 + $pNumCols);
$objReferenceHelper = PHPExcel_ReferenceHelper::getInstance();
$objReferenceHelper->insertNewBefore($pColumn . '1', -$pNumCols, 0, $this);
} else {
throw new Exception("Column references should not be numeric.");
}
return $this;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::removeColumnByIndex (   $pColumn = 0,
  $pNumCols = 1 
)

Remove a column, updating all possible related data.

Parameters
int$pColumnRemove starting with this one (numeric column coordinate of the cell)
int$pNumColsNumber of columns to remove
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1826 of file Worksheet.php.

References removeColumn(), and PHPExcel_Cell\stringFromColumnIndex().

{
if ($pColumn >= 0) {
return $this->removeColumn(PHPExcel_Cell::stringFromColumnIndex($pColumn), $pNumCols);
} else {
throw new Exception("Columns to be deleted should at least start from column 0");
}
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::removeConditionalStyles (   $pCoordinate = 'A1')

Removes conditional styles for a cell.

Parameters
string$pCoordinate
Returns
PHPExcel_Worksheet

Definition at line 1220 of file Worksheet.php.

{
unset($this->_conditionalStylesCollection[$pCoordinate]);
return $this;
}
PHPExcel_Worksheet::removeRow (   $pRow = 1,
  $pNumRows = 1 
)

Delete a row, updating all possible related data.

Parameters
int$pRowRemove starting with this one
int$pNumRowsNumber of rows to remove
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1789 of file Worksheet.php.

References PHPExcel_ReferenceHelper\getInstance().

{
if ($pRow >= 1) {
$objReferenceHelper = PHPExcel_ReferenceHelper::getInstance();
$objReferenceHelper->insertNewBefore('A' . ($pRow + $pNumRows), 0, -$pNumRows, $this);
} else {
throw new Exception("Rows to be deleted should at least start from row 1.");
}
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::resetTabColor ( )

Reset tab color.

Returns
PHPExcel_Worksheet

Definition at line 2531 of file Worksheet.php.

{
$this->_tabColor = null;
unset($this->_tabColor);
return $this;
}
PHPExcel_Worksheet::setAutoFilter (   $pRange = '')

Set Autofilter Range.

Parameters
string$pRangeCell range (i.e. A1:E10)
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1632 of file Worksheet.php.

Referenced by setAutoFilterByColumnAndRow().

{
// Uppercase coordinate
$pRange = strtoupper($pRange);
if (strpos($pRange,':') !== false) {
$this->_autoFilter = $pRange;
$this->_dirty = true;
} else {
throw new Exception('Autofilter must be set on a range of cells.');
}
return $this;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::setAutoFilterByColumnAndRow (   $pColumn1 = 0,
  $pRow1 = 1,
  $pColumn2 = 0,
  $pRow2 = 1 
)

Set Autofilter Range by using numeric cell coordinates.

Parameters
int$pColumn1Numeric column coordinate of the first cell
int$pRow1Numeric row coordinate of the first cell
int$pColumn2Numeric column coordinate of the second cell
int$pRow2Numeric row coordinate of the second cell
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1656 of file Worksheet.php.

References setAutoFilter(), and PHPExcel_Cell\stringFromColumnIndex().

{
return $this->setAutoFilter(
PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1
. ':' .
PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2
);
}

+ Here is the call graph for this function:

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

Set break on a cell.

Parameters
string$pCellCell coordinate (e.g. A1)
int$pBreakBreak type (type of PHPExcel_Worksheet::BREAK_*)
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1370 of file Worksheet.php.

Referenced by setBreakByColumnAndRow().

{
// Uppercase coordinate
$pCell = strtoupper($pCell);
if ($pCell != '') {
$this->_breaks[$pCell] = $pBreak;
} else {
throw new Exception('No cell coordinate specified.');
}
return $this;
}

+ Here is the caller graph for this function:

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

Set break on a cell by using numeric cell coordinates.

Parameters
integer$pColumnNumeric column coordinate of the cell
integer$pRowNumeric row coordinate of the cell
integer$pBreakBreak type (type of PHPExcel_Worksheet::BREAK_*)
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1393 of file Worksheet.php.

References setBreak(), and PHPExcel_Cell\stringFromColumnIndex().

{
return $this->setBreak(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow, $pBreak);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::setCellValue (   $pCoordinate = 'A1',
  $pValue = null,
  $returnCell = false 
)

Set a cell value.

Parameters
string$pCoordinateCoordinate of the cell
mixed$pValueValue of the cell
bool$returnCellReturn the worksheet (false, default) or the cell (true)
Returns
PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

Definition at line 858 of file Worksheet.php.

References getCell().

{
$cell = $this->getCell($pCoordinate);
$cell->setValue($pValue);
if ($returnCell) {
return $cell;
}
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::setCellValueByColumnAndRow (   $pColumn = 0,
  $pRow = 1,
  $pValue = null,
  $returnCell = false 
)

Set a cell value by using numeric cell coordinates.

Parameters
string$pColumnNumeric column coordinate of the cell
string$pRowNumeric row coordinate of the cell
mixed$pValueValue of the cell
bool$returnCellReturn the worksheet (false, default) or the cell (true)
Returns
PHPExcel_Worksheet|PHPExcel_Cell Depending on the last parameter being specified

Definition at line 878 of file Worksheet.php.

References getCell(), and PHPExcel_Cell\stringFromColumnIndex().

{
$cell = $this->getCell(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
$cell->setValue($pValue);
if ($returnCell) {
return $cell;
}
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::setCellValueExplicit (   $pCoordinate = 'A1',
  $pValue = null,
  $pDataType = PHPExcel_Cell_DataType::TYPE_STRING 
)

Set a cell value.

Parameters
string$pCoordinateCoordinate of the cell
mixed$pValueValue of the cell
string$pDataTypeExplicit data type
Returns
PHPExcel_Worksheet

Definition at line 897 of file Worksheet.php.

References getCell().

{
// Set value
$this->getCell($pCoordinate)->setValueExplicit($pValue, $pDataType);
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::setCellValueExplicitByColumnAndRow (   $pColumn = 0,
  $pRow = 1,
  $pValue = null,
  $pDataType = PHPExcel_Cell_DataType::TYPE_STRING 
)

Set a cell value by using numeric cell coordinates.

Parameters
string$pColumnNumeric column coordinate of the cell
string$pRowNumeric row coordinate of the cell
mixed$pValueValue of the cell
string$pDataTypeExplicit data type
Returns
PHPExcel_Worksheet

Definition at line 913 of file Worksheet.php.

References getCell(), and PHPExcel_Cell\stringFromColumnIndex().

{
return $this->getCell(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow)->setValueExplicit($pValue, $pDataType);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::setComments (   $pValue = array())

Set comments array for the entire sheet.

Parameters
arrayof PHPExcel_Comment
Returns
PHPExcel_Worksheet

Definition at line 1950 of file Worksheet.php.

{
$this->_comments = $pValue;
return $this;
}
PHPExcel_Worksheet::setConditionalStyles (   $pCoordinate = 'A1',
  $pValue 
)

Set conditional styles.

Parameters
$pCoordinatestring E.g. 'A1'
$pValuePHPExcel_Style_Conditional[]
Returns
PHPExcel_Worksheet

Definition at line 1243 of file Worksheet.php.

{
$this->_conditionalStylesCollection[$pCoordinate] = $pValue;
return $this;
}
PHPExcel_Worksheet::setDataValidation (   $pCellCoordinate = 'A1',
PHPExcel_Cell_DataValidation  $pDataValidation = null 
)

Set data validation.

Parameters
string$pCellCoordinateCell coordinate to insert data validation
PHPExcel_Cell_DataValidation$pDataValidation
Returns
PHPExcel_Worksheet

Definition at line 2454 of file Worksheet.php.

{
if ($pDataValidation === null) {
unset($this->_dataValidationCollection[$pCellCoordinate]);
} else {
$this->_dataValidationCollection[$pCellCoordinate] = $pDataValidation;
}
return $this;
}
PHPExcel_Worksheet::setDefaultStyle ( PHPExcel_Style  $pValue)

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

Deprecated:
Parameters
PHPExcel_Style$value
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1157 of file Worksheet.php.

References PHPExcel_Style\getFont().

{
$this->_parent->getDefaultStyle()->applyFromArray(array(
'font' => array(
'name' => $pValue->getFont()->getName(),
'size' => $pValue->getFont()->getSize(),
),
));
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::setHeaderFooter ( PHPExcel_Worksheet_HeaderFooter  $pValue)

Set page header/footer.

Parameters
PHPExcel_Worksheet_HeaderFooter$pValue
Returns
PHPExcel_Worksheet

Definition at line 778 of file Worksheet.php.

{
$this->_headerFooter = $pValue;
return $this;
}
PHPExcel_Worksheet::setHyperlink (   $pCellCoordinate = 'A1',
PHPExcel_Cell_Hyperlink  $pHyperlink = null 
)

Set hyperlnk.

Parameters
string$pCellCoordinateCell coordinate to insert hyperlink
PHPExcel_Cell_Hyperlink$pHyperlink
Returns
PHPExcel_Worksheet

Definition at line 2399 of file Worksheet.php.

{
if ($pHyperlink === null) {
unset($this->_hyperlinkCollection[$pCellCoordinate]);
} else {
$this->_hyperlinkCollection[$pCellCoordinate] = $pHyperlink;
}
return $this;
}
PHPExcel_Worksheet::setMergeCells (   $pValue = array())

Set merge cells array for the entire sheet.

Use instead mergeCells() to merge a single cell range.

Parameters
array

Definition at line 1520 of file Worksheet.php.

{
$this->_mergeCells = $pValue;
return $this;
}
PHPExcel_Worksheet::setPageMargins ( PHPExcel_Worksheet_PageMargins  $pValue)

Set page margins.

Parameters
PHPExcel_Worksheet_PageMargins$pValue
Returns
PHPExcel_Worksheet

Definition at line 756 of file Worksheet.php.

{
$this->_pageMargins = $pValue;
return $this;
}
PHPExcel_Worksheet::setPageSetup ( PHPExcel_Worksheet_PageSetup  $pValue)

Set page setup.

Parameters
PHPExcel_Worksheet_PageSetup$pValue
Returns
PHPExcel_Worksheet

Definition at line 734 of file Worksheet.php.

{
$this->_pageSetup = $pValue;
return $this;
}
PHPExcel_Worksheet::setPrintGridlines (   $pValue = false)

Set print gridlines.

Parameters
boolean$pValuePrint gridlines (true/false)
Returns
PHPExcel_Worksheet

Definition at line 1869 of file Worksheet.php.

{
$this->_printGridlines = $pValue;
return $this;
}
PHPExcel_Worksheet::setProtection ( PHPExcel_Worksheet_Protection  $pValue)

Set Protection.

Parameters
PHPExcel_Worksheet_Protection$pValue
Returns
PHPExcel_Worksheet

Definition at line 822 of file Worksheet.php.

{
$this->_protection = $pValue;
$this->_dirty = true;
return $this;
}
PHPExcel_Worksheet::setRightToLeft (   $value = false)

Set right-to-left.

Parameters
boolean$valueRight-to-left true/false
Returns
PHPExcel_Worksheet

Definition at line 2104 of file Worksheet.php.

{
$this->_rightToLeft = $value;
return $this;
}
PHPExcel_Worksheet::setSelectedCell (   $pCoordinate = 'A1')

Selected cell.

Parameters
string$pCellCell (i.e. A1)
Returns
PHPExcel_Worksheet

Definition at line 2037 of file Worksheet.php.

References setSelectedCells().

{
return $this->setSelectedCells($pCoordinate);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::setSelectedCellByColumnAndRow (   $pColumn = 0,
  $pRow = 1 
)

Selected cell by using numeric cell coordinates.

Parameters
int$pColumnNumeric column coordinate of the cell
int$pRowNumeric row coordinate of the cell
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 2084 of file Worksheet.php.

References setSelectedCells(), and PHPExcel_Cell\stringFromColumnIndex().

{
return $this->setSelectedCells(PHPExcel_Cell::stringFromColumnIndex($pColumn) . $pRow);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::setSelectedCells (   $pCoordinate = 'A1')

Select a range of cells.

Parameters
string$pCoordinateCell range, examples: 'A1', 'B2:G5', 'A:C', '3:6'
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 2049 of file Worksheet.php.

References PHPExcel_Cell\splitRange().

Referenced by getStyle(), setSelectedCell(), and setSelectedCellByColumnAndRow().

{
// Uppercase coordinate
$pCoordinate = strtoupper($pCoordinate);
// Convert 'A' to 'A:A'
$pCoordinate = preg_replace('/^([A-Z]+)$/', '${1}:${1}', $pCoordinate);
// Convert '1' to '1:1'
$pCoordinate = preg_replace('/^([0-9]+)$/', '${1}:${1}', $pCoordinate);
// Convert 'A:C' to 'A1:C1048576'
$pCoordinate = preg_replace('/^([A-Z]+):([A-Z]+)$/', '${1}1:${2}1048576', $pCoordinate);
// Convert '1:3' to 'A1:XFD3'
$pCoordinate = preg_replace('/^([0-9]+):([0-9]+)$/', 'A${1}:XFD${2}', $pCoordinate);
if (strpos($pCoordinate,':') !== false || strpos($pCoordinate,',') !== false) {
list($first, ) = PHPExcel_Cell::splitRange($pCoordinate);
$this->_activeCell = $first[0];
} else {
$this->_activeCell = $pCoordinate;
}
$this->_selectedCells = $pCoordinate;
return $this;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::setSharedStyle ( PHPExcel_Style  $pSharedCellStyle = null,
  $pRange = '' 
)

Set shared cell style to a range of cells.

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

Deprecated:
Parameters
PHPExcel_Style$pSharedCellStyleCell style to share
string$pRangeRange of cells (i.e. "A1:B10"), or just one cell (i.e. "A1")
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1272 of file Worksheet.php.

References duplicateStyle().

{
$this->duplicateStyle($pSharedCellStyle, $pRange);
return $this;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::setSheetState (   $value = PHPExcel_Worksheet::SHEETSTATE_VISIBLE)

Set sheet state.

Parameters
string$valueSheet state (visible, hidden, veryHidden)
Returns
PHPExcel_Worksheet

Definition at line 713 of file Worksheet.php.

Referenced by __construct().

{
$this->_sheetState = $value;
return $this;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::setSheetView ( PHPExcel_Worksheet_SheetView  $pValue)

Set sheet view.

Parameters
PHPExcel_Worksheet_SheetView$pValue
Returns
PHPExcel_Worksheet

Definition at line 800 of file Worksheet.php.

{
$this->_sheetView = $pValue;
return $this;
}
PHPExcel_Worksheet::setShowGridlines (   $pValue = false)

Set show gridlines.

Parameters
boolean$pValueShow gridlines (true/false)
Returns
PHPExcel_Worksheet

Definition at line 1849 of file Worksheet.php.

{
$this->_showGridlines = $pValue;
return $this;
}
PHPExcel_Worksheet::setShowRowColHeaders (   $pValue = false)

Set show row and column headers.

Parameters
boolean$pValueShow row and column headers (true/false)
Returns
PHPExcel_Worksheet

Definition at line 1889 of file Worksheet.php.

{
$this->_showRowColHeaders = $pValue;
return $this;
}
PHPExcel_Worksheet::setShowSummaryBelow (   $pValue = true)

Set show summary below.

Parameters
boolean$pValueShow summary below (true/false)
Returns
PHPExcel_Worksheet

Definition at line 1909 of file Worksheet.php.

{
$this->_showSummaryBelow = $pValue;
return $this;
}
PHPExcel_Worksheet::setShowSummaryRight (   $pValue = true)

Set show summary right.

Parameters
boolean$pValueShow summary right (true/false)
Returns
PHPExcel_Worksheet

Definition at line 1929 of file Worksheet.php.

{
$this->_showSummaryRight = $pValue;
return $this;
}
PHPExcel_Worksheet::setTitle (   $pValue = 'Worksheet')

Set title.

Parameters
string$pValueString containing the dimension of this worksheet
Returns
PHPExcel_Worksheet

Definition at line 649 of file Worksheet.php.

References _checkSheetTitle(), PHPExcel_Shared_String\CountCharacters(), PHPExcel_ReferenceHelper\getInstance(), getParent(), getTitle(), and PHPExcel_Shared_String\Substring().

Referenced by __construct().

{
// Is this a 'rename' or not?
if ($this->getTitle() == $pValue) {
return $this;
}
// Syntax check
self::_checkSheetTitle($pValue);
// Old title
$oldTitle = $this->getTitle();
// Is there already such sheet name?
if ($this->getParent()->getSheetByName($pValue)) {
// Use name, but append with lowest possible integer
if (PHPExcel_Shared_String::CountCharacters($pValue) > 29) {
$pValue = PHPExcel_Shared_String::Substring($pValue,0,29);
}
$i = 1;
while ($this->getParent()->getSheetByName($pValue . ' ' . $i)) {
++$i;
if ($i == 10) {
if (PHPExcel_Shared_String::CountCharacters($pValue) > 28) {
$pValue = PHPExcel_Shared_String::Substring($pValue,0,28);
}
} elseif ($i == 100) {
if (PHPExcel_Shared_String::CountCharacters($pValue) > 27) {
$pValue = PHPExcel_Shared_String::Substring($pValue,0,27);
}
}
}
$altTitle = $pValue . ' ' . $i;
return $this->setTitle($altTitle);
}
// Set title
$this->_title = $pValue;
$this->_dirty = true;
// New title
$newTitle = $this->getTitle();
PHPExcel_ReferenceHelper::getInstance()->updateNamedFormulas($this->getParent(), $oldTitle, $newTitle);
return $this;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

PHPExcel_Worksheet::shrinkRangeToFit (   $range)

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

Parameters
string$range
Returns
string Adjusted range value

Definition at line 2491 of file Worksheet.php.

References PHPExcel_Cell\columnIndexFromString(), getHighestColumn(), getHighestRow(), PHPExcel_Cell\getRangeBoundaries(), and PHPExcel_Cell\stringFromColumnIndex().

{
$maxCol = $this->getHighestColumn();
$maxRow = $this->getHighestRow();
$maxCol = PHPExcel_Cell::columnIndexFromString($maxCol);
$rangeBlocks = explode(' ',$range);
foreach ($rangeBlocks as &$rangeSet) {
$rangeBoundaries = PHPExcel_Cell::getRangeBoundaries($rangeSet);
if (PHPExcel_Cell::columnIndexFromString($rangeBoundaries[0][0]) > $maxCol) { $rangeBoundaries[0][0] = PHPExcel_Cell::stringFromColumnIndex($maxCol); }
if ($rangeBoundaries[0][1] > $maxRow) { $rangeBoundaries[0][1] = $maxRow; }
if (PHPExcel_Cell::columnIndexFromString($rangeBoundaries[1][0]) > $maxCol) { $rangeBoundaries[1][0] = PHPExcel_Cell::stringFromColumnIndex($maxCol); }
if ($rangeBoundaries[1][1] > $maxRow) { $rangeBoundaries[1][1] = $maxRow; }
$rangeSet = $rangeBoundaries[0][0].$rangeBoundaries[0][1].':'.$rangeBoundaries[1][0].$rangeBoundaries[1][1];
}
unset($rangeSet);
$stRange = implode(' ',$rangeBlocks);
return $stRange;
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::sortCellCollection ( )

Sort collection of cells.

Returns
PHPExcel_Worksheet

Definition at line 435 of file Worksheet.php.

Referenced by getCellCollection().

{
if (!is_null($this->_cellCollection)) {
return $this->_cellCollection->getSortedCellList();
}
return array();
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::toArray (   $nullValue = null,
  $calculateFormulas = true,
  $formatData = true,
  $returnCellRef = false 
)

Create array from worksheet.

Parameters
mixed$nullValueValue returned in the array entry if a cell doesn't exist
boolean$calculateFormulasShould formulas be calculated?
boolean$formatDataShould formatting be applied to cell values?
boolean$returnCellRefFalse - Return a simple array of rows and columns indexed by number counting from zero True - Return rows and columns indexed by their actual row and column IDs
Returns
array

Definition at line 2257 of file Worksheet.php.

References garbageCollect(), getHighestColumn(), getHighestRow(), and rangeToArray().

{
// Garbage collect...
$this->garbageCollect();
// Identify the range that we need to extract from the worksheet
$maxCol = $this->getHighestColumn();
$maxRow = $this->getHighestRow();
// Return
return $this->rangeToArray( 'A1:'.$maxCol.$maxRow,
$nullValue, $calculateFormulas, $formatData, $returnCellRef);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::unfreezePane ( )

Unfreeze Pane.

Returns
PHPExcel_Worksheet

Definition at line 1724 of file Worksheet.php.

References freezePane().

{
return $this->freezePane('');
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::unmergeCells (   $pRange = 'A1:A1')

Remove merge on a cell range.

Parameters
string$pRangeCell range (e.g. A1:E1)
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1470 of file Worksheet.php.

Referenced by unmergeCellsByColumnAndRow().

:A1')
{
// Uppercase coordinate
$pRange = strtoupper($pRange);
if (strpos($pRange,':') !== false) {
if (isset($this->_mergeCells[$pRange])) {
unset($this->_mergeCells[$pRange]);
} else {
throw new Exception('Cell range ' . $pRange . ' not known as merged.');
}
} else {
throw new Exception('Merge can only be removed from a range of cells.');
}
return $this;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::unmergeCellsByColumnAndRow (   $pColumn1 = 0,
  $pRow1 = 1,
  $pColumn2 = 0,
  $pRow2 = 1 
)

Remove merge on a cell range by using numeric cell coordinates.

Parameters
int$pColumn1Numeric column coordinate of the first cell
int$pRow1Numeric row coordinate of the first cell
int$pColumn2Numeric column coordinate of the last cell
int$pRow2Numeric row coordinate of the last cell
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1498 of file Worksheet.php.

References PHPExcel_Cell\stringFromColumnIndex(), and unmergeCells().

{
$cellRange = PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1 . ':' . PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2;
return $this->unmergeCells($cellRange);
}

+ Here is the call graph for this function:

PHPExcel_Worksheet::unprotectCells (   $pRange = 'A1')

Remove protection on a cell range.

Parameters
string$pRangeCell (e.g. A1) or cell range (e.g. A1:E1)
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1574 of file Worksheet.php.

Referenced by unprotectCellsByColumnAndRow().

{
// Uppercase coordinate
$pRange = strtoupper($pRange);
if (isset($this->_protectedCells[$pRange])) {
unset($this->_protectedCells[$pRange]);
} else {
throw new Exception('Cell range ' . $pRange . ' not known as protected.');
}
return $this;
}

+ Here is the caller graph for this function:

PHPExcel_Worksheet::unprotectCellsByColumnAndRow (   $pColumn1 = 0,
  $pRow1 = 1,
  $pColumn2 = 0,
  $pRow2 = 1,
  $pPassword = '',
  $pAlreadyHashed = false 
)

Remove protection on a cell range by using numeric cell coordinates.

Parameters
int$pColumn1Numeric column coordinate of the first cell
int$pRow1Numeric row coordinate of the first cell
int$pColumn2Numeric column coordinate of the last cell
int$pRow2Numeric row coordinate of the last cell
string$pPasswordPassword to unlock the protection
boolean$pAlreadyHashedIf the password has already been hashed, set this to true
Exceptions
Exception
Returns
PHPExcel_Worksheet

Definition at line 1599 of file Worksheet.php.

References PHPExcel_Cell\stringFromColumnIndex(), and unprotectCells().

{
$cellRange = PHPExcel_Cell::stringFromColumnIndex($pColumn1) . $pRow1 . ':' . PHPExcel_Cell::stringFromColumnIndex($pColumn2) . $pRow2;
return $this->unprotectCells($cellRange, $pPassword, $pAlreadyHashed);
}

+ Here is the call graph for this function:

Field Documentation

PHPExcel_Worksheet::$_activeCell = 'A1'
private

Definition at line 256 of file Worksheet.php.

Referenced by getActiveCell().

PHPExcel_Worksheet::$_autoFilter = ''
private

Definition at line 200 of file Worksheet.php.

Referenced by getAutoFilter().

PHPExcel_Worksheet::$_breaks = array()
private

Definition at line 179 of file Worksheet.php.

Referenced by getBreaks().

PHPExcel_Worksheet::$_cachedHighestColumn = 'A'
private

Definition at line 270 of file Worksheet.php.

Referenced by getHighestColumn().

PHPExcel_Worksheet::$_cachedHighestRow = 1
private

Definition at line 277 of file Worksheet.php.

Referenced by getHighestRow().

PHPExcel_Worksheet::$_cellCollection = null
private

Definition at line 67 of file Worksheet.php.

Referenced by __clone(), and getCellCacheController().

PHPExcel_Worksheet::$_cellCollectionIsSorted = false
private

Definition at line 172 of file Worksheet.php.

PHPExcel_Worksheet::$_columnDimensions = array()
private

Definition at line 88 of file Worksheet.php.

Referenced by getColumnDimensions().

PHPExcel_Worksheet::$_comments = array()
private

Definition at line 249 of file Worksheet.php.

Referenced by getComments().

PHPExcel_Worksheet::$_conditionalStylesCollection = array()
private

Definition at line 165 of file Worksheet.php.

Referenced by getConditionalStylesCollection().

PHPExcel_Worksheet::$_dataValidationCollection = array()
private

Definition at line 298 of file Worksheet.php.

Referenced by getDataValidationCollection().

PHPExcel_Worksheet::$_defaultColumnDimension = null
private

Definition at line 95 of file Worksheet.php.

Referenced by getDefaultColumnDimension().

PHPExcel_Worksheet::$_defaultRowDimension = null
private

Definition at line 81 of file Worksheet.php.

Referenced by getDefaultRowDimension().

PHPExcel_Worksheet::$_dirty = true
private

Definition at line 312 of file Worksheet.php.

PHPExcel_Worksheet::$_drawingCollection = null
private

Definition at line 102 of file Worksheet.php.

Referenced by __clone(), and getDrawingCollection().

PHPExcel_Worksheet::$_freezePane = ''
private

Definition at line 207 of file Worksheet.php.

Referenced by getFreezePane().

PHPExcel_Worksheet::$_hash = null
private

Definition at line 319 of file Worksheet.php.

Referenced by getHashCode().

PHPExcel_Worksheet::$_headerFooter
private

Definition at line 137 of file Worksheet.php.

Referenced by getHeaderFooter().

PHPExcel_Worksheet::$_hyperlinkCollection = array()
private

Definition at line 291 of file Worksheet.php.

Referenced by getHyperlinkCollection().

PHPExcel_Worksheet::$_invalidCharacters = array('*', ':', '/', '\\', '?', '[', ']')
staticprivate

Definition at line 53 of file Worksheet.php.

Referenced by getInvalidCharacters().

PHPExcel_Worksheet::$_mergeCells = array()
private

Definition at line 186 of file Worksheet.php.

Referenced by getMergeCells().

PHPExcel_Worksheet::$_pageMargins
private

Definition at line 130 of file Worksheet.php.

Referenced by getPageMargins().

PHPExcel_Worksheet::$_pageSetup
private

Definition at line 123 of file Worksheet.php.

Referenced by getPageSetup().

PHPExcel_Worksheet::$_parent
private

Definition at line 60 of file Worksheet.php.

Referenced by duplicateStyle(), and getParent().

PHPExcel_Worksheet::$_printGridlines = false
private

Definition at line 221 of file Worksheet.php.

Referenced by getPrintGridlines().

PHPExcel_Worksheet::$_protectedCells = array()
private

Definition at line 193 of file Worksheet.php.

Referenced by getProtectedCells().

PHPExcel_Worksheet::$_protection
private

Definition at line 151 of file Worksheet.php.

Referenced by getProtection().

PHPExcel_Worksheet::$_rightToLeft = false
private

Definition at line 284 of file Worksheet.php.

Referenced by getRightToLeft().

PHPExcel_Worksheet::$_rowDimensions = array()
private

Definition at line 74 of file Worksheet.php.

Referenced by getRowDimensions().

PHPExcel_Worksheet::$_selectedCells = 'A1'
private

Definition at line 263 of file Worksheet.php.

Referenced by getSelectedCells().

PHPExcel_Worksheet::$_sheetState
private

Definition at line 116 of file Worksheet.php.

Referenced by getSheetState().

PHPExcel_Worksheet::$_sheetView
private

Definition at line 144 of file Worksheet.php.

Referenced by getSheetView().

PHPExcel_Worksheet::$_showGridlines = true
private

Definition at line 214 of file Worksheet.php.

Referenced by getShowGridlines().

PHPExcel_Worksheet::$_showRowColHeaders = true
private

Definition at line 228 of file Worksheet.php.

Referenced by getShowRowColHeaders().

PHPExcel_Worksheet::$_showSummaryBelow = true
private

Definition at line 235 of file Worksheet.php.

Referenced by getShowSummaryBelow().

PHPExcel_Worksheet::$_showSummaryRight = true
private

Definition at line 242 of file Worksheet.php.

Referenced by getShowSummaryRight().

PHPExcel_Worksheet::$_styles = array()
private

Definition at line 158 of file Worksheet.php.

Referenced by getStyles().

PHPExcel_Worksheet::$_tabColor
private

Definition at line 305 of file Worksheet.php.

Referenced by getTabColor().

PHPExcel_Worksheet::$_title
private

Definition at line 109 of file Worksheet.php.

Referenced by getTitle().

const PHPExcel_Worksheet::BREAK_COLUMN = 2

Definition at line 41 of file Worksheet.php.

Referenced by PHPExcel_Reader_Excel5\_readVerticalPageBreaks(), PHPExcel_Writer_Excel2007_Worksheet\_writeBreaks(), PHPExcel_Writer_Excel5_Worksheet\_writeBreaks(), and PHPExcel_Reader_Excel2007\load().

const PHPExcel_Worksheet::BREAK_NONE = 0

Definition at line 39 of file Worksheet.php.

Referenced by PHPExcel_Writer_Excel5_Worksheet\_writeBreaks(), and PHPExcel_ReferenceHelper\insertNewBefore().

const PHPExcel_Worksheet::BREAK_ROW = 1

Definition at line 40 of file Worksheet.php.

Referenced by PHPExcel_Reader_Excel5\_readHorizontalPageBreaks(), PHPExcel_Writer_Excel2007_Worksheet\_writeBreaks(), PHPExcel_Writer_Excel5_Worksheet\_writeBreaks(), and PHPExcel_Reader_Excel2007\load().

const PHPExcel_Worksheet::SHEETSTATE_HIDDEN = 'hidden'

Definition at line 45 of file Worksheet.php.

Referenced by PHPExcel_Reader_Excel5\_readSheet().

const PHPExcel_Worksheet::SHEETSTATE_VERYHIDDEN = 'veryHidden'

Definition at line 46 of file Worksheet.php.

Referenced by PHPExcel_Reader_Excel5\_readSheet().

const PHPExcel_Worksheet::SHEETSTATE_VISIBLE = 'visible'

Definition at line 44 of file Worksheet.php.

Referenced by __construct(), and PHPExcel_Reader_Excel5\_readSheet().

The documentation for this class was generated from the following file: